Changes for page Методы API для работы с ГЛОНАССSoft

Last modified by Андрей Калиновский on 2025/07/03 16:28

From version < 209.1 >

edited by Андрей Калиновский
on 2025/02/25 16:31

To version < 246.1 >

edited by Андрей Калиновский
on 2025/07/03 16:18

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -11,6 +11,11 @@
  В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
++(% class="box infomessage" %)
++(((
++**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
++\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
++)))
  **Содержание страницы:**
  )))
@@ -118,29 +118,41 @@
  Запрос должен содержать данные параметра "**agentId**"
  (% style="color:#000000" %)Ответ:
++
++(((
  {
--    "agentId": "",  (%%)
--    "parentId": "",
--    "parentName": "string",
--    "name": "string",
--    "fullName": "string",
--    "agentInfoType": 0,
--    "isForeign": true/false,
--    "district": "string",
--    "region": "string",
--    "city": "string",
--    "inn": "string",
--    "kpp": "string",
--    "address": "string",
--    "addressFact": "string",
--    "email": "string",
--    "director": "string",
--    "bankName": "string",
--    "bankBIK": "string",
--    "bankRS": "string",
--    "bankKS": "string"
--  }
++  "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя
++  "parentName": "string", ~/~/ Наименование агента
++  "name": "string", ~/~/ Имя клиента
++  "fullName": "string", ~/~/ ФИО клиента
++  "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%))
++  "isForeign": true, ~/~/ Флаг "Иностранный контрагент"
++  "district": "string", ~/~/ Район
++  "region": "string", ~/~/ Область
++  "city": "string", ~/~/ Город
++  "email": "string", ~/~/ Email
++  "director": "string", ~/~/ Руководитель
++  "RegionalData": [ ~/~/ Определяет региональные сведения.
++    {
++      "Country": 0, ~/~/ Страна
++      "groups": [ ~/~/ Список групп
++        {
++          "groupId": "string", ~/~/ Уникальный идентификатор группы
++          "fields": [ ~/~/ Список значений полей
++            {
++              "name": "string", ~/~/ Имя поля формы
++              "value": "string" ~/~/ Значение поля формы
++            }
++          ]
++        }
++      ]
++    }
++  ]
++}
++)))
++
  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
  |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента
  |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
@@ -437,7 +437,7 @@
      [
         "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
      ],
--    "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
++    "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
  }
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -749,6 +749,9 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
++(% class="wikigeneratedid" %)
++=   =
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
@@ -860,7 +860,7 @@
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true,
++  "deleted": false,
    "extId": "string",
    "name": "string",
    "picture": "string",
@@ -879,7 +879,7 @@
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true,
++  "deleted": false,
    "extId": "string",
    "name": "string",
    "picture": "string",
@@ -913,7 +913,7 @@
  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
  )))
--(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -980,7 +980,7 @@
  (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
  )))
--(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
++(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
  (% style="color:#000000" %)Метод запроса: **DELETE**
@@ -1611,77 +1611,6 @@
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
--== **Импортировать историю ТС (Асинхронный запрос)** ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
--)))
--
--Метод запроса: **POST**
--
--URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
--
--Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
--
--
--Ответ:
--
--{
--
--  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
--
--  "Status": 0, ~/~/ Перечисление состояний выполнения запроса
--
--~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
--
--  "Message": "string", ~/~/ Информация о выполнении запроса
--
--  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
--
--  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
--
--  "Data": "string" ~/~/ Данные
--
--}
--
--
--== **Возвращает статус асинхронного запроса импорта истории ТС** ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
--)))
--
--Метод запроса: **GET**
--
--URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
--
--Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
--
--
--Ответ:
--
--{
--
--  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
--
--  "Status": 0, ~/~/ Перечисление состояний выполения запроса
--~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
--
--  "Message": "string", ~/~/ Информация о выполнении запроса
--
--  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
--
--~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
--
--  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
--
--  "Data": "string" ~/~/ Данные
--
--}
--
--
  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
  (% class="box infomessage" %)
@@ -1827,7 +1827,6 @@
    "stage": "", ~/~/ Состояние
  (% style="color:#000000" %)  }
--==   ==
  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
@@ -2510,8 +2510,12 @@
          "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
          "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
          "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
