Get specimen

GET openspecimen/rest/ng/specimens/{specimenId}

Use this API to get specific specimen detail. The specimen ID is given to get that specimen detail.

Parameter Details:

The API accepts only specimen ID in URL of which details are needed.

Result:

If specimen exists of given specimen ID, then specimen details is given. Else error message.

API Example:

URL

openspecimen/rest/ng/specimens/1

Method

GET

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

}