openspecimen/rest/ng/institutes/{instId}
or
openspecimen/rest/ng/institutes/name={name}
Use this resource to delete the institute. Use HTTP DELETE 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 |
|---|---|
instId | Institute id of the site |
http[s]:<host>:<port>/openspecimen/rest/ng/institutes/{instId}
or
http[s]:<host>:<port>/openspecimen/rest/ng/institutes/name={name}
Use this URL to delete institute in openSpecimen application.
Result:
The response of this request will contains the details of the deleted institute.
Below is the example of the delete institute:
| URL | http://<host>:<port>/openspecimen/rest/ng/institutes/{instId} |
| Method | DELETE |
| Request | application /json |
Response | "success" |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Institute has been deleted successfully |
| 401 | All requests | Authorization failed, user doesn’t have authority |
| 404 | All requests | Institute not found, institute with given details not present in the system |
| 500 | All requests | Internal server error, encountered server error while performing operations |