Versions Compared

Key

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

This API is used to update any pre-existing specimen requirement

Note: Depending on the lineage of the requirement, some parameters specified in the below request are not applicable. For example, the specimen type of aliquot cannot be modified. 

URL/openspecimen/rest/ng/specimen-requirements/{reqId}
MethodPUT
Body


Code Block
languagejs
{
  "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"
}                                                                               



Response

HTTP Status CodeDescription
200The specimen requirement is updated.
400Something incorrect with the request. The response body contains the error code and the human readable error message.
500Something wrong with the server. Please contact support along with the request payload and exception stack trace.

...