openspecimen/rest/ng/sites
or
openspecimen/rest/ng/sites?maxResults={maxResults}
Use this resource to get sites. This API returns all the sites 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 |
|---|---|
| maxResults | maximum number of records to fetch. By default it will be 1000 |
http[s]:<host>:<port>/openspecimen/rest/ng/sites
or
http[s]:<host>:<port>/openspecimen/rest/ng/sites?maxResults={maxResults}
Use this URL to get sites in openSpecimen application.
Result:
The response of this request will contains the details of the sites.
Below is the example of the get sites:
| URL | http://<host>:<port>/openspecimen/rest/ng/sites or http://<host>:<port>/openspecimen/rest/ng/sites?maxResults={maxResults} |
| Method | GET |
| Request | application/json |
Response | [0] [{ 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" }, [1] { name: "Pune101" coordinatorCollection: id: 4 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 | sites got successfully |
| 401 | All requests | Authorization failed, user doesn’t have authority |
| 500 | All requests | Internal server error, encountered server error while performing operations |