Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

catissuecore/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 idIdentifier of department that user wants to update 
nameDepartment Name. It should be unique in specified instituteInstitute
NameinstituteNames

Name Collection of Institute institutes names in which the department comes. For this the institute institutes should be already registered in system.


http[s]:<host>:<port>/catissuecore/rest/ng/departments/{departmentId}

Use this URL to update department in caTissue application.


Result:

The response of this request will contains the details of the updated department.

Below is the example of the update department:

URLhttp://<host>:<port>/catissuecore/rest/ng/departments/{departmentId}
MethodPUT
Requestapplication/json
json

{

    "name":"My department",    

    "instituteNameinstituteNames" : ["KS Cancer Center", "WUSTL"]

}

Response

{

    "id" : "1",

    "name":"My department",

     "instituteNameinstituteNames" : ["KS Cancer Center", "WUSTL"  ]
}

 

Error Cases :

code
Applies to
Status Message
200All resourcesDepartment has been updated successfully
400All requestsInvalid parameters, e.g  duplicate Department Name, blank Department Name etc
401All requestsAuthorization failed, User doesn’t have Authority
404All requestsDepartment not found, Department with given details not present in the system
500All requestsInternal server error, Encountered server error while performing operations