/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 | System generated identifier for registered participant for particular collection protocol |
| 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 | { "cohort": "Treated" |
Response | { "id": 1 "cohort": "Treated" } |
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 |