Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


URL/openspecimen/rest/ng/specimen-
requirements                                          
requirements                                    
Method
GET
GET                                                     
Response


Code Block
languagejs
[
  {
    "id": 1,
    "name": "WB for RBCs",
    "code": "WB-R",
    "specimenClass": "Fluid",
    "type": "Whole Blood",
    "anatomicSite": "Not Specified",
    "laterality": "Not Specified",
    "pathology": "Not Specified",
    "initialQty": 10,
    "concentration": 1.1,
    "collector": {
      "id": 2,
      "emailAddress": "johnd@sample-labs.com"
    },
    "collectionProcedure": "Not Specified",
    "collectionContainer": "EDTA Vacutainer",
    "receiver": {
      "id": 3,
      "emailAddress": "jannied@sample-labs.com"
    },
    "labelFmt": null,
    "cpShortTitle": "TCP",
    "eventLabel": "Baseline",
    "children": [
      /* Hierarchy of child requirements */
      {
        ...
      }
    ]
  }
]



ParameterDescription
cpIdCollection protocol ID whose specimen requirements need to be retrieved. Mandatory query parameter.
eventLabelCollection protocol event label whose specimen requirements need to be retrieved. Mandatory query parameter.
includeChildReqsBoolean. Default: true. When includeChildReqs is false, only the top-level / primary requirements are populated in the response.