openspecimen/rest/ng/collection-protocols
or
openspecimen/rest/ng/collection-protocols?searchString={searchString}
or
openspecimen/rest/ng/collection-protocols?maxResults={maxResults}
or
openspecimen/rest/ng/collection-protocols?searchString={searchString}&maxResults={maxResults}
Use this resource to get All CPs. User can also specify the search string which will be used to match the shot titles. 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 |
|---|---|
| searchString | String for search condition to get the CPs |
| maxResults | Integer value to get maximum records. By default it will be 1000 |
http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols
or
http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols?searchString={searchString}
or
http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols?maxResults={maxResults}
or
http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols?maxResults={maxResults}&searchString={searchString}
Use this URL to get CPs in openSpecimen application.
Result:
The response of this request will contains the details of the CPs.
Below is the example of the get CPs:
| URL | http://<host>:<port>/openspecimen/rest/ng/collection-protocols?maxResults=2&searchString=s |
| Method | GET |
| Request | application/json |
Response | [{ id: 1 shortTitle: "SCS_CP" title: "skinCancerStudy" ppidFormat: " " } { id: 63 shortTitle: "scg1" title: "scg1" ppidFormat: null } ] |
| URL | http://<host>:<port>/openspecimen/rest/ng/collection-protocols?searchString=s |
| Method | GET |
| Request | application/json |
Response | [{ id: 1 shortTitle: "SCS_CP" title: "skinCancerStudy" ppidFormat: " " } { id: 63 shortTitle: "scg1" title: "scg1" ppidFormat: null } { id: 83 shortTitle: "SP test" title: "SP test" ppidFormat: " " } { id: 101 shortTitle: "SuperTest" title: "SuperTest" ppidFormat: " " } { id: 102 shortTitle: "Super2" title: "SuperTest2" ppidFormat: " " } { id: 113 shortTitle: "Southern Health Protocol" title: "Southern Health Protocol" ppidFormat: ""SHP%05d",PPID" }{ id: 121 shortTitle: "St Vincent Protocol" title: "St Vincent Protocol" ppidFormat: " " } { id: 126 shortTitle: "SCS_CPa1" title: "skinCancerStudy2" ppidFormat: " " }]
|
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | CPs got successfully |
| 401 | All requests | Authorization failed, user doesn’t have authority |
| 500 | All requests | Internal server error, encountered server error while performing operations |