Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/06/27 16:12
<
>
edited by Андрей Калиновский
on 2025/03/25 14:48
on 2025/03/25 14:48
edited by Андрей Калиновский
on 2025/06/27 13:52
on 2025/06/27 13:52
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" %)Идентификатор клиента-родителя ... ... @@ -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,880 + "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,899 + "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" %)Метод позволяет изменить статус пользователя, указанного в запросе.933 +(% 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" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.1000 +(% 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, ~/~/ Уровень топлива на конец периода 2458 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2459 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2518 2518 "fuelConsumption": 0, ~/~/ Расход топлива 2519 2519 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2520 2520 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне ... ... @@ -2794,6 +2794,35 @@ 2794 2794 } 2795 2795 ] 2796 2796 2739 + 2740 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2741 + 2742 +(% class="box successmessage" %) 2743 +((( 2744 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2745 +))) 2746 + 2747 +(% style="color:#000000" %)Метод запроса: **PUT** 2748 + 2749 +Пример запроса: 2750 + 2751 +((( 2752 +{ 2753 + "id": 0, ~/~/ Идентификатор объекта геозоны 2754 + "name": "string", ~/~/ Наименование объекта геозоны 2755 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2756 + "description": "string", ~/~/ Описание объекта геозоны 2757 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2758 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2759 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2760 +} 2761 +))) 2762 + 2763 + 2764 +Пример ответа: 2765 + 2766 +200 ~/~/ Success 2767 + 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 - Выполнение ТО 2799 + "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 2806 + 2807 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2808 + 2809 +(% class="box infomessage" %) 2810 +((( 2811 +**POST /api/v3/notifications** 2812 +))) 2813 + 2814 +Метод запроса **POST** 2815 + 2816 +(% style="text-align: left;" %) 2817 +(% style="color:#000000" %)Пример запроса 2818 + 2819 +((( 2820 +{ 2821 + "id": 0, ~/~/ ID правила 2822 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2823 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2824 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2825 + "name": "string", ~/~/ Имя правила 2826 + "active": true, ~/~/ Активность правила 2827 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2828 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2829 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2830 + ], 2831 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2832 + 0 2833 + ], 2834 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2835 + 0 2836 + ], 2837 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2838 + 0 2839 + ], 2840 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2841 + "additionalProp1": "string", 2842 + "additionalProp2": "string", 2843 + "additionalProp3": "string" 2844 + }, 2845 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2846 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2847 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2848 + ], 2849 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2850 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2851 + "string" 2852 + ], 2853 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2854 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2855 + { 2856 + "id": 0, ~/~/ Идентификатор участника чата. 2857 + "info": "string" ~/~/ Дополнительные сведения. 2858 + } 2859 + ], 2860 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2861 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2862 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2863 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2864 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2865 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2866 + "timezone": 0, ~/~/ часовой пояс 2867 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2868 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2869 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2870 + { 2871 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2872 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2873 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2874 + "additionalProp1": "string", 2875 + "additionalProp2": "string", 2876 + "additionalProp3": "string" 2877 + } 2878 + } 2879 + ] 2880 +} 2881 +))) 2882 + 2883 +((( 2884 + 2885 +))) 2886 + 2887 +((( 2888 + 2889 +))) 2890 + 2891 +Ответ: 2892 + 2893 +{ 2894 + "id": 0, ~/~/ ID правила 2895 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2896 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2897 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2898 + "name": "string", ~/~/ Имя правила 2899 + "active": true, ~/~/ Активность правила 2900 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2901 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2902 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2903 + ], 2904 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2905 + 0 2906 + ], 2907 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2908 + 0 2909 + ], 2910 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2911 + 0 2912 + ], 2913 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2914 + "additionalProp1": "string", 2915 + "additionalProp2": "string", 2916 + "additionalProp3": "string" 2917 + }, 2918 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2919 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2920 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2921 + ], 2922 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2923 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2924 + "string" 2925 + ], 2926 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2927 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2928 + { 2929 + "id": 0, ~/~/ Идентификатор участника чата. 2930 + "info": "string" ~/~/ Дополнительные сведения. 2931 + } 2932 + ], 2933 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2934 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2935 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2936 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2937 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2938 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2939 + "timezone": 0, ~/~/ часовой пояс 2940 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2941 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2942 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2943 + { 2944 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2945 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2946 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2947 + "additionalProp1": "string", 2948 + "additionalProp2": "string", 2949 + "additionalProp3": "string" 2950 + } 2951 + } 2952 + ] 2953 +} 2954 + 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 4172 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4173 + "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 4189 +((( 4073 4073 { 4074 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4075 - " Balance": 04191 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4192 + "amount": 0 ~/~/ Сумма пополнения баланса 4076 4076 } 4194 +))) 4077 4077 4196 +((( 4197 + 4198 +))) 4199 + 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" %)Значение баланса 4202 +((( 4203 +{ 4204 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4205 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4206 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4207 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4208 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4209 + "Description": "string" ~/~/ Описание корректировки. 4210 +} 4211 +))) 4083 4083 4084 4084 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4085 4085 ... ... @@ -4092,16 +4092,25 @@ 4092 4092 4093 4093 Тело запроса: 4094 4094 4224 +((( 4095 4095 { 4096 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4097 - " Balance": 04226 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4227 + "amount": 0 ~/~/ Сумма списания с баланса 4098 4098 } 4229 +))) 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" %)Значение баланса 4233 +((( 4234 +{ 4235 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4236 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4237 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4238 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4239 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4240 + "Description": "string" ~/~/ Описание корректировки 4241 +} 4242 +))) 4105 4105 4106 4106 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4107 4107 ... ... @@ -4112,28 +4112,35 @@ 4112 4112 4113 4113 Тело запроса: 4114 4114 4253 +((( 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, 4255 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4256 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4257 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4258 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4259 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4260 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4123 4123 } 4262 +))) 4124 4124 4264 +((( 4265 + 4266 +))) 4267 + 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 -Отсрочка, количество дней 4270 +((( 4271 +{ 4272 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4273 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4274 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4275 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4276 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4277 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4278 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4279 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4280 +} 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": [ 4293 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4294 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4295 + "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 4297 + "Feature": "string", ~/~/ Код услуги. 4298 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4299 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4300 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4301 + "Price": 0, ~/~/ Цена за единицу. 4302 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4303 + "PeriodValue": 0, ~/~/ Значение периода. 4304 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4160 4160 } 4161 4161 ] 4162 4162 } 4163 4163 4309 + 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 - Месяцы 4312 +((( 4313 +{ 4314 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4315 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4316 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4317 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4318 + "Name": "string", ~/~/ Наименование. 4319 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4320 + "Constraint": { ~/~/ Ограничения по тарифу 4321 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4322 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4323 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4324 + }, 4325 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4326 + { 4327 + "Feature": "string", ~/~/Код услуги. 4328 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4329 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4330 + "Price": 0, ~/~/ Цена за единицу. 4331 + "PeriodValue": 0, ~/~/ Значение периода. 4332 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4333 + } 4334 + ], 4335 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4336 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4337 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4338 + }, 4339 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4340 + { 4341 + "Feature": "string", ~/~/ Код услуги. 4342 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4343 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4344 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4345 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4346 + "Price": 0, ~/~/ Цена за единицу. 4347 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4348 + "PeriodValue": 0, ~/~/ Значение периода. 4349 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4350 + "Quantity": 0 ~/~/ Количество использования услуги. 4351 + } 4352 + ] 4353 +} 4354 +))) 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 4459 +== **Импортировать историю ТС (Асинхронный запрос)** == 4460 + 4461 +(% class="box successmessage" %) 4462 +((( 4463 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4464 +))) 4465 + 4466 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4467 + 4468 +Метод запроса: **POST** 4469 + 4470 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4471 + 4472 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4473 + 4474 + 4475 +Ответ: 4476 + 4477 +{ 4478 + 4479 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4480 + 4481 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4482 + 4483 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4484 + 4485 + "Message": "string", ~/~/ Информация о выполнении запроса 4486 + 4487 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4488 + 4489 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4490 + 4491 + "Data": "string" ~/~/ Данные 4492 + 4493 +} 4494 + 4495 + 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 ТС 4513 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4514 +**Параметр** 4515 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4516 +**Описание** 4517 +))) 4518 +|((( 4519 +activity 4520 +)))|((( 4521 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4522 +))) 4523 +|((( 4524 +progress 4525 +)))|((( 4526 +Guid ТС 4527 +))) 4301 4301 4529 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4530 + 4531 +(% class="box infomessage" %) 4532 +((( 4533 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4534 +))) 4535 + 4536 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4537 + 4538 +Метод запроса: **GET** 4539 + 4540 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4541 + 4542 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4543 + 4544 + 4545 +Ответ: 4546 + 4547 +{ 4548 + 4549 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4550 + 4551 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4552 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4553 + 4554 + "Message": "string", ~/~/ Информация о выполнении запроса 4555 + 4556 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4557 + 4558 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4559 + 4560 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4561 + 4562 + "Data": "string" ~/~/ Данные 4563 + 4564 +} 4565 + 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 } 5077 + 5078 + 5079 +== **Превышение скорости** == 5080 + 5081 +(% class="box infomessage" %) 5082 +((( 5083 +**POST /api/v3/Reports/overSpeedDuration** 4813 4813 ))) 4814 4814 5086 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5087 + 5088 +Пример запроса: 5089 + 5090 +((( 5091 +{ 5092 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5093 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5094 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5095 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5096 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5097 +} 5098 +))) 5099 + 5100 +((( 5101 + 5102 +))) 5103 + 5104 +((( 5105 +Пример ответа: 5106 +))) 5107 + 5108 +((( 5109 +((( 5110 +[ 5111 + { 5112 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5113 + "duration": 0, ~/~/ Продолжительность события в секундах 5114 + "maxSpeed": 0, ~/~/ Максимальная скорость 5115 + "speedLimit": 0 ~/~/ Ограничение скорости 5116 + } 5117 +] 5118 +))) 5119 +))) 5120 +))) 5121 + 4815 4815 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4816 4816 4817 4817 ... ... @@ -5816,6 +5816,62 @@ 5816 5816 ))) 5817 5817 5818 5818 6126 += **Раздел: Роли** = 6127 + 6128 +== **Получение списка клиентских и системных ролей пользователя ** == 6129 + 6130 +(% class="box successmessage" %) 6131 +((( 6132 +**POST /api/v3/groups/find** 6133 +))) 6134 + 6135 +Пример запроса: 6136 + 6137 +((( 6138 +{ 6139 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6140 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6141 +} 6142 +))) 6143 + 6144 +((( 6145 + 6146 +))) 6147 + 6148 +((( 6149 +Пример ответа: 6150 +))) 6151 + 6152 +((( 6153 +((( 6154 +{ 6155 + "groups": [ ~/~/ Системные роли пользователя 6156 + { 6157 + "code": "string", ~/~/ Код роли. 6158 + "name": "string", ~/~/ Имя 6159 + "shortName": "string" ~/~/ Короткое имя 6160 + } 6161 + ], 6162 + "customGroups": [ ~/~/ Системные роли пользователя 6163 + { 6164 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6165 + "name": "string", ~/~/ Наименование 6166 + "shortName": "string", ~/~/ Короткое наименование 6167 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6168 + } 6169 + ] 6170 +} 6171 +))) 6172 +))) 6173 + 6174 +((( 6175 + 6176 +))) 6177 + 6178 +((( 6179 + 6180 +))) 6181 + 5819 5819 = **Раздел: Локатор ** = 5820 5820 5821 5821 ... ... @@ -5823,7 +5823,7 @@ 5823 5823 5824 5824 (% class="box infomessage" %) 5825 5825 ((( 5826 -**GET /api/v3/locators** 6189 +**GET /api/v3/locators ** 5827 5827 ))) 5828 5828 5829 5829 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -5832,33 +5832,83 @@ 5832 5832 Пример ответа: 5833 5833 5834 5834 ((( 6198 +((( 6199 +{ 6200 + "vehiclesIds": [ ~/~/ Объекты 6201 + 0 6202 + ], 6203 + "geoIds": [ ~/~/ Геозоны 6204 + 0 6205 + ], 6206 + "fieldsIds": [ ~/~/ Поля 6207 + 0 6208 + ], 6209 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6210 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6211 + "agentName": "string", ~/~/ Наименование агента. 6212 + "isEnabled": true, ~/~/ Активность 6213 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6214 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6215 + "name": "string", ~/~/ Наименование. 6216 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6217 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6218 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6219 + "validity": 0, ~/~/ Значение срока действия 6220 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6221 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6222 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6223 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6224 + "url": "string", ~/~/ Ссылка 6225 + "language": 0, ~/~/ Язык 6226 + "showVehicleName": true, ~/~/ Наименование объекта 6227 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6228 + "allowTrackReport": true, ~/~/ Трек 6229 + "showTrackTracing": true, ~/~/ Трассировка трека 6230 + "showSensors": true, ~/~/ Датчик 6231 + "availableMapLayers": [ ~/~/ Слои на карте 6232 + 0 6233 + ] 6234 +} 6235 +))) 6236 +))) 6237 + 6238 + 6239 +== **Получение перечня моделей ** == 6240 + 6241 +(% class="box successmessage" %) 6242 +((( 6243 +**POST /api/v3/models/find** 6244 +))) 6245 + 6246 +Пример запроса: 6247 + 6248 +((( 6249 +((( 6250 +{ 6251 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6252 + "name": "string", ~/~/ Наименование локатора 6253 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6254 +))) 6255 + 6256 + 6257 + 6258 + Пример ответа: 6259 + 6260 + 6261 +((( 5835 5835 [ 5836 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 ~/~/ Количество полей. 6264 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6265 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6266 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6267 + "name": "string", ~/~/ Наименование локатора 6268 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 5856 5856 } 5857 5857 ] 5858 5858 ))) 6272 +))) 5859 5859 5860 5860 5861 - 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 ~/~/ Язык 6292 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6293 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6294 + "vehiclesIds": [ ~/~/ Oбъекты 6295 + 0 6296 + ], 6297 + "geoIds": [ ~/~/ Геозоны 6298 + 0 6299 + ], 6300 + "fieldsIds": [ ~/~/ Поля 6301 + 0 6302 + ], 6303 + "showVehicleName": true, ~/~/ Наименование объекта 6304 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6305 + "allowTrackReport": true, ~/~/ Трек 6306 + "showTrackTracing": true, ~/~/ Трассировка трека 6307 + "showSensors": true, ~/~/ Датчик 6308 + "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ГИС) 6309 + ] 5882 5882 } 5883 5883 ))) 5884 5884 ... ... @@ -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 ~/~/ Язык 6340 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6341 + "vehiclesIds": [ ~/~/ Oбъекты 6342 + 0 6343 + ], 6344 + "geoIds": [ ~/~/ Геозоны 6345 + 0 6346 + ], 6347 + "fieldsIds": [ ~/~/ Поля 6348 + 0 6349 + ], 6350 + "showVehicleName": true, ~/~/ Наименование объекта 6351 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6352 + "allowTrackReport": true, ~/~/ Трек 6353 + "showTrackTracing": true, ~/~/ Трассировка трека 6354 + "showSensors": true, ~/~/ Датчик 6355 + "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ГИС) 6356 + ] 5914 5914 } 6358 + 6359 + 5915 5915 ))) 5916 5916 5917 - 5918 5918 Пример ответа: 5919 5919 5920 5920 200 ~/~/ Success ... ... @@ -6079,6 +6079,73 @@ 6079 6079 6080 6080 6081 6081 6526 += **Раздел: Управление доступа к машинам** = 6527 + 6528 + 6529 +== Получение списка транспортных средств видимых пользователю == 6530 + 6531 +(% class="box infomessage" %) 6532 +((( 6533 +**GET /api/v3/UserVisibleVehicles/{userId}** 6534 +))) 6535 + 6536 +Пример ответа: 6537 + 6538 +((( 6539 +{ 6540 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6541 + 0 6542 + ] 6543 +} 6544 +))) 6545 + 6546 + 6547 + 6548 +== Задает видимость транспортных средств пользователю == 6549 + 6550 +(% class="box infomessage" %) 6551 +((( 6552 +**POST /api/v3/UserVisibleVehicles** 6553 +))) 6554 + 6555 +Пример запроса: 6556 + 6557 +((( 6558 +((( 6559 +{ 6560 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6561 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6562 + 0 6563 + ] 6564 +} 6565 +))) 6566 + 6567 +((( 6568 + 6569 +))) 6570 + 6571 +((( 6572 + 6573 +))) 6574 + 6575 +((( 6576 +Пример ответа : 6577 +))) 6578 + 6579 +((( 6580 + 6581 +))) 6582 + 6583 +((( 6584 +200 ~/~/ Success 6585 +))) 6586 +))) 6587 + 6588 + 6589 + 6590 + 6591 + 6592 + 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]] **