Leave a comment at the end of this page or email contact@krishagni.com
Update Institute
openspecimen/rest/ng/institutes/{id}
Use this resource for update the institute in the OpenSpecimen application. 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 |
---|---|
id | Identifier of institute to update |
name | Institute name |
departments | It is a collection of departments: name: name of department |
http[s]:<host>:<port>/openspecimen/rest/ng/institutes/{id}
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 |
|
Method | PUT |
Request | application/json |
json | Json Code { "id": 3, "name": "Bocabio", "departments": [ { "name": "Tissue Banking" } ] } |
Response | { "id": 3, "name": "Bocabio1", "activityStatus": "Active", "departmentsCount": 0, "usersCount": 0, "departments": [ { "id": 54, "name": "Tissue Banking" } ] } |
Error Cases :
code | Applies to | Status Message |
---|---|---|
200 | All resources | Institute has been updated successfully |
400 | All requests | Invalid parameters, e.g duplicate institute name, blank institute name etc |
401 | All requests | Authorization failed, user doesn’t have authority |
404 | All requests | Institute not found, institute with given details not present in the system |
500 | All requests | Internal server error, encountered server error while performing operations |
Leave a comment at the end of this page or email contact@krishagni.com