Page Comparison

openspecimen/rest/ng/institutes/{instituteIdid}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
institute Idid	Identifier of institute to update
name	Institute name

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

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 Center

3

Method PUT

Request application/json

json

{

Code Block

language	js
theme	Eclipse
title	Json Code
linenumbers	true

{
    "id": 3,
    "name": "Bocabio",
    "departments": [
        {
            "name":

"KS Cancer Research Center"

 "Tissue Banking"
        }
    ]
}

Response

{

"id" : "1",

"name":"KS Cancer Research Center"
}

Code Block

language	js
theme	Eclipse
linenumbers	true

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

Error Cases :

code	Applies to	Status Message
200	All resources	Institute has been updated successfully
400	All requests	Invalid parameters, e.g duplicate institute name, blank institute name etc
401	All requests	Authorization failed, user doesn’t have authority
404	All requests	Institute not found, institute with given details not present in the system
500	All requests	Internal server error, encountered server error while performing operations

Versions Compared

Old Version 8

New Version Current

Key