Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/07/29 15:51
<
>
edited by Андрей Калиновский
on 2025/03/25 14:48
on 2025/03/25 14:48
edited by Андрей Калиновский
on 2025/07/03 16:18
on 2025/07/03 16:18
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -123,29 +123,41 @@ 123 123 Запрос должен содержать данные параметра "**agentId**" 124 124 125 125 (% style="color:#000000" %)Ответ: 126 + 127 +((( 126 126 { 127 - "agentId": "", (%%) 128 - "parentId": "", 129 - "parentName": "string", 130 - "name": "string", 131 - "fullName": "string", 132 - "agentInfoType": 0, 133 - "isForeign": true/false, 134 - "district": "string", 135 - "region": "string", 136 - "city": "string", 137 - "inn": "string", 138 - "kpp": "string", 139 - "address": "string", 140 - "addressFact": "string", 141 - "email": "string", 142 - "director": "string", 143 - "bankName": "string", 144 - "bankBIK": "string", 145 - "bankRS": "string", 146 - "bankKS": "string" 147 - } 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 +))) 148 148 160 + 149 149 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 150 150 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 151 151 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя ... ... @@ -442,7 +442,7 @@ 442 442 [ 443 443 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 444 444 ], 445 - "language": 0~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский457 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 446 446 } 447 447 { 448 448 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -754,6 +754,9 @@ 754 754 (% style="text-align:left" %) 755 755 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 756 756 769 +(% class="wikigeneratedid" %) 770 += = 771 + 757 757 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 758 758 759 759 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == ... ... @@ -865,7 +865,7 @@ 865 865 { 866 866 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 867 867 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 868 - "deleted": true,883 + "deleted": false, 869 869 "extId": "string", 870 870 "name": "string", 871 871 "picture": "string", ... ... @@ -884,7 +884,7 @@ 884 884 { 885 885 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 886 886 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 887 - "deleted": true,902 + "deleted": false, 888 888 "extId": "string", 889 889 "name": "string", 890 890 "picture": "string", ... ... @@ -918,7 +918,7 @@ 918 918 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 919 919 ))) 920 920 921 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.936 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 922 922 923 923 (% style="color:#000000" %)Метод запроса: **PUT** 924 924 ... ... @@ -985,7 +985,7 @@ 985 985 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 986 986 ))) 987 987 988 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.1003 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 989 989 990 990 (% style="color:#000000" %)Метод запроса: **DELETE** 991 991 ... ... @@ -1616,77 +1616,6 @@ 1616 1616 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1617 1617 1618 1618 1619 -== **Импортировать историю ТС (Асинхронный запрос)** == 1620 - 1621 -(% class="box successmessage" %) 1622 -((( 1623 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1624 -))) 1625 - 1626 -Метод запроса: **POST** 1627 - 1628 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1629 - 1630 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1631 - 1632 - 1633 -Ответ: 1634 - 1635 -{ 1636 - 1637 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1638 - 1639 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1640 - 1641 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1642 - 1643 - "Message": "string", ~/~/ Информация о выполнении запроса 1644 - 1645 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1646 - 1647 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1648 - 1649 - "Data": "string" ~/~/ Данные 1650 - 1651 -} 1652 - 1653 - 1654 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1655 - 1656 -(% class="box infomessage" %) 1657 -((( 1658 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1659 -))) 1660 - 1661 -Метод запроса: **GET** 1662 - 1663 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1664 - 1665 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1666 - 1667 - 1668 -Ответ: 1669 - 1670 -{ 1671 - 1672 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1673 - 1674 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1675 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1676 - 1677 - "Message": "string", ~/~/ Информация о выполнении запроса 1678 - 1679 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1680 - 1681 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1682 - 1683 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1684 - 1685 - "Data": "string" ~/~/ Данные 1686 - 1687 -} 1688 - 1689 - 1690 1690 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1691 1691 1692 1692 (% class="box infomessage" %) ... ... @@ -1832,7 +1832,6 @@ 1832 1832 "stage": "", ~/~/ Состояние 1833 1833 (% style="color:#000000" %) } 1834 1834 1835 -== == 1836 1836 1837 1837 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1838 1838 ... ... @@ -2515,6 +2515,8 @@ 2515 2515 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2516 2516 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2517 2517 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2461 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2462 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2518 2518 "fuelConsumption": 0, ~/~/ Расход топлива 2519 2519 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2520 2520 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне ... ... @@ -2644,26 +2644,50 @@ 2644 2644 В заголовках запроса: X-Auth: Токен авторизации 2645 2645 2646 2646 2647 -В теле запроса перечисляетемассив id объектов, вквадратных скобкахчерез запятую.2592 +В массиве указываем id объектов через запятую 2648 2648 2649 2649 Ответ: 2595 + 2596 +[ 2650 2650 { 2651 - "vehicleId": 0, ~/~/Идентификатор объекта.2652 - "vehicleGuid": " 3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификаторобъекта.2653 - "vehicleNumber": " string",~/~/Номер объекта.2654 - "receiveTime": "202 4-02-27T14:11:00.315Z",~/~/Времяполучениязаписи на сервере,т.е. время срабатывания+ время передачи от устройствана сервер2655 - "recordTime": "202 4-02-27T14:11:00.315Z",~/~/Времязаписиотустройства, т.е. время фактическогособытия натранспортном средстве.2656 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.2657 - "speed": 0,~/~/Скорость объекта.2658 - "course": 0,~/~/Курс движения [0;360]2659 - "latitude": 0,~/~/Широта [-90°;90°].2660 - "longitude": 0,~/~/Долгота [-180°;180°]. 2661 - "address": " string",~/~/Адрес.2662 - "geozones": [ ~/~/Сведения по геозонам. 2598 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2599 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2600 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2601 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2602 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2603 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2604 + "speed": 31, ~/~/ Скорость объекта 2605 + "course": 116, ~/~/ Курс движения [0;360] 2606 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2607 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2608 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2609 + "geozones": [ ~/~/ Сведения по геозонам. 2663 2663 { 2664 - "id": 0, 2665 - "name": "string" 2611 + "id": 10225647, ~/~/ ID Геозоны 2612 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2613 + }, 2614 + { 2615 + "id": 10282875, ~/~/ ID Геозоны 2616 + "name": "Ё2" ~/~/ Наименование геозоны 2617 + }, 2618 + { 2619 + "id": 10226240, ~/~/ ID Геозоны 2620 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2621 + }, 2622 + { 2623 + "id": 9747869, ~/~/ ID Геозоны 2624 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2625 + }, 2626 + { 2627 + "id": 10221123, ~/~/ ID Геозоны 2628 + "name": "53r" ~/~/ Наименование геозоны 2629 + }, 2630 + { 2631 + "id": 10197638, ~/~/ ID Геозоны 2632 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2666 2666 } 2634 + ] 2635 + } 2667 2667 2668 2668 2669 2669 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = ... ... @@ -2794,6 +2794,35 @@ 2794 2794 } 2795 2795 ] 2796 2796 2766 + 2767 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2768 + 2769 +(% class="box successmessage" %) 2770 +((( 2771 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2772 +))) 2773 + 2774 +(% style="color:#000000" %)Метод запроса: **PUT** 2775 + 2776 +Пример запроса: 2777 + 2778 +((( 2779 +{ 2780 + "id": 0, ~/~/ Идентификатор объекта геозоны 2781 + "name": "string", ~/~/ Наименование объекта геозоны 2782 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2783 + "description": "string", ~/~/ Описание объекта геозоны 2784 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2785 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2786 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2787 +} 2788 +))) 2789 + 2790 + 2791 +Пример ответа: 2792 + 2793 +200 ~/~/ Success 2794 + 2797 2797 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2798 2798 2799 2799 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2825,7 +2825,7 @@ 2825 2825 "id": 0, ~/~/ ID уведомления 2826 2826 "name": "string", ~/~/ Название уведомления 2827 2827 "active": true, ~/~/ Состояние true - активен, false - деактивирован 2828 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2826 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2829 2829 "userId": "", ~/~/ Пользователь, создавший уведомление 2830 2830 "parentId": "", ~/~/ Идентификатор клиента 2831 2831 "parentName": "string" ~/~/ Имя клиента ... ... @@ -2832,6 +2832,155 @@ 2832 2832 } 2833 2833 ] 2834 2834 2833 + 2834 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2835 + 2836 +(% class="box infomessage" %) 2837 +((( 2838 +**POST /api/v3/notifications** 2839 +))) 2840 + 2841 +Метод запроса **POST** 2842 + 2843 +(% style="text-align: left;" %) 2844 +(% style="color:#000000" %)Пример запроса 2845 + 2846 +((( 2847 +{ 2848 + "id": 0, ~/~/ ID правила 2849 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2850 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2851 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2852 + "name": "string", ~/~/ Имя правила 2853 + "active": true, ~/~/ Активность правила 2854 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2855 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2856 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2857 + ], 2858 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2859 + 0 2860 + ], 2861 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2862 + 0 2863 + ], 2864 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2865 + 0 2866 + ], 2867 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2868 + "additionalProp1": "string", 2869 + "additionalProp2": "string", 2870 + "additionalProp3": "string" 2871 + }, 2872 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2873 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2874 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2875 + ], 2876 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2877 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2878 + "string" 2879 + ], 2880 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2881 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2882 + { 2883 + "id": 0, ~/~/ Идентификатор участника чата. 2884 + "info": "string" ~/~/ Дополнительные сведения. 2885 + } 2886 + ], 2887 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2888 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2889 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2890 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2891 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2892 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2893 + "timezone": 0, ~/~/ часовой пояс 2894 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2895 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2896 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2897 + { 2898 + "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 - Срок действия правила истек 2899 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2900 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2901 + "additionalProp1": "string", 2902 + "additionalProp2": "string", 2903 + "additionalProp3": "string" 2904 + } 2905 + } 2906 + ] 2907 +} 2908 +))) 2909 + 2910 +((( 2911 + 2912 +))) 2913 + 2914 +((( 2915 + 2916 +))) 2917 + 2918 +Ответ: 2919 + 2920 +{ 2921 + "id": 0, ~/~/ ID правила 2922 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2923 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2924 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2925 + "name": "string", ~/~/ Имя правила 2926 + "active": true, ~/~/ Активность правила 2927 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2928 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2929 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2930 + ], 2931 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2932 + 0 2933 + ], 2934 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2935 + 0 2936 + ], 2937 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2938 + 0 2939 + ], 2940 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2941 + "additionalProp1": "string", 2942 + "additionalProp2": "string", 2943 + "additionalProp3": "string" 2944 + }, 2945 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2946 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2947 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2948 + ], 2949 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2950 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2951 + "string" 2952 + ], 2953 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2954 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2955 + { 2956 + "id": 0, ~/~/ Идентификатор участника чата. 2957 + "info": "string" ~/~/ Дополнительные сведения. 2958 + } 2959 + ], 2960 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2961 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2962 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2963 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2964 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2965 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2966 + "timezone": 0, ~/~/ часовой пояс 2967 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2968 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2969 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2970 + { 2971 + "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 - Срок действия правила истек 2972 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2973 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2974 + "additionalProp1": "string", 2975 + "additionalProp2": "string", 2976 + "additionalProp3": "string" 2977 + } 2978 + } 2979 + ] 2980 +} 2981 + 2835 2835 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2836 2836 2837 2837 (% class="box infomessage" %) ... ... @@ -4049,16 +4049,12 @@ 4049 4049 Тело запроса: 4050 4050 4051 4051 { 4052 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4053 - "Balance": 0 4199 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4200 + "Balance": 0 ~/~/ Значение баланса. 4054 4054 } 4055 4055 4056 4056 Ответ: Success 4057 4057 4058 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4059 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4060 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4061 - 4062 4062 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4063 4063 4064 4064 (% class="box warningmessage" %) ... ... @@ -4070,16 +4070,29 @@ 4070 4070 4071 4071 Тело запроса: 4072 4072 4216 +((( 4073 4073 { 4074 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4075 - " Balance": 04218 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4219 + "amount": 0 ~/~/ Сумма пополнения баланса 4076 4076 } 4221 +))) 4077 4077 4223 +((( 4224 + 4225 +))) 4226 + 4078 4078 Ответ: Success 4079 4079 4080 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4081 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4082 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4229 +((( 4230 +{ 4231 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4232 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4233 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4234 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4235 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4236 + "Description": "string" ~/~/ Описание корректировки. 4237 +} 4238 +))) 4083 4083 4084 4084 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4085 4085 ... ... @@ -4092,16 +4092,25 @@ 4092 4092 4093 4093 Тело запроса: 4094 4094 4251 +((( 4095 4095 { 4096 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4097 - " Balance": 04253 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4254 + "amount": 0 ~/~/ Сумма списания с баланса 4098 4098 } 4256 +))) 4099 4099 4100 4100 Ответ: Success 4101 4101 4102 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4103 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4104 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4260 +((( 4261 +{ 4262 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4263 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4264 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4265 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4266 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4267 + "Description": "string" ~/~/ Описание корректировки 4268 +} 4269 +))) 4105 4105 4106 4106 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4107 4107 ... ... @@ -4112,28 +4112,35 @@ 4112 4112 4113 4113 Тело запроса: 4114 4114 4280 +((( 4115 4115 { 4116 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4117 - "CalculationType": 0, 4118 - "PermissibleBalance": 0, 4119 - "DefermentDays": 0, 4120 - "SendUiNotifications": true, 4121 - "SendEmailNotifications": true, 4122 - "IsPrivate": true, 4282 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4283 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4284 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4285 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4286 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4287 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4123 4123 } 4289 +))) 4124 4124 4291 +((( 4292 + 4293 +))) 4294 + 4125 4125 Ответ: Success 4126 4126 4127 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4128 -|ClientId|Идентификатор клиента 4129 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4130 -|PermissibleBalance|Допустимый баланс 4131 -|DefermentDays|((( 4132 -Отсрочка, количество дней 4297 +((( 4298 +{ 4299 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4300 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4301 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4302 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4303 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4304 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4305 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4306 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4307 +} 4133 4133 ))) 4134 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4135 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4136 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4137 4137 4138 4138 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4139 4139 ... ... @@ -4145,35 +4145,68 @@ 4145 4145 Тело запроса: 4146 4146 4147 4147 { 4148 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4149 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4150 - "Features": [ 4320 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4321 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4322 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4151 4151 { 4152 - "Feature": "string", 4153 - "IsEnabled": true, 4154 - "IsFactual": true, 4155 - "Limit": 0, 4156 - "Price": 0, 4157 - "DebitDate": "2023-10-18T13:26:58.987Z", 4158 - "PeriodValue": 0, 4159 - "PeriodType": 0 4324 + "Feature": "string", ~/~/ Код услуги. 4325 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4326 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4327 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4328 + "Price": 0, ~/~/ Цена за единицу. 4329 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4330 + "PeriodValue": 0, ~/~/ Значение периода. 4331 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4160 4160 } 4161 4161 ] 4162 4162 } 4163 4163 4336 + 4164 4164 Ответ: Success 4165 4165 4166 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4167 -|ClientId|Идентификатор клиента 4168 -|PlanId|Идентификатор тарифного плана 4169 -|Feature|Код услуги 4170 -|IsEnabled|Признак, определяющий активирована ли услуга 4171 -|IsFactual|Признак, определяющий расчёт по факту 4172 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4173 -|Price|Цена за единицу. 4174 -|DebitDate|Следующий момент времени списания с баланса за услугу. 4175 -|PeriodValue|Значение периода. 4176 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4339 +((( 4340 +{ 4341 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4342 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4343 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4344 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4345 + "Name": "string", ~/~/ Наименование. 4346 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4347 + "Constraint": { ~/~/ Ограничения по тарифу 4348 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4349 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4350 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4351 + }, 4352 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4353 + { 4354 + "Feature": "string", ~/~/Код услуги. 4355 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4356 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4357 + "Price": 0, ~/~/ Цена за единицу. 4358 + "PeriodValue": 0, ~/~/ Значение периода. 4359 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4360 + } 4361 + ], 4362 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4363 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4364 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4365 + }, 4366 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4367 + { 4368 + "Feature": "string", ~/~/ Код услуги. 4369 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4370 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4371 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4372 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4373 + "Price": 0, ~/~/ Цена за единицу. 4374 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4375 + "PeriodValue": 0, ~/~/ Значение периода. 4376 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4377 + "Quantity": 0 ~/~/ Количество использования услуги. 4378 + } 4379 + ] 4380 +} 4381 +))) 4177 4177 4178 4178 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4179 4179 ... ... @@ -4278,6 +4278,43 @@ 4278 4278 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4279 4279 |msgCount|Кол-во обработанных сообщений всего 4280 4280 4486 +== **Импортировать историю ТС (Асинхронный запрос)** == 4487 + 4488 +(% class="box successmessage" %) 4489 +((( 4490 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4491 +))) 4492 + 4493 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4494 + 4495 +Метод запроса: **POST** 4496 + 4497 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4498 + 4499 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4500 + 4501 + 4502 +Ответ: 4503 + 4504 +{ 4505 + 4506 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4507 + 4508 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4509 + 4510 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4511 + 4512 + "Message": "string", ~/~/ Информация о выполнении запроса 4513 + 4514 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4515 + 4516 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4517 + 4518 + "Data": "string" ~/~/ Данные 4519 + 4520 +} 4521 + 4522 + 4281 4281 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4282 4282 4283 4283 (% class="box infomessage" %) ... ... @@ -4295,10 +4295,59 @@ 4295 4295 "message": "string" 4296 4296 } 4297 4297 4298 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4299 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4300 -|progress|Guid ТС 4540 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4541 +**Параметр** 4542 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4543 +**Описание** 4544 +))) 4545 +|((( 4546 +activity 4547 +)))|((( 4548 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4549 +))) 4550 +|((( 4551 +progress 4552 +)))|((( 4553 +Guid ТС 4554 +))) 4301 4301 4556 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4557 + 4558 +(% class="box infomessage" %) 4559 +((( 4560 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4561 +))) 4562 + 4563 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4564 + 4565 +Метод запроса: **GET** 4566 + 4567 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4568 + 4569 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4570 + 4571 + 4572 +Ответ: 4573 + 4574 +{ 4575 + 4576 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4577 + 4578 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4579 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4580 + 4581 + "Message": "string", ~/~/ Информация о выполнении запроса 4582 + 4583 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4584 + 4585 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4586 + 4587 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4588 + 4589 + "Data": "string" ~/~/ Данные 4590 + 4591 +} 4592 + 4302 4302 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4303 4303 4304 4304 (% class="box infomessage" %) ... ... @@ -4810,8 +4810,51 @@ 4810 4810 } 4811 4811 ] 4812 4812 } 5104 + 5105 + 5106 +== **Превышение скорости** == 5107 + 5108 +(% class="box infomessage" %) 5109 +((( 5110 +**POST /api/v3/Reports/overSpeedDuration** 4813 4813 ))) 4814 4814 5113 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5114 + 5115 +Пример запроса: 5116 + 5117 +((( 5118 +{ 5119 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5120 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5121 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5122 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5123 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5124 +} 5125 +))) 5126 + 5127 +((( 5128 + 5129 +))) 5130 + 5131 +((( 5132 +Пример ответа: 5133 +))) 5134 + 5135 +((( 5136 +((( 5137 +[ 5138 + { 5139 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5140 + "duration": 0, ~/~/ Продолжительность события в секундах 5141 + "maxSpeed": 0, ~/~/ Максимальная скорость 5142 + "speedLimit": 0 ~/~/ Ограничение скорости 5143 + } 5144 +] 5145 +))) 5146 +))) 5147 +))) 5148 + 4815 4815 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4816 4816 4817 4817 ... ... @@ -5816,6 +5816,62 @@ 5816 5816 ))) 5817 5817 5818 5818 6153 += **Раздел: Роли** = 6154 + 6155 +== **Получение списка клиентских и системных ролей пользователя ** == 6156 + 6157 +(% class="box successmessage" %) 6158 +((( 6159 +**POST /api/v3/groups/find** 6160 +))) 6161 + 6162 +Пример запроса: 6163 + 6164 +((( 6165 +{ 6166 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6167 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6168 +} 6169 +))) 6170 + 6171 +((( 6172 + 6173 +))) 6174 + 6175 +((( 6176 +Пример ответа: 6177 +))) 6178 + 6179 +((( 6180 +((( 6181 +{ 6182 + "groups": [ ~/~/ Системные роли пользователя 6183 + { 6184 + "code": "string", ~/~/ Код роли. 6185 + "name": "string", ~/~/ Имя 6186 + "shortName": "string" ~/~/ Короткое имя 6187 + } 6188 + ], 6189 + "customGroups": [ ~/~/ Системные роли пользователя 6190 + { 6191 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6192 + "name": "string", ~/~/ Наименование 6193 + "shortName": "string", ~/~/ Короткое наименование 6194 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6195 + } 6196 + ] 6197 +} 6198 +))) 6199 +))) 6200 + 6201 +((( 6202 + 6203 +))) 6204 + 6205 +((( 6206 + 6207 +))) 6208 + 5819 5819 = **Раздел: Локатор ** = 5820 5820 5821 5821 ... ... @@ -5823,7 +5823,7 @@ 5823 5823 5824 5824 (% class="box infomessage" %) 5825 5825 ((( 5826 -**GET /api/v3/locators** 6216 +**GET /api/v3/locators ** 5827 5827 ))) 5828 5828 5829 5829 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -5832,33 +5832,54 @@ 5832 5832 Пример ответа: 5833 5833 5834 5834 ((( 5835 -[ 5836 - { 5837 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5838 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5839 - "agentName": "string", ~/~/ Наименование агента. 5840 - "isEnabled": true, ~/~/ Активен 5841 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5842 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5843 - "name": "string", ~/~/ Наименование 5844 - "status": 0, ~/~/ 5845 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5846 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5847 - "validity": 0, ~/~/ Срок действия в днях (1-90). 5848 - "autoProlongation": true, ~/~/ Автопродление срока действия. 5849 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5850 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5851 - "url": "string", ~/~/ Ссылка 5852 - "language": 0, ~/~/ Язык. 5853 - "vehiclesCount": 0, ~/~/ Количество объектов. 5854 - "geozonesCount": 0, ~/~/ Количество геозон. 5855 - "fieldsCount": 0 ~/~/ Количество полей. 5856 - } 5857 -] 6225 +((( 6226 +{ 6227 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6228 + 0 6229 + ], 6230 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6231 + 0 6232 + ], 6233 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6234 + 0 6235 + ], 6236 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6237 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6238 + "agentName": "string", ~/~/ Наименование агента. 6239 + "isEnabled": true, ~/~/ Активность 6240 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6241 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6242 + "name": "string", ~/~/ Наименование. 6243 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6244 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6245 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6246 + "validity": 0, ~/~/ Значение срока действия 6247 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6248 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6249 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6250 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6251 + "url": "string", ~/~/ Ссылка 6252 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6253 + "showVehicleName": true, ~/~/ Наименование объекта 6254 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6255 + "allowTrackReport": true, ~/~/ Трек 6256 + "showTrackTracing": true, ~/~/ Трассировка трека 6257 + "showSensors": true, ~/~/ Датчик 6258 + "availableMapLayers": [ ~/~/ Слои на карте 6259 + 0 6260 + ] 6261 +} 5858 5858 ))) 6263 +))) 5859 5859 5860 5860 6266 +((( 6267 +((( 6268 + 6269 +))) 6270 +))) 5861 5861 6272 + 5862 5862 == **Создание локатора** == 5863 5863 5864 5864 (% class="box successmessage" %) ... ... @@ -5870,7 +5870,6 @@ 5870 5870 5871 5871 ((( 5872 5872 { 5873 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5874 5874 "isEnabled": true, ~/~/ Активность 5875 5875 "name": "string", ~/~/ Наименование локатора 5876 5876 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) ... ... @@ -5877,8 +5877,24 @@ 5877 5877 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5878 5878 "validity": 0, ~/~/ Срок действия в днях (1-90) 5879 5879 "autoProlongation": true, ~/~/ Автопродление срока действия. 5880 - "url": "string", ~/~/ Ссылка 5881 - "language": 0 ~/~/ Язык 6290 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6291 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6292 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6293 + 0 6294 + ], 6295 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6296 + 0 6297 + ], 6298 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6299 + 0 6300 + ], 6301 + "showVehicleName": true, ~/~/ Наименование объекта 6302 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6303 + "allowTrackReport": true, ~/~/ Трек 6304 + "showTrackTracing": true, ~/~/ Трассировка трека 6305 + "showSensors": true, ~/~/ Датчик 6306 + "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ГИС) 6307 + ] 5882 5882 } 5883 5883 ))) 5884 5884 ... ... @@ -5890,7 +5890,95 @@ 5890 5890 ))) 5891 5891 5892 5892 6319 +== **Выводит список локаторов ** == 5893 5893 6321 +(% class="box successmessage" %) 6322 +((( 6323 +**POST /api/v3/locators/find** 6324 +))) 6325 + 6326 +Пример запроса: 6327 + 6328 +((( 6329 +{ 6330 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6331 +} 6332 +))) 6333 + 6334 +((( 6335 + 6336 +))) 6337 + 6338 +((( 6339 +{ 6340 + "isEnabled": true, ~/~/ Активность 6341 + "name": "string", ~/~/ Наименование локатора 6342 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6343 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6344 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6345 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6346 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6347 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6348 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6349 + 0 6350 + ], 6351 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6352 + 0 6353 + ], 6354 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6355 + 0 6356 + ], 6357 + "showVehicleName": true, ~/~/ Наименование объекта 6358 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6359 + "allowTrackReport": true, ~/~/ Трек 6360 + "showTrackTracing": true, ~/~/ Трассировка трека 6361 + "showSensors": true, ~/~/ Датчик 6362 + "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ГИС) 6363 + ] 6364 +} 6365 +))) 6366 + 6367 + 6368 +Пример ответа: 6369 + 6370 +((( 6371 +[ 6372 + { 6373 + "vehiclesCount": 0, ~/~/ Количество объектов. 6374 + "geozonesCount": 0, ~/~/ Количество геозон. 6375 + "fieldsCount": 0, ~/~/ Количество полей. 6376 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6377 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6378 + "agentName": "string", ~/~/ Наименование агента. 6379 + "isEnabled": true, ~/~/ Активность локатора 6380 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6381 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6382 + "name": "string", ~/~/ Наименование локатора 6383 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6384 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6385 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6386 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6387 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6388 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6389 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6390 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6391 + "url": "string", ~/~/ ссылка на локатор 6392 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6393 + "showVehicleName": true, ~/~/ Наименование объекта 6394 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6395 + "allowTrackReport": true, ~/~/ Трек 6396 + "showTrackTracing": true, ~/~/ Трассировка трека 6397 + "showSensors": true, ~/~/ Датчик 6398 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6399 + 6400 + 0 6401 + ] 6402 + } 6403 +] 6404 +))) 6405 + 6406 + 6407 + 5894 5894 == **Изменение локатора** == 5895 5895 5896 5896 (% class="box infomessage" %) ... ... @@ -5909,12 +5909,28 @@ 5909 5909 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 5910 5910 "validity": 0, ~/~/ Срок действия в днях (1-90) 5911 5911 "autoProlongation": true, ~/~/ Автопродление срока действия 5912 - "url": "string", ~/~/ Ссылка 5913 - "language": 0 ~/~/ Язык 6426 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6427 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6428 + 0 6429 + ], 6430 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6431 + 0 6432 + ], 6433 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6434 + 0 6435 + ], 6436 + "showVehicleName": true, ~/~/ Наименование объекта 6437 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6438 + "allowTrackReport": true, ~/~/ Трек 6439 + "showTrackTracing": true, ~/~/ Трассировка трека 6440 + "showSensors": true, ~/~/ Датчик 6441 + "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ГИС) 6442 + ] 5914 5914 } 6444 + 6445 + 5915 5915 ))) 5916 5916 5917 - 5918 5918 Пример ответа: 5919 5919 5920 5920 200 ~/~/ Success ... ... @@ -6079,6 +6079,107 @@ 6079 6079 6080 6080 6081 6081 6612 += **Раздел: Управление доступа к машинам** = 6613 + 6614 + 6615 +== Получение списка транспортных средств видимых пользователю == 6616 + 6617 +(% class="box infomessage" %) 6618 +((( 6619 +**GET /api/v3/UserVisibleVehicles/{userId}** 6620 +))) 6621 + 6622 +Пример ответа: 6623 + 6624 +((( 6625 +{ 6626 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6627 + 0 6628 + ] 6629 +} 6630 +))) 6631 + 6632 + 6633 + 6634 +== Задает видимость транспортных средств пользователю == 6635 + 6636 +(% class="box infomessage" %) 6637 +((( 6638 +**POST /api/v3/UserVisibleVehicles** 6639 +))) 6640 + 6641 +Пример запроса: 6642 + 6643 +((( 6644 +((( 6645 +{ 6646 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6647 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6648 + 0 6649 + ] 6650 +} 6651 +))) 6652 + 6653 +((( 6654 + 6655 +))) 6656 + 6657 +((( 6658 + 6659 +))) 6660 + 6661 +((( 6662 +Пример ответа : 6663 +))) 6664 + 6665 +((( 6666 + 6667 +))) 6668 + 6669 +((( 6670 +200 ~/~/ Success 6671 +))) 6672 +))) 6673 + 6674 + 6675 +== **Получение перечня моделей ** == 6676 + 6677 +(% class="box successmessage" %) 6678 +((( 6679 +**POST /api/v3/models/find** 6680 +))) 6681 + 6682 +Пример запроса: 6683 + 6684 +((( 6685 +((( 6686 +{ 6687 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6688 + "name": "string", ~/~/ Наименование локатора 6689 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6690 +))) 6691 + 6692 + 6693 + 6694 + Пример ответа: 6695 + 6696 + 6697 +((( 6698 +[ 6699 + { 6700 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6701 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6702 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6703 + "name": "string", ~/~/ Наименование локатора 6704 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 6705 + } 6706 +] 6707 +))) 6708 +))) 6709 + 6710 + 6711 + 6712 + 6082 6082 (% class="box" lang="en-US" style="text-align: center;" %) 6083 6083 ((( 6084 6084 (% 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]] **