++        "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
++        "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
          "fuelConsumption": 0, ~/~/ Расход топлива
          "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
++         "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
++
        }
      ]
    }
@@ -2557,7 +2557,8 @@
      "model": "string", ~/~/ Модель объекта
      "fuels": [ ~/~/ Массив данным по заправкам и сливам
        {
--        "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
++        "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
++
          "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
          "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
          "valueFuel": 0, ~/~/ Количество
@@ -2636,26 +2636,50 @@
  В заголовках запроса: X-Auth: Токен авторизации
--В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
++В массиве указываем id объектов через запятую
  Ответ:
++
++[
    {
--    "vehicleId": 0, ~/~/Идентификатор объекта.
--    "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
--    "vehicleNumber": "string",~/~/Номер объекта.
--    "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
--    "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
--    "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
--    "speed": 0,~/~/Скорость объекта.
--    "course": 0,~/~/Курс движения [0;360]
--    "latitude": 0,~/~/Широта [-90°;90°].
--    "longitude": 0,~/~/Долгота [-180°;180°].
--    "address": "string",~/~/Адрес.
--    "geozones": [ ~/~/Сведения по геозонам.
++    "vehicleId": 55728, ~/~/ Идентификатор объекта
++    "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта
++    "vehicleNumber": "0105 КМ", ~/~/ Номер объекта
++    "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных
++    "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных
++    "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
++    "speed": 31, ~/~/ Скорость объекта
++    "course": 116, ~/~/ Курс движения [0;360]
++    "latitude": 45.722128, ~/~/ Широта [-90°;90°].
++    "longitude": 39.800432, ~/~/ Долгота [-180°;180°].
++    "address": "\"   Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес
++    "geozones": [ ~/~/ Сведения по геозонам.
        {
--        "id": 0,
--        "name": "string"
++        "id": 10225647, ~/~/ ID Геозоны
++        "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны
++      },
++      {
++        "id": 10282875, ~/~/ ID Геозоны
++        "name": "Ё2" ~/~/ Наименование геозоны
++      },
++      {
++        "id": 10226240, ~/~/ ID Геозоны
++        "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны
++      },
++      {
++        "id": 9747869, ~/~/ ID Геозоны
++        "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны
++      },
++      {
++        "id": 10221123, ~/~/ ID Геозоны
++        "name": "53r" ~/~/ Наименование геозоны
++      },
++      {
++        "id": 10197638, ~/~/ ID Геозоны
++        "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны
        }
++    ]
++  }
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
@@ -2786,6 +2786,35 @@
    }
  ]
++
++== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
++
++(% class="box successmessage" %)
++(((
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
++)))
++
++(% style="color:#000000" %)Метод запроса: **PUT**
++
++Пример запроса:
++
++(((
++{
++  "id": 0,  ~/~/ Идентификатор объекта геозоны
++  "name": "string",  ~/~/ Наименование объекта геозоны
++  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
++  "description": "string", ~/~/ Описание объекта геозоны
++  "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
++  "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
++  "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
++}
++)))
++
++
++Пример ответа:
++
++200 ~/~/ Success
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
@@ -2817,7 +2817,7 @@
      "id": 0, ~/~/ ID уведомления
      "name": "string", ~/~/ Название уведомления
      "active": true, ~/~/ Состояние true - активен, false - деактивирован
--    "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
++    "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя)
      "userId": "", ~/~/ Пользователь, создавший уведомление
      "parentId": "", ~/~/ Идентификатор клиента
      "parentName": "string" ~/~/ Имя клиента
@@ -2824,6 +2824,155 @@
    }
  ]
