Get Notifications

Request notifications for results letters associated with a client program.

Request

Endpoint

GET {clientId}/api/v1/outreach?programName=someProgram&startDate=01/01/2000&endDate=01/01/2000&continuationToken=123abc

Path parameters

Parameter	Description	Type	Required/Optional
clientId	The clientId is a unique code that is provided by LetsGetChecked. The clientId is used to identify a client, when a client calls the Orders and Results APIs. The code is a number between 0 and 9999.	string	Required

Query parameters

Parameter	Description	Type	Required/Optional
programName	The LetsGetChecked program name.	string	Required
startDate	The program start date.	string	Required
endDate	The program end date.	string	Required
continuationToken	The response contains an X-Continuation-Token HTTP header which represents a pointer to the last item on the page.	string	Required

Response

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
pcpLetterSendStatus	The results letter sent to the patient's PCP after the results are released.	object (pcpLetterSendStatus)
{pcpLetterSendStatus}/Status	The following value is possible: DeliverySent	string
{pcpLetterSendStatus}/FailureReason	FailureReason is always null.	string
{pcpLetterSendStatus}/UpdatedAt	The timestamp, in UTC time, in ISO 8601 format.	string
patientLetterSendStatus	The patient's results letter that is sent after the results are released.	object (patientLetterSendStatus)
{patientLetterSendStatus}/Status	The following value is possible: DeliverySent	string
{patientLetterSendStatus}/FailureReason	FailureReason is always null.	string
{patientLetterSendStatus}/UpdatedAt	The timestamp, in UTC time, in ISO 8601 format.	string

Sample Response

{
   "items":[
      {
         "barcode":"LGC-1234-1234-1234",
         "programName":"programName",
         "pcpLetterSendStatus":{
            "Status":"DeliverySent",
            "FailureReason":null,
            "UpdatedAt":"2021-06-23T18:25:43.511Z"
         },
         "patientLetterSendStatus":{
            "Status":"DeliverySent",
            "FailureReason":null,
            "UpdatedAt":"2021-06-23T18:25:43.511Z"
         }
      }
   ]
}