http[s]:<host>:<port>/openspecimen/rest/ng/biohazards
Use this resource to create new biohazards in the openSpecimen application. Use HTTP POST method to call this API by passing the below details in JSON format.
...
Parameter | Details |
|---|---|
| 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 like active,closed etc. {active, closed, pending, disabled} |
http[s]:<host>:<port>/openspecimen/rest/ng/biohazards
Use this URL to add biohazard in caTissue openSpecimen application.
Result:
The response of this request will contains the details of the created biohazard.
Below is the example of the create biohazard:
| URL | http://<host>:<port>/openspecimen/rest/ng/biohazards |
| Method | POST |
| Request | application/json |
| json | { "name" : "Cr-51", "type" : "infectious", "comment" : "something", "activityStatus" : "Active" } |
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 created successfully |
| 400 | All requests | Invalid parameters, e.g duplicate Biohazard Name, blank Biohazard Name, blank Biohazard Type biohazard name, blank biohazard name, blank biohazard type etc |
| 401 | All requests | Authorization failed, user doesn't have Authority |
| 500 | All requests | Internal server error, Encountered server error while performing operations |