Skip to main content

GET Results Status

Returns the status of the result that is associated with a LetsGetChecked test kit. The following result statuses are possible:

StatusDescription
Activation completedThe participant successfully activated their test kit.
CancelledA Cancelled status might occur if a patient requests that a lab should not process their test sample. If a result is cancelled, the client cannot fetch a Results payload.
SampleCollectedThe timestamp when the carrier collected the test kit from the participant.
SampleAtLabThe participant's sample is received at the LetsGetChecked lab.
ResultsReceivedThe results are reported by the LetsGetChecked Lab and are awaiting physician approval before they are released.
ResultsAvailableThe results are available for a test kit. The LetsGetChecked Medical team reviews the test results before they are communicated to the participant.

Request

Endpoint

​​ Path parameters

Response

Sample response

Request

Endpoint

GET {clientId}/api/v1/results/{barcode}?alphaCode={alphaCode}&fields=status

Path parameters

ParameterDescriptionTypeRequired/Optional
Barcode/numerical codeFormatted as LGC-0000-0000-0000, where 0 indicates any digit.stringRequired
alphaCodeFormatted as AAAAAA, where A indicates any uppercase letter from A to Z.stringRequired
FieldsDetermines which fields to include in the response. The default value is status. Tip: This parameter is included to enable more details to be added in the future.stringOptional

Response

The sample response is a single JSON object that contains the following fields:

PropertyDescriptionType
statusThe result statusstring

Sample response

{
"status" : "string"
}