http[s]:<host>:<port>/openspecimen/rest/ng/biohazards/{biohazardIdid}
or
http[s]:<host>:<port>/openspecimen/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 |
|---|---|
| id | id of the biohazardous agent. |
| name | Name 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 satus of Biohazard biohazard like Activeactive,Closed closed etc. {active, closed, pending, disabled} |
...
http[s]:<host>:<port>/openspecimen/rest/ng/biohazards/{biohazardIdid}
or
http[s]:<host>:<port>/openspecimen/rest/ng/biohazards/name={biohazardNamename}
Use this URL to update biohazard in openSpecimen application.
...
The response of this request will contains the details of the updated sitebiohazard.
Below is the example of the update biohazard:
| URL | openspecimen/rest/ng/biohazards/{biohazardIdid} or openspecimen/rest/ng/biohazards/name={biohazardNamename} |
| Method | PUT |
| Request | application/json |
| json | { "name" : "Cr-51", "type" : "infectious", "comment" : "something" } |
Response | { biohazardIdid: 48 name: "Cr-51" type: "infectious" comment: "Somethingsomething" activityStatus:"Active" } |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Biohazard has been updated successfully |
| 400 | All requests | Invalid parameters, e.g duplicate Biohazard Namebiohazard name, blank Biohazard Name biohazard name etc |
| 401 | All requests | Authorization failed, User user doesn’t have Authority |
| 404 | All requests | Biohazard not found, Biohazard with given details not present in the system |
| 500 | All requests | Internal server error, Encountered server error while performing operations |
...