http[s]:<host>:<port>/openspecimen/rest/ng/biohazards/name={biohazardNamename}
or
http[s]:<host>:<port>/openspecimen/rest/ng/biohazards/{biohazardIdid}
Use this resource to patch the biohazard. Use HTTP PATCH 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 of Biohazard biohazard like Active,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 patch biohazard in openSpecimen application.
...
| URL | openspecimen/rest/ng/biohazards/{biohazardIdid} or openspecimen/rest/ng/biohazards/name={name} |
| Method | PATCH |
| Request | application/json |
| json | { "comment" : "something" } |
Response | { biohazardId: 48 name: "Cr-51" type: "infectious" comment: "Something" 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 Name, blank Biohazard Name etc |
| 401 | All requests | Authorization failed, 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 |