openspecimen/rest/ng/institutes
Use this resource to create new institute in the openspecimen application. Use HTTP POST 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 |
|---|---|
| name | Institute Name. It should be unique in application |
| departments | It is a collection of departments: name: name of department |
http[s]:<host>:<port>/openspecimen/rest/ng/institutes
Use this URL to add institute in openspecimen application.
Result:
The response of this request will contains the details of the created institutes.
Below is the example of the create institute:
| URL | http://<host>:<port>/openspecimen/rest/ng/institutes |
| Method | POST |
| Request | application/json |
| json | {
"name": "Bocabio",
"departments": [
{
"name": "Tissue Banking"
}
]
}
|
Response | {
"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 created 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 |
| 500 | All requests | Internal server error, encountered server error while performing operations |