Leave a comment at the end of this page or email contact@krishagni.com
Update Site
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 |
---|---|
is | Id of the site |
name | Name of the physical location. |
instituteName | Name of the institute which site is belongs to |
coordinators | Collection of user object. 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 site,repository,laboratory,not specified } |
activityStatus | Defines the status of a site record {active, closed, pending, disabled} |
address | Address of the site |
http[s]:<host>:<port>/openspecimen/rest/ng/sites/{id}
Use this URL to update site in 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 |
|
Method | PUT |
Request | application/json |
json | { "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 | { "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 |
Leave a comment at the end of this page or email contact@krishagni.com