This API is available for creating Specimen.
List of mandatory fields:
- Label
- TissueSite
- TissueSide
- PathologicalStatus
- Lineage
- InitialQuantity
- collectionStatus
- SpecimenClass
- SpecimenType
- ActivityStatus
- Barcode
- Comment
- CreatedOn
- scgId
| URL | catissuecore/rest/ng/specimens |
| Request type | application/json |
| Method | POST |
| json | { "activityStatus" : "Active", "barcode" : "245095132", "biohazardDetails" : [ ], "collectionStatus" : "Collected", "comment" : "creating an adhoc specimen.", "createdOn" : "May 1, 2014 11:21:45 AM", "externalIdentifierDetails" : [ ], "initialQuantity" : 2.0, "label" : "sample_123", "lineage" : "New", "pathologicalStatus" : "Metastatic", "scgId" : 1, "specimenClass" : "Fluid", "specimenType" : "Feces", "tissueSide" : "Left", "tissueSite" : "Nasal cavity" } |
Response |
{ "activityStatus" : "Active", "barcode" : "", "biohazardDetails" : [ ], "collectionStatus" : "Collected", "comment" : "creating an adhoc specimen.", "createdOn" : "May 1, 2014 11:21:45 AM", "externalIdentifierDetails" : [ ], "id" : 2, "initialQuantity" : 2.0, "label" : "", "lineage" : "New", "pathologicalStatus" : "Metastatic", "scgId" : 1, "specimenClass" : "Fluid", "specimenType" : "Feces", "tissueSide" : "Left", "tissueSite" : "Nasal cavity" } |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Specimen has been created successfully |
| 400 | All requests | Invalid parameters, e.g duplicate label, duplicate barcode, invalid class Name etc |
| 401 | All requests | Authorization failed, User doesn’t have Authority to create specimen for the given collection protocol |
| 500 | All requests | Internal server error, Encountered server error while performing operations |