openspecimen/rest/ng/institutes/{instituteId}
or
openspecimen/rest/ng/institutes/name={name}
Use this resource for update the institute. Use HTTP PUT 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 |
|---|---|
| institute Id | Identifier of institute to update |
| name | Institute name |
http[s]:<host>:<port>/openspecimen/rest/ng/institutes/{instituteId}
or
http[s]:<host>:<port>/openspecimen/rest/ng/institutes/name={name}
Use this URL to update institute in openSpecimen application.
Result:
The response of this request will contains the details of the updated Institute.
Below is the example of the update institute:
| URL |
or
|
| Method | PUT |
| Request | application/json |
| json | { "name":"KS Cancer Research Center" } |
Response | { "id" : "1", "name":"KS Cancer Research Center"
|
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Institute has been updated successfully |
| 400 | All requests | Invalid parameters, e.g duplicate Institute Nameinstitute name, blank Institute Name institute name etc |
| 401 | All requests | Authorization failed, User user doesn’t have Authorityauthority |
| 404 | All requests | Institute not found, Instittute institute with given details not present in the system |
| 500 | All requests | Internal server error, Encountered encountered server error while performing operations |