Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/06/27 16:12
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -13,12 +13,10 @@ 13 13 14 14 (% class="box infomessage" %) 15 15 ((( 16 -**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в пользовательских настройках. 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 17 17 ))) 18 18 19 -При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 20 - 21 - 22 22 **Содержание страницы:** 23 23 ))) 24 24 ... ... @@ -125,29 +125,41 @@ 125 125 Запрос должен содержать данные параметра "**agentId**" 126 126 127 127 (% style="color:#000000" %)Ответ: 126 + 127 +((( 128 128 { 129 - "agentId": "", (%%) 130 - "parentId": "", 131 - "parentName": "string", 132 - "name": "string", 133 - "fullName": "string", 134 - "agentInfoType": 0, 135 - "isForeign": true/false, 136 - "district": "string", 137 - "region": "string", 138 - "city": "string", 139 - "inn": "string", 140 - "kpp": "string", 141 - "address": "string", 142 - "addressFact": "string", 143 - "email": "string", 144 - "director": "string", 145 - "bankName": "string", 146 - "bankBIK": "string", 147 - "bankRS": "string", 148 - "bankKS": "string" 149 - } 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 +))) 150 150 160 + 151 151 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 152 152 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 153 153 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя ... ... @@ -867,7 +867,7 @@ 867 867 { 868 868 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 869 869 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 870 - "deleted": true,880 + "deleted": false, 871 871 "extId": "string", 872 872 "name": "string", 873 873 "picture": "string", ... ... @@ -886,7 +886,7 @@ 886 886 { 887 887 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 888 888 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 889 - "deleted": true,899 + "deleted": false, 890 890 "extId": "string", 891 891 "name": "string", 892 892 "picture": "string", ... ... @@ -920,7 +920,7 @@ 920 920 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 921 921 ))) 922 922 923 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.933 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 924 924 925 925 (% style="color:#000000" %)Метод запроса: **PUT** 926 926 ... ... @@ -987,7 +987,7 @@ 987 987 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 988 988 ))) 989 989 990 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.1000 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 991 991 992 992 (% style="color:#000000" %)Метод запроса: **DELETE** 993 993 ... ... @@ -1618,77 +1618,6 @@ 1618 1618 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1619 1619 1620 1620 1621 -== **Импортировать историю ТС (Асинхронный запрос)** == 1622 - 1623 -(% class="box successmessage" %) 1624 -((( 1625 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1626 -))) 1627 - 1628 -Метод запроса: **POST** 1629 - 1630 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1631 - 1632 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1633 - 1634 - 1635 -Ответ: 1636 - 1637 -{ 1638 - 1639 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1640 - 1641 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1642 - 1643 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1644 - 1645 - "Message": "string", ~/~/ Информация о выполнении запроса 1646 - 1647 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1648 - 1649 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1650 - 1651 - "Data": "string" ~/~/ Данные 1652 - 1653 -} 1654 - 1655 - 1656 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1657 - 1658 -(% class="box infomessage" %) 1659 -((( 1660 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1661 -))) 1662 - 1663 -Метод запроса: **GET** 1664 - 1665 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1666 - 1667 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1668 - 1669 - 1670 -Ответ: 1671 - 1672 -{ 1673 - 1674 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1675 - 1676 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1677 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1678 - 1679 - "Message": "string", ~/~/ Информация о выполнении запроса 1680 - 1681 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1682 - 1683 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1684 - 1685 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1686 - 1687 - "Data": "string" ~/~/ Данные 1688 - 1689 -} 1690 - 1691 - 1692 1692 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1693 1693 1694 1694 (% class="box infomessage" %) ... ... @@ -1834,7 +1834,6 @@ 1834 1834 "stage": "", ~/~/ Состояние 1835 1835 (% style="color:#000000" %) } 1836 1836 1837 -== == 1838 1838 1839 1839 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1840 1840 ... ... @@ -2517,8 +2517,12 @@ 2517 2517 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2518 2518 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2519 2519 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2458 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2459 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2520 2520 "fuelConsumption": 0, ~/~/ Расход топлива 2521 2521 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2462 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2463 + 2522 2522 } 2523 2523 ] 2524 2524 } ... ... @@ -2564,7 +2564,8 @@ 2564 2564 "model": "string", ~/~/ Модель объекта 2565 2565 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2566 2566 { 2567 - "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 + 2568 2568 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2569 2569 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2570 2570 "valueFuel": 0, ~/~/ Количество ... ... @@ -2643,26 +2643,50 @@ 2643 2643 В заголовках запроса: X-Auth: Токен авторизации 2644 2644 2645 2645 2646 -В теле запроса перечисляетемассив id объектов, вквадратных скобкахчерез запятую.2589 +В массиве указываем id объектов через запятую 2647 2647 2648 2648 Ответ: 2592 + 2593 +[ 2649 2649 { 2650 - "vehicleId": 0, ~/~/Идентификатор объекта.2651 - "vehicleGuid": " 3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификаторобъекта.2652 - "vehicleNumber": " string",~/~/Номер объекта.2653 - "receiveTime": "202 4-02-27T14:11:00.315Z",~/~/Времяполучениязаписи на сервере,т.е. время срабатывания+ время передачи от устройствана сервер2654 - "recordTime": "202 4-02-27T14:11:00.315Z",~/~/Времязаписиотустройства, т.е. время фактическогособытия натранспортном средстве.2655 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.2656 - "speed": 0,~/~/Скорость объекта.2657 - "course": 0,~/~/Курс движения [0;360]2658 - "latitude": 0,~/~/Широта [-90°;90°].2659 - "longitude": 0,~/~/Долгота [-180°;180°]. 2660 - "address": " string",~/~/Адрес.2661 - "geozones": [ ~/~/Сведения по геозонам. 2595 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2596 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2597 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2598 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2599 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2600 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2601 + "speed": 31, ~/~/ Скорость объекта 2602 + "course": 116, ~/~/ Курс движения [0;360] 2603 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2604 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2605 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2606 + "geozones": [ ~/~/ Сведения по геозонам. 2662 2662 { 2663 - "id": 0, 2664 - "name": "string" 2608 + "id": 10225647, ~/~/ ID Геозоны 2609 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2610 + }, 2611 + { 2612 + "id": 10282875, ~/~/ ID Геозоны 2613 + "name": "Ё2" ~/~/ Наименование геозоны 2614 + }, 2615 + { 2616 + "id": 10226240, ~/~/ ID Геозоны 2617 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2618 + }, 2619 + { 2620 + "id": 9747869, ~/~/ ID Геозоны 2621 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2622 + }, 2623 + { 2624 + "id": 10221123, ~/~/ ID Геозоны 2625 + "name": "53r" ~/~/ Наименование геозоны 2626 + }, 2627 + { 2628 + "id": 10197638, ~/~/ ID Геозоны 2629 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2665 2665 } 2631 + ] 2632 + } 2666 2666 2667 2667 2668 2668 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = ... ... @@ -2793,6 +2793,35 @@ 2793 2793 } 2794 2794 ] 2795 2795 2763 + 2764 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2765 + 2766 +(% class="box successmessage" %) 2767 +((( 2768 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2769 +))) 2770 + 2771 +(% style="color:#000000" %)Метод запроса: **PUT** 2772 + 2773 +Пример запроса: 2774 + 2775 +((( 2776 +{ 2777 + "id": 0, ~/~/ Идентификатор объекта геозоны 2778 + "name": "string", ~/~/ Наименование объекта геозоны 2779 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2780 + "description": "string", ~/~/ Описание объекта геозоны 2781 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2782 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2783 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2784 +} 2785 +))) 2786 + 2787 + 2788 +Пример ответа: 2789 + 2790 +200 ~/~/ Success 2791 + 2796 2796 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2797 2797 2798 2798 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2824,7 +2824,7 @@ 2824 2824 "id": 0, ~/~/ ID уведомления 2825 2825 "name": "string", ~/~/ Название уведомления 2826 2826 "active": true, ~/~/ Состояние true - активен, false - деактивирован 2827 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2823 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2828 2828 "userId": "", ~/~/ Пользователь, создавший уведомление 2829 2829 "parentId": "", ~/~/ Идентификатор клиента 2830 2830 "parentName": "string" ~/~/ Имя клиента ... ... @@ -2831,6 +2831,155 @@ 2831 2831 } 2832 2832 ] 2833 2833 2830 + 2831 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2832 + 2833 +(% class="box infomessage" %) 2834 +((( 2835 +**POST /api/v3/notifications** 2836 +))) 2837 + 2838 +Метод запроса **POST** 2839 + 2840 +(% style="text-align: left;" %) 2841 +(% style="color:#000000" %)Пример запроса 2842 + 2843 +((( 2844 +{ 2845 + "id": 0, ~/~/ ID правила 2846 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2847 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2848 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2849 + "name": "string", ~/~/ Имя правила 2850 + "active": true, ~/~/ Активность правила 2851 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2852 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2853 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2854 + ], 2855 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2856 + 0 2857 + ], 2858 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2859 + 0 2860 + ], 2861 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2862 + 0 2863 + ], 2864 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2865 + "additionalProp1": "string", 2866 + "additionalProp2": "string", 2867 + "additionalProp3": "string" 2868 + }, 2869 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2870 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2871 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2872 + ], 2873 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2874 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2875 + "string" 2876 + ], 2877 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2878 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2879 + { 2880 + "id": 0, ~/~/ Идентификатор участника чата. 2881 + "info": "string" ~/~/ Дополнительные сведения. 2882 + } 2883 + ], 2884 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2885 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2886 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2887 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2888 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2889 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2890 + "timezone": 0, ~/~/ часовой пояс 2891 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2892 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2893 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2894 + { 2895 + "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 - Срок действия правила истек 2896 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2897 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2898 + "additionalProp1": "string", 2899 + "additionalProp2": "string", 2900 + "additionalProp3": "string" 2901 + } 2902 + } 2903 + ] 2904 +} 2905 +))) 2906 + 2907 +((( 2908 + 2909 +))) 2910 + 2911 +((( 2912 + 2913 +))) 2914 + 2915 +Ответ: 2916 + 2917 +{ 2918 + "id": 0, ~/~/ ID правила 2919 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2920 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2921 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2922 + "name": "string", ~/~/ Имя правила 2923 + "active": true, ~/~/ Активность правила 2924 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2925 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2926 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2927 + ], 2928 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2929 + 0 2930 + ], 2931 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2932 + 0 2933 + ], 2934 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2935 + 0 2936 + ], 2937 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2938 + "additionalProp1": "string", 2939 + "additionalProp2": "string", 2940 + "additionalProp3": "string" 2941 + }, 2942 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2943 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2944 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2945 + ], 2946 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2947 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2948 + "string" 2949 + ], 2950 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2951 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2952 + { 2953 + "id": 0, ~/~/ Идентификатор участника чата. 2954 + "info": "string" ~/~/ Дополнительные сведения. 2955 + } 2956 + ], 2957 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2958 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2959 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2960 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2961 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2962 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2963 + "timezone": 0, ~/~/ часовой пояс 2964 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2965 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2966 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2967 + { 2968 + "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 - Срок действия правила истек 2969 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2970 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2971 + "additionalProp1": "string", 2972 + "additionalProp2": "string", 2973 + "additionalProp3": "string" 2974 + } 2975 + } 2976 + ] 2977 +} 2978 + 2834 2834 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2835 2835 2836 2836 (% class="box infomessage" %) ... ... @@ -4048,16 +4048,12 @@ 4048 4048 Тело запроса: 4049 4049 4050 4050 { 4051 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4052 - "Balance": 0 4196 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4197 + "Balance": 0 ~/~/ Значение баланса. 4053 4053 } 4054 4054 4055 4055 Ответ: Success 4056 4056 4057 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4058 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4059 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4060 - 4061 4061 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4062 4062 4063 4063 (% class="box warningmessage" %) ... ... @@ -4069,16 +4069,29 @@ 4069 4069 4070 4070 Тело запроса: 4071 4071 4213 +((( 4072 4072 { 4073 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4074 - " Balance": 04215 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4216 + "amount": 0 ~/~/ Сумма пополнения баланса 4075 4075 } 4218 +))) 4076 4076 4220 +((( 4221 + 4222 +))) 4223 + 4077 4077 Ответ: Success 4078 4078 4079 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4080 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4081 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4226 +((( 4227 +{ 4228 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4229 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4230 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4231 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4232 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4233 + "Description": "string" ~/~/ Описание корректировки. 4234 +} 4235 +))) 4082 4082 4083 4083 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4084 4084 ... ... @@ -4091,16 +4091,25 @@ 4091 4091 4092 4092 Тело запроса: 4093 4093 4248 +((( 4094 4094 { 4095 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4096 - " Balance": 04250 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4251 + "amount": 0 ~/~/ Сумма списания с баланса 4097 4097 } 4253 +))) 4098 4098 4099 4099 Ответ: Success 4100 4100 4101 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4102 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4103 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4257 +((( 4258 +{ 4259 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4260 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4261 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4262 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4263 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4264 + "Description": "string" ~/~/ Описание корректировки 4265 +} 4266 +))) 4104 4104 4105 4105 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4106 4106 ... ... @@ -4111,28 +4111,35 @@ 4111 4111 4112 4112 Тело запроса: 4113 4113 4277 +((( 4114 4114 { 4115 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4116 - "CalculationType": 0, 4117 - "PermissibleBalance": 0, 4118 - "DefermentDays": 0, 4119 - "SendUiNotifications": true, 4120 - "SendEmailNotifications": true, 4121 - "IsPrivate": true, 4279 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4280 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4281 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4282 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4283 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4284 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4122 4122 } 4286 +))) 4123 4123 4288 +((( 4289 + 4290 +))) 4291 + 4124 4124 Ответ: Success 4125 4125 4126 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4127 -|ClientId|Идентификатор клиента 4128 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4129 -|PermissibleBalance|Допустимый баланс 4130 -|DefermentDays|((( 4131 -Отсрочка, количество дней 4294 +((( 4295 +{ 4296 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4297 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4298 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4299 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4300 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4301 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4302 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4303 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4304 +} 4132 4132 ))) 4133 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4134 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4135 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4136 4136 4137 4137 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4138 4138 ... ... @@ -4144,35 +4144,68 @@ 4144 4144 Тело запроса: 4145 4145 4146 4146 { 4147 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4148 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4149 - "Features": [ 4317 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4318 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4319 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4150 4150 { 4151 - "Feature": "string", 4152 - "IsEnabled": true, 4153 - "IsFactual": true, 4154 - "Limit": 0, 4155 - "Price": 0, 4156 - "DebitDate": "2023-10-18T13:26:58.987Z", 4157 - "PeriodValue": 0, 4158 - "PeriodType": 0 4321 + "Feature": "string", ~/~/ Код услуги. 4322 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4323 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4324 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4325 + "Price": 0, ~/~/ Цена за единицу. 4326 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4327 + "PeriodValue": 0, ~/~/ Значение периода. 4328 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4159 4159 } 4160 4160 ] 4161 4161 } 4162 4162 4333 + 4163 4163 Ответ: Success 4164 4164 4165 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4166 -|ClientId|Идентификатор клиента 4167 -|PlanId|Идентификатор тарифного плана 4168 -|Feature|Код услуги 4169 -|IsEnabled|Признак, определяющий активирована ли услуга 4170 -|IsFactual|Признак, определяющий расчёт по факту 4171 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4172 -|Price|Цена за единицу. 4173 -|DebitDate|Следующий момент времени списания с баланса за услугу. 4174 -|PeriodValue|Значение периода. 4175 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4336 +((( 4337 +{ 4338 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4339 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4340 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4341 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4342 + "Name": "string", ~/~/ Наименование. 4343 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4344 + "Constraint": { ~/~/ Ограничения по тарифу 4345 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4346 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4347 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4348 + }, 4349 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4350 + { 4351 + "Feature": "string", ~/~/Код услуги. 4352 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4353 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4354 + "Price": 0, ~/~/ Цена за единицу. 4355 + "PeriodValue": 0, ~/~/ Значение периода. 4356 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4357 + } 4358 + ], 4359 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4360 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4361 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4362 + }, 4363 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4364 + { 4365 + "Feature": "string", ~/~/ Код услуги. 4366 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4367 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4368 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4369 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4370 + "Price": 0, ~/~/ Цена за единицу. 4371 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4372 + "PeriodValue": 0, ~/~/ Значение периода. 4373 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4374 + "Quantity": 0 ~/~/ Количество использования услуги. 4375 + } 4376 + ] 4377 +} 4378 +))) 4176 4176 4177 4177 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4178 4178 ... ... @@ -4277,6 +4277,43 @@ 4277 4277 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4278 4278 |msgCount|Кол-во обработанных сообщений всего 4279 4279 4483 +== **Импортировать историю ТС (Асинхронный запрос)** == 4484 + 4485 +(% class="box successmessage" %) 4486 +((( 4487 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4488 +))) 4489 + 4490 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4491 + 4492 +Метод запроса: **POST** 4493 + 4494 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4495 + 4496 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4497 + 4498 + 4499 +Ответ: 4500 + 4501 +{ 4502 + 4503 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4504 + 4505 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4506 + 4507 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4508 + 4509 + "Message": "string", ~/~/ Информация о выполнении запроса 4510 + 4511 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4512 + 4513 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4514 + 4515 + "Data": "string" ~/~/ Данные 4516 + 4517 +} 4518 + 4519 + 4280 4280 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4281 4281 4282 4282 (% class="box infomessage" %) ... ... @@ -4294,10 +4294,59 @@ 4294 4294 "message": "string" 4295 4295 } 4296 4296 4297 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4298 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4299 -|progress|Guid ТС 4537 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4538 +**Параметр** 4539 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4540 +**Описание** 4541 +))) 4542 +|((( 4543 +activity 4544 +)))|((( 4545 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4546 +))) 4547 +|((( 4548 +progress 4549 +)))|((( 4550 +Guid ТС 4551 +))) 4300 4300 4553 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4554 + 4555 +(% class="box infomessage" %) 4556 +((( 4557 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4558 +))) 4559 + 4560 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4561 + 4562 +Метод запроса: **GET** 4563 + 4564 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4565 + 4566 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4567 + 4568 + 4569 +Ответ: 4570 + 4571 +{ 4572 + 4573 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4574 + 4575 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4576 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4577 + 4578 + "Message": "string", ~/~/ Информация о выполнении запроса 4579 + 4580 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4581 + 4582 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4583 + 4584 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4585 + 4586 + "Data": "string" ~/~/ Данные 4587 + 4588 +} 4589 + 4301 4301 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4302 4302 4303 4303 (% class="box infomessage" %) ... ... @@ -4809,8 +4809,51 @@ 4809 4809 } 4810 4810 ] 4811 4811 } 5101 + 5102 + 5103 +== **Превышение скорости** == 5104 + 5105 +(% class="box infomessage" %) 5106 +((( 5107 +**POST /api/v3/Reports/overSpeedDuration** 4812 4812 ))) 4813 4813 5110 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5111 + 5112 +Пример запроса: 5113 + 5114 +((( 5115 +{ 5116 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5117 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5118 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5119 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5120 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5121 +} 5122 +))) 5123 + 5124 +((( 5125 + 5126 +))) 5127 + 5128 +((( 5129 +Пример ответа: 5130 +))) 5131 + 5132 +((( 5133 +((( 5134 +[ 5135 + { 5136 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5137 + "duration": 0, ~/~/ Продолжительность события в секундах 5138 + "maxSpeed": 0, ~/~/ Максимальная скорость 5139 + "speedLimit": 0 ~/~/ Ограничение скорости 5140 + } 5141 +] 5142 +))) 5143 +))) 5144 +))) 5145 + 4814 4814 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4815 4815 4816 4816 ... ... @@ -5815,6 +5815,62 @@ 5815 5815 ))) 5816 5816 5817 5817 6150 += **Раздел: Роли** = 6151 + 6152 +== **Получение списка клиентских и системных ролей пользователя ** == 6153 + 6154 +(% class="box successmessage" %) 6155 +((( 6156 +**POST /api/v3/groups/find** 6157 +))) 6158 + 6159 +Пример запроса: 6160 + 6161 +((( 6162 +{ 6163 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6164 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6165 +} 6166 +))) 6167 + 6168 +((( 6169 + 6170 +))) 6171 + 6172 +((( 6173 +Пример ответа: 6174 +))) 6175 + 6176 +((( 6177 +((( 6178 +{ 6179 + "groups": [ ~/~/ Системные роли пользователя 6180 + { 6181 + "code": "string", ~/~/ Код роли. 6182 + "name": "string", ~/~/ Имя 6183 + "shortName": "string" ~/~/ Короткое имя 6184 + } 6185 + ], 6186 + "customGroups": [ ~/~/ Системные роли пользователя 6187 + { 6188 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6189 + "name": "string", ~/~/ Наименование 6190 + "shortName": "string", ~/~/ Короткое наименование 6191 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6192 + } 6193 + ] 6194 +} 6195 +))) 6196 +))) 6197 + 6198 +((( 6199 + 6200 +))) 6201 + 6202 +((( 6203 + 6204 +))) 6205 + 5818 5818 = **Раздел: Локатор ** = 5819 5819 5820 5820 ... ... @@ -5822,7 +5822,7 @@ 5822 5822 5823 5823 (% class="box infomessage" %) 5824 5824 ((( 5825 -**GET /api/v3/locators** 6213 +**GET /api/v3/locators ** 5826 5826 ))) 5827 5827 5828 5828 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -5831,33 +5831,83 @@ 5831 5831 Пример ответа: 5832 5832 5833 5833 ((( 6222 +((( 6223 +{ 6224 + "vehiclesIds": [ ~/~/ Объекты 6225 + 0 6226 + ], 6227 + "geoIds": [ ~/~/ Геозоны 6228 + 0 6229 + ], 6230 + "fieldsIds": [ ~/~/ Поля 6231 + 0 6232 + ], 6233 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6234 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6235 + "agentName": "string", ~/~/ Наименование агента. 6236 + "isEnabled": true, ~/~/ Активность 6237 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6238 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6239 + "name": "string", ~/~/ Наименование. 6240 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6241 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6242 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6243 + "validity": 0, ~/~/ Значение срока действия 6244 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6245 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6246 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6247 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6248 + "url": "string", ~/~/ Ссылка 6249 + "language": 0, ~/~/ Язык 6250 + "showVehicleName": true, ~/~/ Наименование объекта 6251 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6252 + "allowTrackReport": true, ~/~/ Трек 6253 + "showTrackTracing": true, ~/~/ Трассировка трека 6254 + "showSensors": true, ~/~/ Датчик 6255 + "availableMapLayers": [ ~/~/ Слои на карте 6256 + 0 6257 + ] 6258 +} 6259 +))) 6260 +))) 6261 + 6262 + 6263 +== **Получение перечня моделей ** == 6264 + 6265 +(% class="box successmessage" %) 6266 +((( 6267 +**POST /api/v3/models/find** 6268 +))) 6269 + 6270 +Пример запроса: 6271 + 6272 +((( 6273 +((( 6274 +{ 6275 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6276 + "name": "string", ~/~/ Наименование локатора 6277 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6278 +))) 6279 + 6280 + 6281 + 6282 + Пример ответа: 6283 + 6284 + 6285 +((( 5834 5834 [ 5835 5835 { 5836 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5837 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5838 - "agentName": "string", ~/~/ Наименование агента. 5839 - "isEnabled": true, ~/~/ Активен 5840 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5841 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5842 - "name": "string", ~/~/ Наименование 5843 - "status": 0, ~/~/ 5844 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5845 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5846 - "validity": 0, ~/~/ Срок действия в днях (1-90). 5847 - "autoProlongation": true, ~/~/ Автопродление срока действия. 5848 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5849 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5850 - "url": "string", ~/~/ Ссылка 5851 - "language": 0, ~/~/ Язык. 5852 - "vehiclesCount": 0, ~/~/ Количество объектов. 5853 - "geozonesCount": 0, ~/~/ Количество геозон. 5854 - "fieldsCount": 0 ~/~/ Количество полей. 6288 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6289 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6290 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6291 + "name": "string", ~/~/ Наименование локатора 6292 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 5855 5855 } 5856 5856 ] 5857 5857 ))) 6296 +))) 5858 5858 5859 5859 5860 - 5861 5861 == **Создание локатора** == 5862 5862 5863 5863 (% class="box successmessage" %) ... ... @@ -5869,7 +5869,6 @@ 5869 5869 5870 5870 ((( 5871 5871 { 5872 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5873 5873 "isEnabled": true, ~/~/ Активность 5874 5874 "name": "string", ~/~/ Наименование локатора 5875 5875 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) ... ... @@ -5876,8 +5876,24 @@ 5876 5876 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5877 5877 "validity": 0, ~/~/ Срок действия в днях (1-90) 5878 5878 "autoProlongation": true, ~/~/ Автопродление срока действия. 5879 - "url": "string", ~/~/ Ссылка 5880 - "language": 0 ~/~/ Язык 6316 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6317 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6318 + "vehiclesIds": [ ~/~/ Oбъекты 6319 + 0 6320 + ], 6321 + "geoIds": [ ~/~/ Геозоны 6322 + 0 6323 + ], 6324 + "fieldsIds": [ ~/~/ Поля 6325 + 0 6326 + ], 6327 + "showVehicleName": true, ~/~/ Наименование объекта 6328 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6329 + "allowTrackReport": true, ~/~/ Трек 6330 + "showTrackTracing": true, ~/~/ Трассировка трека 6331 + "showSensors": true, ~/~/ Датчик 6332 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию 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ГИС) 6333 + ] 5881 5881 } 5882 5882 ))) 5883 5883 ... ... @@ -5908,12 +5908,28 @@ 5908 5908 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 5909 5909 "validity": 0, ~/~/ Срок действия в днях (1-90) 5910 5910 "autoProlongation": true, ~/~/ Автопродление срока действия 5911 - "url": "string", ~/~/ Ссылка 5912 - "language": 0 ~/~/ Язык 6364 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6365 + "vehiclesIds": [ ~/~/ Oбъекты 6366 + 0 6367 + ], 6368 + "geoIds": [ ~/~/ Геозоны 6369 + 0 6370 + ], 6371 + "fieldsIds": [ ~/~/ Поля 6372 + 0 6373 + ], 6374 + "showVehicleName": true, ~/~/ Наименование объекта 6375 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6376 + "allowTrackReport": true, ~/~/ Трек 6377 + "showTrackTracing": true, ~/~/ Трассировка трека 6378 + "showSensors": true, ~/~/ Датчик 6379 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию 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ГИС) 6380 + ] 5913 5913 } 6382 + 6383 + 5914 5914 ))) 5915 5915 5916 - 5917 5917 Пример ответа: 5918 5918 5919 5919 200 ~/~/ Success ... ... @@ -5936,7 +5936,215 @@ 5936 5936 5937 5937 5938 5938 6408 += **Раздел: Яндекс Маршруты** = 5939 5939 6410 + 6411 +== **Возвращение списка маршрутов** == 6412 + 6413 +(% class="box infomessage" %) 6414 +((( 6415 +**GET /api/v3/TransportRoutes** 6416 +))) 6417 + 6418 +Пример запроса: 6419 +Id ~/~/ Идентификатор поля 6420 + 6421 + 6422 +Пример ответа: 6423 + 6424 +((( 6425 +[ 6426 + { 6427 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6428 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6429 + "name": "string", ~/~/ Наименование маршрута. 6430 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6431 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6432 + 0 6433 + ] 6434 + } 6435 +] 6436 +))) 6437 + 6438 + 6439 + 6440 +== **Добавить маршрут** == 6441 + 6442 +(% class="box infomessage" %) 6443 +((( 6444 +**POST /api/v3/TransportRoutes** 6445 +))) 6446 + 6447 +Пример запроса: 6448 +{ 6449 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6450 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6451 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6452 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6453 + 0 6454 + ] 6455 +} 6456 + 6457 + 6458 +Пример ответа: 6459 + 6460 +((( 6461 +{ 6462 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6463 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6464 + "name": "string", ~/~/ Определяет наименование маршрута 6465 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6466 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6467 + 0 6468 + ] 6469 +} 6470 +))) 6471 + 6472 + 6473 +== **Обновление маршрута** == 6474 + 6475 +(% class="box successmessage" %) 6476 +((( 6477 +**PUT /api/v3/TransportRoutes** 6478 +))) 6479 + 6480 +Пример запроса: 6481 + 6482 +((( 6483 +{ 6484 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6485 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6486 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6487 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6488 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6489 + 0 6490 + ] 6491 +} 6492 +))) 6493 + 6494 + 6495 +Пример ответа: 6496 + 6497 +((( 6498 +{ 6499 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6500 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6501 + "name": "string", ~/~/ Определяет наименование маршрута 6502 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6503 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6504 + 0 6505 + ] 6506 +} 6507 +))) 6508 + 6509 + 6510 +== **Получить связки маршрутов ТС** == 6511 + 6512 +(% class="box infomessage" %) 6513 +((( 6514 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6515 +))) 6516 + 6517 +Пример запроса: 6518 + 6519 +((( 6520 +[ 6521 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6522 +] 6523 +))) 6524 + 6525 + 6526 +Пример ответа: 6527 + 6528 +((( 6529 +[ 6530 + { 6531 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6532 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6533 + } 6534 +] 6535 +))) 6536 + 6537 + 6538 +== **Удалить маршрут** == 6539 + 6540 +(% class="box warningmessage" %) 6541 +((( 6542 +**DELETE /api/v3/TransportRoutes/{id}** 6543 +))) 6544 + 6545 +Пример запроса: 6546 +Id ~/~/ Идентификатор поля 6547 + 6548 + 6549 + 6550 += **Раздел: Управление доступа к машинам** = 6551 + 6552 + 6553 +== Получение списка транспортных средств видимых пользователю == 6554 + 6555 +(% class="box infomessage" %) 6556 +((( 6557 +**GET /api/v3/UserVisibleVehicles/{userId}** 6558 +))) 6559 + 6560 +Пример ответа: 6561 + 6562 +((( 6563 +{ 6564 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6565 + 0 6566 + ] 6567 +} 6568 +))) 6569 + 6570 + 6571 + 6572 +== Задает видимость транспортных средств пользователю == 6573 + 6574 +(% class="box infomessage" %) 6575 +((( 6576 +**POST /api/v3/UserVisibleVehicles** 6577 +))) 6578 + 6579 +Пример запроса: 6580 + 6581 +((( 6582 +((( 6583 +{ 6584 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6585 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6586 + 0 6587 + ] 6588 +} 6589 +))) 6590 + 6591 +((( 6592 + 6593 +))) 6594 + 6595 +((( 6596 + 6597 +))) 6598 + 6599 +((( 6600 +Пример ответа : 6601 +))) 6602 + 6603 +((( 6604 + 6605 +))) 6606 + 6607 +((( 6608 +200 ~/~/ Success 6609 +))) 6610 +))) 6611 + 6612 + 6613 + 6614 + 6615 + 6616 + 5940 5940 (% class="box" lang="en-US" style="text-align: center;" %) 5941 5941 ((( 5942 5942 (% 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]] **