Last modified by Андрей Калиновский on 2025/02/20 09:52
<
From version < 80.2 >
edited by Илья Крайнов
on 2023/03/29 13:05
To version < 85.1 >
edited by Илья Крайнов
on 2023/03/29 18:03
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1302,7 +1302,10 @@
1302 1302  
1303 1303  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1304 1304  
1305 -POST /api/v3/notifications/find
1305 +(% class="box infomessage" %)
1306 +(((
1307 +**POST /api/v3/notifications/find**
1308 +)))
1306 1306  
1307 1307  Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1308 1308  
... ... @@ -1323,21 +1323,23 @@
1323 1323  
1324 1324  [
1325 1325   {
1326 - "id": 0,
1327 - "name": "string",
1328 - "active": true,
1329 - "type": 0,
1330 - "userId": "",
1331 - "parentId": "",
1332 - "parentName": "string"
1329 + "id": 0, ~/~/ ID уведомления
1330 + "name": "string", ~/~/ Название уведомления
1331 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1332 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1333 + "userId": "", ~/~/ Пользователь, создавший уведомление
1334 + "parentId": "", ~/~/ Идентификатор клиента
1335 + "parentName": "string" ~/~/ Имя клиента
1333 1333   }
1334 1334  ]
1335 1335  
1339 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1336 1336  
1337 -Запрос настроек уведомления
1341 +(% class="box infomessage" %)
1342 +(((
1343 +**GET /api/v3/notifications/{id}**
1344 +)))
1338 1338  
1339 -GET /api/v3/notifications/{id}
1340 -
1341 1341  Метод возвращает данные правил формирования выбранного уведомления.
1342 1342  
1343 1343  (% style="text-align: left;" %)
... ... @@ -1357,54 +1357,81 @@
1357 1357  
1358 1358  (% style="text-align: left;" %)
1359 1359  (% style="color:#000000" %){
1360 - "id": 0,
1361 - "type": 0,
1362 - "userId": "",
1363 - "parentId": "",
1364 - "parentName": "string",
1365 - "name": "string",
1366 - "active": true,
1367 - "vehicleIds": [
1368 - 0
1365 + "id": 0, ~/~/ (%%)id уведомления
1366 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1367 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1368 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1369 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1370 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1371 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1372 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1373 +(% style="color:#000000" %) 0
1369 1369   ],
1370 - "geoids": [
1371 - 0
1375 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1376 +(% style="color:#000000" %) 0
1372 1372   ],
1373 - "fieldids": [
1374 - 0
1378 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
1379 +(% style="color:#000000" %) 0
1375 1375   ],
1376 - "settings": {
1381 + "settings": { ~/~/ Список параметров уведомления
1377 1377   "additionalProp1": "string",
1378 1378   "additionalProp2": "string",
1379 1379   "additionalProp3": "string"
1380 1380   },
1381 - "toEmail": true,
1382 - "recipientIds": [
1383 - ""
1386 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1387 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1388 +(% style="color:#000000" %) ""
1384 1384   ],
1385 - "enableSideEmails": true,
1386 - "sideEmails": [
1387 - "string"
1390 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1391 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1392 +(% style="color:#000000" %) "string"
1388 1388   ],
1389 - "toTelegram": true,
1390 - "telegrams": [
1391 - {
1392 - "id": 0,
1393 - "info": "string"
1394 - }
1394 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1395 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1396 +(% style="color:#000000" %) {
1397 + "id": 0, ~/~/ (%%)Идентификатор участника чата
1398 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1399 +(% style="color:#000000" %) }
1395 1395   ],
1396 - "toMobile": true,
1397 - "toClient": true,
1398 - "stored": true,
1399 - "kind": 0,
1400 - "activationMode": 0,
1401 - "activationTime": "2023-03-29T09:57:48.932Z",
1402 - "timezone": 0,
1403 - "validity": 0,
1404 - "autoProlongation": true
1405 -}
1401 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1402 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1403 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1404 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1405 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1406 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1407 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1408 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1409 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1410 +(% style="color:#000000" %)}
1406 1406  
1412 +== (% style="color:#000000; font-size:16px" %)**Добавление уведомления**(%%) ==
1407 1407  
1414 +(% class="box successmessage" %)
1415 +(((
1416 +**POST /api/v3/notifications/**
1417 +)))
1418 +
1419 +Метод возвращает
1420 +
1421 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1422 +
1423 +(% class="box warningmessage" %)
1424 +(((
1425 +**PUT /api/v3/notifications/**
1426 +)))
1427 +
1428 +Метод возвращает
1429 +
1430 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1431 +
1432 +(% class="box errormessage" %)
1433 +(((
1434 +**DELETE /api/v3/notifications/{id}**
1435 +)))
1436 +
1437 +Метод возвращает
1438 +
1439 +
1408 1408  (% class="box" lang="en-US" style="text-align: center;" %)
1409 1409  (((
1410 1410  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Меню

ГЛОНАССSoft wiki - 2024 г.