Versions Compared

Old Version 4

changes.mady.by.user Darpan Patil (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Vinayak Lonushte

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

openspecimen/rest/ng/biohazardssites

or

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

Use this resource to get biohazardssites in the OpenSpecimen application. This API returns all the biohazards 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 1000100
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/biohazardssites

or

http[s]:<host>:<port>/openspecimen/rest/ng/biohazardssites?maxResults={maxResults}


Use this URL to get biohazards sites in openSpecimen application.

...

The response of this request will contains the details of the biohazardssites.

Below is the example of the get biohazardssites:

URL

http://<host>:<port>/openspecimen/rest/ng

/biohazards

/sites

 or

http://<host>:<port>/openspecimen/rest/ng/sites?maxResults=2

MethodGET
Requestapplication/json

Response

[0]

[{

name: "Pune101"
coordinatorCollection: 
[{ 
      loginName: "admin@admin.com"
domainName: "catissue"
}]
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: 
[{ 
      loginName: "admin@admin.com"
domainName: "catissue"
}] 
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"
} ]

 

 

Code Block
languagejs
themeEclipse
linenumberstrue
[
   {
        "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
200All resourcesbiohazards Sites got successfully
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations