Versions Compared

Key

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

http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/biohazards/{biohazardIdid}

or 

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

Use this resource to update the biohazard. Use HTTP PUT method to call this API by passing the below details in JSON format.

...

Parameter
Details
idid of the biohazardous agent.
nameName of the biohazardous agent.
type

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

{ Infectiousinfectious,Radioactiveradioactive,Toxictoxic,Carcinogencarcinogen,Mutagenmutagen,Not Specified not specified }
Comment [optional]

Comments on the biohazardous character of a specimen

Activity Status

Activity Satus satus of Biohazard biohazard like Activeactive,Closed closed etc.

{active, closed, pending, disabled}

 

http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/biohazards/{biohazardIdid}

or

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

Use this URL to update biohazard in caTissue openSpecimen application.

Result:

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

Below is the example of the update biohazard:

URLcatissuecore

openspecimen/rest/ng/biohazards/{id}

or

openspecimen/rest/ng/biohazards/name={

biohazardId

name}

MethodPUT
Requestapplication/json
json

{

"name" : "Cr-51",

"type" : "infectious",

"comment" : "something"

}

Response

{
biohazardIdid48
name"Cr-51"
type: "infectious"
comment"Somethingsomething"
activityStatus:"Active"
}

 Error Cases :

code
Applies to
Status Message
200All resourcesBiohazard has been updated successfully
400All requestsInvalid parameters, e.g  duplicate Biohazard Namebiohazard name, blank Biohazard Name biohazard name etc
401All requestsAuthorization failed, User 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

...