openspecimen/rest/ng/distribution-protocols/{id}
or
openspecimen/rest/ng/distribution-protocols/title={title}
Use this resource to get distribution protocol. This API returns distribution-protocol present in the openSpecimen application. Use HTTP GET method to call this API by passing the below details in JSON format.
...
Parameter | Details |
|---|---|
| id | distribution protocol id to fetch the distribution-protocol |
| name | distribution protocol title to fetch the distribution-protocol |
http[s]:<host>:<port>/openspecimen/rest/ng/distribution-protocols/{id}
or
http[s]:<host>:<port>/openspecimen/rest/ng/distribution-protocols/title={title}
Use this URL to get distribution-protocol by an id in openSpecimen application.
...
| URL |
or
|
| Method | GET |
| Request | application/json |
Response | { id: 20 title: "DP Protocol" shortTitle: "DP Pro" irbId: "IRB555571" startDate: 1402617600000 anticipatedSpecimenCount: 20 activityStatus: "Active" } |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | distribution-protocol got successfully |
| 401 | All requests | Authorization failed, user doesn’t have authority |
| 500 | All requests | Internal server error, encountered server error while performing operations |