Get All Institutes

openspecimen/rest/ng/institutes

or

openspecimen/rest/ng/institutes?maxResults={maxResults}

Use this resource to get institutes. This API returns all the institutes present in the openSpecimen application. 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
maxResults	Maximum number of records to fetch. By default it will be 1000

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

or

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

Use this URL to get institutes in openSpecimen application.

Result:

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

Below is the example of the get institutes:

URL	http://<host>:<port>/openspecimen/rest/ng/institutes
Method	GET
Request	application/json
Response	`[ { "id": 1, "name": "A1 - For Demo Users", "activityStatus": "Active", "departmentsCount": 0, "usersCount": 0 }, { "id": 2, "name": "Bascom Palmer Eye Insitute", "activityStatus": "Active", "departmentsCount": 0, "usersCount": 0 } ]`

Error Cases :

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