++
++== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/notifications**
++)))
++
++Метод запроса **POST**
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)Пример запроса
++
++(((
++{
++  "id": 0, ~/~/ ID правила
++  "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
++  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "name": "string", ~/~/ Имя правила
++  "active": true, ~/~/ Активность правила
++  "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
++  "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/
++  ],
++  "vehicleIds": [ ~/~/ Список объектов для анализа.
++    0
++  ],
++  "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
++    0
++  ],
++  "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
++    0
++  ],
++  "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
++    "additionalProp1": "string",
++    "additionalProp2": "string",
++    "additionalProp3": "string"
++  },
++  "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
++  "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
++  ],
++  "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
++  "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
++    "string"
++  ],
++  "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
++  "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
++    {
++      "id": 0, ~/~/ Идентификатор участника чата.
++      "info": "string" ~/~/ Дополнительные сведения.
++    }
++  ],
++  "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
++  "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
++  "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
++  "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение)
++  "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
++  "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
++  "timezone": 0, ~/~/ часовой пояс
++  "validity": 0, ~/~/ Срок действия в днях (1-90).
++  "autoProlongation": true, ~/~/ Автопродление срока действия.
++  "templates": [ ~/~/  Переопределения шаблонов уведомлений.
++    {
++      "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 - Срок действия правила истек
++      "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
++      "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
++        "additionalProp1": "string",
++        "additionalProp2": "string",
++        "additionalProp3": "string"
++      }
++    }
++  ]
++}
++)))
++
++(((
++
++)))
++
++(((
++
++)))
++
++Ответ:
++
++{
++  "id": 0, ~/~/ ID правила
++  "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
++  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "name": "string", ~/~/ Имя правила
++  "active": true, ~/~/ Активность правила
++  "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
++  "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/
++  ],
++  "vehicleIds": [ ~/~/ Список объектов для анализа.
++    0
++  ],
++  "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
++    0
++  ],
++  "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
++    0
++  ],
++  "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
++    "additionalProp1": "string",
++    "additionalProp2": "string",
++    "additionalProp3": "string"
++  },
++  "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
++  "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
++  ],
++  "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
++  "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
++    "string"
++  ],
++  "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
++  "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
++    {
++      "id": 0, ~/~/ Идентификатор участника чата.
++      "info": "string" ~/~/ Дополнительные сведения.
++    }
++  ],
++  "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
++  "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
++  "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
++  "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение)
++  "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
++  "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
++  "timezone": 0, ~/~/ часовой пояс
++  "validity": 0, ~/~/ Срок действия в днях (1-90).
++  "autoProlongation": true, ~/~/ Автопродление срока действия.
++  "templates": [ ~/~/  Переопределения шаблонов уведомлений.
++    {
++      "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 - Срок действия правила истек
++      "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
++      "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
++        "additionalProp1": "string",
++        "additionalProp2": "string",
++        "additionalProp3": "string"
++      }
++    }
++  ]
++}
++
  == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
  (% class="box infomessage" %)
@@ -4041,16 +4041,12 @@
  Тело запроса:
  {
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "Balance": 0
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "Balance": 0 ~/~/ Значение баланса.
  }
  Ответ: Success
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
--|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
--
  == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
  (% class="box warningmessage" %)
@@ -4062,16 +4062,29 @@
  Тело запроса:
++(((
  {
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "Balance": 0
++  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "amount": 0 ~/~/ Сумма пополнения баланса
  }
++)))
++(((
++
++)))
++
  Ответ: Success
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
--|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
++(((
++{
++  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
++  "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки.
++  "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
++  "Description": "string" ~/~/ Описание корректировки.
++}
++)))
  == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
@@ -4084,16 +4084,25 @@
  Тело запроса:
++(((
  {
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "Balance": 0
++  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "amount": 0 ~/~/ Сумма списания с баланса
  }
++)))
  Ответ: Success
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
--|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
++(((
++{
++  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
++  "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки.
++  "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
++  "Description": "string" ~/~/ Описание корректировки
++}
++)))
  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
@@ -4104,28 +4104,35 @@
  Тело запроса:
