Last modified by Андрей Калиновский on 2025/06/27 16:12
<
From version < 214.1 >
edited by Андрей Калиновский
on 2025/03/19 14:01
To version < 241.1 >
edited by Андрей Калиновский
on 2025/06/10 15:42
>
Change comment: There is no comment for this version

Summary

Details

Icon 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,8 +2515,12 @@
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 ~/~/ Расход топлива в движении
2462 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2463 +
2520 2520   }
2521 2521   ]
2522 2522   }
... ... @@ -2562,7 +2562,8 @@
2562 2562   "model": "string", ~/~/ Модель объекта
2563 2563   "fuels": [ ~/~/ Массив данным по заправкам и сливам
2564 2564   {
2565 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2509 + "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling
2510 +
2566 2566   "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2567 2567   "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2568 2568   "valueFuel": 0, ~/~/ Количество
... ... @@ -2791,6 +2791,35 @@
2791 2791   }
2792 2792  ]
2793 2793  
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 +
2794 2794  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2795 2795  
2796 2796  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -2822,7 +2822,7 @@
2822 2822   "id": 0, ~/~/ ID уведомления
2823 2823   "name": "string", ~/~/ Название уведомления
2824 2824   "active": true, ~/~/ Состояние true - активен, false - деактивирован
2825 - "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 - Назначение водителя) 
2826 2826   "userId": "", ~/~/ Пользователь, создавший уведомление
2827 2827   "parentId": "", ~/~/ Идентификатор клиента
2828 2828   "parentName": "string" ~/~/ Имя клиента
... ... @@ -2829,6 +2829,155 @@
2829 2829   }
2830 2830  ]
2831 2831  
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 +
2832 2832  == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2833 2833  
2834 2834  (% class="box infomessage" %)
... ... @@ -4046,16 +4046,12 @@
4046 4046  Тело запроса:
4047 4047  
4048 4048  {
4049 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4050 - "Balance": 0
4172 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4173 + "Balance": 0 ~/~/ Значение баланса.
4051 4051  }
4052 4052  
4053 4053  Ответ: Success
4054 4054  
4055 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4056 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4057 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4058 -
4059 4059  == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4060 4060  
4061 4061  (% class="box warningmessage" %)
... ... @@ -4067,16 +4067,29 @@
4067 4067  
4068 4068  Тело запроса:
4069 4069  
4189 +(((
4070 4070  {
4071 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4072 - "Balance": 0
4191 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4192 + "amount": 0 ~/~/ Сумма пополнения баланса 
4073 4073  }
4194 +)))
4074 4074  
4196 +(((
4197 +
4198 +)))
4199 +
4075 4075  Ответ: Success
4076 4076  
4077 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4078 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4079 -|(% 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 +)))
4080 4080  
4081 4081  == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4082 4082  
... ... @@ -4089,16 +4089,25 @@
4089 4089  
4090 4090  Тело запроса:
4091 4091  
4224 +(((
4092 4092  {
4093 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4094 - "Balance": 0
4226 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4227 + "amount": 0 ~/~/ Сумма списания с баланса
4095 4095  }
4229 +)))
4096 4096  
4097 4097  Ответ: Success
4098 4098  
4099 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4100 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4101 -|(% 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 +)))
4102 4102  
4103 4103  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4104 4104  
... ... @@ -4109,28 +4109,35 @@
4109 4109  
4110 4110  Тело запроса:
4111 4111  
4253 +(((
4112 4112  {
4113 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4114 - "CalculationType": 0,
4115 - "PermissibleBalance": 0,
4116 - "DefermentDays": 0,
4117 - "SendUiNotifications": true,
4118 - "SendEmailNotifications": true,
4119 - "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 - выключено
4120 4120  }
4262 +)))
4121 4121  
4264 +(((
4265 +
4266 +)))
4267 +
4122 4122  Ответ: Success
4123 4123  
4124 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4125 -|ClientId|Идентификатор клиента
4126 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4127 -|PermissibleBalance|Допустимый баланс
4128 -|DefermentDays|(((
4129 -Отсрочка, количество дней
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 +}
4130 4130  )))
4131 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4132 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4133 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4134 4134  
4135 4135  == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4136 4136  
... ... @@ -4142,35 +4142,68 @@
4142 4142  Тело запроса:
4143 4143  
4144 4144  {
4145 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4146 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4147 - "Features": [
4293 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
4294 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4295 + "Features": [ ~/~/ Набор услуг по тарифу клиента.
4148 4148   {
4149 - "Feature": "string",
4150 - "IsEnabled": true,
4151 - "IsFactual": true,
4152 - "Limit": 0,
4153 - "Price": 0,
4154 - "DebitDate": "2023-10-18T13:26:58.987Z",
4155 - "PeriodValue": 0,
4156 - "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 - Месяцы)
4157 4157   }
4158 4158   ]
4159 4159  }
4160 4160  
4309 +
4161 4161  Ответ: Success
4162 4162  
4163 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4164 -|ClientId|Идентификатор клиента
4165 -|PlanId|Идентификатор тарифного плана
4166 -|Feature|Код услуги
4167 -|IsEnabled|Признак, определяющий активирована ли услуга
4168 -|IsFactual|Признак, определяющий расчёт по факту
4169 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4170 -|Price|Цена за единицу.
4171 -|DebitDate|Следующий момент времени списания с баланса за услугу.
4172 -|PeriodValue|Значение периода.
4173 -|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 +)))
4174 4174  
4175 4175  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4176 4176  
... ... @@ -4275,6 +4275,43 @@
4275 4275  |producedCount|Кол-во успешно отправленных в шину данных сообщений
4276 4276  |msgCount|Кол-во обработанных сообщений всего
4277 4277  
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 +
4278 4278  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4279 4279  
4280 4280  (% class="box infomessage" %)
... ... @@ -4292,10 +4292,59 @@
4292 4292   "message": "string"
4293 4293  }
4294 4294  
4295 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4296 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4297 -|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 +)))
4298 4298  
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 +
4299 4299  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4300 4300  
4301 4301  (% class="box infomessage" %)
... ... @@ -4807,8 +4807,51 @@
4807 4807   }
4808 4808   ]
4809 4809  }
5077 +
5078 +
5079 +== **Превышение скорости** ==
5080 +
5081 +(% class="box infomessage" %)
5082 +(((
5083 +**POST /api/v3/Reports/overSpeedDuration**
4810 4810  )))
4811 4811  
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 +
4812 4812  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4813 4813  
4814 4814  
... ... @@ -5813,6 +5813,62 @@
5813 5813  )))
5814 5814  
5815 5815  
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 +
5816 5816  = **Раздел: Локатор ** =
5817 5817  
5818 5818  
... ... @@ -5820,7 +5820,7 @@
5820 5820  
5821 5821  (% class="box infomessage" %)
5822 5822  (((
5823 -**GET /api/v3/locators**
6189 +**GET /api/v3/locators **
5824 5824  )))
5825 5825  
5826 5826  В заголовках запроса: X-Auth: Токен авторизации
... ... @@ -5829,33 +5829,83 @@
5829 5829  Пример ответа:
5830 5830  
5831 5831  (((
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 +(((
5832 5832  [
5833 5833   {
5834 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
5835 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
5836 - "agentName": "string", ~/~/ Наименование агента.
5837 - "isEnabled": true, ~/~/ Активен 
5838 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
5839 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
5840 - "name": "string", ~/~/ Наименование
5841 - "status": 0, ~/~/ 
5842 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
5843 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 
5844 - "validity": 0, ~/~/ Срок действия в днях (1-90).
5845 - "autoProlongation": true, ~/~/ Автопродление срока действия.
5846 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
5847 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
5848 - "url": "string", ~/~/ Ссылка
5849 - "language": 0, ~/~/ Язык.
5850 - "vehiclesCount": 0, ~/~/ Количество объектов.
5851 - "geozonesCount": 0, ~/~/ Количество геозон.
5852 - "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 - Машины) 
5853 5853   }
5854 5854  ]
5855 5855  )))
6272 +)))
5856 5856  
5857 5857  
5858 -
5859 5859  == **Создание локатора** ==
5860 5860  
5861 5861  (% class="box successmessage" %)
... ... @@ -5876,6 +5876,24 @@
5876 5876   "autoProlongation": true, ~/~/ Автопродление срока действия.
5877 5877   "url": "string", ~/~/ Ссылка
5878 5878   "language": 0 ~/~/ Язык
6295 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6296 + "vehiclesIds": [ ~/~/ Oбъекты
6297 + 0
6298 + ],
6299 + "geoIds": [ ~/~/ Геозоны
6300 + 0
6301 + ],
6302 + "fieldsIds": [ ~/~/ Поля
6303 + 0
6304 + ],
6305 + "showVehicleName": true, ~/~/ Наименование объекта
6306 + "showVehicleDirection": true, ~/~/ Направление движения на треке
6307 + "allowTrackReport": true, ~/~/ Трек
6308 + "showTrackTracing": true, ~/~/ Трассировка трека
6309 + "showSensors": true, ~/~/ Датчик
6310 + "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
6311 + 0
6312 + ]
5879 5879  }
5880 5880  )))
5881 5881  
... ... @@ -5908,10 +5908,29 @@
5908 5908   "autoProlongation": true, ~/~/ Автопродление срока действия
5909 5909   "url": "string", ~/~/ Ссылка
5910 5910   "language": 0 ~/~/ Язык
6345 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6346 + "vehiclesIds": [ ~/~/ Oбъекты
6347 + 0
6348 + ],
6349 + "geoIds": [ ~/~/ Геозоны
6350 + 0
6351 + ],
6352 + "fieldsIds": [ ~/~/ Поля
6353 + 0
6354 + ],
6355 + "showVehicleName": true, ~/~/ Наименование объекта
6356 + "showVehicleDirection": true, ~/~/ Направление движения на треке
6357 + "allowTrackReport": true, ~/~/ Трек
6358 + "showTrackTracing": true, ~/~/ Трассировка трека
6359 + "showSensors": true, ~/~/ Датчик
6360 + "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
6361 + 0
6362 + ]
5911 5911  }
6364 +
6365 +
5912 5912  )))
5913 5913  
5914 -
5915 5915  Пример ответа:
5916 5916  
5917 5917  200 ~/~/ Success
... ... @@ -5934,7 +5934,215 @@
5934 5934  
5935 5935  
5936 5936  
6390 += **Раздел: Яндекс Маршруты** =
5937 5937  
6392 +
6393 +== **Возвращение списка маршрутов** ==
6394 +
6395 +(% class="box infomessage" %)
6396 +(((
6397 +**GET /api/v3/TransportRoutes**
6398 +)))
6399 +
6400 +Пример запроса:
6401 +Id  ~/~/ Идентификатор поля
6402 +
6403 +
6404 +Пример ответа:
6405 +
6406 +(((
6407 +[
6408 + {
6409 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6410 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6411 + "name": "string", ~/~/ Наименование маршрута.
6412 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6413 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6414 + 0
6415 + ]
6416 + }
6417 +]
6418 +)))
6419 +
6420 +
6421 +
6422 +== **Добавить маршрут** ==
6423 +
6424 +(% class="box infomessage" %)
6425 +(((
6426 +**POST /api/v3/TransportRoutes**
6427 +)))
6428 +
6429 +Пример запроса: 
6430 +{
6431 + "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6432 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6433 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6434 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6435 + 0
6436 + ]
6437 +}
6438 +
6439 +
6440 +Пример ответа:
6441 +
6442 +(((
6443 +{
6444 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6445 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6446 + "name": "string", ~/~/ Определяет наименование маршрута 
6447 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6448 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6449 + 0
6450 + ]
6451 +}
6452 +)))
6453 +
6454 +
6455 +== **Обновление маршрута** ==
6456 +
6457 +(% class="box successmessage" %)
6458 +(((
6459 +**PUT /api/v3/TransportRoutes**
6460 +)))
6461 +
6462 +Пример запроса:
6463 +
6464 +(((
6465 +{
6466 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6467 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6468 + "name": "string", ~/~/ Опредлеляет наименование маршрута.
6469 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6470 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6471 + 0
6472 + ]
6473 +}
6474 +)))
6475 +
6476 +
6477 +Пример ответа:
6478 +
6479 +(((
6480 +{
6481 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6482 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6483 + "name": "string", ~/~/ Определяет наименование маршрута 
6484 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6485 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6486 + 0
6487 + ]
6488 +}
6489 +)))
6490 +
6491 +
6492 +== **Получить связки маршрутов ТС** ==
6493 +
6494 +(% class="box infomessage" %)
6495 +(((
6496 +**POST /api/v3/TransportRoutes/getroutesvehicles**
6497 +)))
6498 +
6499 +Пример запроса:
6500 +
6501 +(((
6502 +[
6503 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6504 +]
6505 +)))
6506 +
6507 +
6508 +Пример ответа:
6509 +
6510 +(((
6511 +[
6512 + {
6513 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6514 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6515 + }
6516 +]
6517 +)))
6518 +
6519 +
6520 +== **Удалить маршрут** ==
6521 +
6522 +(% class="box warningmessage" %)
6523 +(((
6524 +**DELETE /api/v3/TransportRoutes/{id}**
6525 +)))
6526 +
6527 +Пример запроса:
6528 +Id  ~/~/ Идентификатор поля
6529 +
6530 +
6531 +
6532 += **Раздел: Управление доступа к машинам** =
6533 +
6534 +
6535 +== Получение списка транспортных средств видимых пользователю ==
6536 +
6537 +(% class="box infomessage" %)
6538 +(((
6539 +**GET /api/v3/UserVisibleVehicles/{userId}**
6540 +)))
6541 +
6542 +Пример ответа:
6543 +
6544 +(((
6545 +{
6546 + "vehicleIds": [  ~/~/ Идентификаторы ТС
6547 + 0
6548 + ]
6549 +}
6550 +)))
6551 +
6552 +
6553 +
6554 +== Задает видимость транспортных средств пользователю ==
6555 +
6556 +(% class="box infomessage" %)
6557 +(((
6558 +**POST /api/v3/UserVisibleVehicles**
6559 +)))
6560 +
6561 +Пример запроса:
6562 +
6563 +(((
6564 +(((
6565 +{
6566 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6567 + "vehicleIds": [ ~/~/ Идентификаторы ТС
6568 + 0
6569 + ]
6570 +}
6571 +)))
6572 +
6573 +(((
6574 +
6575 +)))
6576 +
6577 +(((
6578 +
6579 +)))
6580 +
6581 +(((
6582 +Пример ответа :
6583 +)))
6584 +
6585 +(((
6586 +
6587 +)))
6588 +
6589 +(((
6590 +200 ~/~/ Success
6591 +)))
6592 +)))
6593 +
6594 +
6595 +
6596 +
6597 +
6598 +
5938 5938  (% class="box" lang="en-US" style="text-align: center;" %)
5939 5939  (((
5940 5940  (% 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]] **

Меню

ГЛОНАССSoft wiki - 2024 г.