openspecimen/rest/ng/visits/bynamespr?visitName=<Visit Name>&
Or
openspecimen/rest/ng/visits/bynamespr?sprNumber=<Surgical Pathology Number>
...
- 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.
- If you pass both then API will return union of visit with given name and 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:
...
Use this URL to get visits in openSpecimen application.
Result:
...
| 01 |
| Method | GET |
| Request | application/json |
Response | | Code Block |
|---|
| 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?cprId=539&includeStats=truesprNumber=1234 |
| Method | GET |
| Request | application/json |
Response | | Code Block |
|---|
| [
0: {
id"cprId": 665595
"eventId": 4
"ppid": "DWP00013"
"eventLabel": "Baseline"
"eventPoint": 10
"cpId": 2
"cpTitle": "Planned Clinical Study"
"cpShortTitle": 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 "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: {
id"cprId": null595
"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": 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 :
| | |
|---|
| 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 |