http[s]:<host>:<port>/openspecimen/rest/ng/sites/name={siteName}
or
http[s]:<host>:<port>/openspecimen/rest/ng/sites/{siteId}
Use this resource to patch the site. Use HTTP PATCH 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 |
|---|---|
| siteId | Site Id of the site (Mandatory Field) |
| name | Name of the physical location. |
| coordinatorCollection | Collection of user login names. Login Name through which user can login to catissue application |
| 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 {active, closed, pending, disabled} |
| 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 patch site in openSpecimen application.
Result:
The response of this request will contains the details of the patched site.
Below is the example of the patch site:
Method | URL |
|---|---|
| URL | openspecimen/rest/ng/sites/name={siteName} or openspecimen/rest/ng/sites/{siteId} |
| Method | PATCH |
| Request | application/json |
| json | { "name" : "Mumbai" } |
Response | { name: "Mumbai" id: 6 type: "repository" activityStatus: "Active" emailAddress: admin@admin.com street: "SB Road" city: "Pune" state: "Maharashtra" 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 First Name ,Blank Site Type etc |
| 401 | All requests | Authorization failed, User doesn't have Authority |
| 404 | All requests | Site not found, User with given details not present in the system |
| 500 | All requests | Internal server error, Encountered server error while performing operations |