Page Comparison

This API is available for add visit for.

List of mandatory fields:

...

/openspecimen/rest/ng/visits

This rest api is used to add visit of registered participant. Use HTTP POST method to call this api by passing below details in json format.

Below are the attributes which need to be sent in request body.

Parameter	Description
cprId	Participant registration identifier
eventId	Event Identifier
ppid	Participant protocol identifer
eventLabel	Event label
eventPoint	Event point
cpId	Collection protocol identifier
cpTitle	Collection protocol title
cpShortTitle	Collection protocol short title
name	Visit name
code	Unique code given to visit. Which can used for barcode based data entry
clinicalDiagnosis	Clinical diagnosis
clinicalStatus	Clinical status
activityStatus	Activity Status
site	Site name where visit perform
status	Status of visit (COMPLETE, PENDING, MISSED)
missedReason	Reason in case of missed visits
missedBy	User details by which visit got missed
comments	Comments on visit
surgicalPathologyNumber	Surgical pathology number
cohort	Cohort is a group of subjects who have shared a particular event together during a particular time span. Cohorts may be tracked over extended periods in a cohort study

http[s]:<host>:<port>/openspecimen/rest/ng/visits

Use this URL to add visit for a registered participant in OpenSpecimen application.

Result:

The response of this request will contains the details of the created visit.

Below is the example of the create participant:

URL	openspecimen/rest/ng/visits
Request type	application/json
Method	POST
json	{ "cprIdname": 5"LP-5600-W0-PD", "eventIdcode": 2"1", "cpShortTitlecpTitle": "CNSLung Cancer Protocol", "namecprId": "skinCancerStudy_1_11", 101, "eventId": 1, "eventLabel": "Initial Visit", "eventPoint": 0, "clinicalDiagnosis": "Not SpecifiedNot Specified", "clinicalStatus": "Not SpecifiedOperative", "activityStatus": "Active", "site": "ATCC""Site 1", "visitDate": 23-11-2015, "collectionStatusstatus": "Complete", "surgicalPathologyNumber": "path1231234567" }
Response	{ { "id":1, "id": 1 "name": "LP-5600-W0-PD", "code": "1", "cpTitle": "Lung Cancer Protocol", "cprId": 5 101, " cpeId eventId": 2 1, " name eventLabel": " skinCancerStudy_1_11" Initial Visit", "eventPoint": 0, "clinicalDiagnosis": "Not Specified", "clinicalStatus": " Not Specified Operative", "activityStatus": "Active", " collectionSiteName site": " ATCC" Site 1", "visitDate": 23-11-2015, " collectionStatus status": "Complete", "surgicalPathologyNumber": "1234567" }

Error Cases :

code	Applies to	Status Message
200	All resources	Specimen Collection group has been created successfully
400	All requests	Invalid parameters, e.g duplicate name, duplicate barcode, invalid Site Name , duplicate code etc
401	All requests	Authorization failed, User doesn’t have Authority to create specimen collection group for the given collection protocol
500	All requests	Internal server error, Encountered server error while performing operations

Versions Compared