openspecimen/rest/ng/sites/{id}
or
openspecimen/rest/ng/sites/name={name}
Use this resource to get site. This API returns site present in the openSpecimen application. Use HTTP GET 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 |
|---|---|
| id | Site id to fetch the site. |
| name | Site name to fetch the site. |
http[s]:<host>:<port>/openspecimen/rest/ng/sites/{id}
or
http[s]:<host>:<port>/openspecimen/rest/ng/sites/name={name}
Use this URL to get site by an id in openSpecimen application.
Result:
The response of this request will contains the details of the site.
Below is the example of the get site :
| URL |
or
|
| Method | GET |
| Request | application/json |
Response | { name: "Pune101" id: 3 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 got successfully |
| 401 | All requests | Authorization failed, user doesn’t have authority |
| 500 | All requests | Internal server error, encountered server error while performing operations |