http[s]:<host>:<port>/openspecimen/rest/ng/biohazards/name={name}
...
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 status of biohazard like Activeactive,Closed closed etc. {active, closed, pending, disabled} |
...
| URL | openspecimen/rest/ng/biohazards/{id} or openspecimen/rest/ng/biohazards/name={name} |
| Method | PATCH |
| Request | application/json |
| json | { "comment" : "something" } |
Response | { id: 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 Nameduplicate biohazard name, blank 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 |