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:19
on 2025/07/03 16:19
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,8 @@ 754 754 (% style="text-align:left" %) 755 755 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 756 756 769 += = 770 + 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,882 + "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,901 + "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" %)Метод позволяет изменить статус пользователя, указанного в запросе.935 +(% 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" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.1002 +(% 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, ~/~/ Уровень топлива на конец периода 2460 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2461 + "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 объектов, вквадратных скобкахчерез запятую.2591 +В массиве указываем id объектов через запятую 2648 2648 2649 2649 Ответ: 2594 + 2595 +[ 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": [ ~/~/Сведения по геозонам. 2597 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2598 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2599 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2600 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2601 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2602 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2603 + "speed": 31, ~/~/ Скорость объекта 2604 + "course": 116, ~/~/ Курс движения [0;360] 2605 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2606 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2607 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2608 + "geozones": [ ~/~/ Сведения по геозонам. 2663 2663 { 2664 - "id": 0, 2665 - "name": "string" 2610 + "id": 10225647, ~/~/ ID Геозоны 2611 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2612 + }, 2613 + { 2614 + "id": 10282875, ~/~/ ID Геозоны 2615 + "name": "Ё2" ~/~/ Наименование геозоны 2616 + }, 2617 + { 2618 + "id": 10226240, ~/~/ ID Геозоны 2619 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2620 + }, 2621 + { 2622 + "id": 9747869, ~/~/ ID Геозоны 2623 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2624 + }, 2625 + { 2626 + "id": 10221123, ~/~/ ID Геозоны 2627 + "name": "53r" ~/~/ Наименование геозоны 2628 + }, 2629 + { 2630 + "id": 10197638, ~/~/ ID Геозоны 2631 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2666 2666 } 2633 + ] 2634 + } 2667 2667 2668 2668 2669 2669 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = ... ... @@ -2794,6 +2794,35 @@ 2794 2794 } 2795 2795 ] 2796 2796 2765 + 2766 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2767 + 2768 +(% class="box successmessage" %) 2769 +((( 2770 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2771 +))) 2772 + 2773 +(% style="color:#000000" %)Метод запроса: **PUT** 2774 + 2775 +Пример запроса: 2776 + 2777 +((( 2778 +{ 2779 + "id": 0, ~/~/ Идентификатор объекта геозоны 2780 + "name": "string", ~/~/ Наименование объекта геозоны 2781 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2782 + "description": "string", ~/~/ Описание объекта геозоны 2783 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2784 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2785 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2786 +} 2787 +))) 2788 + 2789 + 2790 +Пример ответа: 2791 + 2792 +200 ~/~/ Success 2793 + 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 - Выполнение ТО 2825 + "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 2832 + 2833 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2834 + 2835 +(% class="box infomessage" %) 2836 +((( 2837 +**POST /api/v3/notifications** 2838 +))) 2839 + 2840 +Метод запроса **POST** 2841 + 2842 +(% style="text-align: left;" %) 2843 +(% style="color:#000000" %)Пример запроса 2844 + 2845 +((( 2846 +{ 2847 + "id": 0, ~/~/ ID правила 2848 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2849 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2850 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2851 + "name": "string", ~/~/ Имя правила 2852 + "active": true, ~/~/ Активность правила 2853 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2854 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2855 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2856 + ], 2857 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2858 + 0 2859 + ], 2860 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2861 + 0 2862 + ], 2863 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2864 + 0 2865 + ], 2866 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2867 + "additionalProp1": "string", 2868 + "additionalProp2": "string", 2869 + "additionalProp3": "string" 2870 + }, 2871 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2872 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2873 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2874 + ], 2875 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2876 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2877 + "string" 2878 + ], 2879 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2880 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2881 + { 2882 + "id": 0, ~/~/ Идентификатор участника чата. 2883 + "info": "string" ~/~/ Дополнительные сведения. 2884 + } 2885 + ], 2886 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2887 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2888 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2889 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2890 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2891 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2892 + "timezone": 0, ~/~/ часовой пояс 2893 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2894 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2895 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2896 + { 2897 + "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 - Срок действия правила истек 2898 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2899 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2900 + "additionalProp1": "string", 2901 + "additionalProp2": "string", 2902 + "additionalProp3": "string" 2903 + } 2904 + } 2905 + ] 2906 +} 2907 +))) 2908 + 2909 +((( 2910 + 2911 +))) 2912 + 2913 +((( 2914 + 2915 +))) 2916 + 2917 +Ответ: 2918 + 2919 +{ 2920 + "id": 0, ~/~/ ID правила 2921 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2922 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2923 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2924 + "name": "string", ~/~/ Имя правила 2925 + "active": true, ~/~/ Активность правила 2926 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2927 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2928 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2929 + ], 2930 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2931 + 0 2932 + ], 2933 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2934 + 0 2935 + ], 2936 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2937 + 0 2938 + ], 2939 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2940 + "additionalProp1": "string", 2941 + "additionalProp2": "string", 2942 + "additionalProp3": "string" 2943 + }, 2944 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2945 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2946 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2947 + ], 2948 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2949 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2950 + "string" 2951 + ], 2952 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2953 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2954 + { 2955 + "id": 0, ~/~/ Идентификатор участника чата. 2956 + "info": "string" ~/~/ Дополнительные сведения. 2957 + } 2958 + ], 2959 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2960 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2961 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2962 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2963 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2964 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2965 + "timezone": 0, ~/~/ часовой пояс 2966 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2967 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2968 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2969 + { 2970 + "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 - Срок действия правила истек 2971 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2972 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2973 + "additionalProp1": "string", 2974 + "additionalProp2": "string", 2975 + "additionalProp3": "string" 2976 + } 2977 + } 2978 + ] 2979 +} 2980 + 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 4198 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4199 + "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 4215 +((( 4073 4073 { 4074 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4075 - " Balance": 04217 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4218 + "amount": 0 ~/~/ Сумма пополнения баланса 4076 4076 } 4220 +))) 4077 4077 4222 +((( 4223 + 4224 +))) 4225 + 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" %)Значение баланса 4228 +((( 4229 +{ 4230 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4231 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4232 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4233 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4234 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4235 + "Description": "string" ~/~/ Описание корректировки. 4236 +} 4237 +))) 4083 4083 4084 4084 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4085 4085 ... ... @@ -4092,16 +4092,25 @@ 4092 4092 4093 4093 Тело запроса: 4094 4094 4250 +((( 4095 4095 { 4096 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4097 - " Balance": 04252 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4253 + "amount": 0 ~/~/ Сумма списания с баланса 4098 4098 } 4255 +))) 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" %)Значение баланса 4259 +((( 4260 +{ 4261 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4262 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4263 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4264 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4265 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4266 + "Description": "string" ~/~/ Описание корректировки 4267 +} 4268 +))) 4105 4105 4106 4106 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4107 4107 ... ... @@ -4112,28 +4112,35 @@ 4112 4112 4113 4113 Тело запроса: 4114 4114 4279 +((( 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, 4281 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4282 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4283 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4284 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4285 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4286 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4123 4123 } 4288 +))) 4124 4124 4290 +((( 4291 + 4292 +))) 4293 + 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 -Отсрочка, количество дней 4296 +((( 4297 +{ 4298 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4299 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4300 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4301 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4302 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4303 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4304 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4305 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4306 +} 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": [ 4319 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4320 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4321 + "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 4323 + "Feature": "string", ~/~/ Код услуги. 4324 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4325 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4326 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4327 + "Price": 0, ~/~/ Цена за единицу. 4328 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4329 + "PeriodValue": 0, ~/~/ Значение периода. 4330 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4160 4160 } 4161 4161 ] 4162 4162 } 4163 4163 4335 + 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 - Месяцы 4338 +((( 4339 +{ 4340 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4341 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4342 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4343 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4344 + "Name": "string", ~/~/ Наименование. 4345 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4346 + "Constraint": { ~/~/ Ограничения по тарифу 4347 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4348 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4349 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4350 + }, 4351 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4352 + { 4353 + "Feature": "string", ~/~/Код услуги. 4354 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4355 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4356 + "Price": 0, ~/~/ Цена за единицу. 4357 + "PeriodValue": 0, ~/~/ Значение периода. 4358 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4359 + } 4360 + ], 4361 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4362 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4363 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4364 + }, 4365 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4366 + { 4367 + "Feature": "string", ~/~/ Код услуги. 4368 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4369 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4370 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4371 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4372 + "Price": 0, ~/~/ Цена за единицу. 4373 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4374 + "PeriodValue": 0, ~/~/ Значение периода. 4375 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4376 + "Quantity": 0 ~/~/ Количество использования услуги. 4377 + } 4378 + ] 4379 +} 4380 +))) 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 4485 +== **Импортировать историю ТС (Асинхронный запрос)** == 4486 + 4487 +(% class="box successmessage" %) 4488 +((( 4489 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4490 +))) 4491 + 4492 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4493 + 4494 +Метод запроса: **POST** 4495 + 4496 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4497 + 4498 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4499 + 4500 + 4501 +Ответ: 4502 + 4503 +{ 4504 + 4505 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4506 + 4507 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4508 + 4509 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4510 + 4511 + "Message": "string", ~/~/ Информация о выполнении запроса 4512 + 4513 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4514 + 4515 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4516 + 4517 + "Data": "string" ~/~/ Данные 4518 + 4519 +} 4520 + 4521 + 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 ТС 4539 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4540 +**Параметр** 4541 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4542 +**Описание** 4543 +))) 4544 +|((( 4545 +activity 4546 +)))|((( 4547 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4548 +))) 4549 +|((( 4550 +progress 4551 +)))|((( 4552 +Guid ТС 4553 +))) 4301 4301 4555 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4556 + 4557 +(% class="box infomessage" %) 4558 +((( 4559 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4560 +))) 4561 + 4562 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4563 + 4564 +Метод запроса: **GET** 4565 + 4566 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4567 + 4568 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4569 + 4570 + 4571 +Ответ: 4572 + 4573 +{ 4574 + 4575 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4576 + 4577 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4578 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4579 + 4580 + "Message": "string", ~/~/ Информация о выполнении запроса 4581 + 4582 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4583 + 4584 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4585 + 4586 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4587 + 4588 + "Data": "string" ~/~/ Данные 4589 + 4590 +} 4591 + 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 } 5103 + 5104 + 5105 +== **Превышение скорости** == 5106 + 5107 +(% class="box infomessage" %) 5108 +((( 5109 +**POST /api/v3/Reports/overSpeedDuration** 4813 4813 ))) 4814 4814 5112 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5113 + 5114 +Пример запроса: 5115 + 5116 +((( 5117 +{ 5118 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5119 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5120 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5121 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5122 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5123 +} 5124 +))) 5125 + 5126 +((( 5127 + 5128 +))) 5129 + 5130 +((( 5131 +Пример ответа: 5132 +))) 5133 + 5134 +((( 5135 +((( 5136 +[ 5137 + { 5138 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5139 + "duration": 0, ~/~/ Продолжительность события в секундах 5140 + "maxSpeed": 0, ~/~/ Максимальная скорость 5141 + "speedLimit": 0 ~/~/ Ограничение скорости 5142 + } 5143 +] 5144 +))) 5145 +))) 5146 +))) 5147 + 4815 4815 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4816 4816 4817 4817 ... ... @@ -5816,6 +5816,62 @@ 5816 5816 ))) 5817 5817 5818 5818 6152 += **Раздел: Роли** = 6153 + 6154 +== **Получение списка клиентских и системных ролей пользователя ** == 6155 + 6156 +(% class="box successmessage" %) 6157 +((( 6158 +**POST /api/v3/groups/find** 6159 +))) 6160 + 6161 +Пример запроса: 6162 + 6163 +((( 6164 +{ 6165 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6166 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6167 +} 6168 +))) 6169 + 6170 +((( 6171 + 6172 +))) 6173 + 6174 +((( 6175 +Пример ответа: 6176 +))) 6177 + 6178 +((( 6179 +((( 6180 +{ 6181 + "groups": [ ~/~/ Системные роли пользователя 6182 + { 6183 + "code": "string", ~/~/ Код роли. 6184 + "name": "string", ~/~/ Имя 6185 + "shortName": "string" ~/~/ Короткое имя 6186 + } 6187 + ], 6188 + "customGroups": [ ~/~/ Системные роли пользователя 6189 + { 6190 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6191 + "name": "string", ~/~/ Наименование 6192 + "shortName": "string", ~/~/ Короткое наименование 6193 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6194 + } 6195 + ] 6196 +} 6197 +))) 6198 +))) 6199 + 6200 +((( 6201 + 6202 +))) 6203 + 6204 +((( 6205 + 6206 +))) 6207 + 5819 5819 = **Раздел: Локатор ** = 5820 5820 5821 5821 ... ... @@ -5823,7 +5823,7 @@ 5823 5823 5824 5824 (% class="box infomessage" %) 5825 5825 ((( 5826 -**GET /api/v3/locators** 6215 +**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 -] 6224 +((( 6225 +{ 6226 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6227 + 0 6228 + ], 6229 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6230 + 0 6231 + ], 6232 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6233 + 0 6234 + ], 6235 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6236 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6237 + "agentName": "string", ~/~/ Наименование агента. 6238 + "isEnabled": true, ~/~/ Активность 6239 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6240 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6241 + "name": "string", ~/~/ Наименование. 6242 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6243 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6244 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6245 + "validity": 0, ~/~/ Значение срока действия 6246 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6247 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6248 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6249 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6250 + "url": "string", ~/~/ Ссылка 6251 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6252 + "showVehicleName": true, ~/~/ Наименование объекта 6253 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6254 + "allowTrackReport": true, ~/~/ Трек 6255 + "showTrackTracing": true, ~/~/ Трассировка трека 6256 + "showSensors": true, ~/~/ Датчик 6257 + "availableMapLayers": [ ~/~/ Слои на карте 6258 + 0 6259 + ] 6260 +} 5858 5858 ))) 6262 +))) 5859 5859 5860 5860 6265 +((( 6266 +((( 6267 + 6268 +))) 6269 +))) 5861 5861 6271 + 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 ~/~/ Язык 6289 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6290 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6291 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6292 + 0 6293 + ], 6294 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6295 + 0 6296 + ], 6297 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6298 + 0 6299 + ], 6300 + "showVehicleName": true, ~/~/ Наименование объекта 6301 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6302 + "allowTrackReport": true, ~/~/ Трек 6303 + "showTrackTracing": true, ~/~/ Трассировка трека 6304 + "showSensors": true, ~/~/ Датчик 6305 + "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ГИС) 6306 + ] 5882 5882 } 5883 5883 ))) 5884 5884 ... ... @@ -5890,7 +5890,95 @@ 5890 5890 ))) 5891 5891 5892 5892 6318 +== **Выводит список локаторов ** == 5893 5893 6320 +(% class="box successmessage" %) 6321 +((( 6322 +**POST /api/v3/locators/find** 6323 +))) 6324 + 6325 +Пример запроса: 6326 + 6327 +((( 6328 +{ 6329 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6330 +} 6331 +))) 6332 + 6333 +((( 6334 + 6335 +))) 6336 + 6337 +((( 6338 +{ 6339 + "isEnabled": true, ~/~/ Активность 6340 + "name": "string", ~/~/ Наименование локатора 6341 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6342 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6343 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6344 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6345 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6346 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6347 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6348 + 0 6349 + ], 6350 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6351 + 0 6352 + ], 6353 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6354 + 0 6355 + ], 6356 + "showVehicleName": true, ~/~/ Наименование объекта 6357 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6358 + "allowTrackReport": true, ~/~/ Трек 6359 + "showTrackTracing": true, ~/~/ Трассировка трека 6360 + "showSensors": true, ~/~/ Датчик 6361 + "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ГИС) 6362 + ] 6363 +} 6364 +))) 6365 + 6366 + 6367 +Пример ответа: 6368 + 6369 +((( 6370 +[ 6371 + { 6372 + "vehiclesCount": 0, ~/~/ Количество объектов. 6373 + "geozonesCount": 0, ~/~/ Количество геозон. 6374 + "fieldsCount": 0, ~/~/ Количество полей. 6375 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6376 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6377 + "agentName": "string", ~/~/ Наименование агента. 6378 + "isEnabled": true, ~/~/ Активность локатора 6379 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6380 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6381 + "name": "string", ~/~/ Наименование локатора 6382 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6383 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6384 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6385 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6386 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6387 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6388 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6389 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6390 + "url": "string", ~/~/ ссылка на локатор 6391 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6392 + "showVehicleName": true, ~/~/ Наименование объекта 6393 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6394 + "allowTrackReport": true, ~/~/ Трек 6395 + "showTrackTracing": true, ~/~/ Трассировка трека 6396 + "showSensors": true, ~/~/ Датчик 6397 + "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ГИС) 6398 + 6399 + 0 6400 + ] 6401 + } 6402 +] 6403 +))) 6404 + 6405 + 6406 + 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 ~/~/ Язык 6425 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6426 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6427 + 0 6428 + ], 6429 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6430 + 0 6431 + ], 6432 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6433 + 0 6434 + ], 6435 + "showVehicleName": true, ~/~/ Наименование объекта 6436 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6437 + "allowTrackReport": true, ~/~/ Трек 6438 + "showTrackTracing": true, ~/~/ Трассировка трека 6439 + "showSensors": true, ~/~/ Датчик 6440 + "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ГИС) 6441 + ] 5914 5914 } 6443 + 6444 + 5915 5915 ))) 5916 5916 5917 - 5918 5918 Пример ответа: 5919 5919 5920 5920 200 ~/~/ Success ... ... @@ -6079,6 +6079,74 @@ 6079 6079 6080 6080 6081 6081 6611 += **Раздел: Управление доступа к машинам** = 6612 + 6613 + 6614 +== Получение списка транспортных средств видимых пользователю == 6615 + 6616 +(% class="box infomessage" %) 6617 +((( 6618 +**GET /api/v3/UserVisibleVehicles/{userId}** 6619 +))) 6620 + 6621 +Пример ответа: 6622 + 6623 +((( 6624 +{ 6625 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6626 + 0 6627 + ] 6628 +} 6629 +))) 6630 + 6631 + 6632 + 6633 +== Задает видимость транспортных средств пользователю == 6634 + 6635 +(% class="box infomessage" %) 6636 +((( 6637 +**POST /api/v3/UserVisibleVehicles** 6638 +))) 6639 + 6640 +Пример запроса: 6641 + 6642 +((( 6643 +((( 6644 +{ 6645 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6646 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6647 + 0 6648 + ] 6649 +} 6650 +))) 6651 + 6652 +((( 6653 + 6654 +))) 6655 + 6656 +((( 6657 + 6658 +))) 6659 + 6660 +((( 6661 +Пример ответа : 6662 +))) 6663 + 6664 +((( 6665 + 6666 +))) 6667 + 6668 +((( 6669 +200 ~/~/ Success 6670 +))) 6671 +))) 6672 + 6673 + 6674 +== == 6675 + 6676 + 6677 + 6678 + 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]] **