openspecimen/rest/ng/collection-protocols
or
openspecimen/rest/ng/collection-protocols?start={start}&max={maxResults}&searchString={searchString}&countReq={true/false}
Use this resource to get collection protocols. This API returns all the matching collection protocols based on the searchString, if searchString not specified then it returns all the collection 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 |
|---|---|
| chkPrivilege [optional] | Whether to return the CP's as per user's privileges. By default this API will return list of CP's on which user actually has access. If need all CP's then set this attribute to false. |
| searchString [optional] | The value with which you want to search the collection protocol. The given value will be matched with Title and Short Title. |
| start [optional] | start index of the results |
| maxResults [optional] | Maximum number of records to fetch. By default it will be 1000 |
| countReq [optional] | Set this parameter to true, if want to get the total count of matching results. |
http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols
or
http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols?start={start}&max={maxResults}&searchString={searchString}&countReq={true/false}
Use this URL to get collection protocols in openSpecimen application.
Result:
The response of this request will contains the details of the collection protocols.
Below is the example of the get all collection protocols:
| URL | http://<host>:<port>/openspecimen/rest/ng/collection-protocols?searchString=skinCancerStudy |
| Method | GET |
| Request | application/json |
Response | [{ id: 1 shortTitle: "SCS_CP" title: "skinCancerStudy" ppidFormat: " " }] |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Collection 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 |