Versions Compared

Key

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

Use this API to create one or more aliquot requirements from a given parent requirement.

URL/openspecimen/rest/ng/specimen-requirements/{parentReqId}/aliquots
MethodPOST
Body
{
  "code": "PL",
  "noOfAliquots": 5,
  "qtyPerAliquot": 2
}                                                                                    


Response


HTTP Status Code
Description
200                                 The derived specimen requirement is aliquot requirements are created and is assigned a unique ID. The response body contains the requirement aliquot details along with the their unique ID. This unique ID can be used later to update, retrieve or create aliquots. IDs.                                                                                            
400                                            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.


Request Parameters


Parameter
Description
parentReqIdParent specimen requirement ID.
codePrefix of unique code assigned to each aliquot. Example: If code is PL, then first aliquot is assigned PL1, second aliquot is assigned PL2 and like that.
noOfAliquotsNumber of aliquots to create.
qtyPerAliquotQuantity of each aliquot.