Изменения документа Методы API для работы с ГЛОНАССSoft
Редактировал(а) Андрей Калиновский 2025/07/29 15:51
<
>
отредактировано Андрей Калиновский
на 2025/04/24 15:44
на 2025/04/24 15:44
отредактировано Андрей Калиновский
на 2025/07/29 15:41
на 2025/07/29 15:41
Изменить комментарий:
К данной версии нет комментариев
Комментарий
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -287,28 +287,6 @@ 287 287 "bankKS": "string" ~/~/ корр. счёт 288 288 } 289 289 290 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 291 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 292 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 293 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 294 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 295 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 296 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 297 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 298 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 299 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 300 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 301 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 302 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 303 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 304 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 305 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 306 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 307 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 308 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 309 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 310 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 311 - 312 312 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 313 313 314 314 (% class="box warningmessage" %) ... ... @@ -454,7 +454,7 @@ 454 454 [ 455 455 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 456 456 ], 457 - "language": 0~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский435 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 458 458 } 459 459 { 460 460 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -766,6 +766,8 @@ 766 766 (% style="text-align:left" %) 767 767 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 768 768 747 += = 748 + 769 769 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 770 770 771 771 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == ... ... @@ -877,7 +877,7 @@ 877 877 { 878 878 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 879 879 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 880 - "deleted": true,860 + "deleted": false, 881 881 "extId": "string", 882 882 "name": "string", 883 883 "picture": "string", ... ... @@ -896,7 +896,7 @@ 896 896 { 897 897 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 898 898 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 899 - "deleted": true,879 + "deleted": false, 900 900 "extId": "string", 901 901 "name": "string", 902 902 "picture": "string", ... ... @@ -930,7 +930,7 @@ 930 930 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 931 931 ))) 932 932 933 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.913 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 934 934 935 935 (% style="color:#000000" %)Метод запроса: **PUT** 936 936 ... ... @@ -997,7 +997,7 @@ 997 997 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 998 998 ))) 999 999 1000 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.980 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 1001 1001 1002 1002 (% style="color:#000000" %)Метод запроса: **DELETE** 1003 1003 ... ... @@ -1628,77 +1628,6 @@ 1628 1628 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1629 1629 1630 1630 1631 -== **Импортировать историю ТС (Асинхронный запрос)** == 1632 - 1633 -(% class="box successmessage" %) 1634 -((( 1635 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1636 -))) 1637 - 1638 -Метод запроса: **POST** 1639 - 1640 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1641 - 1642 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1643 - 1644 - 1645 -Ответ: 1646 - 1647 -{ 1648 - 1649 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1650 - 1651 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1652 - 1653 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1654 - 1655 - "Message": "string", ~/~/ Информация о выполнении запроса 1656 - 1657 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1658 - 1659 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1660 - 1661 - "Data": "string" ~/~/ Данные 1662 - 1663 -} 1664 - 1665 - 1666 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1667 - 1668 -(% class="box infomessage" %) 1669 -((( 1670 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1671 -))) 1672 - 1673 -Метод запроса: **GET** 1674 - 1675 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1676 - 1677 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1678 - 1679 - 1680 -Ответ: 1681 - 1682 -{ 1683 - 1684 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1685 - 1686 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1687 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1688 - 1689 - "Message": "string", ~/~/ Информация о выполнении запроса 1690 - 1691 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1692 - 1693 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1694 - 1695 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1696 - 1697 - "Data": "string" ~/~/ Данные 1698 - 1699 -} 1700 - 1701 - 1702 1702 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1703 1703 1704 1704 (% class="box infomessage" %) ... ... @@ -1844,7 +1844,6 @@ 1844 1844 "stage": "", ~/~/ Состояние 1845 1845 (% style="color:#000000" %) } 1846 1846 1847 -== == 1848 1848 1849 1849 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1850 1850 ... ... @@ -2461,7 +2461,7 @@ 2461 2461 Тело запроса: 2462 2462 2463 2463 { 2464 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2372 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2465 2465 "vehicleIds": [0], ~/~/ Список ID объектов 2466 2466 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2467 2467 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2508,7 +2508,7 @@ 2508 2508 Тело запроса: 2509 2509 2510 2510 { 2511 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2419 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2512 2512 "vehicleIds": [0], ~/~/ Список ID объектов 2513 2513 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2514 2514 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2527,6 +2527,8 @@ 2527 2527 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2528 2528 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2529 2529 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2438 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2439 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2530 2530 "fuelConsumption": 0, ~/~/ Расход топлива 2531 2531 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2532 2532 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне ... ... @@ -2656,26 +2656,50 @@ 2656 2656 В заголовках запроса: X-Auth: Токен авторизации 2657 2657 2658 2658 2659 -В теле запроса перечисляетемассив id объектов, вквадратных скобкахчерез запятую.2569 +В массиве указываем id объектов через запятую 2660 2660 2661 2661 Ответ: 2572 + 2573 +[ 2662 2662 { 2663 - "vehicleId": 0, ~/~/Идентификатор объекта.2664 - "vehicleGuid": " 3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификаторобъекта.2665 - "vehicleNumber": " string",~/~/Номер объекта.2666 - "receiveTime": "202 4-02-27T14:11:00.315Z",~/~/Времяполучениязаписи на сервере,т.е. время срабатывания+ время передачи от устройствана сервер2667 - "recordTime": "202 4-02-27T14:11:00.315Z",~/~/Времязаписиотустройства, т.е. время фактическогособытия натранспортном средстве.2668 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.2669 - "speed": 0,~/~/Скорость объекта.2670 - "course": 0,~/~/Курс движения [0;360]2671 - "latitude": 0,~/~/Широта [-90°;90°].2672 - "longitude": 0,~/~/Долгота [-180°;180°]. 2673 - "address": " string",~/~/Адрес.2674 - "geozones": [ ~/~/Сведения по геозонам. 2575 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2576 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2577 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2578 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2579 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2580 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2581 + "speed": 31, ~/~/ Скорость объекта 2582 + "course": 116, ~/~/ Курс движения [0;360] 2583 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2584 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2585 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2586 + "geozones": [ ~/~/ Сведения по геозонам. 2675 2675 { 2676 - "id": 0, 2677 - "name": "string" 2588 + "id": 10225647, ~/~/ ID Геозоны 2589 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2590 + }, 2591 + { 2592 + "id": 10282875, ~/~/ ID Геозоны 2593 + "name": "Ё2" ~/~/ Наименование геозоны 2594 + }, 2595 + { 2596 + "id": 10226240, ~/~/ ID Геозоны 2597 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2598 + }, 2599 + { 2600 + "id": 9747869, ~/~/ ID Геозоны 2601 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2602 + }, 2603 + { 2604 + "id": 10221123, ~/~/ ID Геозоны 2605 + "name": "53r" ~/~/ Наименование геозоны 2606 + }, 2607 + { 2608 + "id": 10197638, ~/~/ ID Геозоны 2609 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2678 2678 } 2611 + ] 2612 + } 2679 2679 2680 2680 2681 2681 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = ... ... @@ -2866,7 +2866,7 @@ 2866 2866 "id": 0, ~/~/ ID уведомления 2867 2867 "name": "string", ~/~/ Название уведомления 2868 2868 "active": true, ~/~/ Состояние true - активен, false - деактивирован 2869 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2803 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2870 2870 "userId": "", ~/~/ Пользователь, создавший уведомление 2871 2871 "parentId": "", ~/~/ Идентификатор клиента 2872 2872 "parentName": "string" ~/~/ Имя клиента ... ... @@ -2873,6 +2873,155 @@ 2873 2873 } 2874 2874 ] 2875 2875 2810 + 2811 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2812 + 2813 +(% class="box infomessage" %) 2814 +((( 2815 +**POST /api/v3/notifications** 2816 +))) 2817 + 2818 +Метод запроса **POST** 2819 + 2820 +(% style="text-align: left;" %) 2821 +(% style="color:#000000" %)Пример запроса 2822 + 2823 +((( 2824 +{ 2825 + "id": 0, ~/~/ ID правила 2826 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2827 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2828 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2829 + "name": "string", ~/~/ Имя правила 2830 + "active": true, ~/~/ Активность правила 2831 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2832 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2833 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2834 + ], 2835 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2836 + 0 2837 + ], 2838 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2839 + 0 2840 + ], 2841 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2842 + 0 2843 + ], 2844 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2845 + "additionalProp1": "string", 2846 + "additionalProp2": "string", 2847 + "additionalProp3": "string" 2848 + }, 2849 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2850 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2851 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2852 + ], 2853 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2854 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2855 + "string" 2856 + ], 2857 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2858 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2859 + { 2860 + "id": 0, ~/~/ Идентификатор участника чата. 2861 + "info": "string" ~/~/ Дополнительные сведения. 2862 + } 2863 + ], 2864 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2865 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2866 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2867 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2868 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2869 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2870 + "timezone": 0, ~/~/ часовой пояс 2871 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2872 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2873 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2874 + { 2875 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2876 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2877 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2878 + "additionalProp1": "string", 2879 + "additionalProp2": "string", 2880 + "additionalProp3": "string" 2881 + } 2882 + } 2883 + ] 2884 +} 2885 +))) 2886 + 2887 +((( 2888 + 2889 +))) 2890 + 2891 +((( 2892 + 2893 +))) 2894 + 2895 +Ответ: 2896 + 2897 +{ 2898 + "id": 0, ~/~/ ID правила 2899 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2900 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2901 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2902 + "name": "string", ~/~/ Имя правила 2903 + "active": true, ~/~/ Активность правила 2904 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2905 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2906 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2907 + ], 2908 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2909 + 0 2910 + ], 2911 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2912 + 0 2913 + ], 2914 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2915 + 0 2916 + ], 2917 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2918 + "additionalProp1": "string", 2919 + "additionalProp2": "string", 2920 + "additionalProp3": "string" 2921 + }, 2922 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2923 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2924 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2925 + ], 2926 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2927 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2928 + "string" 2929 + ], 2930 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2931 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2932 + { 2933 + "id": 0, ~/~/ Идентификатор участника чата. 2934 + "info": "string" ~/~/ Дополнительные сведения. 2935 + } 2936 + ], 2937 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2938 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2939 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2940 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2941 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2942 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2943 + "timezone": 0, ~/~/ часовой пояс 2944 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2945 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2946 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2947 + { 2948 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2949 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2950 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2951 + "additionalProp1": "string", 2952 + "additionalProp2": "string", 2953 + "additionalProp3": "string" 2954 + } 2955 + } 2956 + ] 2957 +} 2958 + 2876 2876 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2877 2877 2878 2878 (% class="box infomessage" %) ... ... @@ -4090,16 +4090,12 @@ 4090 4090 Тело запроса: 4091 4091 4092 4092 { 4093 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4094 - "Balance": 0 4176 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4177 + "Balance": 0 ~/~/ Значение баланса. 4095 4095 } 4096 4096 4097 4097 Ответ: Success 4098 4098 4099 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4100 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4101 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4102 - 4103 4103 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4104 4104 4105 4105 (% class="box warningmessage" %) ... ... @@ -4111,16 +4111,29 @@ 4111 4111 4112 4112 Тело запроса: 4113 4113 4193 +((( 4114 4114 { 4115 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4116 - " Balance": 04195 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4196 + "amount": 0 ~/~/ Сумма пополнения баланса 4117 4117 } 4198 +))) 4118 4118 4200 +((( 4201 + 4202 +))) 4203 + 4119 4119 Ответ: Success 4120 4120 4121 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4122 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4123 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4206 +((( 4207 +{ 4208 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4209 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4210 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4211 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4212 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4213 + "Description": "string" ~/~/ Описание корректировки. 4214 +} 4215 +))) 4124 4124 4125 4125 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4126 4126 ... ... @@ -4133,16 +4133,25 @@ 4133 4133 4134 4134 Тело запроса: 4135 4135 4228 +((( 4136 4136 { 4137 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4138 - " Balance": 04230 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4231 + "amount": 0 ~/~/ Сумма списания с баланса 4139 4139 } 4233 +))) 4140 4140 4141 4141 Ответ: Success 4142 4142 4143 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4144 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4145 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4237 +((( 4238 +{ 4239 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4240 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4241 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4242 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4243 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4244 + "Description": "string" ~/~/ Описание корректировки 4245 +} 4246 +))) 4146 4146 4147 4147 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4148 4148 ... ... @@ -4153,28 +4153,35 @@ 4153 4153 4154 4154 Тело запроса: 4155 4155 4257 +((( 4156 4156 { 4157 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4158 - "CalculationType": 0, 4159 - "PermissibleBalance": 0, 4160 - "DefermentDays": 0, 4161 - "SendUiNotifications": true, 4162 - "SendEmailNotifications": true, 4163 - "IsPrivate": true, 4259 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4260 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4261 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4262 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4263 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4264 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4164 4164 } 4266 +))) 4165 4165 4268 +((( 4269 + 4270 +))) 4271 + 4166 4166 Ответ: Success 4167 4167 4168 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4169 -|ClientId|Идентификатор клиента 4170 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4171 -|PermissibleBalance|Допустимый баланс 4172 -|DefermentDays|((( 4173 -Отсрочка, количество дней 4274 +((( 4275 +{ 4276 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4277 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4278 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4279 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4280 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4281 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4282 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4283 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4284 +} 4174 4174 ))) 4175 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4176 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4177 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4178 4178 4179 4179 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4180 4180 ... ... @@ -4186,35 +4186,68 @@ 4186 4186 Тело запроса: 4187 4187 4188 4188 { 4189 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4190 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4191 - "Features": [ 4297 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4298 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4299 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4192 4192 { 4193 - "Feature": "string", 4194 - "IsEnabled": true, 4195 - "IsFactual": true, 4196 - "Limit": 0, 4197 - "Price": 0, 4198 - "DebitDate": "2023-10-18T13:26:58.987Z", 4199 - "PeriodValue": 0, 4200 - "PeriodType": 0 4301 + "Feature": "string", ~/~/ Код услуги. 4302 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4303 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4304 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4305 + "Price": 0, ~/~/ Цена за единицу. 4306 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4307 + "PeriodValue": 0, ~/~/ Значение периода. 4308 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4201 4201 } 4202 4202 ] 4203 4203 } 4204 4204 4313 + 4205 4205 Ответ: Success 4206 4206 4207 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4208 -|ClientId|Идентификатор клиента 4209 -|PlanId|Идентификатор тарифного плана 4210 -|Feature|Код услуги 4211 -|IsEnabled|Признак, определяющий активирована ли услуга 4212 -|IsFactual|Признак, определяющий расчёт по факту 4213 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4214 -|Price|Цена за единицу. 4215 -|DebitDate|Следующий момент времени списания с баланса за услугу. 4216 -|PeriodValue|Значение периода. 4217 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4316 +((( 4317 +{ 4318 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4319 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4320 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4321 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4322 + "Name": "string", ~/~/ Наименование. 4323 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4324 + "Constraint": { ~/~/ Ограничения по тарифу 4325 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4326 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4327 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4328 + }, 4329 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4330 + { 4331 + "Feature": "string", ~/~/Код услуги. 4332 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4333 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4334 + "Price": 0, ~/~/ Цена за единицу. 4335 + "PeriodValue": 0, ~/~/ Значение периода. 4336 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4337 + } 4338 + ], 4339 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4340 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4341 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4342 + }, 4343 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4344 + { 4345 + "Feature": "string", ~/~/ Код услуги. 4346 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4347 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4348 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4349 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4350 + "Price": 0, ~/~/ Цена за единицу. 4351 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4352 + "PeriodValue": 0, ~/~/ Значение периода. 4353 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4354 + "Quantity": 0 ~/~/ Количество использования услуги. 4355 + } 4356 + ] 4357 +} 4358 +))) 4218 4218 4219 4219 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4220 4220 ... ... @@ -4319,6 +4319,43 @@ 4319 4319 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4320 4320 |msgCount|Кол-во обработанных сообщений всего 4321 4321 4463 +== **Импортировать историю ТС (Асинхронный запрос)** == 4464 + 4465 +(% class="box successmessage" %) 4466 +((( 4467 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4468 +))) 4469 + 4470 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4471 + 4472 +Метод запроса: **POST** 4473 + 4474 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4475 + 4476 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4477 + 4478 + 4479 +Ответ: 4480 + 4481 +{ 4482 + 4483 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4484 + 4485 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4486 + 4487 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4488 + 4489 + "Message": "string", ~/~/ Информация о выполнении запроса 4490 + 4491 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4492 + 4493 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4494 + 4495 + "Data": "string" ~/~/ Данные 4496 + 4497 +} 4498 + 4499 + 4322 4322 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4323 4323 4324 4324 (% class="box infomessage" %) ... ... @@ -4336,10 +4336,59 @@ 4336 4336 "message": "string" 4337 4337 } 4338 4338 4339 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4340 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4341 -|progress|Guid ТС 4517 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4518 +**Параметр** 4519 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4520 +**Описание** 4521 +))) 4522 +|((( 4523 +activity 4524 +)))|((( 4525 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4526 +))) 4527 +|((( 4528 +progress 4529 +)))|((( 4530 +Guid ТС 4531 +))) 4342 4342 4533 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4534 + 4535 +(% class="box infomessage" %) 4536 +((( 4537 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4538 +))) 4539 + 4540 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4541 + 4542 +Метод запроса: **GET** 4543 + 4544 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4545 + 4546 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4547 + 4548 + 4549 +Ответ: 4550 + 4551 +{ 4552 + 4553 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4554 + 4555 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4556 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4557 + 4558 + "Message": "string", ~/~/ Информация о выполнении запроса 4559 + 4560 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4561 + 4562 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4563 + 4564 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4565 + 4566 + "Data": "string" ~/~/ Данные 4567 + 4568 +} 4569 + 4343 4343 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4344 4344 4345 4345 (% class="box infomessage" %) ... ... @@ -5201,23 +5201,8 @@ 5201 5201 ))) 5202 5202 5203 5203 5204 -== **Удаление существующего поля** == 5205 5205 5206 -(% class="box errormessage" %) 5207 5207 ((( 5208 -**DELETE /api/v3/agroLands/{id}** 5209 -))) 5210 - 5211 -Пример запроса: 5212 -id ~/~/ Идентификатор поля 5213 - 5214 -Пример ответа: 5215 - 5216 -((( 5217 -200 ~/~/ Успех 5218 -))) 5219 - 5220 -((( 5221 5221 5222 5222 ))) 5223 5223 ... ... @@ -5224,10 +5224,6 @@ 5224 5224 ((( 5225 5225 ((( 5226 5226 ((( 5227 - 5228 -))) 5229 - 5230 -((( 5231 5231 == **Изменение поля** == 5232 5232 5233 5233 (% class="box infomessage" %) ... ... @@ -5473,9 +5473,102 @@ 5473 5473 "perimetr": 0, ~/~/ ериметр, м 5474 5474 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5475 5475 } 5684 + 5685 + 5686 +== **Какие поля посещал объект** == 5687 + 5688 +(% class="box successmessage" %) 5689 +((( 5690 +**POST /api/v3/agroLands/visitingByVehicle** 5476 5476 ))) 5477 5477 5693 +Пример запроса: 5478 5478 5695 +{ 5696 + "vehicleId": 0, ~/~/ id объекта 5697 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5698 + "byTime": 0, ~/~/ Объединение событий по времени 5699 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5700 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5701 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5702 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5703 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5704 +} 5705 + 5706 +Пример ответа: 5707 + 5708 +[ 5709 + { 5710 + "fieldId": 0, ~/~/ id объекта 5711 + "vehicleName": "string", ~/~/ Наименование объекта 5712 + "fieldName": "string", ~/~/ Наименование поля 5713 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5714 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5715 + "vehicleId": 0, ~/~/ Идентификатор ТС 5716 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5717 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5718 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5719 + "mileage": 0 ~/~/ Пробег 5720 + } 5721 +] 5722 +))) 5723 + 5724 + 5725 +== **Посещение поля объектами ** == 5726 + 5727 +(% class="box successmessage" %) 5728 +((( 5729 +**POST /api/v3/agroLands/visitingByField** 5730 +))) 5731 + 5732 +Пример запроса: 5733 +{ 5734 + "fieldId": 0, ~/~/ ID поля 5735 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5736 + "byTime": 0, ~/~/ Объединение событий по времени 5737 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5738 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5739 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5740 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5741 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5742 +} 5743 + 5744 +Пример ответа: 5745 + 5746 +[ 5747 + { 5748 + "fieldId": 0, ~/~/ ID поля 5749 + "vehicleName": "string", ~/~/ Наименование объекта 5750 + "fieldName": "string", ~/~/ Имя поля 5751 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5752 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5753 + "vehicleId": 0, ~/~/ Идентификатор ТС 5754 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5755 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5756 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5757 + "mileage": 0 ~/~/ Пробег 5758 + } 5759 +] 5760 + 5761 + 5762 +== **Удаление существующего поля** == 5763 + 5764 +(% class="box errormessage" %) 5765 +((( 5766 +**DELETE /api/v3/agroLands/{id}** 5767 +))) 5768 + 5769 +Пример запроса: 5770 +id ~/~/ Идентификатор поля 5771 + 5772 +Пример ответа: 5773 + 5774 +((( 5775 +200 ~/~/ Успех 5776 + 5777 + 5778 +))) 5779 + 5479 5479 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5480 5480 ))) 5481 5481 ))) ... ... @@ -5900,49 +5900,129 @@ 5900 5900 ))) 5901 5901 5902 5902 6204 += **Раздел: Роли** = 6205 + 6206 +== **Получение списка клиентских и системных ролей пользователя ** == 6207 + 6208 +(% class="box successmessage" %) 6209 +((( 6210 +**POST /api/v3/groups/find** 6211 +))) 6212 + 6213 +Пример запроса: 6214 + 6215 +((( 6216 +{ 6217 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6218 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6219 +} 6220 +))) 6221 + 6222 +((( 6223 + 6224 +))) 6225 + 6226 +((( 6227 +Пример ответа: 6228 +))) 6229 + 6230 +((( 6231 +((( 6232 +{ 6233 + "groups": [ ~/~/ Системные роли пользователя 6234 + { 6235 + "code": "string", ~/~/ Код роли. 6236 + "name": "string", ~/~/ Имя 6237 + "shortName": "string" ~/~/ Короткое имя 6238 + } 6239 + ], 6240 + "customGroups": [ ~/~/ Системные роли пользователя 6241 + { 6242 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6243 + "name": "string", ~/~/ Наименование 6244 + "shortName": "string", ~/~/ Короткое наименование 6245 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6246 + } 6247 + ] 6248 +} 6249 +))) 6250 +))) 6251 + 6252 +((( 6253 + 6254 +))) 6255 + 6256 +((( 6257 + 6258 +))) 6259 + 5903 5903 = **Раздел: Локатор ** = 5904 5904 5905 5905 5906 -== **Получение списка локаторов,доступных пользователю** ==6263 +== **Получение данных по локатору** == 5907 5907 5908 5908 (% class="box infomessage" %) 5909 5909 ((( 5910 -**GET /api/v3/locators** 6267 +**GET /api/v3/locators/{locatorId}** 5911 5911 ))) 5912 5912 5913 -В за головкахзапроса:X-Auth:Токен авторизации6270 +В запросе указывается locatorid - идентификатор локатора 5914 5914 5915 5915 5916 5916 Пример ответа: 5917 5917 5918 5918 ((( 5919 -[ 5920 - { 5921 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5922 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5923 - "agentName": "string", ~/~/ Наименование агента. 5924 - "isEnabled": true, ~/~/ Активен 5925 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5926 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5927 - "name": "string", ~/~/ Наименование 5928 - "status": 0, ~/~/ 5929 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5930 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5931 - "validity": 0, ~/~/ Срок действия в днях (1-90). 5932 - "autoProlongation": true, ~/~/ Автопродление срока действия. 5933 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5934 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5935 - "url": "string", ~/~/ Ссылка 5936 - "language": 0, ~/~/ Язык. 5937 - "vehiclesCount": 0, ~/~/ Количество объектов. 5938 - "geozonesCount": 0, ~/~/ Количество геозон. 5939 - "fieldsCount": 0 ~/~/ Количество полей. 5940 - } 5941 -] 6276 +((( 6277 +{ 6278 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6279 + 0 6280 + ], 6281 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6282 + 0 6283 + ], 6284 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6285 + 0 6286 + ], 6287 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6288 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6289 + "agentName": "string", ~/~/ Наименование агента. 6290 + "isEnabled": true, ~/~/ Активность 6291 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6292 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6293 + "name": "string", ~/~/ Наименование. 6294 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6295 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6296 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6297 + "validity": 0, ~/~/ Значение срока действия 6298 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6299 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6300 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6301 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6302 + "url": "string", ~/~/ Ссылка 6303 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6304 + 6305 + "showVehicleName": true, ~/~/ Наименование объекта 6306 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6307 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6308 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6309 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6310 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6311 + 6312 + 1 6313 + 6314 + ] 6315 +} 5942 5942 ))) 6317 +))) 5943 5943 5944 5944 6320 +((( 6321 +((( 6322 + 6323 +))) 6324 +))) 5945 5945 6326 + 5946 5946 == **Создание локатора** == 5947 5947 5948 5948 (% class="box successmessage" %) ... ... @@ -5954,7 +5954,6 @@ 5954 5954 5955 5955 ((( 5956 5956 { 5957 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5958 5958 "isEnabled": true, ~/~/ Активность 5959 5959 "name": "string", ~/~/ Наименование локатора 5960 5960 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) ... ... @@ -5961,8 +5961,28 @@ 5961 5961 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5962 5962 "validity": 0, ~/~/ Срок действия в днях (1-90) 5963 5963 "autoProlongation": true, ~/~/ Автопродление срока действия. 5964 - "url": "string", ~/~/ Ссылка 5965 - "language": 0 ~/~/ Язык 6344 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6345 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6346 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6347 + 0 6348 + ], 6349 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6350 + 0 6351 + ], 6352 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6353 + 0 6354 + ], 6355 + 6356 + "showVehicleName": true, ~/~/ Наименование объекта 6357 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6358 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6359 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6360 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6361 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6362 + 6363 + 1 6364 + 6365 + ] 5966 5966 } 5967 5967 ))) 5968 5968 ... ... @@ -5974,7 +5974,69 @@ 5974 5974 ))) 5975 5975 5976 5976 6377 +== **Выводит список локаторов ** == 5977 5977 6379 +(% class="box successmessage" %) 6380 +((( 6381 +**POST /api/v3/locators/find** 6382 +))) 6383 + 6384 +Пример запроса: 6385 + 6386 +((( 6387 +{ 6388 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6389 +} 6390 +))) 6391 + 6392 +((( 6393 + 6394 +))) 6395 + 6396 +((( 6397 + 6398 +))) 6399 + 6400 + 6401 +Пример ответа: 6402 + 6403 +((( 6404 +[ 6405 + { 6406 + "vehiclesCount": 0, ~/~/ Количество объектов. 6407 + "geozonesCount": 0, ~/~/ Количество геозон. 6408 + "fieldsCount": 0, ~/~/ Количество полей. 6409 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6410 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6411 + "agentName": "string", ~/~/ Наименование агента. 6412 + "isEnabled": true, ~/~/ Активность локатора 6413 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6414 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6415 + "name": "string", ~/~/ Наименование локатора 6416 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6417 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6418 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6419 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6420 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6421 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6422 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6423 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6424 + "url": "string", ~/~/ ссылка на локатор 6425 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6426 + "showVehicleName": true, ~/~/ Наименование объекта 6427 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6428 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6429 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6430 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6431 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6432 + 6433 + 0 6434 + ] 6435 + } 6436 +] 6437 +))) 6438 + 6439 + 5978 5978 == **Изменение локатора** == 5979 5979 5980 5980 (% class="box infomessage" %) ... ... @@ -5993,12 +5993,31 @@ 5993 5993 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 5994 5994 "validity": 0, ~/~/ Срок действия в днях (1-90) 5995 5995 "autoProlongation": true, ~/~/ Автопродление срока действия 5996 - "url": "string", ~/~/ Ссылка 5997 - "language": 0 ~/~/ Язык 6458 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6459 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6460 + 0 6461 + ], 6462 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6463 + 0 6464 + ], 6465 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6466 + 0 6467 + ], 6468 + "showVehicleName": true, ~/~/ Наименование объекта 6469 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6470 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6471 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6472 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6473 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6474 + 6475 + 0 6476 + 6477 + ] 5998 5998 } 6479 + 6480 + 5999 5999 ))) 6000 6000 6001 - 6002 6002 Пример ответа: 6003 6003 6004 6004 200 ~/~/ Success ... ... @@ -6020,7 +6020,6 @@ 6020 6020 ))) 6021 6021 6022 6022 6023 - 6024 6024 = **Раздел: Яндекс Маршруты** = 6025 6025 6026 6026 ... ... @@ -6034,7 +6034,6 @@ 6034 6034 Пример запроса: 6035 6035 Id ~/~/ Идентификатор поля 6036 6036 6037 - 6038 6038 Пример ответа: 6039 6039 6040 6040 ((( ... ... @@ -6052,7 +6052,6 @@ 6052 6052 ))) 6053 6053 6054 6054 6055 - 6056 6056 == **Добавить маршрут** == 6057 6057 6058 6058 (% class="box infomessage" %) ... ... @@ -6107,7 +6107,6 @@ 6107 6107 } 6108 6108 ))) 6109 6109 6110 - 6111 6111 Пример ответа: 6112 6112 6113 6113 ((( ... ... @@ -6138,7 +6138,6 @@ 6138 6138 ] 6139 6139 ))) 6140 6140 6141 - 6142 6142 Пример ответа: 6143 6143 6144 6144 ((( ... ... @@ -6162,8 +6162,6 @@ 6162 6162 Id ~/~/ Идентификатор поля 6163 6163 6164 6164 6165 -==== ==== 6166 - 6167 6167 = **Раздел: Управление доступа к машинам** = 6168 6168 6169 6169 ... ... @@ -6185,7 +6185,6 @@ 6185 6185 ))) 6186 6186 6187 6187 6188 - 6189 6189 == Задает видимость транспортных средств пользователю == 6190 6190 6191 6191 (% class="box infomessage" %) ... ... @@ -6210,10 +6210,6 @@ 6210 6210 ))) 6211 6211 6212 6212 ((( 6213 - 6214 -))) 6215 - 6216 -((( 6217 6217 Пример ответа : 6218 6218 ))) 6219 6219 ... ... @@ -6227,10 +6227,6 @@ 6227 6227 ))) 6228 6228 6229 6229 6230 - 6231 - 6232 - 6233 - 6234 6234 (% class="box" lang="en-US" style="text-align: center;" %) 6235 6235 ((( 6236 6236 (% 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]] **