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

Last modified by Андрей Калиновский on 2025/06/27 16:12

From version < 240.1 >

edited by Андрей Калиновский
on 2025/06/09 16:36

To version < 213.1 >

edited by Андрей Калиновский
on 2025/03/19 13:51

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -13,10 +13,12 @@
  (% class="box infomessage" %)
  (((
--**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
--\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
++**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в пользовательских настройках.
  )))
++При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
++
++
  **Содержание страницы:**
  )))
@@ -123,41 +123,29 @@
  Запрос должен содержать данные параметра "**agentId**"
  (% style="color:#000000" %)Ответ:
--
--(((
  {
--  "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" ~/~/ Значение поля формы
--            }
--          ]
--        }
--      ]
--    }
--  ]
--}
--)))
++    "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"
++  }
--
  |=(% 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" %)Идентификатор клиента-родителя
@@ -877,7 +877,7 @@
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": false,
++  "deleted": true,
    "extId": "string",
    "name": "string",
    "picture": "string",
@@ -896,7 +896,7 @@
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": false,
++  "deleted": true,
    "extId": "string",
    "name": "string",
    "picture": "string",
@@ -930,7 +930,7 @@
  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
  )))
--(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -997,7 +997,7 @@
  (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
  )))
--(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
++(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
  (% style="color:#000000" %)Метод запроса: **DELETE**
@@ -1628,6 +1628,77 @@
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
++== **Импортировать историю ТС (Асинхронный запрос)** ==
++
++(% 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" %)
@@ -1773,6 +1773,7 @@
    "stage": "", ~/~/ Состояние
  (% style="color:#000000" %)  }
++==   ==
  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
@@ -2455,12 +2455,8 @@
          "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
          "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
          "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
--        "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
--        "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
          "fuelConsumption": 0, ~/~/ Расход топлива
          "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
--         "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
--
        }
      ]
    }
@@ -2506,8 +2506,7 @@
      "model": "string", ~/~/ Модель объекта
      "fuels": [ ~/~/ Массив данным по заправкам и сливам
        {
--        "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
--
++        "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
          "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
          "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
          "valueFuel": 0, ~/~/ Количество
@@ -2736,35 +2736,6 @@
    }
  ]
--
--== (% 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" %)**Запрос списка уведомлений клиента**(%%) ==
@@ -2796,7 +2796,7 @@
      "id": 0, ~/~/ ID уведомления
      "name": "string", ~/~/ Название уведомления
      "active": true, ~/~/ Состояние true - активен, false - деактивирован
--    "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя)
++    "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
      "userId": "", ~/~/ Пользователь, создавший уведомление
      "parentId": "", ~/~/ Идентификатор клиента
      "parentName": "string" ~/~/ Имя клиента
@@ -2803,155 +2803,6 @@
    }
  ]
--
--== (% 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" %)
@@ -4398,43 +4398,6 @@
  |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" %)
@@ -4452,59 +4452,10 @@
    "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" %)
@@ -5016,51 +5016,8 @@
      }
    ]
  }
--
--
--== **Превышение скорости** ==
--
--(% 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" %)**Раздел: Сельскохозяйственные поля **(%%) =
@@ -6065,62 +6065,6 @@
  )))
--= **Раздел: Роли** =
--
--== **Получение списка клиентских и системных ролей пользователя ** ==
--
--(% 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" ~/~/ Идентификатор владельца
--    }
--  ]
--}
--)))
--)))
--
--(((
--
--)))
--
--(((
--
--)))
--
  = **Раздел: Локатор ** =
@@ -6128,7 +6128,7 @@
  (% class="box infomessage" %)
  (((
--**GET /api/v3/locators **
++**GET /api/v3/locators**
  )))
  В заголовках запроса: X-Auth: Токен авторизации
@@ -6137,83 +6137,33 @@
  Пример ответа:
  (((
--(((
--{
--  "vehiclesIds": [ ~/~/ Объекты
--    0
--  ],
--  "geoIds": [ ~/~/ Геозоны
--    0
--  ],
--  "fieldsIds": [ ~/~/ Поля
--    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, ~/~/ Язык
--  "showVehicleName": true, ~/~/ Наименование объекта
--  "showVehicleDirection": true, ~/~/ Направление движения на треке
--  "allowTrackReport": true, ~/~/ Трек
--  "showTrackTracing": true, ~/~/ Трассировка трека
--  "showSensors": true, ~/~/ Датчик
--  "availableMapLayers": [ ~/~/  Слои на карте
--    0
--  ]
--}
--)))
--)))
--
--
--== **Получение перечня моделей ** ==
--
--(% 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 - Машины)
++    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
++    "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
++    "agentName": "string", ~/~/ Наименование агента.
++    "isEnabled": true, ~/~/ Активен
++    "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
++    "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
++    "name": "string", ~/~/ Наименование
++    "status": 0, ~/~/
++    "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный)
++    "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации)
++    "validity": 0, ~/~/ Срок действия в днях (1-90).
++    "autoProlongation": true, ~/~/ Автопродление срока действия.
++    "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
++    "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
++    "url": "string", ~/~/ Ссылка
++    "language": 0, ~/~/ Язык.
++    "vehiclesCount": 0, ~/~/ Количество объектов.
++    "geozonesCount": 0, ~/~/ Количество геозон.
++    "fieldsCount": 0 ~/~/ Количество полей.
    }
  ]
  )))
--)))
++
  == **Создание локатора** ==
  (% class="box successmessage" %)
@@ -6234,24 +6234,6 @@
    "autoProlongation": true, ~/~/ Автопродление срока действия.
    "url": "string", ~/~/ Ссылка
    "language": 0 ~/~/ Язык
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "vehiclesIds": [ ~/~/ Oбъекты
--    0
--  ],
--  "geoIds": [ ~/~/ Геозоны
--    0
--  ],
--  "fieldsIds": [ ~/~/ Поля
--    0
--  ],
--  "showVehicleName": true, ~/~/ Наименование объекта
--  "showVehicleDirection": true, ~/~/ Направление движения на треке
--  "allowTrackReport": true, ~/~/ Трек
--  "showTrackTracing": true, ~/~/ Трассировка трека
--  "showSensors": true, ~/~/ Датчик
--  "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
--    0
--  ]
  }
  )))
@@ -6284,29 +6284,10 @@
    "autoProlongation": true, ~/~/ Автопродление срока действия
    "url": "string", ~/~/ Ссылка
    "language": 0 ~/~/ Язык
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "vehiclesIds": [ ~/~/ Oбъекты
--    0
--  ],
--  "geoIds": [ ~/~/ Геозоны
--    0
--  ],
--  "fieldsIds": [ ~/~/ Поля
--    0
--  ],
--  "showVehicleName": true, ~/~/ Наименование объекта
--  "showVehicleDirection": true, ~/~/ Направление движения на треке
--  "allowTrackReport": true, ~/~/ Трек
--  "showTrackTracing": true, ~/~/ Трассировка трека
--  "showSensors": true, ~/~/ Датчик
--  "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
--    0
--  ]
  }
--
--
  )))
++
  Пример ответа:
 ~/~/ Success
@@ -6329,215 +6329,7 @@
--= **Раздел: Яндекс Маршруты** =
--
--== **Возвращение списка маршрутов** ==
--
--(% 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" 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

Меню