Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/06/27 16:12
<
>
edited by Андрей Калиновский
on 2024/12/23 14:03
on 2024/12/23 14:03
edited by Андрей Калиновский
on 2025/06/10 15:42
on 2025/06/10 15:42
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -11,6 +11,11 @@ 11 11 12 12 В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 13 13 14 +(% class="box infomessage" %) 15 +((( 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 18 +))) 14 14 15 15 **Содержание страницы:** 16 16 ))) ... ... @@ -118,29 +118,41 @@ 118 118 Запрос должен содержать данные параметра "**agentId**" 119 119 120 120 (% style="color:#000000" %)Ответ: 126 + 127 +((( 121 121 { 122 - "agentId": "", (%%) 123 - "parentId": "", 124 - "parentName": "string", 125 - "name": "string", 126 - "fullName": "string", 127 - "agentInfoType": 0, 128 - "isForeign": true/false, 129 - "district": "string", 130 - "region": "string", 131 - "city": "string", 132 - "inn": "string", 133 - "kpp": "string", 134 - "address": "string", 135 - "addressFact": "string", 136 - "email": "string", 137 - "director": "string", 138 - "bankName": "string", 139 - "bankBIK": "string", 140 - "bankRS": "string", 141 - "bankKS": "string" 142 - } 129 + "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента 130 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя 131 + "parentName": "string", ~/~/ Наименование агента 132 + "name": "string", ~/~/ Имя клиента 133 + "fullName": "string", ~/~/ ФИО клиента 134 + "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%)) 135 + "isForeign": true, ~/~/ Флаг "Иностранный контрагент" 136 + "district": "string", ~/~/ Район 137 + "region": "string", ~/~/ Область 138 + "city": "string", ~/~/ Город 139 + "email": "string", ~/~/ Email 140 + "director": "string", ~/~/ Руководитель 141 + "RegionalData": [ ~/~/ Определяет региональные сведения. 142 + { 143 + "Country": 0, ~/~/ Страна 144 + "groups": [ ~/~/ Список групп 145 + { 146 + "groupId": "string", ~/~/ Уникальный идентификатор группы 147 + "fields": [ ~/~/ Список значений полей 148 + { 149 + "name": "string", ~/~/ Имя поля формы 150 + "value": "string" ~/~/ Значение поля формы 151 + } 152 + ] 153 + } 154 + ] 155 + } 156 + ] 157 +} 158 +))) 143 143 160 + 144 144 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 145 145 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 146 146 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя ... ... @@ -860,7 +860,7 @@ 860 860 { 861 861 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 862 862 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 863 - "deleted": true,880 + "deleted": false, 864 864 "extId": "string", 865 865 "name": "string", 866 866 "picture": "string", ... ... @@ -879,7 +879,7 @@ 879 879 { 880 880 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 881 881 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 882 - "deleted": true,899 + "deleted": false, 883 883 "extId": "string", 884 884 "name": "string", 885 885 "picture": "string", ... ... @@ -913,7 +913,7 @@ 913 913 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 914 914 ))) 915 915 916 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.933 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 917 917 918 918 (% style="color:#000000" %)Метод запроса: **PUT** 919 919 ... ... @@ -980,7 +980,7 @@ 980 980 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 981 981 ))) 982 982 983 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.1000 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 984 984 985 985 (% style="color:#000000" %)Метод запроса: **DELETE** 986 986 ... ... @@ -1126,6 +1126,7 @@ 1126 1126 ], 1127 1127 "showInTooltip": true, ~/~/ Отображать в подсказке 1128 1128 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1146 + "color": "string", ~/~/ Код цвета датчиков 1129 1129 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1130 1130 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1131 1131 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1389,6 +1389,7 @@ 1389 1389 ], 1390 1390 "showInTooltip": true, ~/~/ Отображать в подсказке 1391 1391 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1410 + "color": "string", ~/~/ код цвета датчиков 1392 1392 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1393 1393 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1394 1394 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1559,6 +1559,7 @@ 1559 1559 ], 1560 1560 "showInTooltip": true, ~/~/ Отображение в подсказке 1561 1561 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1581 + "color": "string", ~/~/ код цвета датчиков 1562 1562 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1563 1563 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1564 1564 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION ... ... @@ -1608,77 +1608,6 @@ 1608 1608 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1609 1609 1610 1610 1611 -== **Импортировать историю ТС (Асинхронный запрос)** == 1612 - 1613 -(% class="box successmessage" %) 1614 -((( 1615 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1616 -))) 1617 - 1618 -Метод запроса: **POST** 1619 - 1620 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1621 - 1622 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1623 - 1624 - 1625 -Ответ: 1626 - 1627 -{ 1628 - 1629 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1630 - 1631 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1632 - 1633 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1634 - 1635 - "Message": "string", ~/~/ Информация о выполнении запроса 1636 - 1637 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1638 - 1639 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1640 - 1641 - "Data": "string" ~/~/ Данные 1642 - 1643 -} 1644 - 1645 - 1646 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1647 - 1648 -(% class="box infomessage" %) 1649 -((( 1650 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1651 -))) 1652 - 1653 -Метод запроса: **GET** 1654 - 1655 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1656 - 1657 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1658 - 1659 - 1660 -Ответ: 1661 - 1662 -{ 1663 - 1664 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1665 - 1666 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1667 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1668 - 1669 - "Message": "string", ~/~/ Информация о выполнении запроса 1670 - 1671 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1672 - 1673 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1674 - 1675 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1676 - 1677 - "Data": "string" ~/~/ Данные 1678 - 1679 -} 1680 - 1681 - 1682 1682 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1683 1683 1684 1684 (% class="box infomessage" %) ... ... @@ -1824,7 +1824,6 @@ 1824 1824 "stage": "", ~/~/ Состояние 1825 1825 (% style="color:#000000" %) } 1826 1826 1827 -== == 1828 1828 1829 1829 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1830 1830 ... ... @@ -1951,7 +1951,7 @@ 1951 1951 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1952 1952 1953 1953 ((( 1954 - "color": "string",** 1902 + "color": "string",** ~/~/ **Цвет датчика 1955 1955 ))) 1956 1956 1957 1957 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива ... ... @@ -2464,6 +2464,8 @@ 2464 2464 "motohours": 0, ~/~/ Моточасы за период, секунды 2465 2465 "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2466 2466 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2415 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2416 + 2467 2467 } 2468 2468 ] 2469 2469 } ... ... @@ -2505,8 +2505,12 @@ 2505 2505 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2506 2506 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2507 2507 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2458 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2459 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2508 2508 "fuelConsumption": 0, ~/~/ Расход топлива 2509 2509 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2462 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2463 + 2510 2510 } 2511 2511 ] 2512 2512 } ... ... @@ -2552,7 +2552,8 @@ 2552 2552 "model": "string", ~/~/ Модель объекта 2553 2553 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2554 2554 { 2555 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2509 + "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling 2510 + 2556 2556 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2557 2557 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2558 2558 "valueFuel": 0, ~/~/ Количество ... ... @@ -2781,6 +2781,35 @@ 2781 2781 } 2782 2782 ] 2783 2783 2739 + 2740 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2741 + 2742 +(% class="box successmessage" %) 2743 +((( 2744 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2745 +))) 2746 + 2747 +(% style="color:#000000" %)Метод запроса: **PUT** 2748 + 2749 +Пример запроса: 2750 + 2751 +((( 2752 +{ 2753 + "id": 0, ~/~/ Идентификатор объекта геозоны 2754 + "name": "string", ~/~/ Наименование объекта геозоны 2755 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2756 + "description": "string", ~/~/ Описание объекта геозоны 2757 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2758 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2759 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2760 +} 2761 +))) 2762 + 2763 + 2764 +Пример ответа: 2765 + 2766 +200 ~/~/ Success 2767 + 2784 2784 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2785 2785 2786 2786 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2812,7 +2812,7 @@ 2812 2812 "id": 0, ~/~/ ID уведомления 2813 2813 "name": "string", ~/~/ Название уведомления 2814 2814 "active": true, ~/~/ Состояние true - активен, false - деактивирован 2815 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2799 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2816 2816 "userId": "", ~/~/ Пользователь, создавший уведомление 2817 2817 "parentId": "", ~/~/ Идентификатор клиента 2818 2818 "parentName": "string" ~/~/ Имя клиента ... ... @@ -2819,6 +2819,155 @@ 2819 2819 } 2820 2820 ] 2821 2821 2806 + 2807 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2808 + 2809 +(% class="box infomessage" %) 2810 +((( 2811 +**POST /api/v3/notifications** 2812 +))) 2813 + 2814 +Метод запроса **POST** 2815 + 2816 +(% style="text-align: left;" %) 2817 +(% style="color:#000000" %)Пример запроса 2818 + 2819 +((( 2820 +{ 2821 + "id": 0, ~/~/ ID правила 2822 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2823 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2824 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2825 + "name": "string", ~/~/ Имя правила 2826 + "active": true, ~/~/ Активность правила 2827 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2828 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2829 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2830 + ], 2831 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2832 + 0 2833 + ], 2834 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2835 + 0 2836 + ], 2837 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2838 + 0 2839 + ], 2840 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2841 + "additionalProp1": "string", 2842 + "additionalProp2": "string", 2843 + "additionalProp3": "string" 2844 + }, 2845 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2846 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2847 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2848 + ], 2849 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2850 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2851 + "string" 2852 + ], 2853 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2854 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2855 + { 2856 + "id": 0, ~/~/ Идентификатор участника чата. 2857 + "info": "string" ~/~/ Дополнительные сведения. 2858 + } 2859 + ], 2860 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2861 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2862 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2863 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2864 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2865 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2866 + "timezone": 0, ~/~/ часовой пояс 2867 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2868 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2869 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2870 + { 2871 + "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 - Срок действия правила истек 2872 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2873 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2874 + "additionalProp1": "string", 2875 + "additionalProp2": "string", 2876 + "additionalProp3": "string" 2877 + } 2878 + } 2879 + ] 2880 +} 2881 +))) 2882 + 2883 +((( 2884 + 2885 +))) 2886 + 2887 +((( 2888 + 2889 +))) 2890 + 2891 +Ответ: 2892 + 2893 +{ 2894 + "id": 0, ~/~/ ID правила 2895 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2896 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2897 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2898 + "name": "string", ~/~/ Имя правила 2899 + "active": true, ~/~/ Активность правила 2900 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2901 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2902 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2903 + ], 2904 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2905 + 0 2906 + ], 2907 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2908 + 0 2909 + ], 2910 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2911 + 0 2912 + ], 2913 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2914 + "additionalProp1": "string", 2915 + "additionalProp2": "string", 2916 + "additionalProp3": "string" 2917 + }, 2918 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2919 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2920 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2921 + ], 2922 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2923 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2924 + "string" 2925 + ], 2926 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2927 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2928 + { 2929 + "id": 0, ~/~/ Идентификатор участника чата. 2930 + "info": "string" ~/~/ Дополнительные сведения. 2931 + } 2932 + ], 2933 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2934 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2935 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2936 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2937 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2938 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2939 + "timezone": 0, ~/~/ часовой пояс 2940 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2941 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2942 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2943 + { 2944 + "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 - Срок действия правила истек 2945 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2946 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2947 + "additionalProp1": "string", 2948 + "additionalProp2": "string", 2949 + "additionalProp3": "string" 2950 + } 2951 + } 2952 + ] 2953 +} 2954 + 2822 2822 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2823 2823 2824 2824 (% class="box infomessage" %) ... ... @@ -4036,16 +4036,12 @@ 4036 4036 Тело запроса: 4037 4037 4038 4038 { 4039 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4040 - "Balance": 0 4172 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4173 + "Balance": 0 ~/~/ Значение баланса. 4041 4041 } 4042 4042 4043 4043 Ответ: Success 4044 4044 4045 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4046 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4047 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4048 - 4049 4049 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4050 4050 4051 4051 (% class="box warningmessage" %) ... ... @@ -4057,16 +4057,29 @@ 4057 4057 4058 4058 Тело запроса: 4059 4059 4189 +((( 4060 4060 { 4061 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4062 - " Balance": 04191 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4192 + "amount": 0 ~/~/ Сумма пополнения баланса 4063 4063 } 4194 +))) 4064 4064 4196 +((( 4197 + 4198 +))) 4199 + 4065 4065 Ответ: Success 4066 4066 4067 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4068 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4069 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4202 +((( 4203 +{ 4204 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4205 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4206 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4207 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4208 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4209 + "Description": "string" ~/~/ Описание корректировки. 4210 +} 4211 +))) 4070 4070 4071 4071 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4072 4072 ... ... @@ -4079,16 +4079,25 @@ 4079 4079 4080 4080 Тело запроса: 4081 4081 4224 +((( 4082 4082 { 4083 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4084 - " Balance": 04226 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4227 + "amount": 0 ~/~/ Сумма списания с баланса 4085 4085 } 4229 +))) 4086 4086 4087 4087 Ответ: Success 4088 4088 4089 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4090 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4091 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4233 +((( 4234 +{ 4235 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4236 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4237 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4238 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4239 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4240 + "Description": "string" ~/~/ Описание корректировки 4241 +} 4242 +))) 4092 4092 4093 4093 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4094 4094 ... ... @@ -4099,28 +4099,35 @@ 4099 4099 4100 4100 Тело запроса: 4101 4101 4253 +((( 4102 4102 { 4103 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4104 - "CalculationType": 0, 4105 - "PermissibleBalance": 0, 4106 - "DefermentDays": 0, 4107 - "SendUiNotifications": true, 4108 - "SendEmailNotifications": true, 4109 - "IsPrivate": true, 4255 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4256 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4257 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4258 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4259 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4260 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4110 4110 } 4262 +))) 4111 4111 4264 +((( 4265 + 4266 +))) 4267 + 4112 4112 Ответ: Success 4113 4113 4114 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4115 -|ClientId|Идентификатор клиента 4116 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4117 -|PermissibleBalance|Допустимый баланс 4118 -|DefermentDays|((( 4119 -Отсрочка, количество дней 4270 +((( 4271 +{ 4272 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4273 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4274 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4275 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4276 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4277 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4278 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4279 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4280 +} 4120 4120 ))) 4121 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4122 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4123 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4124 4124 4125 4125 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4126 4126 ... ... @@ -4132,35 +4132,68 @@ 4132 4132 Тело запроса: 4133 4133 4134 4134 { 4135 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4136 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4137 - "Features": [ 4293 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4294 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4295 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4138 4138 { 4139 - "Feature": "string", 4140 - "IsEnabled": true, 4141 - "IsFactual": true, 4142 - "Limit": 0, 4143 - "Price": 0, 4144 - "DebitDate": "2023-10-18T13:26:58.987Z", 4145 - "PeriodValue": 0, 4146 - "PeriodType": 0 4297 + "Feature": "string", ~/~/ Код услуги. 4298 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4299 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4300 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4301 + "Price": 0, ~/~/ Цена за единицу. 4302 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4303 + "PeriodValue": 0, ~/~/ Значение периода. 4304 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4147 4147 } 4148 4148 ] 4149 4149 } 4150 4150 4309 + 4151 4151 Ответ: Success 4152 4152 4153 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4154 -|ClientId|Идентификатор клиента 4155 -|PlanId|Идентификатор тарифного плана 4156 -|Feature|Код услуги 4157 -|IsEnabled|Признак, определяющий активирована ли услуга 4158 -|IsFactual|Признак, определяющий расчёт по факту 4159 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4160 -|Price|Цена за единицу. 4161 -|DebitDate|Следующий момент времени списания с баланса за услугу. 4162 -|PeriodValue|Значение периода. 4163 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4312 +((( 4313 +{ 4314 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4315 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4316 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4317 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4318 + "Name": "string", ~/~/ Наименование. 4319 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4320 + "Constraint": { ~/~/ Ограничения по тарифу 4321 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4322 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4323 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4324 + }, 4325 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4326 + { 4327 + "Feature": "string", ~/~/Код услуги. 4328 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4329 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4330 + "Price": 0, ~/~/ Цена за единицу. 4331 + "PeriodValue": 0, ~/~/ Значение периода. 4332 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4333 + } 4334 + ], 4335 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4336 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4337 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4338 + }, 4339 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4340 + { 4341 + "Feature": "string", ~/~/ Код услуги. 4342 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4343 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4344 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4345 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4346 + "Price": 0, ~/~/ Цена за единицу. 4347 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4348 + "PeriodValue": 0, ~/~/ Значение периода. 4349 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4350 + "Quantity": 0 ~/~/ Количество использования услуги. 4351 + } 4352 + ] 4353 +} 4354 +))) 4164 4164 4165 4165 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4166 4166 ... ... @@ -4265,6 +4265,43 @@ 4265 4265 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4266 4266 |msgCount|Кол-во обработанных сообщений всего 4267 4267 4459 +== **Импортировать историю ТС (Асинхронный запрос)** == 4460 + 4461 +(% class="box successmessage" %) 4462 +((( 4463 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4464 +))) 4465 + 4466 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4467 + 4468 +Метод запроса: **POST** 4469 + 4470 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4471 + 4472 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4473 + 4474 + 4475 +Ответ: 4476 + 4477 +{ 4478 + 4479 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4480 + 4481 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4482 + 4483 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4484 + 4485 + "Message": "string", ~/~/ Информация о выполнении запроса 4486 + 4487 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4488 + 4489 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4490 + 4491 + "Data": "string" ~/~/ Данные 4492 + 4493 +} 4494 + 4495 + 4268 4268 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4269 4269 4270 4270 (% class="box infomessage" %) ... ... @@ -4282,10 +4282,59 @@ 4282 4282 "message": "string" 4283 4283 } 4284 4284 4285 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4286 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4287 -|progress|Guid ТС 4513 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4514 +**Параметр** 4515 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4516 +**Описание** 4517 +))) 4518 +|((( 4519 +activity 4520 +)))|((( 4521 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4522 +))) 4523 +|((( 4524 +progress 4525 +)))|((( 4526 +Guid ТС 4527 +))) 4288 4288 4529 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4530 + 4531 +(% class="box infomessage" %) 4532 +((( 4533 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4534 +))) 4535 + 4536 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4537 + 4538 +Метод запроса: **GET** 4539 + 4540 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4541 + 4542 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4543 + 4544 + 4545 +Ответ: 4546 + 4547 +{ 4548 + 4549 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4550 + 4551 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4552 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4553 + 4554 + "Message": "string", ~/~/ Информация о выполнении запроса 4555 + 4556 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4557 + 4558 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4559 + 4560 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4561 + 4562 + "Data": "string" ~/~/ Данные 4563 + 4564 +} 4565 + 4289 4289 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4290 4290 4291 4291 (% class="box infomessage" %) ... ... @@ -4444,7 +4444,7 @@ 4444 4444 4445 4445 (% class="box infomessage" %) 4446 4446 ((( 4447 -POST /api/v3/fuelcards/transactions 4724 +**POST /api/v3/fuelcards/transactions** 4448 4448 ))) 4449 4449 4450 4450 Метод запроса: POST ... ... @@ -4482,7 +4482,32 @@ 4482 4482 "address": "string" ~/~/ Адрес АЗС 4483 4483 } 4484 4484 4762 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4485 4485 4764 +(% class="box infomessage" %) 4765 +((( 4766 +**GET /api/v3/fuelcards** 4767 +))) 4768 + 4769 +Метод запроса: GET 4770 + 4771 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4772 + 4773 +Ответ: 4774 + 4775 +[ 4776 + { 4777 + "Name": "string", ~/~/ Определяет наименование карты. 4778 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4779 + "Number": "string", ~/~/ Определяет № карты. 4780 + "Enabled": true, ~/~/ Определяет признак активности карты. 4781 + "Description": "string", ~/~/ Определяет описание карты. 4782 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4783 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4784 + "deleted": true ~/~/ Признак удаления 4785 + } 4786 +] 4787 + 4486 4486 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4487 4487 4488 4488 ... ... @@ -4733,6 +4733,90 @@ 4733 4733 ] 4734 4734 4735 4735 5038 +== **Отчет трек-датчики** == 5039 + 5040 +(% class="box infomessage" %) 5041 +((( 5042 +**POST /api/v3/Reports/sensorsWorks** 5043 +))) 5044 + 5045 +**Пример запроса:** 5046 + 5047 +{ 5048 + "vehicleIds": [ ~/~/ Список ID объектов 5049 + 0 5050 + ], 5051 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 5052 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 5053 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5054 +} 5055 + 5056 +**Пример ответа:** 5057 + 5058 +((( 5059 +{ 5060 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 5061 + { 5062 + "vehicleId": 0, ~/~/ Идентификатор ТС 5063 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 5064 + { 5065 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 5066 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 5067 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 5068 + "name": "string", ~/~/ Наименование оборудования. 5069 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 5070 + "totalMileage": 0, ~/~/ Общий пробег. 5071 + "avgSpeed": 0 ~/~/ Средняя скорость. 5072 + } 5073 + ] 5074 + } 5075 + ] 5076 +} 5077 + 5078 + 5079 +== **Превышение скорости** == 5080 + 5081 +(% class="box infomessage" %) 5082 +((( 5083 +**POST /api/v3/Reports/overSpeedDuration** 5084 +))) 5085 + 5086 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5087 + 5088 +Пример запроса: 5089 + 5090 +((( 5091 +{ 5092 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5093 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5094 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5095 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5096 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5097 +} 5098 +))) 5099 + 5100 +((( 5101 + 5102 +))) 5103 + 5104 +((( 5105 +Пример ответа: 5106 +))) 5107 + 5108 +((( 5109 +((( 5110 +[ 5111 + { 5112 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5113 + "duration": 0, ~/~/ Продолжительность события в секундах 5114 + "maxSpeed": 0, ~/~/ Максимальная скорость 5115 + "speedLimit": 0 ~/~/ Ограничение скорости 5116 + } 5117 +] 5118 +))) 5119 +))) 5120 +))) 5121 + 4736 4736 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4737 4737 4738 4738 ... ... @@ -4807,13 +4807,16 @@ 4807 4807 **POST /api/v3/agroLands** 4808 4808 ))) 4809 4809 5196 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 5197 +X-agent - ID клиента 5198 + 4810 4810 Пример запроса: 4811 4811 4812 4812 ((( 4813 4813 { 4814 4814 "extId": "string", 4815 - "shape": " string", ~/~/ Форма поля4816 - "shapeFormat": "s tring", ~/~/ Формат, в котором представлена форма поля5204 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5205 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 4817 4817 "display": "string", ~/~/ Настройки отображения 4818 4818 "year": 0, ~/~/ Год поля 4819 4819 "name": "string", ~/~/ Наименование ... ... @@ -5310,7 +5310,7 @@ 5310 5310 ))) 5311 5311 5312 5312 5313 -= =(% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) ==5702 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5314 5314 ))) 5315 5315 ))) 5316 5316 ))) ... ... @@ -5355,7 +5355,7 @@ 5355 5355 ] 5356 5356 5357 5357 5358 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 5747 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5359 5359 5360 5360 (% class="box infomessage" %) 5361 5361 ((( ... ... @@ -5453,7 +5453,760 @@ 5453 5453 ] 5454 5454 5455 5455 5845 += **Раздел: Журнал заданий ** = 5456 5456 5847 + 5848 +== **Создание задания в Журнале заданий** == 5849 + 5850 +(% class="box infomessage" %) 5851 +((( 5852 +**POST /api/v3/vehicletasks** 5853 +))) 5854 + 5855 +Пример запроса: 5856 + 5857 +((( 5858 +{ 5859 + "vehicleId": 0, ~/~/ Идентификатор ТС 5860 + "description": "string", ~/~/ Описание 5861 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5862 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5863 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5864 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5865 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5866 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5867 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5868 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5869 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5870 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5871 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5872 + "cost": { 5873 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5874 + "Name": "string", ~/~/ Наименование 5875 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5876 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5877 + "Norm": 0 ~/~/ Норма внесения 5878 + }, 5879 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5880 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5881 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5882 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5883 + "deleted": true, ~/~/ Признак удаления 5884 + "extId": "string", 5885 + "GeoIds": [ ~/~/ Cвязанные поля 5886 + 0 5887 + ] 5888 +} 5889 +))) 5890 + 5891 + 5892 +Пример ответа: 5893 + 5894 +{ 5895 + "vehicleId": 0, ~/~/ Идентификатор ТС 5896 + "description": "string", ~/~/ Описание 5897 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5898 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5899 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5900 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5901 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5902 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5903 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5904 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5905 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5906 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5907 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5908 + "cost": { 5909 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5910 + "Name": "string", ~/~/ Наименование 5911 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5912 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5913 + "Norm": 0 ~/~/ Норма внесения 5914 + }, 5915 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5916 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5917 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5918 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5919 + "deleted": true, ~/~/ Признак удаления 5920 + "extId": "string", ~/~/ ExtId 5921 + "GeoIds": [ ~/~/ Связанные поля 5922 + 0 5923 + ] 5924 +} 5925 + 5926 + 5927 +== **Редактирование задания в Журнале заданий** == 5928 + 5929 +(% class="box successmessage" %) 5930 +((( 5931 +**PUT /api/v3/vehicletasks** 5932 +))) 5933 + 5934 +Пример запроса: 5935 + 5936 +((( 5937 +{ 5938 + "vehicleId": 0, ~/~/ Идентификатор ТС 5939 + "description": "string", ~/~/ Описание 5940 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5941 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5942 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5943 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5944 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5945 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5946 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5947 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5948 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5949 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5950 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5951 + "cost": { 5952 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5953 + "Name": "string", ~/~/ Наименование 5954 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5955 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5956 + "Norm": 0 ~/~/ Норма внесения 5957 + }, 5958 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5959 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5960 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5961 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5962 + "deleted": true, ~/~/ Признак удаления 5963 + "extId": "string", ~/~/ ExtId 5964 + "GeoIds": [ ~/~/ Связанные поля 5965 + 0 5966 + ] 5967 +} 5968 +))) 5969 + 5970 + 5971 +Пример ответа: 5972 + 5973 +{ 5974 + "vehicleId": 0, ~/~/ Идентификатор ТС 5975 + "description": "string", ~/~/ Описание 5976 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5977 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5978 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5979 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5980 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5981 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5982 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5983 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5984 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5985 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5986 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5987 + "cost": { 5988 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5989 + "Name": "string", ~/~/ Наименование 5990 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5991 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5992 + "Norm": 0 ~/~/ Норма внесения 5993 + }, 5994 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5995 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5996 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5997 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5998 + "deleted": true, ~/~/ Признак удаления 5999 + "extId": "string", ~/~/ ExtId 6000 + "GeoIds": [ ~/~/ Связанные поля 6001 + 0 6002 + ] 6003 +} 6004 + 6005 + 6006 +== **Удаление задания в Журнале заданий** == 6007 + 6008 +(% class="box warningmessage" %) 6009 +((( 6010 +**DELETE /api/v3/vehicletasks** 6011 +))) 6012 + 6013 +Пример запроса: 6014 + 6015 +((( 6016 +[ 6017 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 6018 +] 6019 +))) 6020 + 6021 +((( 6022 + 6023 +))) 6024 + 6025 +Пример ответа: 6026 + 6027 +{ 6028 + "vehicleId": 0, ~/~/ Идентификатор ТС 6029 + "description": "string", ~/~/ Описание 6030 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6031 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6032 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 6033 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 6034 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6035 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6036 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6037 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6038 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6039 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6040 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6041 + "cost": { 6042 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6043 + "Name": "string", ~/~/ Наименование 6044 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6045 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6046 + "Norm": 0 ~/~/ Норма внесения 6047 + }, 6048 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6049 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6050 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 6051 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6052 + "deleted": true, ~/~/ Признак удаления 6053 + "extId": "string", ~/~/ ExtId 6054 + "GeoIds": [ ~/~/ Связанные поля 6055 + 0 6056 + ] 6057 +} 6058 + 6059 + 6060 +== **Получение списка Журнала заданий** == 6061 + 6062 +(% class="box infomessage" %) 6063 +((( 6064 +**POST /api/v3/vehicletasks/getbyperiod** 6065 +))) 6066 + 6067 +Пример запроса: 6068 + 6069 +((( 6070 +{ 6071 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 6072 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 6073 + "TimeZone": 0, ~/~/ Часовой пояс. 6074 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 6075 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 6076 + ], 6077 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 6078 + 0 6079 + ], 6080 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 6081 + 0 6082 + ], 6083 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 6084 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 6085 +} 6086 +))) 6087 + 6088 + 6089 +Пример ответа: 6090 + 6091 +((( 6092 +{ 6093 + "total": 0, ~/~/ Общее количество записей 6094 + "pages": 0, ~/~/ Общее количество страниц 6095 + "currentPage": 0, ~/~/ Текущая страница 6096 + "items": [ ~/~/ Записи 6097 + { 6098 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6099 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 6100 + "name": "string", ~/~/ Название задания. 6101 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 6102 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 6103 + "workKind": "string", ~/~/ Вид работ 6104 + "techOp": "string", ~/~/ Тех. операция 6105 + "trailerModel": "string", ~/~/ Модель агрегата 6106 + "width": "string", ~/~/ Ширина, м 6107 + "speed": "string", ~/~/ Тех. скорость 6108 + "fields": "string", ~/~/ Поля 6109 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 6110 + "vehicles": "string", ~/~/ Объект-модель 6111 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 6112 + "drivers": "string", ~/~/ Водители 6113 + "tmc": "string", ~/~/ ТМЦ 6114 + "client": "string", ~/~/ Клиент 6115 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6116 + "dep": "string", ~/~/ Подразделение 6117 + "geoIds": [ ~/~/ Связанные поля 6118 + 0 6119 + ] 6120 + } 6121 + ] 6122 +} 6123 +))) 6124 + 6125 + 6126 += **Раздел: Роли** = 6127 + 6128 +== **Получение списка клиентских и системных ролей пользователя ** == 6129 + 6130 +(% class="box successmessage" %) 6131 +((( 6132 +**POST /api/v3/groups/find** 6133 +))) 6134 + 6135 +Пример запроса: 6136 + 6137 +((( 6138 +{ 6139 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6140 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6141 +} 6142 +))) 6143 + 6144 +((( 6145 + 6146 +))) 6147 + 6148 +((( 6149 +Пример ответа: 6150 +))) 6151 + 6152 +((( 6153 +((( 6154 +{ 6155 + "groups": [ ~/~/ Системные роли пользователя 6156 + { 6157 + "code": "string", ~/~/ Код роли. 6158 + "name": "string", ~/~/ Имя 6159 + "shortName": "string" ~/~/ Короткое имя 6160 + } 6161 + ], 6162 + "customGroups": [ ~/~/ Системные роли пользователя 6163 + { 6164 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6165 + "name": "string", ~/~/ Наименование 6166 + "shortName": "string", ~/~/ Короткое наименование 6167 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6168 + } 6169 + ] 6170 +} 6171 +))) 6172 +))) 6173 + 6174 +((( 6175 + 6176 +))) 6177 + 6178 +((( 6179 + 6180 +))) 6181 + 6182 += **Раздел: Локатор ** = 6183 + 6184 + 6185 +== **Получение списка локаторов, доступных пользователю ** == 6186 + 6187 +(% class="box infomessage" %) 6188 +((( 6189 +**GET /api/v3/locators ** 6190 +))) 6191 + 6192 +В заголовках запроса: X-Auth: Токен авторизации 6193 + 6194 + 6195 +Пример ответа: 6196 + 6197 +((( 6198 +((( 6199 +{ 6200 + "vehiclesIds": [ ~/~/ Объекты 6201 + 0 6202 + ], 6203 + "geoIds": [ ~/~/ Геозоны 6204 + 0 6205 + ], 6206 + "fieldsIds": [ ~/~/ Поля 6207 + 0 6208 + ], 6209 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6210 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6211 + "agentName": "string", ~/~/ Наименование агента. 6212 + "isEnabled": true, ~/~/ Активность 6213 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6214 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6215 + "name": "string", ~/~/ Наименование. 6216 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6217 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6218 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6219 + "validity": 0, ~/~/ Значение срока действия 6220 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6221 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6222 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6223 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6224 + "url": "string", ~/~/ Ссылка 6225 + "language": 0, ~/~/ Язык 6226 + "showVehicleName": true, ~/~/ Наименование объекта 6227 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6228 + "allowTrackReport": true, ~/~/ Трек 6229 + "showTrackTracing": true, ~/~/ Трассировка трека 6230 + "showSensors": true, ~/~/ Датчик 6231 + "availableMapLayers": [ ~/~/ Слои на карте 6232 + 0 6233 + ] 6234 +} 6235 +))) 6236 +))) 6237 + 6238 + 6239 +== **Получение перечня моделей ** == 6240 + 6241 +(% class="box successmessage" %) 6242 +((( 6243 +**POST /api/v3/models/find** 6244 +))) 6245 + 6246 +Пример запроса: 6247 + 6248 +((( 6249 +((( 6250 +{ 6251 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6252 + "name": "string", ~/~/ Наименование локатора 6253 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6254 +))) 6255 + 6256 + 6257 + 6258 + Пример ответа: 6259 + 6260 + 6261 +((( 6262 +[ 6263 + { 6264 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6265 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6266 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6267 + "name": "string", ~/~/ Наименование локатора 6268 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 6269 + } 6270 +] 6271 +))) 6272 +))) 6273 + 6274 + 6275 +== **Создание локатора** == 6276 + 6277 +(% class="box successmessage" %) 6278 +((( 6279 +**POST /api/v3/locators** 6280 +))) 6281 + 6282 +Пример запроса: 6283 + 6284 +((( 6285 +{ 6286 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6287 + "isEnabled": true, ~/~/ Активность 6288 + "name": "string", ~/~/ Наименование локатора 6289 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6290 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6291 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6292 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6293 + "url": "string", ~/~/ Ссылка 6294 + "language": 0 ~/~/ Язык 6295 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6296 + "vehiclesIds": [ ~/~/ Oбъекты 6297 + 0 6298 + ], 6299 + "geoIds": [ ~/~/ Геозоны 6300 + 0 6301 + ], 6302 + "fieldsIds": [ ~/~/ Поля 6303 + 0 6304 + ], 6305 + "showVehicleName": true, ~/~/ Наименование объекта 6306 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6307 + "allowTrackReport": true, ~/~/ Трек 6308 + "showTrackTracing": true, ~/~/ Трассировка трека 6309 + "showSensors": true, ~/~/ Датчик 6310 + "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap) 6311 + 0 6312 + ] 6313 +} 6314 +))) 6315 + 6316 + 6317 +Пример ответа: 6318 + 6319 +((( 6320 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 6321 +))) 6322 + 6323 + 6324 + 6325 +== **Изменение локатора** == 6326 + 6327 +(% class="box infomessage" %) 6328 +((( 6329 +**PUT /api/v3/locators** 6330 +))) 6331 + 6332 +Пример запроса: 6333 + 6334 +((( 6335 +{ 6336 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6337 + "isEnabled": true, ~/~/ Активность 6338 + "name": "string", ~/~/ Наименование 6339 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6340 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6341 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6342 + "autoProlongation": true, ~/~/ Автопродление срока действия 6343 + "url": "string", ~/~/ Ссылка 6344 + "language": 0 ~/~/ Язык 6345 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6346 + "vehiclesIds": [ ~/~/ Oбъекты 6347 + 0 6348 + ], 6349 + "geoIds": [ ~/~/ Геозоны 6350 + 0 6351 + ], 6352 + "fieldsIds": [ ~/~/ Поля 6353 + 0 6354 + ], 6355 + "showVehicleName": true, ~/~/ Наименование объекта 6356 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6357 + "allowTrackReport": true, ~/~/ Трек 6358 + "showTrackTracing": true, ~/~/ Трассировка трека 6359 + "showSensors": true, ~/~/ Датчик 6360 + "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap) 6361 + 0 6362 + ] 6363 +} 6364 + 6365 + 6366 +))) 6367 + 6368 +Пример ответа: 6369 + 6370 +200 ~/~/ Success 6371 + 6372 + 6373 +== **Удалить локатор** == 6374 + 6375 +(% class="box warningmessage" %) 6376 +((( 6377 +**DELETE /api/v3/locators** 6378 +))) 6379 + 6380 +Пример запроса: 6381 + 6382 +((( 6383 +[ 6384 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6385 +] 6386 +))) 6387 + 6388 + 6389 + 6390 += **Раздел: Яндекс Маршруты** = 6391 + 6392 + 6393 +== **Возвращение списка маршрутов** == 6394 + 6395 +(% class="box infomessage" %) 6396 +((( 6397 +**GET /api/v3/TransportRoutes** 6398 +))) 6399 + 6400 +Пример запроса: 6401 +Id ~/~/ Идентификатор поля 6402 + 6403 + 6404 +Пример ответа: 6405 + 6406 +((( 6407 +[ 6408 + { 6409 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6410 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6411 + "name": "string", ~/~/ Наименование маршрута. 6412 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6413 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6414 + 0 6415 + ] 6416 + } 6417 +] 6418 +))) 6419 + 6420 + 6421 + 6422 +== **Добавить маршрут** == 6423 + 6424 +(% class="box infomessage" %) 6425 +((( 6426 +**POST /api/v3/TransportRoutes** 6427 +))) 6428 + 6429 +Пример запроса: 6430 +{ 6431 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6432 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6433 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6434 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6435 + 0 6436 + ] 6437 +} 6438 + 6439 + 6440 +Пример ответа: 6441 + 6442 +((( 6443 +{ 6444 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6445 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6446 + "name": "string", ~/~/ Определяет наименование маршрута 6447 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6448 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6449 + 0 6450 + ] 6451 +} 6452 +))) 6453 + 6454 + 6455 +== **Обновление маршрута** == 6456 + 6457 +(% class="box successmessage" %) 6458 +((( 6459 +**PUT /api/v3/TransportRoutes** 6460 +))) 6461 + 6462 +Пример запроса: 6463 + 6464 +((( 6465 +{ 6466 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6467 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6468 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6469 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6470 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6471 + 0 6472 + ] 6473 +} 6474 +))) 6475 + 6476 + 6477 +Пример ответа: 6478 + 6479 +((( 6480 +{ 6481 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6482 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6483 + "name": "string", ~/~/ Определяет наименование маршрута 6484 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6485 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6486 + 0 6487 + ] 6488 +} 6489 +))) 6490 + 6491 + 6492 +== **Получить связки маршрутов ТС** == 6493 + 6494 +(% class="box infomessage" %) 6495 +((( 6496 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6497 +))) 6498 + 6499 +Пример запроса: 6500 + 6501 +((( 6502 +[ 6503 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6504 +] 6505 +))) 6506 + 6507 + 6508 +Пример ответа: 6509 + 6510 +((( 6511 +[ 6512 + { 6513 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6514 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6515 + } 6516 +] 6517 +))) 6518 + 6519 + 6520 +== **Удалить маршрут** == 6521 + 6522 +(% class="box warningmessage" %) 6523 +((( 6524 +**DELETE /api/v3/TransportRoutes/{id}** 6525 +))) 6526 + 6527 +Пример запроса: 6528 +Id ~/~/ Идентификатор поля 6529 + 6530 + 6531 + 6532 += **Раздел: Управление доступа к машинам** = 6533 + 6534 + 6535 +== Получение списка транспортных средств видимых пользователю == 6536 + 6537 +(% class="box infomessage" %) 6538 +((( 6539 +**GET /api/v3/UserVisibleVehicles/{userId}** 6540 +))) 6541 + 6542 +Пример ответа: 6543 + 6544 +((( 6545 +{ 6546 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6547 + 0 6548 + ] 6549 +} 6550 +))) 6551 + 6552 + 6553 + 6554 +== Задает видимость транспортных средств пользователю == 6555 + 6556 +(% class="box infomessage" %) 6557 +((( 6558 +**POST /api/v3/UserVisibleVehicles** 6559 +))) 6560 + 6561 +Пример запроса: 6562 + 6563 +((( 6564 +((( 6565 +{ 6566 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6567 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6568 + 0 6569 + ] 6570 +} 6571 +))) 6572 + 6573 +((( 6574 + 6575 +))) 6576 + 6577 +((( 6578 + 6579 +))) 6580 + 6581 +((( 6582 +Пример ответа : 6583 +))) 6584 + 6585 +((( 6586 + 6587 +))) 6588 + 6589 +((( 6590 +200 ~/~/ Success 6591 +))) 6592 +))) 6593 + 6594 + 6595 + 6596 + 6597 + 6598 + 5457 5457 (% class="box" lang="en-US" style="text-align: center;" %) 5458 5458 ((( 5459 5459 (% 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]] **