Versions Compared

Key

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

openspecimen/rest/ng/institutes/{instId}

Use this resource to get institute . This API returns all the institute present in the . User can also specify the search string which will be used to match the values.

Use HTTP GET 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
InstIdInstitute id to fetch the institute


http[s]:<host>:<port>/catissuecore/rest/ng/institutes/{instId}

Use this URL to get institute by an id in caTissue application.

Result:

The response of this request will contains the details of the institute.

Below is the example of the get institute:

URLhttp://<host>:<port>/catissuecore/rest/ng/institutes/1
MethodGET
Requestapplication/json

Response

{

    "id" : "1",

    "name":"Institute of Oklahoma"

}

 

Error Cases :

code
Applies to
Status Message
200All resourcesInstitute got successfully
401All requestsAuthorization failed, User doesn’t have Authority
500All requestsInternal server error, Encountered server error while performing operations