openspecimen/rest/ng/institutes
or
openspecimen/rest/ng/institutes?maxResults={maxResults}
Use this resource to get institutes . This API returns all the institutes present in the . User can also specify the search string which will be used to match the values.
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 PVs |
| maxResults | Integer value to get maximum records. By default it will be 1000 |
| attribute | The name of the attribute this PV is associated with. Example : |
http[s]:<host>:<port>/catissuecore/rest/ng/institutes
or
http[s]:<host>:<port>/catissuecore/rest/ng/institutes?maxResults={maxResults}
Use this URL to get institutes in caTissue application.
Result:
The response of this request will contains the details of the institutes.
Below is the example of the get institutes:
| URL | http://<host>:<port>/catissuecore/rest/ng/institutes |
| Method | GET |
| Request | application/json |
Response | [{ "id" : "1", "name":"Institute of Oklahoma" },{ "id" : "2", "name":"Cell", }]
|
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Institutes got successfully |
| 401 | All requests | Authorization failed, User doesn’t have Authority |
| 500 | All requests | Internal server error, Encountered server error while performing operations |