++(((
  {
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "CalculationType": 0,
--  "PermissibleBalance": 0,
--  "DefermentDays": 0,
--  "SendUiNotifications": true,
--  "SendEmailNotifications": true,
--  "IsPrivate": true,
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
++  "PermissibleBalance": 0, ~/~/ Допустимый баланс
++  "DefermentDays": 0, ~/~/ Отсрочка (дни).
++  "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
++  "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
  }
++)))
++(((
++
++)))
++
  Ответ: Success
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|ClientId|Идентификатор клиента
--|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
--|PermissibleBalance|Допустимый баланс
--|DefermentDays|(((
--Отсрочка, количество дней
++(((
++{
++  "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
++  "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент.
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
++  "PermissibleBalance": 0, ~/~/ Допустимый баланс.
++  "DefermentDays": 0, ~/~/ Отсрочка (дни)
++  "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
++  "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
++}
  )))
--|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
--|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
--|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
  == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
@@ -4137,35 +4137,68 @@
  Тело запроса:
  {
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "Features": [
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
++  "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
++  "Features": [ ~/~/ Набор услуг по тарифу клиента.
      {
--      "Feature": "string",
--      "IsEnabled": true,
--      "IsFactual": true,
--      "Limit": 0,
--      "Price": 0,
--      "DebitDate": "2023-10-18T13:26:58.987Z",
--      "PeriodValue": 0,
--      "PeriodType": 0
++      "Feature": "string", ~/~/ Код услуги.
++      "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
++      "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
++      "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
++      "Price": 0, ~/~/ Цена за единицу.
++      "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
++      "PeriodValue": 0, ~/~/ Значение периода.
++      "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
      }
    ]
  }
++
  Ответ: Success
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|ClientId|Идентификатор клиента
--|PlanId|Идентификатор тарифного плана
--|Feature|Код услуги
--|IsEnabled|Признак, определяющий активирована ли услуга
--|IsFactual|Признак, определяющий расчёт по факту
--|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
--|Price|Цена за единицу.
--|DebitDate|Следующий момент времени списания с баланса за услугу.
--|PeriodValue|Значение периода.
--|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
++(((
++{
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "Plan": { ~/~/ Определяет тарифный план (шаблон услуг)
++    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
++    "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца.
++    "Name": "string", ~/~/ Наименование.
++    "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план.
++    "Constraint": { ~/~/ Ограничения по тарифу
++      "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни)
++      "PermissibleBalance": 0, ~/~/ Допустимый баланс.
++      "DefermentDays": 0 ~/~/ Отсрочка (дни)
++    },
++    "Features": [ ~/~/ Набор услуг по тарифному плану.
++      {
++        "Feature": "string", ~/~/Код услуги.
++        "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту.
++        "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
++        "Price": 0, ~/~/ Цена за единицу.
++        "PeriodValue": 0, ~/~/ Значение периода.
++        "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни)
++      }
++    ],
++    "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план.
++    "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана.
++    "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана.
++  },
++  "Features": [ ~/~/ Набор услуг по тарифу клиента.
++    {
++      "Feature": "string", ~/~/ Код услуги.
++      "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
++      "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
++      "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
++      "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
++      "Price": 0, ~/~/ Цена за единицу.
++      "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу.
++      "PeriodValue": 0, ~/~/ Значение периода.
++      "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане.
++      "Quantity": 0 ~/~/ Количество использования услуги.
++    }
++  ]
++}
++)))
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
@@ -4270,6 +4270,43 @@
  |producedCount|Кол-во успешно отправленных в шину данных сообщений
  |msgCount|Кол-во обработанных сообщений всего
++== **Импортировать историю ТС (Асинхронный запрос)** ==
++
++(% class="box successmessage" %)
++(((
++**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
++)))
++
++При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
++
++Метод запроса: **POST**
++
++URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
++
++Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
++
++
++Ответ:
++
++{
++
++  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
++
++  "Status": 0, ~/~/ Перечисление состояний выполнения запроса
++
++~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
++
++  "Message": "string", ~/~/ Информация о выполнении запроса
++
++  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
++
++  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
++
++  "Data": "string" ~/~/ Данные
++
++}
++
++
  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
  (% class="box infomessage" %)
@@ -4287,10 +4287,59 @@
    "message": "string"
  }
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
--|progress|Guid ТС
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
++**Параметр**
++)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
++**Описание**
++)))
++|(((
++activity
++)))|(((
++Активен ли экспорт/импорт истории сейчас, true - да, false - нет
++)))
++|(((
++progress
++)))|(((
++Guid ТС
++)))
++== **Возвращает статус асинхронного запроса импорта истории ТС** ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
++)))
++
++При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
++
++Метод запроса: **GET**
++
++URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
++
++Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
++
++
++Ответ:
++
++{
++
++  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
++
++  "Status": 0, ~/~/ Перечисление состояний выполения запроса
++~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
++
++  "Message": "string", ~/~/ Информация о выполнении запроса
++
++  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
++
++~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
++
++  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
++
++  "Data": "string" ~/~/ Данные
++
++}
++
  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
  (% class="box infomessage" %)
