Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

openspecimen/rest/ng/institutes/{instituteId}

or

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


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
institute IdIdentifier of institute to update
nameInstitute name


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

or

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


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

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, institute with given details not present in the system
500All requestsInternal server error, encountered server error while performing operations
  • No labels