Page Comparison

openspecimen/rest/ng/sites

or

openspecimen/rest/ng/sites?startAt={startAt}&maxResults={maxResults}&name={name}&institute={institute}

Use this resource to get sites in the OpenSpecimen application. 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
startAt [optiona]	Starting row of the result
maxResults [optiona]	maximum number of records to fetch. By default it will be 100
name [optiona]	Result contains all sites which have name contains given value
exactMatch [optiona]	It will be used with name parameter, exactMatch is true then name parameter consider as exact match with site name
institute [optiona]	Result contains all sites which are belongs to the given institute

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=2

Method

GET

Request

application/json

Response

Code Block

language	js
theme	Eclipse
linenumbers	true

[
   {
        "id": 2,
        "name": "Arkansas Repository",
        "instituteName": "A1 - For Demo Users",
        "code": null,
        "type": "Repository",
        "activityStatus": "Active",
        "cpCount": 0
    },
    {
        "id": 3,
        "name": "Austin Biobank",
        "instituteName": "St Vincent Hospital",
        "code": "AUH",
        "type": "Repository",
        "activityStatus": "Active",
        "cpCount": 0
    }
]

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

Versions Compared

Old Version 1

New Version Current

Key