Developer Documentation (API)

List scheduled notifications of a template

GET Request
Endpoint URL https://veski.leikbreytir.is/api/pass-template/{template-id}/notification
Purpose
Lists all past and due notifications that are existing for the given template.
If there’s no notificationText in the return JSON it means that this is a version of a template.

Required input parameters

HTTP Authorization Header that contains your API key
template-id – the UUID of the pass template that you want to receive notifications for

Returned values

A JSON array containing an array called scheduledTasks and executedTasks.
Depending on the load in our system it might happen that a task is scheduled and the publicationDate is slightly in the past.
The system will pick up the task shortly afterwards and push the changes to the devices of your users.

Example output:

{
    "scheduledTasks": [
        {
            "notificationId": "7a1576c6-b5e5-433a-a5a7-586ef11a3bac",
            "publicationDate": "2019-11-15 12:55",
            "notificationText": "Example notification!"
        },
        {
            "notificationId": "e2c6ee03-fd0a-463c-81ee-2047bc5d48af",
            "publicationDate": "2019-11-16 12:55",
            "notificationText": "Example notification!"
        },
        {
            "notificationId": "eb3795e2-0b9a-44e7-a8a0-95ac611efd39",
            "publicationDate": "2019-11-17 14:38",
            "notificationText": "Example notification!"
        }
    ],
    "executedTasks": [
        {
            "notificationId": "07f11075-8794-46d0-9e4b-16735dd382e5",
            "publicationDate": "2019-08-15 13:22"
        },
        {
            "notificationId": "5c1642d9-db0a-43b9-978a-94535192b802",
            "publicationDate": "2019-08-16 13:22",
            "notificationText": "Example notification!"
        }
    ]
}