Item | Value |
|---|---|
HTTP Method | POST |
URL | rest/ng/specimens |
Request Body | {
"cpId": <Collection Protocol ID>,
"labels": <Array of one or more specimen labels>,
"barcodes": <Array of one or more specimen barcodes>,
"cprId": <Registration ID>,
"visitId": <Visit ID>,
"specimenListId": <Cart ID>,
"exactMatch": <Boolean indicating whether labels/barcodes matching is exact or substring>,
"startAt": <Index of starting record in the entire result set>
"maxResults": <Maximum records to return in the response>
}
|
Response Body | List of specimens that match the requested criteria |
Parameters:
Parameter | Detail |
|---|---|
cpId | Collection protocol ID. When specified, specimens search is limited to the collection protocol identified by this parameter. Optional parameter. |
labels | Array of one or more specimen labels. Only the specimens matching these labels are returned in the result set. Optional parameter. |
barcodes | Array of one or more specimen barcodes. Only the specimens matching these barcodes are returned in the result set. Optional parameter. |
cprId | Registration ID. When specified, specimens search is limited to the specimens of the registration identified by this parameter. Optional parameter. |
visitId | Visit ID. When specified, specimens search is limited to the specimens of the visit identified by this parameter. Optional parameter. |
specimenListId | Cart ID. When specified, specimens search is limited to the specimens contained in a cart identified by this parameter. Optional parameter. |
exactMatch | Boolean. By default false. This parameter is used to guide whether the labels or barcodes, when specified, should be matched in entirety or only substring should be matched. |
startAt, maxResults | These parameters are used for pagination of specimen records. startAt indicates the starting index of the first record in the entire result set. maxResults specifies the max records to return. Pagination using page size = 5 startAt: 0, maxResults = 5 startAt: 5, maxResults = 5 startAt: 10, maxResults = 5 … startAt: (n - 1) * maxResults, maxResults = pageSize Where n is the page number. |