openspecimen/rest/ng/visits/collect
Use this resource to add visit and collect specimens of that visit.
Use HTTP POST method to call this API by passing the below details in JSON format.
Below are the attributes which need to be sent in the request body:
Parameter | Details |
|---|---|
| visitName [optional] | Name of the visit |
| sprNumber [optional] | Surgical pathology number |
Here both parameters are optional
- If you pass only visit name API will return visit with given visit name
- If you pass only spr number then API will return all visits with given spr number.
Result:
The response of this request will contains the details of the visits with anticipated and unplanned collection status.
Below is the example of the get visits by name:
| URL | http://<host>:<port>/openspecimen/rest/ng/visits/bynamespr?visitName=01 |
| Method | GET |
| Request | application/json |
Response | 0: {
"cprId": 595
"eventId": 4
"ppid": "DWP00013"
"eventLabel": "Baseline"
"eventPoint": 10
"cpId": 2
"cpTitle": "Planned Clinical Study"
"cpShortTitle": "A Planned Clinical Study FD"
"id": 722
"name": "01"
"clinicalDiagnosis": "Not Specified"
"clinicalStatus": "Not Specified"
"activityStatus": "Active"
"site": "Arkansas Hospital"
"status": "Complete"
"comments": null
"surgicalPathologyNumber": "1234"
"sprName": null
"missedReason": null
"missedBy": null
"sprLocked": false
"visitDate": 1450377000000
"code": null
"cohort": null
"extensionDetail": null
}
|
Below is the example of the get visits by spr number:
| URL | http://<host>:<port>/openspecimen/rest/ng/visits/bynamespr?sprNumber=1234 |
| Method | GET |
| Request | application/json |
Response | 0: {
"cprId": 595
"eventId": 4
"ppid": "DWP00013"
"eventLabel": "Baseline"
"eventPoint": 10
"cpId": 2
"cpTitle": "Planned Clinical Study"
"cpShortTitle": "A Planned Clinical Study FD"
"id": 722
"name": "01"
"clinicalDiagnosis": "Not Specified"
"clinicalStatus": "Not Specified"
"activityStatus": "Active"
"site": "Arkansas Hospital"
"status": "Complete"
"comments": null
"surgicalPathologyNumber": "1234"
"sprName": null
"missedReason": null
"missedBy": null
"sprLocked": false
"visitDate": 1450377000000
"code": null
"cohort": null
"extensionDetail": null
}
-
1: {
"cprId": 595
"eventId": 86
"ppid": "DWP00013"
"eventLabel": "Test"
"eventPoint": 10
"cpId": 2
"cpTitle": "Planned Clinical Study"
"cpShortTitle": "A Planned Clinical Study FD"
"id": 723
"name": "02"
"clinicalDiagnosis": "Not Specified"
"clinicalStatus": "Not Specified"
"activityStatus": "Active"
"site": "3165 Porder Drive"
"status": "Complete"
"comments": null
"surgicalPathologyNumber": "1234"
"sprName": null
"missedReason": null
"missedBy": null
"sprLocked": false
"visitDate": 1450377000000
"code": null
"cohort": null
"extensionDetail": null
}
|
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Specimen collection groups got successfully |
| 401 | All requests | Authorization failed, user doesn’t have authority |
| 500 | All requests | Internal server error, encountered server error while performing operations |