Versions Compared

Key

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

openspecimen/rest/ng/institutes/{instId}

or

openspecimen/rest/ng/institutes/name={nameid}

Use this resource to delete the institute in OpenSpecimen application. 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
instIdidInstitute id of the site


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

or

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

Use this URL to delete institute in openSpecimen application.

...

URLhttp://<host>:<port>/openspecimen/rest/ng/institutes/{instId}32
MethodDELETE
Requestapplication /json

Response

Code Block
languagejs
themeEclipse
linenumbers
"success"
true
{
    "id": 32,
    "name": "Bocabio1_1451812927614",
    "activityStatus": "Disabled",
    "departmentsCount": 0,
    "usersCount": 0,
    "departments":
    [
        {
            "id": 54,
            "name": "Tissue Banking"
        }
    ]
}

 

 Error Cases :

code
Applies to
Status Message
200All resourcesInstitute has been deleted successfully
401All requestsAuthorization failed, user doesn’t have authority
404All requestsInstitute not found, institute with given details not present in the system
500All requestsInternal server error, encountered server error while performing operations