Versions Compared

Key

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

openspecimen/rest/ng/sites/{id}

or

openspecimen/rest/ng/sites/byname?name={siteIdname}

Use this resource to get site in the OpenSpecimen application. This API returns site 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
siteIdidSite id to fetch the site.
nameSite name to fetch the site.


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

or

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

Use this URL to get site by an id in openSpecimen application.

...

Below is the example of the get site :

URL

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

or

http://<host>:<port>/openspecimen/rest/ng/sites/3byname?name="CHMCA"

MethodGET
Requestapplication/json

Response

{

name"Pune101"
coordinatorCollection
[{ 
      loginName"admin@admin.com"
domainName"catissue"
}]
id3
type"repository"
emailAddress:"admin@admin.com"
activityStatus"Active"
emailAddressadmin@admin.com
street"SB Road"
city"Pune"
state"Maharashtra"
country"India"
zipCode"412312"
faxNumber"123321"
phoneNumber"213434324"
}

...

Code Block
languagejs
themeEclipse
linenumberstrue
{
    "id": 20,
    "name": "CHMCA",
    "instituteName": "Stanford",
    "code": null,
    "type": "Repository",
    "activityStatus": "Active",
    "cpCount": 0,
    "coordinators":
    [
        {
            "id": 95,
            "firstName": "admin",
            "lastName": "admin",
            "loginName": "admin@admin.com",
            "domain": "openspecimen",
            "emailAddress": "admin@admin.com",
            "admin": true,
            "cpCount": 0,
            "creationDate": 1436898600000
        }
    ],
    "address": null,
    "extensionDetail": null
}

Error Cases :

code
Applies to
Status Message
200All resourcesSite got successfully
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations