Leave a comment at the end of this page or email contact@krishagni.com
Get Visits By Registration Identifier
openspecimen/rest/ng/visits?cprId=<regId>&includeStats=true/false
Use this resource to get visits. This API returns all visits for the given registration id.
Use HTTP GET 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 |
---|---|
cprId | Identifier of the collection protocol registration. |
includeStats [optional] | For true value, API will return collection status of visits which include planned and unplanned collection. By default false value is set. |
http[s]:<host>:<port>/openspecimen/rest/ng/visits?cprId=<regId>&includeStats=true/false
Use this URL to get visits in openSpecimen application.
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:
URL | http://<host>:<port>/openspecimen /rest/ng/visits?cprId=539&includeStats=true |
Method | GET |
Request | application/json |
Response | [ 0: { id: 665 eventId: 84 name: "LP-6800-W0-PD" eventLabel: "Initial Visit" eventPoint: 0 status: "Complete" visitDate: 1449039799000 anticipatedVisitDate: 1448994600000 anticipatedSpecimens: 12 collectedSpecimens: 9 uncollectedSpecimens: 0 unplannedSpecimens: 0 missedReason: null missedBy: null } - 1: { id: null eventId: 85 name: null eventLabel: "Week Two" eventPoint: 7 status: null visitDate: null anticipatedVisitDate: 1449599400000 anticipatedSpecimens: 3 collectedSpecimens: 0 uncollectedSpecimens: 0 unplannedSpecimens: 0 missedReason: null missedBy: 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 |
Leave a comment at the end of this page or email contact@krishagni.com