GET v1/selNotifications
Метод який повертає масив нотифікацій акаунта.
Параметри запиту
Формат запиту (URI parameters)
Відсутній.
Тіло запиту (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": "2024-10-30T19:31:22" }, { "id": 1, "notifyID": 2, "deviceID": 1, "deviceName": "sample string 3", "groupDeviceID": 4, "groupDeviceName": "sample string 5", "isAllDevices": true, "relevanceDate": "2024-10-30T19:31:22" } ], "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": "2024-10-30T19:31:22", "dateTo": "2024-10-30T19:31:22", "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": true, "isNoNeedCalculateReason": "sample string 13", "isUseTimeInEachDay": true, "notifyPeriod": "з 30.10.2024<br/>по 30.10.2024", "isDisposable": true }, { "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": "2024-10-30T19:31:22" }, { "id": 1, "notifyID": 2, "deviceID": 1, "deviceName": "sample string 3", "groupDeviceID": 4, "groupDeviceName": "sample string 5", "isAllDevices": true, "relevanceDate": "2024-10-30T19:31:22" } ], "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": "2024-10-30T19:31:22", "dateTo": "2024-10-30T19:31:22", "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": true, "isNoNeedCalculateReason": "sample string 13", "isUseTimeInEachDay": true, "notifyPeriod": "з 30.10.2024<br/>по 30.10.2024", "isDisposable": true } ]