Versions Compared

Key

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

catissuecoreopenspecimen/rest/ng/institutes/{instituteId}

or

catissuecoreopenspecimen/rest/ng/institutes/name={name}


Use this resource for update the Instituteinstitute. 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 IdIdentifier of institute to Updateupdate
nameInstitute name


http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/institutes/{instituteId}

or

http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/institutes/name={name}


Use this URL to update institute in caTissue 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

http://<host>:<port>/catissuecoreopenspecimen/rest/ng/institutes/1

or

http://<host>:<port>/catissuecoreopenspecimen/rest/ng/institutes/name=KS Center

MethodPUT
Requestapplication/json
json{
    "name":"KS Cancer Research Center"
}

Response

{

    "id" : "1",

    "name":"KS Cancer Research Center"
}

 

 

Error Cases :

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