Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

Update Biohazard

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

or 

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

Use this resource to update the biohazard. Use HTTP PUT 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
idid of the biohazardous agent.
nameName of the biohazardous agent.
type

Type of biohazard, involves types like infectious, radioactive, toxic etc.

{ infectious,radioactive,toxic,carcinogen,mutagen,not specified }
Comment [optional]

Comments on the biohazardous character of a specimen

Activity Status

Activity satus of biohazard like active,closed etc.

{active, closed, pending, disabled}

 

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

or

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

Use this URL to update biohazard in openSpecimen application.

Result:

The response of this request will contains the details of the updated biohazard.

Below is the example of the update biohazard:

URL

openspecimen/rest/ng/biohazards/{id}

or

openspecimen/rest/ng/biohazards/name={name}

MethodPUT
Requestapplication/json
json

{

"name" : "Cr-51",

"type" : "infectious",

"comment" : "something"

}

Response

{
id48
name"Cr-51"
type: "infectious"
comment"something"
activityStatus:"Active"
}

 Error Cases :

code
Applies to
Status Message
200All resourcesBiohazard has been updated successfully
400All requestsInvalid parameters, e.g  duplicate biohazard name, blank biohazard name etc
401All requestsAuthorization failed, user doesn’t have Authority
404All requestsBiohazard not found, Biohazard with given details not present in the system
500All requestsInternal server error, Encountered server error while performing operations

 

 

Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com