Versions Compared

Key

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

openspecimen/rest/ng/biohazards

or

openspecimen/{biohazardIdrest/ng/biohazards?maxResults={maxResults}

Use this resource to get biohazardbiohazards. This API returns biohazard present all the biohazards 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
biohazardIdbiohazard id to fetch the biohazardmaxResultsmaximum number of records to fetch. By default it will be 1000


http[s]:<host>:<port>/openspecimen/rest/ng/biohazards

or

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


Use this URL to get biohazard by an id biohazards in openSpecimen application.

...

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

Below is the example of the get biohazard biohazards :

URL

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

MethodGET
Requestapplication/json

Response

[0]

{

biohazardId3

name"Cr-51"
type: "infectious"
comment"Something "
activityStatus:"Active"
}
[1]

{

biohazardId4

name: "Cr-52"
type: "infectious"
comment"Something "
activityStatus:"Active"
}

 

Error Cases :

code
Applies to
Status Message
200All resourcesbiohazard got successfully
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations