Versions Compared

Key

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

catissuecoreopenspecimen/rest/ng/institutes/{instituteIdid}

Use this resource for update the Instituteinstitute in the OpenSpecimen  application. Use HTTP PUT method to call this API by passing the below details in JSON format.


 Below Below are the attributes which need to be sent in the request body:

Parameter
Details
institute IdidIdentifier of institute to Updateupdate
nameInstitute name
departments

It is a collection of departments:

name: name of department


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

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 roleinstitute:

URL

http://<host>:<port>/

catissuecore

openspecimen/rest/ng/institutes/

{instituteId}

3

MethodPUT
Requestapplication/json
json{
    
Code Block
languagejs
themeEclipse
titleJson Code
linenumberstrue
{
    "id": 3,
    "name": "Bocabio",
    "departments": [
        {
            "name":
"KS Cancer Research Center"
}

Response

{

    "id" : "1",

    "name":"KS Cancer Research Center"
}

 

 

 "Tissue Banking"
        }
    ]
}

Response

Code Block
languagejs
themeEclipse
linenumberstrue
{
    "id": 3,
    "name": "Bocabio1",
    "activityStatus": "Active",
    "departmentsCount": 0,
    "usersCount": 0,
    "departments":
    [
        {
            "id": 54,
            "name": "Tissue Banking"
        }
    ]
}

 

Error Cases :

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