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

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.SupportZhuchkov
1 +XWiki.krainovim
Content
... ... @@ -436,7 +436,7 @@
436 436   "email": "" , ~/~/ E-mail
437 437   "sessionDuration":"", ~/~/ длительность сессии в минутах
438 438   "status": "1",  ~/~/ статус пользователя
439 - "lastLogged": "", ~/~/ дата/время последней авторизации
439 + "astLogged": "", ~/~/ дата/время последней авторизации
440 440  
441 441  (% style="color:#000000" %)}
442 442  
... ... @@ -701,9 +701,9 @@
701 701  
702 702  (% style="color:#000000" %)Метод запроса: **GET**
703 703  
704 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
704 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
705 705  
706 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
706 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
707 707  
708 708  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
709 709  
... ... @@ -763,7 +763,7 @@
763 763  (% lang="en-US" %)**POST /api/v3/vehicles**
764 764  )))
765 765  
766 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
766 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе.
767 767  
768 768  (% style="color:#000000" %)Метод запроса: **POST**
769 769  
... ... @@ -1011,7 +1011,7 @@
1011 1011  (% lang="en-US" %)**PUT /api/v3/vehicles**
1012 1012  )))
1013 1013  
1014 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1014 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе.
1015 1015  
1016 1016  (% style="color:#000000" %)Метод запроса: **PUT**
1017 1017  
... ... @@ -1140,7 +1140,7 @@
1140 1140  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1141 1141  )))
1142 1142  
1143 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1143 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса.
1144 1144  
1145 1145  (% style="color:#000000" %)Метод запроса: **DELETE**
1146 1146  
... ... @@ -1302,10 +1302,7 @@
1302 1302  
1303 1303  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1304 1304  
1305 -(% class="box infomessage" %)
1306 -(((
1307 -**POST /api/v3/notifications/find**
1308 -)))
1305 +POST /api/v3/notifications/find
1309 1309  
1310 1310  Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1311 1311  
... ... @@ -1326,23 +1326,21 @@
1326 1326  
1327 1327  [
1328 1328   {
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" ~/~/ Имя клиента
1326 + "id": 0,
1327 + "name": "string",
1328 + "active": true,
1329 + "type": 0,
1330 + "userId": "",
1331 + "parentId": "",
1332 + "parentName": "string"
1336 1336   }
1337 1337  ]
1338 1338  
1339 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1340 1340  
1341 -(% class="box infomessage" %)
1342 -(((
1343 -**GET /api/v3/notifications/{id}**
1344 -)))
1337 +Запрос настроек уведомления
1345 1345  
1339 +GET /api/v3/notifications/{id}
1340 +
1346 1346  Метод возвращает данные правил формирования выбранного уведомления.
1347 1347  
1348 1348  (% style="text-align: left;" %)
... ... @@ -1349,7 +1349,7 @@
1349 1349  Метод запроса **GET**
1350 1350  
1351 1351  (% style="text-align: left;" %)
1352 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1347 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/notifications/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{id}]]
1353 1353  
1354 1354  (% style="text-align: left;" %)
1355 1355  (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
... ... @@ -1362,142 +1362,54 @@
1362 1362  
1363 1363  (% style="text-align: left;" %)
1364 1364  (% style="color:#000000" %){
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
1374 - ],
1375 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1376 -(% style="color:#000000" %) 0
1377 - ],
1378 - "fieldids": [ ~/~/ (%%)Список id полей для анализа
1379 -(% style="color:#000000" %) 0
1380 - ],
1381 - "settings": { ~/~/ Список параметров уведомления
1382 - "additionalProp1": "string",
1383 - "additionalProp2": "string",
1384 - "additionalProp3": "string"
1385 - },
1386 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1387 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1388 -(% style="color:#000000" %) ""
1389 - ],
1390 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1391 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1392 -(% style="color:#000000" %) "string"
1393 - ],
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" %) }
1400 - ],
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" %)}
1411 -
1412 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1413 -
1414 -(% class="box warningmessage" %)
1415 -(((
1416 -**PUT /api/v3/notifications/**
1417 -)))
1418 -
1419 -Метод позволяет отредактировать уведомление.
1420 -
1421 -Метод запроса **PUT**
1422 -
1423 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1424 -
1425 -В заголовках запроса: X-Auth: Токен авторизации
1426 -
1427 -Тело запроса:
1428 -{
1429 - "id": 0, ~/~/ id уведомления
1430 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1431 - "userId": "", ~/~/ Пользователь, создавший уведомление
1432 - "parentId": "", ~/~/ Идентификатор клиента
1433 - "parentName": "string", ~/~/ Имя клиента
1434 - "name": "string", ~/~/ Название уведомления
1435 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
1436 - "vehicleIds": [ ~/~/ Список id объектов для анализа
1360 + "id": 0,
1361 + "type": 0,
1362 + "userId": "",
1363 + "parentId": "",
1364 + "parentName": "string",
1365 + "name": "string",
1366 + "active": true,
1367 + "vehicleIds": [
1437 1437   0
1438 1438   ],
1439 - "geoids": [ ~/~/ Список id геообъектов для анализа
1370 + "geoids": [
1440 1440   0
1441 1441   ],
1442 - "fieldids": [ ~/~/ Список id полей для анализа
1373 + "fieldids": [
1443 1443   0
1444 1444   ],
1445 - "settings": { ~/~/ Список параметров уведомления
1376 + "settings": {
1446 1446   "additionalProp1": "string",
1447 1447   "additionalProp2": "string",
1448 1448   "additionalProp3": "string"
1449 1449   },
1450 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1451 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1381 + "toEmail": true,
1382 + "recipientIds": [
1452 1452   ""
1453 1453   ],
1454 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1455 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1385 + "enableSideEmails": true,
1386 + "sideEmails": [
1456 1456   "string"
1457 1457   ],
1458 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1459 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1389 + "toTelegram": true,
1390 + "telegrams": [
1460 1460   {
1461 - "id": 0, ~/~/ Идентификатор участника чата
1462 - "info": "string" ~/~/ Дополнительные сведения
1392 + "id": 0,
1393 + "info": "string"
1463 1463   }
1464 1464   ],
1465 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1466 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1467 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1468 - "kind": 0, ~/~/ Определяет вид уведомления
1469 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1470 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1471 - "timezone": 0, ~/~/ Сдвиг часового пояса
1472 - "validity": 0, ~/~/ Срок действия в днях (1-90)
1473 - "autoProlongation": true ~/~/ Автопродление срока действия
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
1474 1474  }
1475 1475  
1476 -Ответ:
1477 1477  
1478 -Success
1479 -
1480 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1481 -
1482 -(% class="box errormessage" %)
1483 -(((
1484 -**DELETE /api/v3/notifications/{id}**
1485 -)))
1486 -
1487 -Метод позволяет удалить выбранное уведомление.
1488 -
1489 -Метод запроса **DELETE**
1490 -
1491 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1492 -
1493 -Передаваемый параметр: {id} - id уведомления
1494 -
1495 -В заголовках запроса: X-Auth: Токен авторизации
1496 -
1497 -Ответ:
1498 -
1499 -Success
1500 -
1501 1501  (% class="box" lang="en-US" style="text-align: center;" %)
1502 1502  (((
1503 1503  (% 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 г.