openspecimen/rest/ng/distribution-protocols
or
openspecimen/rest/ng/distribution-protocols?maxResults={maxResults}
Use this resource to get distribution protocols. This API returns all the distribution protocols present in the openSpecimen application.
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 |
|---|---|
| maxResults | maximum number of records to fetch. By default it will be 1000 |
http[s]:<host>:<port>/openspecimen/rest/ng/distribution-protocols
or
http[s]:<host>:<port>/openspecimen/rest/ng/distribution-protocols?maxResults={maxResults}
Use this URL to get distribution protocols in openSpecimen application.
Result:
The response of this request will contains the details of the distribution protocols.
Below is the example of the get distribution-protocols:
| URL |
or
|
| Method | GET |
| Request | application/json |
Response | [0] [{ id: 1 title: "DPProtocol" shortTitle: "DP Pro" irbId: "IRB555571" startDate: 1402617600000 anticipatedSpecimenCount: 20 activityStatus: "Active" }, [1] { id: 2 title: "CP Protocol" shortTitle: "CP Pro" irbId: "IRB555571" startDate: 1402617600000 anticipatedSpecimenCount: 20 activityStatus: "Active" }]
|
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | distribution protocols got successfully |
| 401 | All requests | Authorization failed, user doesn’t have authority |
| 500 | All requests | Internal server error, encountered server error while performing operations |