@@ -4802,8 +4802,51 @@
      }
    ]
  }
++
++
++== **Превышение скорости** ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/Reports/overSpeedDuration**
  )))
++ Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
++
++Пример запроса:
++
++(((
++{
++  "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
++  "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
++  "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
++  "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
++  "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный )
++}
++)))
++
++(((
++
++)))
++
++(((
++Пример ответа:
++)))
++
++(((
++(((
++[
++  {
++    "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события
++    "duration": 0, ~/~/ Продолжительность события в секундах
++    "maxSpeed": 0, ~/~/ Максимальная скорость
++    "speedLimit": 0 ~/~/ Ограничение скорости
++  }
++]
++)))
++)))
++)))
++
  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
@@ -4878,13 +4878,16 @@
  **POST /api/v3/agroLands**
  )))
++Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать
++X-agent  - ID клиента
++
  Пример запроса:
  (((
  {
    "extId": "string",
--  "shape": "string", ~/~/ Форма поля
--  "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
++  "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
++  "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
    "display": "string", ~/~/ Настройки отображения
    "year": 0, ~/~/ Год поля
    "name": "string", ~/~/ Наименование
@@ -5524,10 +5524,10 @@
  ]
--= **Раздел: Контроллер информации о пользователях** =
++= **Раздел: Журнал заданий ** =
--== **Добавить задание** ==
++== **Создание задания в Журнале заданий** ==
  (% class="box infomessage" %)
  (((
@@ -5606,7 +5606,7 @@
  }
--== **Обновить задание ** ==
++== **Редактирование задания в Журнале заданий** ==
  (% class="box successmessage" %)
  (((
@@ -5685,7 +5685,7 @@
  }
--== Удаление заданий механизатора  ==
++== **Удаление задания в Журнале заданий** ==
  (% class="box warningmessage" %)
  (((
@@ -5739,7 +5739,7 @@
  }
--== **Получение задач за период ** ==
++== **Получение списка Журнала заданий** ==
  (% class="box infomessage" %)
  (((
@@ -5805,6 +5805,566 @@
  )))
++= **Раздел: Роли** =
++
++== **Получение списка клиентских и системных ролей пользователя ** ==
++
++(% class="box successmessage" %)
++(((
++**POST /api/v3/groups/find**
++)))
++
++Пример запроса:
++
++(((
++{
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
++  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей
++}
++)))
++
++(((
++
++)))
++
++(((
++Пример ответа:
++)))
++
++(((
++(((
++{
++  "groups": [  ~/~/ Системные роли пользователя
++    {
++      "code": "string", ~/~/ Код роли.
++      "name": "string", ~/~/ Имя
++      "shortName": "string" ~/~/ Короткое имя
++    }
++  ],
++  "customGroups": [ ~/~/ Системные роли пользователя
++    {
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
++      "name": "string", ~/~/ Наименование
++      "shortName": "string", ~/~/ Короткое наименование
++      "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
++    }
++  ]
++}
++)))
++)))
++
++(((
++
++)))
++
++(((
++
++)))
++
++= **Раздел: Локатор ** =
++
++
++== **Получение списка локаторов, доступных пользователю ** ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/locators **
++)))
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++
++Пример ответа:
++
++(((
++(((
++{
++  "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую
++    0
++  ],
++  "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую
++    0
++  ],
++  "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую
++    0
++  ],
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
++  "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
++  "agentName": "string", ~/~/ Наименование агента.
++  "isEnabled": true, ~/~/ Активность
++  "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
++  "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
++  "name": "string", ~/~/ Наименование.
++  "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный)
++  "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
++  "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
++  "validity": 0, ~/~/ Значение срока действия
++  "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2)
++  "autoProlongation": true, ~/~/ Автопродление срока действия.
++  "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
++  "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
++  "url": "string", ~/~/ Ссылка
++  "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
++  "showVehicleName": true, ~/~/ Наименование объекта
++  "showVehicleDirection": true, ~/~/ Направление движения на треке
++  "allowTrackReport": true, ~/~/ Трек
++  "showTrackTracing": true, ~/~/ Трассировка трека
++  "showSensors": true, ~/~/ Датчик
++  "availableMapLayers": [ ~/~/  Слои на карте
++    0
++  ]
++}
++)))
++)))
++
++
++(((
++(((
++
++)))
++)))
++
++
++== **Создание локатора** ==
++
++(% class="box successmessage" %)
++(((
++**POST /api/v3/locators**
++)))
++
++Пример запроса:
++
++(((
++{
++  "isEnabled": true, ~/~/ Активность
++  "name": "string", ~/~/ Наименование локатора
++  "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
++  "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
++  "validity": 0, ~/~/ Срок действия в днях (1-90)
++  "autoProlongation": true, ~/~/ Автопродление срока действия.
++  "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую
++    0
++  ],
++  "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую
++    0
++  ],
++  "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую
++    0
++  ],
++  "showVehicleName": true, ~/~/ Наименование объекта
++  "showVehicleDirection": true, ~/~/ Направление движения на треке
++  "allowTrackReport": true, ~/~/ Трек
++  "showTrackTracing": true, ~/~/ Трассировка трека
++  "showSensors": true, ~/~/ Датчик
++  "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
++      ]
++}
++)))
++
++
++Пример ответа:
++
++(((
++3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
++)))
++
++
++== **Выводит список локаторов ** ==
++
++(% class="box successmessage" %)
++(((
++**POST /api/v3/locators/find**
++)))
++
++Пример запроса:
++
++(((
++{
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента
++}
++)))
++
++(((
++
++)))
++
++(((
++{
++  "isEnabled": true, ~/~/ Активность
++  "name": "string", ~/~/ Наименование локатора
++  "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
++  "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
++  "validity": 0, ~/~/ Срок действия в днях (1-90)
++  "autoProlongation": true, ~/~/ Автопродление срока действия.
++  "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
++  "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую
++    0
++  ],
++  "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую
++    0
++  ],
++  "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую
++    0
++  ],
++  "showVehicleName": true, ~/~/ Наименование объекта
++  "showVehicleDirection": true, ~/~/ Направление движения на треке
++  "allowTrackReport": true, ~/~/ Трек
++  "showTrackTracing": true, ~/~/ Трассировка трека
++  "showSensors": true, ~/~/ Датчик
++  "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
++      ]
++}
++)))
++
++
++Пример ответа:
++
++(((
++[
++  {
++    "vehiclesCount": 0, ~/~/ Количество объектов.
++    "geozonesCount": 0, ~/~/ Количество геозон.
++    "fieldsCount": 0, ~/~/ Количество полей.
++    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
++    "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
++    "agentName": "string", ~/~/ Наименование агента.
++    "isEnabled": true, ~/~/ Активность локатора
++    "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания
++    "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления
++    "name": "string", ~/~/ Наименование локатора
++    "status": 0,   ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный)
++    "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени )
++    "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC)
++    "validity": 0, ~/~/ Срок действия в днях (1-90)
++    "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2)
++    "autoProlongation": true, ~/~/ Автоматическая пролонгация
++    "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
++    "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора
++    "url": "string", ~/~/ ссылка на локатор
++    "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
++    "showVehicleName": true, ~/~/ Наименование объекта
++    "showVehicleDirection": true, ~/~/ Направление движения на треке
++    "allowTrackReport": true, ~/~/ Трек
++    "showTrackTracing": true, ~/~/ Трассировка трека
++    "showSensors": true, ~/~/ Датчик
++    "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ГИС)
++
++    0
++    ]
++  }
++]
++)))
++
++
++
++== **Изменение локатора** ==
++
++(% class="box infomessage" %)
++(((
++**PUT /api/v3/locators**
++)))
++
++Пример запроса:
++
++(((
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
++  "isEnabled": true, ~/~/ Активность
++  "name": "string", ~/~/ Наименование
++  "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени )
++  "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
++  "validity": 0, ~/~/ Срок действия в днях (1-90)
++  "autoProlongation": true, ~/~/ Автопродление срока действия
++  "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
++ "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую
++    0
++  ],
++  "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую
++    0
++  ],
++  "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую
++    0
++  ],
++  "showVehicleName": true, ~/~/ Наименование объекта
++  "showVehicleDirection": true, ~/~/ Направление движения на треке
++  "allowTrackReport": true, ~/~/ Трек
++  "showTrackTracing": true, ~/~/ Трассировка трека
++  "showSensors": true, ~/~/ Датчик
++  "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
++  ]
++}
++
++
++)))
++
++Пример ответа:
++
++200 ~/~/ Success
++
++
++== **Удалить локатор** ==
++
++(% class="box warningmessage" %)
++(((
++**DELETE /api/v3/locators**
++)))
++
++Пример запроса:
++
++(((
++[
++  "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
++]
++)))
++
++
++
++= **Раздел: Яндекс Маршруты** =
++
++
++== **Возвращение списка маршрутов** ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/TransportRoutes**
++)))
++
++Пример запроса:
++Id  ~/~/ Идентификатор поля
++
++
++Пример ответа:
++
++(((
++[
++  {
++    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id
++    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
++    "name": "string", ~/~/ Наименование маршрута.
++    "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
++    "vehicles": [  ~/~/ Определяет список ТС для маршрута
++      0
++    ]
++  }
++]
++)))
++
++
++
++== **Добавить маршрут** ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/TransportRoutes**
++)))
++
++Пример запроса:
++{
++  "name": "string",  ~/~/  Опредлеляет наименование маршрута.
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
++  "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
++  "vehicles": [  ~/~/ Определяет список ТС для маршрута
++    0
++  ]
++}
++
++
++Пример ответа:
++
++(((
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
++  "name": "string", ~/~/ Определяет наименование маршрута
++  "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
++  "vehicles": [ ~/~/ Определяет список ТС для маршрута
++    0
++  ]
++}
++)))
++
++
++== **Обновление маршрута** ==
++
++(% class="box successmessage" %)
++(((
++**PUT /api/v3/TransportRoutes**
++)))
++
++Пример запроса:
++
++(((
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
++  "name": "string", ~/~/ Опредлеляет наименование маршрута.
++  "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
++  "vehicles": [ ~/~/ Определяет список ТС для маршрута
++    0
++  ]
++}
++)))
++
++
++Пример ответа:
++
++(((
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
++  "name": "string", ~/~/ Определяет наименование маршрута
++  "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
++  "vehicles": [ ~/~/ Определяет список ТС для маршрута
++    0
++  ]
++}
++)))
++
++
++== **Получить связки маршрутов ТС** ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/TransportRoutes/getroutesvehicles**
++)))
++
++Пример запроса:
++
++(((
++[
++  "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
++]
++)))
++
++
++Пример ответа:
++
++(((
++[
++  {
++    "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
++    "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
++  }
++]
++)))
++
++
++== **Удалить маршрут** ==
++
++(% class="box warningmessage" %)
++(((
++**DELETE /api/v3/TransportRoutes/{id}**
++)))
++
++Пример запроса:
++Id  ~/~/ Идентификатор поля
++
++
++
++= **Раздел: Управление доступа к машинам** =
++
++
++== Получение списка транспортных средств видимых пользователю ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/UserVisibleVehicles/{userId}**
++)))
++
++Пример ответа:
++
++(((
++{
++  "vehicleIds": [  ~/~/ Идентификаторы ТС
++    0
++  ]
++}
++)))
++
++
++
++== Задает видимость транспортных средств пользователю ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/UserVisibleVehicles**
++)))
++
++Пример запроса:
++
++(((
++(((
++{
++  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
++  "vehicleIds": [ ~/~/ Идентификаторы ТС
++    0
++  ]
++}
++)))
++
++(((
++
++)))
++
++(((
++
++)))
++
++(((
++Пример ответа :
++)))
++
++(((
++
++)))
++
++(((
++200 ~/~/ Success
++)))
++)))
++
++
++== **Получение перечня моделей ** ==
++
++(% class="box successmessage" %)
++(((
++**POST /api/v3/models/find**
++)))
++
++Пример запроса:
++
++(((
++(((
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
++  "name": "string", ~/~/ Наименование локатора
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей
++)))
++
++
++
++ Пример ответа:
++
++
++(((
++[
++  {
++    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
++    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные
++    "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные
++    "name": "string", ~/~/ Наименование локатора
++    "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины)
++  }
++]
++)))
++)))
++
++
++
++
  (% class="box" lang="en-US" style="text-align: center;" %)
  (((
  (% 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]] **

Changes for page Методы API для работы с ГЛОНАССSoft

Summary

Details

Меню