Редактировал(а) Андрей Калиновский 2025/07/29 15:51

<
От версии < 227.1 >
отредактировано Андрей Калиновский
на 2025/05/06 11:45
К версии < 253.2 >
отредактировано Андрей Калиновский
на 2025/07/29 15:51
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Icon Свойства страницы
Содержимое
... ... @@ -287,28 +287,6 @@
287 287   "bankKS": "string" ~/~/ корр. счёт
288 288  }
289 289  
290 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
291 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
292 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
293 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
294 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
295 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
296 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
297 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
298 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
299 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
300 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
301 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
302 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
303 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
304 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
305 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
306 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
307 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
308 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
309 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
310 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
311 -
312 312  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
313 313  
314 314  (% class="box warningmessage" %)
... ... @@ -454,7 +454,7 @@
454 454   [
455 455   "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
456 456   ],
457 - "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
435 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
458 458  }
459 459  {
460 460   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -766,6 +766,11 @@
766 766  (% style="text-align:left" %)
767 767  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
768 768  
747 +(% class="wikigeneratedid" id="H" %)
748 +(((
749 +
750 +)))
751 +
769 769  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
770 770  
771 771  == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
... ... @@ -877,7 +877,7 @@
877 877  {
878 878   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
879 879   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
880 - "deleted": true,
863 + "deleted": false,
881 881   "extId": "string",
882 882   "name": "string",
883 883   "picture": "string",
... ... @@ -896,7 +896,7 @@
896 896  {
897 897   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
898 898   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
899 - "deleted": true,
882 + "deleted": false,
900 900   "extId": "string",
901 901   "name": "string",
902 902   "picture": "string",
... ... @@ -930,7 +930,7 @@
930 930  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
931 931  )))
932 932  
933 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
916 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
934 934  
935 935  (% style="color:#000000" %)Метод запроса: **PUT**
936 936  
... ... @@ -997,7 +997,7 @@
997 997  (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
998 998  )))
999 999  
1000 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
983 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
1001 1001  
1002 1002  (% style="color:#000000" %)Метод запроса: **DELETE**
1003 1003  
... ... @@ -1628,7 +1628,7 @@
1628 1628  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1629 1629  
1630 1630  
1631 -(% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**
1614 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1632 1632  
1633 1633  (% class="box infomessage" %)
1634 1634  (((
... ... @@ -1773,7 +1773,6 @@
1773 1773   "stage": "", ~/~/ Состояние
1774 1774  (% style="color:#000000" %) }
1775 1775  
1776 -== ==
1777 1777  
1778 1778  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1779 1779  
... ... @@ -2390,7 +2390,7 @@
2390 2390  Тело запроса:
2391 2391  
2392 2392  {
2393 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2375 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2394 2394   "vehicleIds": [0], ~/~/ Список ID объектов
2395 2395   "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2396 2396   "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
... ... @@ -2437,7 +2437,7 @@
2437 2437  Тело запроса:
2438 2438  
2439 2439  {
2440 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2422 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2441 2441   "vehicleIds": [0], ~/~/ Список ID объектов
2442 2442   "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2443 2443   "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
... ... @@ -2456,6 +2456,8 @@
2456 2456   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2457 2457   "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2458 2458   "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2441 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
2442 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
2459 2459   "fuelConsumption": 0, ~/~/ Расход топлива
2460 2460   "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2461 2461   "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
... ... @@ -2585,26 +2585,50 @@
2585 2585  В заголовках запроса: X-Auth: Токен авторизации
2586 2586  
2587 2587  
2588 теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2572 массиве указываем id объектов через запятую
2589 2589  
2590 2590  Ответ:
2575 +
2576 +[
2591 2591   {
2592 - "vehicleId": 0, ~/~/Идентификатор объекта.
2593 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2594 - "vehicleNumber": "string",~/~/Номер объекта.
2595 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2596 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2597 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2598 - "speed": 0,~/~/Скорость объекта.
2599 - "course": 0,~/~/Курс движения [0;360]
2600 - "latitude": 0,~/~/Широта [-90°;90°].
2601 - "longitude": 0,~/~/Долгота [-180°;180°].
2602 - "address": "string",~/~/Адрес.
2603 - "geozones": [ ~/~/Сведения по геозонам.
2578 + "vehicleId": 55728, ~/~/ Идентификатор объекта 
2579 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 
2580 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 
2581 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 
2582 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 
2583 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2584 + "speed": 31, ~/~/ Скорость объекта 
2585 + "course": 116, ~/~/ Курс движения [0;360]
2586 + "latitude": 45.722128, ~/~/ Широта [-90°;90°].
2587 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°].
2588 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 
2589 + "geozones": [ ~/~/ Сведения по геозонам. 
2604 2604   {
2605 - "id": 0,
2606 - "name": "string"
2591 + "id": 10225647, ~/~/ ID Геозоны 
2592 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2593 + },
2594 + {
2595 + "id": 10282875, ~/~/ ID Геозоны 
2596 + "name": "Ё2" ~/~/ Наименование геозоны 
2597 + },
2598 + {
2599 + "id": 10226240, ~/~/ ID Геозоны 
2600 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2601 + },
2602 + {
2603 + "id": 9747869, ~/~/ ID Геозоны 
2604 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2605 + },
2606 + {
2607 + "id": 10221123, ~/~/ ID Геозоны 
2608 + "name": "53r" ~/~/ Наименование геозоны 
2609 + },
2610 + {
2611 + "id": 10197638, ~/~/ ID Геозоны 
2612 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2607 2607   }
2614 + ]
2615 + }
2608 2608  
2609 2609  
2610 2610  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
... ... @@ -2795,7 +2795,7 @@
2795 2795   "id": 0, ~/~/ ID уведомления
2796 2796   "name": "string", ~/~/ Название уведомления
2797 2797   "active": true, ~/~/ Состояние true - активен, false - деактивирован
2798 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2806 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 
2799 2799   "userId": "", ~/~/ Пользователь, создавший уведомление
2800 2800   "parentId": "", ~/~/ Идентификатор клиента
2801 2801   "parentName": "string" ~/~/ Имя клиента
... ... @@ -2802,6 +2802,155 @@
2802 2802   }
2803 2803  ]
2804 2804  
2813 +
2814 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
2815 +
2816 +(% class="box infomessage" %)
2817 +(((
2818 +**POST /api/v3/notifications**
2819 +)))
2820 +
2821 +Метод запроса **POST**
2822 +
2823 +(% style="text-align: left;" %)
2824 +(% style="color:#000000" %)Пример запроса
2825 +
2826 +(((
2827 +{
2828 + "id": 0, ~/~/ ID правила
2829 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2830 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2831 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2832 + "name": "string", ~/~/ Имя правила
2833 + "active": true, ~/~/ Активность правила
2834 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2835 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2836 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2837 + ],
2838 + "vehicleIds": [ ~/~/ Список объектов для анализа.
2839 + 0
2840 + ],
2841 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2842 + 0
2843 + ],
2844 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2845 + 0
2846 + ],
2847 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2848 + "additionalProp1": "string",  
2849 + "additionalProp2": "string",
2850 + "additionalProp3": "string"
2851 + },
2852 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2853 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2854 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2855 + ],
2856 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2857 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2858 + "string"
2859 + ],
2860 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2861 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2862 + {
2863 + "id": 0, ~/~/ Идентификатор участника чата.
2864 + "info": "string" ~/~/ Дополнительные сведения.
2865 + }
2866 + ],
2867 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2868 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2869 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2870 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2871 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2872 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2873 + "timezone": 0, ~/~/ часовой пояс 
2874 + "validity": 0, ~/~/ Срок действия в днях (1-90).
2875 + "autoProlongation": true, ~/~/ Автопродление срока действия.
2876 + "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2877 + {
2878 + "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 - Срок действия правила истек
2879 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2880 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2881 + "additionalProp1": "string",
2882 + "additionalProp2": "string",
2883 + "additionalProp3": "string"
2884 + }
2885 + }
2886 + ]
2887 +}
2888 +)))
2889 +
2890 +(((
2891 +
2892 +)))
2893 +
2894 +(((
2895 +
2896 +)))
2897 +
2898 +Ответ:
2899 +
2900 +{
2901 + "id": 0, ~/~/ ID правила
2902 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2903 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2904 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2905 + "name": "string", ~/~/ Имя правила
2906 + "active": true, ~/~/ Активность правила
2907 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2908 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2909 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2910 + ],
2911 + "vehicleIds": [ ~/~/ Список объектов для анализа.
2912 + 0
2913 + ],
2914 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2915 + 0
2916 + ],
2917 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2918 + 0
2919 + ],
2920 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2921 + "additionalProp1": "string",  
2922 + "additionalProp2": "string",
2923 + "additionalProp3": "string"
2924 + },
2925 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2926 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2927 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2928 + ],
2929 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2930 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2931 + "string"
2932 + ],
2933 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2934 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2935 + {
2936 + "id": 0, ~/~/ Идентификатор участника чата.
2937 + "info": "string" ~/~/ Дополнительные сведения.
2938 + }
2939 + ],
2940 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2941 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2942 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2943 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2944 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2945 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2946 + "timezone": 0, ~/~/ часовой пояс 
2947 + "validity": 0, ~/~/ Срок действия в днях (1-90).
2948 + "autoProlongation": true, ~/~/ Автопродление срока действия.
2949 + "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2950 + {
2951 + "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 - Срок действия правила истек
2952 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2953 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2954 + "additionalProp1": "string",
2955 + "additionalProp2": "string",
2956 + "additionalProp3": "string"
2957 + }
2958 + }
2959 + ]
2960 +}
2961 +
2805 2805  == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2806 2806  
2807 2807  (% class="box infomessage" %)
... ... @@ -4019,16 +4019,12 @@
4019 4019  Тело запроса:
4020 4020  
4021 4021  {
4022 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4023 - "Balance": 0
4179 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4180 + "Balance": 0 ~/~/ Значение баланса.
4024 4024  }
4025 4025  
4026 4026  Ответ: Success
4027 4027  
4028 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4029 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4030 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4031 -
4032 4032  == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4033 4033  
4034 4034  (% class="box warningmessage" %)
... ... @@ -4040,16 +4040,29 @@
4040 4040  
4041 4041  Тело запроса:
4042 4042  
4196 +(((
4043 4043  {
4044 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4045 - "Balance": 0
4198 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4199 + "amount": 0 ~/~/ Сумма пополнения баланса 
4046 4046  }
4201 +)))
4047 4047  
4203 +(((
4204 +
4205 +)))
4206 +
4048 4048  Ответ: Success
4049 4049  
4050 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4051 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4052 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4209 +(((
4210 +{
4211 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4212 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4213 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4214 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки.
4215 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4216 + "Description": "string" ~/~/ Описание корректировки.
4217 +}
4218 +)))
4053 4053  
4054 4054  == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4055 4055  
... ... @@ -4062,16 +4062,25 @@
4062 4062  
4063 4063  Тело запроса:
4064 4064  
4231 +(((
4065 4065  {
4066 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4067 - "Balance": 0
4233 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4234 + "amount": 0 ~/~/ Сумма списания с баланса
4068 4068  }
4236 +)))
4069 4069  
4070 4070  Ответ: Success
4071 4071  
4072 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4073 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4074 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4240 +(((
4241 +{
4242 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4243 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4244 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4245 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки.
4246 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4247 + "Description": "string" ~/~/ Описание корректировки
4248 +}
4249 +)))
4075 4075  
4076 4076  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4077 4077  
... ... @@ -4082,28 +4082,35 @@
4082 4082  
4083 4083  Тело запроса:
4084 4084  
4260 +(((
4085 4085  {
4086 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4087 - "CalculationType": 0,
4088 - "PermissibleBalance": 0,
4089 - "DefermentDays": 0,
4090 - "SendUiNotifications": true,
4091 - "SendEmailNotifications": true,
4092 - "IsPrivate": true,
4262 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4263 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4264 + "PermissibleBalance": 0, ~/~/ Допустимый баланс
4265 + "DefermentDays": 0, ~/~/ Отсрочка (дни).
4266 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4267 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4093 4093  }
4269 +)))
4094 4094  
4271 +(((
4272 +
4273 +)))
4274 +
4095 4095  Ответ: Success
4096 4096  
4097 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4098 -|ClientId|Идентификатор клиента
4099 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4100 -|PermissibleBalance|Допустимый баланс
4101 -|DefermentDays|(((
4102 -Отсрочка, количество дней
4277 +(((
4278 +{
4279 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4280 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент.
4281 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4282 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4283 + "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4284 + "DefermentDays": 0, ~/~/ Отсрочка (дни)
4285 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4286 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4287 +}
4103 4103  )))
4104 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4105 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4106 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4107 4107  
4108 4108  == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4109 4109  
... ... @@ -4115,35 +4115,68 @@
4115 4115  Тело запроса:
4116 4116  
4117 4117  {
4118 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4119 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4120 - "Features": [
4300 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
4301 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4302 + "Features": [ ~/~/ Набор услуг по тарифу клиента.
4121 4121   {
4122 - "Feature": "string",
4123 - "IsEnabled": true,
4124 - "IsFactual": true,
4125 - "Limit": 0,
4126 - "Price": 0,
4127 - "DebitDate": "2023-10-18T13:26:58.987Z",
4128 - "PeriodValue": 0,
4129 - "PeriodType": 0
4304 + "Feature": "string", ~/~/ Код услуги.
4305 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4306 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4307 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
4308 + "Price": 0, ~/~/ Цена за единицу.
4309 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4310 + "PeriodValue": 0, ~/~/ Значение периода.
4311 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
4130 4130   }
4131 4131   ]
4132 4132  }
4133 4133  
4316 +
4134 4134  Ответ: Success
4135 4135  
4136 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4137 -|ClientId|Идентификатор клиента
4138 -|PlanId|Идентификатор тарифного плана
4139 -|Feature|Код услуги
4140 -|IsEnabled|Признак, определяющий активирована ли услуга
4141 -|IsFactual|Признак, определяющий расчёт по факту
4142 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4143 -|Price|Цена за единицу.
4144 -|DebitDate|Следующий момент времени списания с баланса за услугу.
4145 -|PeriodValue|Значение периода.
4146 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4319 +(((
4320 +{
4321 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4322 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг)
4323 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4324 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца.
4325 + "Name": "string", ~/~/ Наименование.
4326 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план.
4327 + "Constraint": { ~/~/ Ограничения по тарифу 
4328 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 
4329 + "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4330 + "DefermentDays": 0 ~/~/ Отсрочка (дни)
4331 + },
4332 + "Features": [ ~/~/ Набор услуг по тарифному плану.
4333 + {
4334 + "Feature": "string", ~/~/Код услуги.
4335 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту.
4336 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4337 + "Price": 0, ~/~/ Цена за единицу.
4338 + "PeriodValue": 0, ~/~/ Значение периода.
4339 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 
4340 + }
4341 + ],
4342 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план.
4343 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана.
4344 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана.
4345 + },
4346 + "Features": [ ~/~/ Набор услуг по тарифу клиента.
4347 + {
4348 + "Feature": "string", ~/~/ Код услуги.
4349 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4350 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4351 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4352 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4353 + "Price": 0, ~/~/ Цена за единицу.
4354 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4355 + "PeriodValue": 0, ~/~/ Значение периода.
4356 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане.
4357 + "Quantity": 0 ~/~/ Количество использования услуги.
4358 + }
4359 + ]
4360 +}
4361 +)))
4147 4147  
4148 4148  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4149 4149  
... ... @@ -4248,9 +4248,6 @@
4248 4248  |producedCount|Кол-во успешно отправленных в шину данных сообщений
4249 4249  |msgCount|Кол-во обработанных сообщений всего
4250 4250  
4251 -(% class="wikigeneratedid" %)
4252 -== ==
4253 -
4254 4254  == **Импортировать историю ТС (Асинхронный запрос)** ==
4255 4255  
4256 4256  (% class="box successmessage" %)
... ... @@ -4288,11 +4288,6 @@
4288 4288  }
4289 4289  
4290 4290  
4291 -== ==
4292 -
4293 -(% class="wikigeneratedid" %)
4294 -== ==
4295 -
4296 4296  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4297 4297  
4298 4298  (% class="box infomessage" %)
... ... @@ -4310,13 +4310,22 @@
4310 4310   "message": "string"
4311 4311  }
4312 4312  
4313 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4314 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4315 -|progress|Guid ТС
4520 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4521 +**Параметр**
4522 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4523 +**Описание**
4524 +)))
4525 +|(((
4526 +activity
4527 +)))|(((
4528 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4529 +)))
4530 +|(((
4531 +progress
4532 +)))|(((
4533 +Guid ТС
4534 +)))
4316 4316  
4317 -(% class="wikigeneratedid" %)
4318 -== ==
4319 -
4320 4320  == **Возвращает статус асинхронного запроса импорта истории ТС** ==
4321 4321  
4322 4322  (% class="box infomessage" %)
... ... @@ -5215,33 +5215,9 @@
5215 5215  )))
5216 5216  
5217 5217  
5218 -== **Удаление существующего поля** ==
5219 -
5220 -(% class="box errormessage" %)
5221 5221  (((
5222 -**DELETE /api/v3/agroLands/{id}**
5223 -)))
5224 -
5225 -Пример запроса:
5226 -id  ~/~/ Идентификатор поля
5227 -
5228 -Пример ответа:
5229 -
5230 5230  (((
5231 -200 ~/~/ Успех
5232 -)))
5233 -
5234 5234  (((
5235 -
5236 -)))
5237 -
5238 -(((
5239 -(((
5240 -(((
5241 -
5242 -)))
5243 -
5244 -(((
5245 5245  == **Изменение поля** ==
5246 5246  
5247 5247  (% class="box infomessage" %)
... ... @@ -5487,9 +5487,102 @@
5487 5487   "perimetr": 0, ~/~/ ериметр, м
5488 5488   "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5489 5489  }
5682 +
5683 +
5684 +== **Какие поля посещал объект** ==
5685 +
5686 +(% class="box successmessage" %)
5687 +(((
5688 +**POST /api/v3/agroLands/visitingByVehicle**
5490 5490  )))
5491 5491  
5691 +Пример запроса:
5492 5492  
5693 +{
5694 + "vehicleId": 0, ~/~/ id объекта 
5695 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5696 + "byTime": 0, ~/~/ Объединение событий по времени
5697 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5698 + "byDist": 0, ~/~/ Объединение событий по расстоянию
5699 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента)
5700 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента)
5701 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5702 +}
5703 +
5704 +Пример ответа:
5705 +
5706 +[
5707 + {
5708 + "fieldId": 0, ~/~/ id объекта 
5709 + "vehicleName": "string", ~/~/ Наименование объекта 
5710 + "fieldName": "string", ~/~/ Наименование поля 
5711 + "fuelUsage": 0, ~/~/ Расход топлива, л/га
5712 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5713 + "vehicleId": 0, ~/~/ Идентификатор ТС
5714 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения
5715 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения
5716 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5717 + "mileage": 0 ~/~/ Пробег 
5718 + }
5719 +]
5720 +)))
5721 +
5722 +
5723 +== **Посещение поля объектами ** ==
5724 +
5725 +(% class="box successmessage" %)
5726 +(((
5727 +**POST /api/v3/agroLands/visitingByField**
5728 +)))
5729 +
5730 +Пример запроса:
5731 +{
5732 + "fieldId": 0, ~/~/ ID поля
5733 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5734 + "byTime": 0, ~/~/ Объединение событий по времени
5735 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5736 + "byDist": 0, ~/~/ Объединение событий по расстоянию
5737 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента)
5738 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента)
5739 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5740 +}
5741 +
5742 +Пример ответа:
5743 +
5744 +[
5745 + {
5746 + "fieldId": 0, ~/~/ ID поля
5747 + "vehicleName": "string", ~/~/ Наименование объекта 
5748 + "fieldName": "string", ~/~/ Имя поля
5749 + "fuelUsage": 0, ~/~/ Расход топлива, л/га
5750 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5751 + "vehicleId": 0, ~/~/ Идентификатор ТС
5752 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения
5753 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения
5754 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5755 + "mileage": 0 ~/~/ Пробег
5756 + }
5757 +]
5758 +
5759 +
5760 +== **Удаление существующего поля** ==
5761 +
5762 +(% class="box errormessage" %)
5763 +(((
5764 +**DELETE /api/v3/agroLands/{id}**
5765 +)))
5766 +
5767 +Пример запроса:
5768 +id  ~/~/ Идентификатор поля
5769 +
5770 +Пример ответа:
5771 +
5772 +(((
5773 +200 ~/~/ Успех
5774 +
5775 +
5776 +)))
5777 +
5493 5493  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5494 5494  )))
5495 5495  )))
... ... @@ -5914,49 +5914,129 @@
5914 5914  )))
5915 5915  
5916 5916  
6202 += **Раздел: Роли** =
6203 +
6204 +== **Получение списка клиентских и системных ролей пользователя ** ==
6205 +
6206 +(% class="box successmessage" %)
6207 +(((
6208 +**POST /api/v3/groups/find**
6209 +)))
6210 +
6211 +Пример запроса:
6212 +
6213 +(((
6214 +{
6215 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6216 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6217 +}
6218 +)))
6219 +
6220 +(((
6221 +
6222 +)))
6223 +
6224 +(((
6225 +Пример ответа:
6226 +)))
6227 +
6228 +(((
6229 +(((
6230 +{
6231 + "groups": [  ~/~/ Системные роли пользователя
6232 + {
6233 + "code": "string", ~/~/ Код роли.
6234 + "name": "string", ~/~/ Имя  
6235 + "shortName": "string" ~/~/ Короткое имя 
6236 + }
6237 + ],
6238 + "customGroups": [ ~/~/ Системные роли пользователя
6239 + {
6240 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6241 + "name": "string", ~/~/ Наименование 
6242 + "shortName": "string", ~/~/ Короткое наименование 
6243 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6244 + }
6245 + ]
6246 +}
6247 +)))
6248 +)))
6249 +
6250 +(((
6251 +
6252 +)))
6253 +
6254 +(((
6255 +
6256 +)))
6257 +
5917 5917  = **Раздел: Локатор ** =
5918 5918  
5919 5919  
5920 -== **Получение списка локаторов, доступных пользователю ** ==
6261 +== **Получение данных по локатору** ==
5921 5921  
5922 5922  (% class="box infomessage" %)
5923 5923  (((
5924 -**GET /api/v3/locators**
6265 +**GET /api/v3/locators/{locatorId}**
5925 5925  )))
5926 5926  
5927 -В заголовках запроса: X-Auth: Токен авторизации
6268 +В запросе указывается locatorid - идентификатор локатора
5928 5928  
5929 5929  
5930 5930  Пример ответа:
5931 5931  
5932 5932  (((
5933 -[
5934 - {
5935 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
5936 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
5937 - "agentName": "string", ~/~/ Наименование агента.
5938 - "isEnabled": true, ~/~/ Активен 
5939 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
5940 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
5941 - "name": "string", ~/~/ Наименование
5942 - "status": 0, ~/~/ 
5943 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
5944 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 
5945 - "validity": 0, ~/~/ Срок действия в днях (1-90).
5946 - "autoProlongation": true, ~/~/ Автопродление срока действия.
5947 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
5948 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
5949 - "url": "string", ~/~/ Ссылка
5950 - "language": 0, ~/~/ Язык.
5951 - "vehiclesCount": 0, ~/~/ Количество объектов.
5952 - "geozonesCount": 0, ~/~/ Количество геозон.
5953 - "fieldsCount": 0 ~/~/ Количество полей.
5954 - }
5955 -]
6274 +(((
6275 +{
6276 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6277 + 0
6278 + ],
6279 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6280 + 0
6281 + ],
6282 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6283 + 0
6284 + ],
6285 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6286 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6287 + "agentName": "string", ~/~/ Наименование агента.
6288 + "isEnabled": true, ~/~/ Активность 
6289 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6290 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6291 + "name": "string", ~/~/ Наименование.
6292 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6293 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6294 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6295 + "validity": 0, ~/~/ Значение срока действия
6296 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6297 + "autoProlongation": true, ~/~/ Автопродление срока действия.
6298 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6299 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6300 + "url": "string", ~/~/ Ссылка
6301 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6302 +
6303 + "showVehicleName": true, ~/~/ Наименование объекта
6304 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6305 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6306 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6307 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6308 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6309 +
6310 + 1
6311 +
6312 + ]
6313 +}
5956 5956  )))
6315 +)))
5957 5957  
5958 5958  
6318 +(((
6319 +(((
6320 +
6321 +)))
6322 +)))
5959 5959  
6324 +
5960 5960  == **Создание локатора** ==
5961 5961  
5962 5962  (% class="box successmessage" %)
... ... @@ -5968,7 +5968,6 @@
5968 5968  
5969 5969  (((
5970 5970  {
5971 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
5972 5972   "isEnabled": true, ~/~/ Активность
5973 5973   "name": "string", ~/~/ Наименование локатора
5974 5974   "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
... ... @@ -5975,8 +5975,28 @@
5975 5975   "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
5976 5976   "validity": 0, ~/~/ Срок действия в днях (1-90)
5977 5977   "autoProlongation": true, ~/~/ Автопродление срока действия.
5978 - "url": "string", ~/~/ Ссылка
5979 - "language": 0 ~/~/ Язык
6342 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6343 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6344 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6345 + 0
6346 + ],
6347 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6348 + 0
6349 + ],
6350 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6351 + 0
6352 + ],
6353 +
6354 + "showVehicleName": true, ~/~/ Наименование объекта
6355 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6356 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6357 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6358 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6359 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6360 +
6361 + 1
6362 +
6363 + ]
5980 5980  }
5981 5981  )))
5982 5982  
... ... @@ -5988,7 +5988,69 @@
5988 5988  )))
5989 5989  
5990 5990  
6375 +== **Выводит список локаторов ** ==
5991 5991  
6377 +(% class="box successmessage" %)
6378 +(((
6379 +**POST /api/v3/locators/find**
6380 +)))
6381 +
6382 +Пример запроса:
6383 +
6384 +(((
6385 +{
6386 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента
6387 +}
6388 +)))
6389 +
6390 +(((
6391 +
6392 +)))
6393 +
6394 +(((
6395 +
6396 +)))
6397 +
6398 +
6399 +Пример ответа:
6400 +
6401 +(((
6402 +[
6403 + {
6404 + "vehiclesCount": 0, ~/~/ Количество объектов.
6405 + "geozonesCount": 0, ~/~/ Количество геозон.
6406 + "fieldsCount": 0, ~/~/ Количество полей.
6407 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6408 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
6409 + "agentName": "string", ~/~/ Наименование агента.
6410 + "isEnabled": true, ~/~/ Активность локатора
6411 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания
6412 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 
6413 + "name": "string", ~/~/ Наименование локатора 
6414 + "status": 0,  ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6415 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6416 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC)
6417 + "validity": 0, ~/~/ Срок действия в днях (1-90)
6418 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6419 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 
6420 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6421 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 
6422 + "url": "string", ~/~/ ссылка на локатор 
6423 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6424 + "showVehicleName": true, ~/~/ Наименование объекта
6425 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6426 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6427 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6428 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6429 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6430 +
6431 + 0
6432 + ]
6433 + }
6434 +]
6435 +)))
6436 +
6437 +
5992 5992  == **Изменение локатора** ==
5993 5993  
5994 5994  (% class="box infomessage" %)
... ... @@ -6007,12 +6007,31 @@
6007 6007   "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
6008 6008   "validity": 0, ~/~/ Срок действия в днях (1-90)
6009 6009   "autoProlongation": true, ~/~/ Автопродление срока действия
6010 - "url": "string", ~/~/ Ссылка
6011 - "language": 0 ~/~/ Язык
6456 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6457 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6458 + 0
6459 + ],
6460 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6461 + 0
6462 + ],
6463 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6464 + 0
6465 + ],
6466 + "showVehicleName": true, ~/~/ Наименование объекта
6467 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6468 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6469 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6470 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6471 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6472 +
6473 + 0
6474 +
6475 + ]
6012 6012  }
6477 +
6478 +
6013 6013  )))
6014 6014  
6015 -
6016 6016  Пример ответа:
6017 6017  
6018 6018  200 ~/~/ Success
... ... @@ -6034,7 +6034,6 @@
6034 6034  )))
6035 6035  
6036 6036  
6037 -
6038 6038  = **Раздел: Яндекс Маршруты** =
6039 6039  
6040 6040  
... ... @@ -6048,7 +6048,6 @@
6048 6048  Пример запроса:
6049 6049  Id  ~/~/ Идентификатор поля
6050 6050  
6051 -
6052 6052  Пример ответа:
6053 6053  
6054 6054  (((
... ... @@ -6066,7 +6066,6 @@
6066 6066  )))
6067 6067  
6068 6068  
6069 -
6070 6070  == **Добавить маршрут** ==
6071 6071  
6072 6072  (% class="box infomessage" %)
... ... @@ -6121,7 +6121,6 @@
6121 6121  }
6122 6122  )))
6123 6123  
6124 -
6125 6125  Пример ответа:
6126 6126  
6127 6127  (((
... ... @@ -6152,7 +6152,6 @@
6152 6152  ]
6153 6153  )))
6154 6154  
6155 -
6156 6156  Пример ответа:
6157 6157  
6158 6158  (((
... ... @@ -6176,8 +6176,6 @@
6176 6176  Id  ~/~/ Идентификатор поля
6177 6177  
6178 6178  
6179 -==== ====
6180 -
6181 6181  = **Раздел: Управление доступа к машинам** =
6182 6182  
6183 6183  
... ... @@ -6199,7 +6199,6 @@
6199 6199  )))
6200 6200  
6201 6201  
6202 -
6203 6203  == Задает видимость транспортных средств пользователю ==
6204 6204  
6205 6205  (% class="box infomessage" %)
... ... @@ -6224,10 +6224,6 @@
6224 6224  )))
6225 6225  
6226 6226  (((
6227 -
6228 -)))
6229 -
6230 -(((
6231 6231  Пример ответа :
6232 6232  )))
6233 6233  
... ... @@ -6241,10 +6241,6 @@
6241 6241  )))
6242 6242  
6243 6243  
6244 -
6245 -
6246 -
6247 -
6248 6248  (% class="box" lang="en-US" style="text-align: center;" %)
6249 6249  (((
6250 6250  (% 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 г.