Get Institute

openspecimen/rest/ng/institutes/{id}

or

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

Use this resource to get institute . This API returns the institute present in the openSpecimen application of given name and id.

Below are the attributes which need to be sent in the url :

Parameter	Details
id	Institute id to fetch the institute
name	Institute name to fetch the institute

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

or

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

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

Result:

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

Below is the example of the get institute:

URL	http://<host>:<port>/openspecimen/rest/ng/institutes/1 or http://<host>:<port>/openspecimen/rest/ng/institutes/byname?name=Bocabio
Method	GET
Request	application/json
Response	`{ "id": 1, "name": "Bocabio", "activityStatus": "Active", "departmentsCount": 0, "usersCount": 0, "departments": [ { "id": 47, "name": "Tissue Banking" } ] }`

Error Cases :

code	Applies to	Status Message
200	All resources	Institute got successfully
401	All requests	Authorization failed, user doesn’t have authority
500	All requests	Internal server error, encountered server error while performing operations