Versions Compared

Key

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

openspecimen/rest/ng/institutes/{id}

or

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

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 Below are the attributes which need to be sent in the request body:

Parameter
Details
idIdentifier of institute to update
nameInstitute name

http[s]:<host>:<port>/openspecimen/rest/ng/institutes/{id}

or

departments

It is a collection of departments:

name: name of department


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

Use this URL to update institute in openSpecimen 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>/openspecimen/rest/ng/institutes/1

or

http://<host>:<port>/openspecimen/rest/ng/institutes/name=KS Center3

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

Response

{

    "id" : "1",

    "name":"KS Cancer Research Center"
}

 
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 name, blank institute name etc
401All requestsAuthorization failed, user doesn’t have authority
404All requestsInstitute not found, institute with given details not present in the system
500All requestsInternal server error, encountered server error while performing operations