openspecimen/rest/ng/specimen-collection-groups
or
openspecimen/rest/ng/specimen-collection-groups?start={start}&max={maxResults}&searchString={searchString}&countReq={true/false}
Use this resource to get specimen collection groups. This API returns all the matching specimen collection groups based on the searchString, if searchString not specified then it returns all the specimen collection groups 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 |
|---|---|
| searchString [optional] | The value with which you want to search the specimen collection groups. The given value will be matched with Name and Barcode. |
| start [optional] | start index of the results |
| maxResults [optional] | Maximum number of records to fetch. By default it will be 100 |
| countReq [optional] | Set this parameter to true, if want to get the total count of matching results. |
http[s]:<host>:<port>/openspecimen/rest/ng/specimen-collection-groups
Use this URL to get specimen collection groups in openSpecimen application.
Result:
The response of this request will contains the details of the specimen collection groups.
Below is the example of the get specimen collection groups:
| URL | http://<host>:<port>/openspecimen/rest/ng/specimen-collection-groups?searchString=Breast Cancer CP_61_154 |
| Method | GET |
| Request | application/json |
Response | [{
|
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Specimen collection groups got successfully |
| 401 | All requests | Authorization failed, user doesn’t have authority |
| 500 | All requests | Internal server error, encountered server error while performing operations |