Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/20 09:52
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.SupportZhuchkov - Content
-
... ... @@ -436,7 +436,7 @@ 436 436 "email": "" , ~/~/ E-mail 437 437 "sessionDuration":"", ~/~/ длительность сессии в минутах 438 438 "status": "1", ~/~/ статус пользователя 439 - "astLogged": "", ~/~/ дата/время последней авторизации 439 + "lastLogged": "", ~/~/ дата/время последней авторизации 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**__>- идентификатор объекта (опционально)706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 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 ... ... @@ -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/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{id}]]1352 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 1353 1353 1354 1354 (% style="text-align: left;" %) 1355 1355 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления ... ... @@ -1409,15 +1409,6 @@ 1409 1409 (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 1410 1410 (% style="color:#000000" %)} 1411 1411 1412 -== (% style="color:#000000; font-size:16px" %)**Добавление уведомления**(%%) == 1413 - 1414 -(% class="box successmessage" %) 1415 -((( 1416 -**POST /api/v3/notifications/** 1417 -))) 1418 - 1419 -Метод возвращает 1420 - 1421 1421 == (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 1422 1422 1423 1423 (% class="box warningmessage" %) ... ... @@ -1425,8 +1425,67 @@ 1425 1425 **PUT /api/v3/notifications/** 1426 1426 ))) 1427 1427 1428 -Метод возвращает1419 +Метод позволяет отредактировать уведомление. 1429 1429 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 объектов для анализа 1437 + 0 1438 + ], 1439 + "geoids": [ ~/~/ Список id геообъектов для анализа 1440 + 0 1441 + ], 1442 + "fieldids": [ ~/~/ Список id полей для анализа 1443 + 0 1444 + ], 1445 + "settings": { ~/~/ Список параметров уведомления 1446 + "additionalProp1": "string", 1447 + "additionalProp2": "string", 1448 + "additionalProp3": "string" 1449 + }, 1450 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 1451 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 1452 + "" 1453 + ], 1454 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 1455 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 1456 + "string" 1457 + ], 1458 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 1459 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 1460 + { 1461 + "id": 0, ~/~/ Идентификатор участника чата 1462 + "info": "string" ~/~/ Дополнительные сведения 1463 + } 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 ~/~/ Автопродление срока действия 1474 +} 1475 + 1476 +Ответ: 1477 + 1478 +Success 1479 + 1430 1430 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 1431 1431 1432 1432 (% class="box errormessage" %) ... ... @@ -1434,9 +1434,20 @@ 1434 1434 **DELETE /api/v3/notifications/{id}** 1435 1435 ))) 1436 1436 1437 -Метод возвращает1487 +Метод позволяет удалить выбранное уведомление. 1438 1438 1489 +Метод запроса **DELETE** 1439 1439 1491 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 1492 + 1493 +Передаваемый параметр: {id} - id уведомления 1494 + 1495 +В заголовках запроса: X-Auth: Токен авторизации 1496 + 1497 +Ответ: 1498 + 1499 +Success 1500 + 1440 1440 (% class="box" lang="en-US" style="text-align: center;" %) 1441 1441 ((( 1442 1442 (% 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]] **