GET Notification by Barcode
Request notifications for results letters associated with a client program, using the barcode.
Request
Endpoint
GET {clientId}/api/v1/outreach/{barcode}
Headers
The GET Notification by barcode requires the following information in the headers of an HTTP request:
| HTTP Header | Description |
|---|---|
| Authorization | The HTTP Authorization request header contains the credentials to authenticate a user agent with a server. |
| Accept | The HTTP Accept request header contains information about the content types, expressed as MIME types, that the client can understand. The MIME types for the GET Notification by Barcode request is application/json |
Path parameters
| Parameter | Description | Type | Required/Optional |
|---|---|---|---|
| clientId | The Client ID is a unique code that is provided by LetsGetChecked. The code is formed by 1 to 4 alphanumeric characters. | string | Required |
| barcode | Formatted as LGC-0000-0000-0000, where 0 indicates any digit. | string | Required |
Response
Status Codes
| Status Code | Description |
|---|---|
| 200 | Returned whenever a notification, with the specified barcode, is found. |
| 400 | Returned whenever a parameter is send in an invalid format. |
| 404 | Returned whenever a notification, with the specified barcode, is not found. |
| 503 | Returned whenever the service is unavailable. |
| 500 | Returned whenever some generic error occurred in the server. |
The sample response is a single JSON object that contains the following fields:
| Property | Description | Type |
|---|---|---|
| Barcode / numerical code | Formatted as LGC-0000-0000-0000, where 0 indicates any digit. | string |
| programName | The LetsGetChecked program name. | string |
| calls | This property is currently not in use and does not have a structure defined yet so is value is always an empty array. | object(callStatus) |
| pcpLetterSendStatus | The results letter sent to the patient's PCP after results are released. | Object (pcpLetterSendStatus) |
| {pcpLetterSendStatus}/Status | The following value is possible: | string |
| {pcpLetterSendStatus}/FailureReason | This property is currently not in use and the value is always null. The value can be a maximum of 200 characters. | string |
| {pcpLetterSendStatus}/UpdatedAt | The timestamp, in UTC time, in ISO 8601 format. | string |
| patientLetterSendStatus | The patient results letter that is sent after the results are released. | object (patientLetterSendStatus) |
| {patientLetterSendStatus}/Status | The following value is possible: | string |
| {patientLetterSendStatus}/FailureReason | This property is currently not in use and the value is always null. The value can be a maximum of 200 characters. | string |
| {patientLetterSendStatus}/UpdatedAt | The timestamp, in UTC time, in ISO 8601 format. | string |
Sample Response
{
"barcode":"LGC-1234-1234-1234",
"programName":"programName",
"calls": [],
"pcpLetterSendStatus":{
"Status":"DeliverySent",
"FailureReason":null,
"UpdatedAt":"2021-06-23T18:25:43.511Z"
},
"patientLetterSendStatus":{
"Status":"DeliverySent",
"FailureReason":null,
"UpdatedAt":"2021-06-23T18:25:43.511Z"
}
}
