Versions Compared

Version Old Version 2 New Version 3
Changes made by

Gaspar

Gaspar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Get Notification by ID

GET /notification/status/{project}/{clientId}/{notificationID}

...

Parameter Name

Type

Description

project

string

Reference project to send notifications. This allows the app to store data in a different data persistence tool.

Supported values:

  • LAC-FP

clientId

string

Could be:

  • ID associated to a DHIS2 TrackedEntityInstance.

  • _id associated to a mongoDB client document.

msg

string

Message to be linked to the notification.

channel

string

Way of communication where the scheduled message will be sent:

Current supported values:

  • facebook

  • whatsapp

  • SMS

to

string

Identifier used by the specified channel to send the message.

templateID

string

Identifier used by the specified channel to use a pre-defined template.

templateParams

string

Parameters to be used in the template specified.

notificationDate

string

Date on which the notification will be sent.

status

cancelled | sent | scheduled | error | unsent

Current status of the notification.

  • Cancelled: Cancelled by the cancel endpoint

  • Sent: Sent to the user successfully.

  • Scheduled: Pending to be sent.

  • Error: Try to send the notification, but an error occurs.

  • Unsent: Try to send the notification, but client doens’t consent to receive messages.

Responses

200: Success

Code Block
{
  "notifications": [
    {
      "channel": "facebook",
      "clientId": "CEWRFqwe123",
      "notificationId": "aosfACOaqw213",
      "msg": "Created from openHIM 22",
      "notificationDate": "2024-02-19T10:15:08.093",
      "project": "LAC-FP",
      "status": "canceled",
      "templateId": "template_4",
      "templateParams": "{\"quick_replies\":[{\"content_type\":\"text\",\"image_url\":\"http://example.com/img/red.png\",\"payload\":\"<POSTBACK_PAYLOAD>\",\"title\":\"Red\"},{\"content_type\":\"text\",\"image_url\":\"http://example.com/img/green.png\",\"payload\":\"<POSTBACK_PAYLOAD><\",\"title\":\"Green\"}],\"text\":\"Pick a color:\"}",
      "to": "123456767"
    }
  ]
}

...