openspecimen/rest/ng/departments/{departmentId}
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 |
|---|---|
| department id | Identifier of department that user wants to update |
| name | Department Name. It should be unique in specified institute |
| instituteName | Institute name in which the department comes. For this the institute should be already registered in system |
http[s]:<host>:<port>/openspecimen/rest/ng/departments/{departmentId}
Use this URL to update department in openSpecimen application.
Result:
The response of this request will contains the details of the updated department.
Below is the example of the update department:
| URL | http://<host>:<port>/openspecimen/rest/ng/departments/{departmentId} |
| Method | PUT |
| Request | application/json |
| json | { "name":"My department", "instituteName" : "KS Cancer Center" } |
Response | { "id" : "1", "name":"My department", "instituteName" : "KS Cancer Center" |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Department has been updated successfully |
| 400 | All requests | Invalid parameters, e.g duplicate department name, blank department name etc. |
| 401 | All requests | Authorization failed, user doesn’t have authority |
| 404 | All requests | Department not found, department with given details not present in the system |
| 500 | All requests | Internal server error, encountered server error while performing operations |