http[s]:<host>:<port>/openspecimen/rest/ng/sites
Use this resource to create new Site in the open specimen application. Use HTTP POST 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 |
|---|---|
| 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 {active, closed, pending, disabled} |
| street | Name of street to which the site belongs. |
| city | Name of city to which the site belongs. |
| state [optional] | Name of the state to which the site belongs |
| country | Name of the country to which the site belongs |
| zipCode | Zip Code of location |
| faxNumber [optional] | Fax number of the site |
| phoneNumber [optional] | Phone number of the site |
http[s]:<host>:<port>/openspecimen/rest/ng/sites
Use this URL to add site in open specimen application.
Result:
The response of this request will contains the details of the created site.
Below is the example of the create site:
| URL | http://<host>:<port>/openspecimen/rest/ng/sites |
| Method | POST |
| Request | application/json |
| json | { "name" : "Pune", "coordinatorCollection" : [ { "loginName" : "admin@admin.com", "domainName" :"catissue"}], "type" : "repository", "emailAddress" : "admin@admin.com", "activityStatus" : "Active", "street" : "SB Road", "city" : "Pune", "state" : "Maharashtra", "country" : "India" , "zipCode" : "412312", "faxNumber" : "123321", "phoneNumber" : "213434324" } |
Response | { name: "Pune" id: 6 type: "repository" emailAddress:"admin@admin.com" 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 created successfully |
| 400 | All requests | Invalid parameters, e.g duplicate Site Name, blank Site Name, blank Site Type etc |
| 401 | All requests | Authorization failed, User doesn't have Authority |
| 500 | All requests | Internal server error, Encountered server error while performing operations |