PUT openspecimen/rest/ng/specimens/{specimenId}/status
Use this API to update status of specific specimen.
Parameter Details:
This API accepts specimen ID in URL and status details in JSON format.
| Parameter | Details |
|---|---|
| status | The status of the specimen. |
| reason | Reason for change in status. |
Result:
This API provides specimen details as result with updated status. If specimen is not found for given specimen ID then error message is given.
API Example:
| URL | http://localhost:8080/openspecimen/rest/ng/specimens/1 |
| Method | PUT |
| Request | application/json |
| JSON | { "status": "Collected", "Reason": "The specimen sample is collected" } |
| Response | { "id": 1, "cpId": 1, "cprId": 1, "eventId": null, "visitId": 1, "visitName": "first visit", "cpShortTitle": "blood", "reqId": 1, "sortOrder": null, "label": "blood1", "barcode": null, "type": "Whole Blood", "specimenClass": "Fluid", "lineage": "New", "anatomicSite": "Autonomic nervous system, NOS", "laterality": "Not Applicable", "status": "Collected", "reqLabel": "whole blood", "pathology": "Malignant, Pre-Invasive", "initialQty": 250, "availableQty": 220, "available": true, "concentration": 10, "parentId": null, "parentLabel": null, "storageLocation": { "id": 1, "name": "Fluid Container", "positionX": "1", "positionY": "A" }, "storageType": "Auto", "collectionContainer": null, "activityStatus": "Active", "createdOn": 1442993220000, "code": null, "distributed": true, "collectionEvent": null, "receivedEvent": null, "labelFmt": null, "biohazards": [], "comments": null, "closeAfterChildrenCreation": null, "children": [], "pooledSpecimenId": null, "pooledSpecimenLabel": null, "specimensPool": null, "closeParent": null, "poolSpecimen": false, "extensionDetail": null } |