Versions Compared

Key

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

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

http[s]:<host>:<port>/catissuecore/rest/ng/sites/{siteId}

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
siteIdisSite Id of the site
nameName of the physical location.coordinatorCollection
instituteNameName of the institute which site is belongs to
coordinators

Collection of user info object. UserInfo contains Login User Info contains Login Name and Domain Name

type

Function of the site. It could be collection, storing, experimentation or it could be unspecified

{ Collection Sitecollection site,Repositoryrepository,Laboratorylaboratory,Not Specified not specified }

activityStatus

Defines the status of a Site site record

{active, closed, pending, disabled}

emailAddressaddressEmail Address
streetName of street to which site belongs.
cityCity of which the site belongs.stateState of which the site belongs, By default it will be blank.
countryCountry of which the site belongs.
zipCodeZip Code of location which the site belongs.
faxNumber Fax number of the site, By default it will be blank.
phoneNumber Phone number of the site, By default it will be blank.


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

http[s]:<host>:<port>/catissuecore/rest/ng/sites/{siteId}

Use this URL to update site in caTissue open specimen application.

Result:

The response of this request will contains the details of the updated site.

Below is the example of the update site:

{
name"DD1"
coordinatorCollection
[{ 
      loginName"admin@admin.com"
domainName"catissue"
}]
id6
type"sitesType"
activityStatus"Active"
emailAddress: "admin@admin.com"
street"SB Road"
city"Pune412312"
state"MH"
country"India"
zipCode"412312"
faxNumber"123321"
phoneNumber"213434324"
URL

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

or

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

MethodPUT
Requestapplication/json
json
Code Block
languagejs
themeEclipse

{
"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

linenumberstrue
{
    "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
languagejs
themeEclipse
linenumberstrue
{
    "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
200All resourcesSite has been updated successfully
400All requestsInvalid parameters, e.g  duplicate Site Namesite name, blank Site Name site name etc
401All requestsAuthorization failed, User 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