POST v1/insNotify

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

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

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

Відсутній.

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

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

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

integer

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

notifyDevices

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

Collection of NotifyDeviceNew

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

notifyRegions

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

Collection of NotifyRegionNew

Не обов'язковий (в залежності від типу нотифікації)

notifyParams

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

Collection of NotifyParamNew

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

notifyDestinations

Масив варіантів надходження нотифікації

Collection of NotifyDestinationNew

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

isActive

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

boolean

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

description

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

string

Не обов'язковий

dayOfWeek

Масив днів тижня, у разі циклічного періоду дії (True або False) або (1 або 0) довжиною 7)

Collection of boolean

Не обов'язковий (якщо не циклічний період дії)

dateFrom

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

date

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

dateTo

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

date

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

isUseTimeInEachDay

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

boolean

Не обов'язковий

scenarioKey

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

string

Не обов'язковий

isDisposable

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

boolean

Не обов'язковий

Формат запиту

application/json

Приклад:
{
  "notifyActionID": 1,
  "notifyDevices": [
    {
      "deviceID": 1,
      "groupDeviceID": 2,
      "isAllDevices": true
    },
    {
      "deviceID": 1,
      "groupDeviceID": 2,
      "isAllDevices": true
    }
  ],
  "notifyRegions": [
    {
      "regionID": 1,
      "groupRegionID": 2,
      "isAllRegions": true,
      "isBaseRegion": true,
      "name": "sample string 5",
      "verticle": {
        "x": 1.1,
        "y": 2.1
      },
      "isDeleteCreatedRegion": true
    },
    {
      "regionID": 1,
      "groupRegionID": 2,
      "isAllRegions": true,
      "isBaseRegion": true,
      "name": "sample string 5",
      "verticle": {
        "x": 1.1,
        "y": 2.1
      },
      "isDeleteCreatedRegion": true
    }
  ],
  "notifyParams": [
    {
      "notifyParamTypeID": 1,
      "notifyParamValue": "sample string 2"
    },
    {
      "notifyParamTypeID": 1,
      "notifyParamValue": "sample string 2"
    }
  ],
  "notifyDestinations": [
    {
      "accountID": 1,
      "email": "sample string 1"
    },
    {
      "accountID": 1,
      "email": "sample string 1"
    }
  ],
  "isActive": true,
  "description": "sample string 3",
  "dayOfWeek": [
    true,
    true
  ],
  "dateFrom": "2024-04-19T16:29:42",
  "dateTo": "2024-04-19T16:29:42",
  "isUseTimeInEachDay": true,
  "scenarioKey": "sample string 7",
  "isDisposable": true
}

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

Опис

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

ID новоствореного об'єкта

integer

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

application/json

Приклад:
{
  "id": 1
}