openspecimen/rest/ng/collection-protocols
...
openspecimen/rest/ng/collection-protocols?start={start}&max={maxResults}&searchStringquery={searchString}&countReq={true/false}
...
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. |
...
| 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 |