openspecimen/rest/ng/institutes/{instId}
or
openspecimen/rest/ng/institutes/name={name}
Use this resource to get institute . This API returns all the institute 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 |
|---|---|
| instId | Institute id to fetch the institute |
| name | Institute name to fetch the institute |
http[s]:<host>:<port>/catissuecore/rest/ng/institutes/{instId}
or
http[s]:<host>:<port>/catissuecore/rest/ng/institutes/name={name}
Use this URL to get institute by an id in caTissue application.
Result:
The response of this request will contains the details of the institute.
Below is the example of the get institute:
| URL |
or
|
| Method | GET |
| Request | application/json |
Response | { "id" : "1", "name":"Institute of Oklahoma" } |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Institute got successfully |
| 401 | All requests | Authorization failed, User doesn’t have Authority |
| 500 | All requests | Internal server error, Encountered server error while performing operations |