GET v1/getNotify?id={id}

Метод для отримання нотифікації.

Параметри запиту

Формат запиту (URI parameters)

НазваОписTипДодатково
id

ID нотифікації

integer

Обов'язковий

Тіло запиту (body parameters)

Відсутнє.

Параметри відповіді

Опис

НазваОписTипДодатково
id

ID нотифікації

integer

clientID

ID клієнта

integer

accountID

ID акаунта

integer

notifyActionID

ID типу нотифікації

integer

notifyActionName

Назва типу нотифікації

string

dayOfWeek

Масив днів тиждня (True або False) або (1 або 0) довжиною 7)

Collection of boolean

notifyDevices

Масив авто нотифікації

Collection of NotifyDevice

notifyRegions

Масив регіонів нотифікації

Collection of NotifyRegion

notifyDestinations

Масив варіантів отримання нотифікації

Collection of NotifyDestination

isActive

Ознака чи є нотифікація активна

boolean

dateFrom

Дата початку дії нотифікації

date

dateTo

Дата закінчення дії нотифікації

date

description

Опис нотифікації

string

type

Тип нотифікації (разова чи циклічна)

NotifyType

scenarioKey

Ключ сценарію нотифікації

string

notifyParams

Масив параметрів нотифікації

Collection of NotifyParam

isNeedCalculate

Ознака яка чи потрібно нотифікувати в даний момент часу

boolean

isNoNeedCalculateReason

Причина чому не потрібно проводити розрахунки події нотифікації

string

isUseTimeInEachDay

Ознака чи враховувати час дії нотифікації в кожній добі (Для разової багатоденної нотифікації)

boolean

notifyPeriod

Період нотифікації

Object

isDisposable

Ознака чи видаляти нотифікацію після отримання

boolean

Формат відповіді

application/json

Приклад:
{
  "id": 1,
  "clientID": 2,
  "accountID": 3,
  "notifyActionID": 4,
  "notifyActionName": "sample string 5",
  "dayOfWeek": [
    true,
    true
  ],
  "notifyDevices": [
    {
      "id": 1,
      "notifyID": 2,
      "deviceID": 1,
      "deviceName": "sample string 3",
      "groupDeviceID": 4,
      "groupDeviceName": "sample string 5",
      "isAllDevices": true,
      "relevanceDate": "2022-12-01T22:29:26.546108+02:00"
    },
    {
      "id": 1,
      "notifyID": 2,
      "deviceID": 1,
      "deviceName": "sample string 3",
      "groupDeviceID": 4,
      "groupDeviceName": "sample string 5",
      "isAllDevices": true,
      "relevanceDate": "2022-12-01T22:29:26.546108+02:00"
    }
  ],
  "notifyRegions": [
    {
      "id": 1,
      "notifyID": 2,
      "regionID": 3,
      "regionName": "sample string 4",
      "groupRegionID": 5,
      "groupRegionName": "sample string 6",
      "isAllRegions": true,
      "isBaseRegion": true,
      "isDeleteCreatedRegion": true
    },
    {
      "id": 1,
      "notifyID": 2,
      "regionID": 3,
      "regionName": "sample string 4",
      "groupRegionID": 5,
      "groupRegionName": "sample string 6",
      "isAllRegions": true,
      "isBaseRegion": true,
      "isDeleteCreatedRegion": true
    }
  ],
  "notifyDestinations": [
    {
      "id": 1,
      "notifyID": 2,
      "accountID": 3,
      "accountName": "sample string 4",
      "accountPhone": "sample string 5",
      "email": "sample string 6"
    },
    {
      "id": 1,
      "notifyID": 2,
      "accountID": 3,
      "accountName": "sample string 4",
      "accountPhone": "sample string 5",
      "email": "sample string 6"
    }
  ],
  "isActive": true,
  "dateFrom": "2022-12-01T22:29:26.546108+02:00",
  "dateTo": "2022-12-01T22:29:26.546108+02:00",
  "description": "sample string 11",
  "type": 2,
  "scenarioKey": "sample string 12",
  "notifyParams": [
    {
      "id": 1,
      "notifyID": 2,
      "notifyParamTypeID": 3,
      "notifyParamType": {
        "id": 3,
        "notifyActionID": 4,
        "name": "sample string 6",
        "defaultValue": "sample string 5"
      },
      "value": "sample string 7"
    },
    {
      "id": 1,
      "notifyID": 2,
      "notifyParamTypeID": 3,
      "notifyParamType": {
        "id": 3,
        "notifyActionID": 4,
        "name": "sample string 6",
        "defaultValue": "sample string 5"
      },
      "value": "sample string 7"
    }
  ],
  "isNeedCalculate": false,
  "isNoNeedCalculateReason": "Термін дії закінчився",
  "isUseTimeInEachDay": true,
  "notifyPeriod": "з 01.12.2022<br/>по 01.12.2022",
  "isDisposable": true
}