openspecimen/rest/ng/institutes/{instId}
or
openspecimen/rest/ng/institutes/name={name}
Use this resource to get institute . This API returns the institute present in the openSpecimen application of given name and id.
Below are the attributes which need to be sent in the url :
Parameter | Details |
|---|---|
| instId | Institute id to fetch the institute |
| name | Institute name to fetch the institute |
http[s]:<host>:<port>/openspecimen/rest/ng/institutes/{instId}
or
http[s]:<host>:<port>/openspecimen/rest/ng/institutes/name={name}
Use this URL to get institute by an id in openSpecimen 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 |