http[s]:<host>:<port>/openspecimen/rest/ng/sites/name={siteName}
or
http[s]:<host>:<port>/openspecimen/rest/ng/sites/{siteId}
Use this resource to update the site. Use HTTP PUT method to call this API by passing the below details in JSON format.
...
Parameter | Details |
|---|---|
| siteId | Site Id of the site |
| name | Name of the physical location. |
| coordinatorCollection | Collection of user info object. UserInfo 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 site,repository,laboratory,not specified } |
| 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={siteName}
or
http[s]:<host>:<port>/openspecimen/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:
| URL | openspecimen/rest/ng/sites/name={siteName} or openspecimen/rest/ng/sites/{siteId} |
| Method | PUT |
| Request | application/json |
| json | { "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 | { name: "DD1Pune" id: 6 type: "sitesType" activityStatus: "Active" emailAddress: "admin@admin.com" street: "SB Road" city: "Pune412312Pune" state: "MHMaharashtra" country: "India" zipCode: "412312" faxNumber: "123321" phoneNumber: "213434324" } |
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 |