openspecimen/rest/ng/visits/{visitId}
Use this resource to get visits. This API returns all visit.
Use HTTP GET method to call this API by passing visit identifier in url path
http[s]:<host>:<port>/openspecimen/rest/ng/visits/{visitId}
Use this URL to get visits in openSpecimen application.
Result:
The response of this request will contains the details of the visit.
Below is the example of the get visits:
| URL | http://<host>:<port>/openspecimen/rest/ng/visits/665 |
| Method | GET |
| Request | application/json |
Response | {
cprId: 539
eventId: 84
ppid: "LP-6800"
eventLabel: "Initial Visit"
eventPoint: 0
cpId: 52
cpTitle: "Lung Cancer Protocol"
cpShortTitle: "LCP"
id: 665
name: "LP-6800-W0-PD"
clinicalDiagnosis: null
clinicalStatus: null
activityStatus: "Active"
site: "3165 Porder Drive"
status: "Complete"
comments: null
surgicalPathologyNumber: null
sprName: "stanford.txt"
missedReason: null
missedBy: null
sprLocked: false
visitDate: 12-02-2015
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 |