Versions Compared

Version Old Version 8 New Version 9
Changes made by

Darpan Patil

Vinayak Lonushte

Saved on

Key

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

openspecimen/rest/ng/sites/{id}

or

openspecimen/rest/ng/sites/name={name}

Use this resource to delete the site in the OpenSpecimen application. Use HTTP DELETE method to call this API by passing the below details in JSON format.

...

Parameter
Details
idSite id of the site.
nameSite name of the site.


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

or

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

Use this URL to delete site in openSpecimen application.

...

URL

http://<host>:<port>/openspecimen/rest/ng/sites/1

or

http://<host>:<port>/openspecimen/rest/ng/sites/name="In Transit"

MethodDELETE
Requestapplication /json

Response

"success"
Code Block
languagejs
themeEclipse
linenumberstrue
{
    "id": 4,
    "name": "Arkansas Hospital_1451841408866",
    "instituteName": "A1 - For Demo Users",
    "type": "Collection Site",
    "activityStatus": "Disabled",	
    "cpCount": 0,
    "coordinators":
    [
        {
            "id": 107,
            "firstName": "Alexandra",
            "lastName": "Alfortish",
            "loginName": "aalfortish",
            "domain": "openspecimen",
            "emailAddress": "aalfortish@lcrc.info",
            "admin": false,
            "cpCount": 0,
            "creationDate": 1438021800000
        },
        {
            "id": 14,
            "firstName": "Vinod",
            "lastName": "Gaikwad",
            "loginName": "vinod",
            "domain": "openspecimen",
            "emailAddress": "vinod.gaikwad@domain.com",
            "admin": false,
            "cpCount": 0,
            "creationDate": null
        }
    ],
    "address": "Arkansas",
}

 

 Error Cases :

code
Applies to
Status Message
200All resourcesSite has been deleted successfully
401All requestsAuthorization failed, user doesn’t have Authority
404All requestsSite not found, Site with given details not present in the system
500All requestsInternal server error, Encountered server error while performing operations