Containers¶
Containers hold biospecimens. A biospecimen can be found only in one container.
List Containers¶
Use the GET /containers/ endpoint to view the list of containers
The following curl request can be used on the command line to list the containers available.
curl -X 'GET' \
'https://vbr-api.a2cps.cloud/containers/?offset=0&limit=50' \
-H 'accept: application/json' \
-H 'Authorization: Bearer Token'
A successful response would look like:
[
{
"container_id": "PAPXb8O6mj2nW",
"container_tracking_id": "DEFAULT-CONTAINER",
"container_type": "default container (virtual)",
"location": "Default",
"status": "created",
"tracking_id": null
},
{
"container_id": "8PqD2Xb7AgzA2",
"container_tracking_id": "K_RU_BOX_ALI_0002",
"container_type": "blood aliquot freezer box",
"location": "MCC1: Rush University Medical Center",
"status": "created",
"tracking_id": "802001516986"
},
{
"container_id": "8POyg4jKEKO36",
"container_tracking_id": "K_RU_BOX_PAX_0001",
"container_type": "paxgene freezer box",
"location": "MCC1: Rush University Medical Center",
"status": "created",
"tracking_id": "802001516986"
}
]
Get Container By Id¶
The GET /containers/{container_id} endpoint can be used to fetch a container of interest.
The cure request would be:
curl -X 'GET' \
'https://vbr-api.a2cps.cloud/containers/8PqD2Xb7AgzA2' \
-H 'accept: application/json' \
-H 'Authorization: Bearer Token
A successful response would hold the entry for the container_id of request.
{
"container_id": "8PqD2Xb7AgzA2",
"container_tracking_id": "K_RU_BOX_ALI_0002",
"container_type": "blood aliquot freezer box",
"location": "MCC1: Rush University Medical Center",
"status": "created",
"tracking_id": "802001516986"
}