Page Comparison

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

or

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

Use this resource to update the site in the site. Use HTTP PUT 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
idis	Site id Id of the site
name	Name of the physical location.coordinatorCollection
instituteName	Name of the institute which site is belongs to
coordinators	Collection of user info object. UserInfo contains Login name and domain nameUser Info contains Login Name and Domain Name
type	Function of the site. It could be collection, storing, experimentation or it could be unspecified { collection site,repository,laboratory,not specified }
activityStatus	Defines the status of a site record { collection siteactive, repositoryclosed, laboratorypending, not specified disabled} emailAddress	Email address
street	Name of street to which site belongs.
city	City of which the site belongs.
state [optional]	State of which the site belongs, By default it will be blank.
country	Country of which the site belongs.
zipCode	Zip Code of location which the site belongs.
faxNumber [optional]	Fax number of the site, By default it will be blank.
phoneNumber [optional]	Phone number of the site, By default it will be blank.

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

...

address

Address of the site

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

Use this URL to update site in open specimen application.

...

Below is the example of the update site:

{

name: "Pune"

coordinatorCollection:

[{

loginName: "admin@admin.com"

domainName: "catissue"

}]

id: 6

type: "sitesType"

activityStatus: "Active"

emailAddress: "admin@admin.com"

street: "SB Road"

city: "Pune"

state: "Maharashtra"

country: "India"

zipCode: "412312"

faxNumber: "123321"

phoneNumber: "213434324"

URL

openspecimenhttp:/rest/ng/sites/name={siteName}

or

/<host>:<port>/openspecimen/rest/ng/sites/{siteId} 4

Method PUT

Request application/json

json

Code Block

{
"name" : "Pune",

"coordinatorCollection" : [ { "loginName" : "admin@admin.com", "domainName" :"catissue"}],

"type" : "Collection Site",

"activityStatus" : "Active",

"emailAddress" : "admin@admin.com",

"street" : "SB Road",

"city" : "Pune",

"state" : "Maharashtra",

"country" : "India" ,

"zipCode" : "412312",

"faxNumber" : "123321",

"phoneNumber" : "213434324"
}

Response

language	js
theme	Eclipse
linenumbers	true

{
    "id": "4",
    "name": "Arkansas Hospital",
    "instituteName": "A1 - For Demo Users",
    "type": "Collection Site",
    "activityStatus": "Active",
    "coordinators":
    [
        {
            "loginName": "aalfortish",
            "domain": "openspecimen"
        },
        {
            "loginName": "vinod",
            "domain": "openspecimen"
        }
    ],
    "address": "Arkansas"
}

Response

Code Block

language	js
theme	Eclipse
linenumbers	true

{
    "id": 4,
    "name": "Arkansas Hospital",
    "instituteName": "A1 - For Demo Users",
    "type": "Collection Site",
    "activityStatus": "Active",
    "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
200	All resources	Site has been updated successfully
400	All requests	Invalid parameters, e.g duplicate site name, blank site name etc
401	All requests	Authorization failed, user doesn’t have Authority
404	All requests	Site not found, Site with given details not present in the system
500	All requests	Internal server error, Encountered server error while performing operations

Versions Compared

Old Version 16

New Version Current

Key