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

Last modified by Павел Субботин on 2025/12/11 11:25

From version < 259.1

edited by Павел Субботин
on 2025/12/11 11:25

To version < 241.2 >

edited by Андрей Калиновский
on 2025/06/27 13:52

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.subbotinpa
++XWiki.Gadmin

Content

@@ -6,7 +6,7 @@
  просим вас соблюдать несколько простых правил при использовании API-команд:##
  )))
--* Формировать не более 2 запроса в секунду с кратковременным разрешением до 3-х.
++* Формировать не более 3 отчётов одновременно.
  * Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
  В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
@@ -287,6 +287,28 @@
    "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" %)Идентификатор клиента-родителя
++|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
++|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
++|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
++|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
++|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
++|(% style="width:215px" %)district|(% style="width:861px" %)Округ
++|(% style="width:215px" %)region|(% style="width:861px" %)Регион
++|(% style="width:215px" %)city|(% style="width:861px" %)Город
++|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
++|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
++|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
++|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
++|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
++|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
++|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
++|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
++|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
++|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
++
  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
  (% class="box warningmessage" %)
@@ -432,7 +432,7 @@
      [
         "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
      ],
--    "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
++    "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
  }
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -744,11 +744,6 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
--(% class="wikigeneratedid" id="H" %)
--(((
--
--)))
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
@@ -2372,7 +2372,7 @@
  Тело запроса:
  {
--  "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
++  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
    "vehicleIds": [0], ~/~/ Список ID объектов
    "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
    "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
@@ -2419,7 +2419,7 @@
  Тело запроса:
  {
--  "sampling": 0, ~/~/ Частота дискретизации, параметр игнорируется
++  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
    "vehicleIds": [0], ~/~/ Список ID объектов
    "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
    "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
@@ -2569,415 +2569,185 @@
  В заголовках запроса: X-Auth: Токен авторизации
--В массиве указываем id объектов через запятую
++В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
  Ответ:
--
--[
    {
--    "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": [ ~/~/ Сведения по геозонам.
++    "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": [ ~/~/Сведения по геозонам.
        {
--        "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" ~/~/ Наименование геозоны
++        "id": 0,
++        "name": "string"
        }
--    ]
--  }
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
--== (% style="color:#000000; font-size:16px" %)**Получение информации о геозоне по ID геозоны **(%%) ==
++== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
  (% class="box infomessage" %)
  (((
--**GET /api/v3/gis/{geozoneId}**
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
  )))
--Пример запроса:
--\\geozoneId ~/~/ id геозоны
++(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
++(% style="color:#000000" %)Метод запроса: **POST**
--(% style="text-align:left" %)
--Ответ:
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
--(((
--{
--  "id": 0, ~/~/ Идентификатор объекта геозоны
--  "name": "string", ~/~/ Наименование объекта геозоны
--  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
--  "description": "string", ~/~/ Описание объекта геозоны
--  "beginCalc": "2025-12-04T07:13:04.658Z", ~/~/ Дата начала расчетов для геозоны
--  "endCalc": "2025-12-04T07:13:04.658Z", ~/~/ Дата окончания расчетов для геозоны
--  "settingsData": "string", ~/~/ Параметры отображения в формате XML.
--  "type": 0, ~/~/ Тип геозоны - линия,полигон
--  "radius": 0, ~/~/ Радиус геозоны
--  "shape": "string", ~/~/ Координаты геозоны
--  "shape_format": "string" ~/~/ Формат xml,json
--}
--)))
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(((
--
--)))
++(% style="text-align:left" %)
++Тело запроса:
--== **Удаление геообъекта ** ==
--
--(((
--
--)))
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/gis/{geozoneId}**
--)))
--
--(((
--Пример запроса:
--)))
--
--(((
--
--)))
--
--(((
--geozoneId ~/~/ Id геообъекта
--)))
--
--(((
--
--)))
--
--(((
--Пример ответа:
--)))
--
--(((
--
--)))
--
--(((
--200 ~/~/ Success
--)))
--
--(((
--
--)))
--
--== **Возвращение данных по пересечению объектами геозон ** ==
--
--(((
--
--)))
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/gis/intersections/geozones**
--)))
--
--(((
--Пример запроса:
--)))
--
--(((
--(((
++(% style="text-align:left" %)
  {
--  "startDate": "2025-12-04T07:19:27.628Z", ~/~/ Дата и время начала расчета
--  "endDate": "2025-12-04T07:19:27.628Z", ~/~/ Дата и время конца расчета
--  "ids": [ ~/~/ Идентификаторы объектов
--    0
--  ],
--  "byTime": 0, ~/~/ объединение геообъектов по времени (секунды)
--  "byDist": 0, ~/~/ объединение геообъектов по расстоянию(метры)
--  "filterByTime": 0, ~/~/ Фильтрация посещений по времени, сек.
--  "filterByHalfPerimeter": true, ~/~/ Фильтрация по половине периметра геообъекта
--  "includeMotoHours": true ~/~/ Флаг, включать ли моточасы в отчет
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
--)))
--)))
--(((
--
--)))
++(% style="text-align:left" %)
++Ответ:
--(((
--Пример ответа:
--)))
--
--(((
--(((
  [
    {
--    "geozoneId": 0, ~/~/ ID геозоны
--    "geozoneName": "string", ~/~/ Наименование геозоны
--    "startDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время входа из геозоны
--    "endDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время выхода из геозоны
--    "duration": 0, ~/~/ Продолжительность внутри геозоны
--    "vehicleId": 0, ~/~/ ID объекта
--    "vehicleName": "string", ~/~/ Имя объекта
--    "motoHours": 0 ~/~/ Моточасы
++    "id": 0, ~/~/ Идентификатор объекта геозоны
++    "name": "string", ~/~/ Название объекта геозоны
++    "type": 0, ~/~/ Тип объекта геозоны
++    "fname": "string", ~/~/ Имя файла
++    "parentId": "string", ~/~/ Идентификатор клиента
++    "radius": 0, ~/~/ Радиус геообъекта
++    "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
++    "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
++    "description": "string", ~/~/ Описание
++    "area": 0, ~/~/ Площадь, м^^2^^
++    "perimetr": 0, ~/~/ Периметр, м
++    "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
    }
  ]
--)))
--)))
++== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
++
++(% class="box infomessage" %)
  (((
--
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
  )))
--== **Возвращение данных по пересечению геозон для объектов с заданными ID ** ==
++(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
--(((
--
--)))
++(% style="color:#000000" %)Метод запроса: **POST**
--(% class="box successmessage" %)
--(((
--**POST /api/v3/gis/intersections/vehicles**
--)))
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
--(((
--Пример запроса:
--)))
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(((
--
--)))
++(% style="text-align:left" %)
++Тело запроса:
--(((
--(((
  {
--  "startDate": "2025-12-04T07:26:11.520Z", ~/~/ Дата и время начала расчета
--  "endDate": "2025-12-04T07:26:11.520Z", ~/~/ Дата и время конца расчета
--  "ids": [ ~/~/ Идентификаторы объектов
--    0
--  ],
--  "byTime": 0, ~/~/ объединение геообъектов по времени (секунды)
--  "byDist": 0, ~/~/ объединение геообъектов по расстоянию(метры)
--  "filterByTime": 0, ~/~/ Фильтрация посещений по времени, сек.
--  "filterByHalfPerimeter": true, ~/~/ Фильтрация по половине периметра геообъекта
--  "includeMotoHours": true ~/~/ Флаг, включать ли моточасы в отчет
++  "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
++  "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
++  "ids": [ ], ~/~/ Массив id объектов
++  "byTime": 0, ~/~/ Объединение событий по времени
++  "byDist": 0, ~/~/ Объединение событий по расстоянию
++  "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
++  "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
  }
--)))
--)))
--(((
--
--)))
--
--(((
--Пример ответа:
--)))
--
--(((
++Ответ:
  [
    {
--    "geozoneId": 0, ~/~/ ID геозоны
--    "geozoneName": "string", ~/~/ Наименование геозоны
--    "startDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время входа из геозоны
--    "endDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время выхода из геозоны
--    "duration": 0, ~/~/ Продолжительность внутри геозоны
++    "geozoneId": 0, ~/~/ ID геообъекта
++    "geozoneName": "string", ~/~/ Название геообъекта
++    "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
++    "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
++    "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
      "vehicleId": 0, ~/~/ ID объекта
--    "vehicleName": "string", ~/~/ Имя объекта
--    "motoHours": 0 ~/~/ Моточасы
++    "vehicleName": "string" ~/~/ Имя объекта
    }
  ]
--)))
++== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
++
++(% class="box infomessage" %)
  (((
--
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
  )))
--== **Получение списка геозон** ==
++(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
--(((
--
--)))
++(% style="color:#000000" %)Метод запроса: **POST**
--(% class="box successmessage" %)
--(((
--**POST /api/v3/gis/find**
--)))
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
--(((
--(((
--Пример запроса:
--)))
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(((
--
--)))
++(% style="text-align:left" %)
++Тело запроса:
--(((
  {
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента, для которого надо получить данные.
++  "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
++  "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
++  "ids": [ ], ~/~/ Массив id геообъектов
++  "byTime": 0, ~/~/ Объединение событий по времени
++  "byDist": 0, ~/~/ Объединение событий по расстоянию
++  "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
++  "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
  }
--)))
--)))
--(((
--
--)))
++Ответ:
--(((
--Пример ответа:
--)))
--
--(((
--(((
  [
    {
--    "id": 0, ~/~/ Идентификатор объекта геозоны
--    "name": "string", ~/~/ Название объекта геозоны
--    "type": 0, ~/~/ Тип объекта геозоны
--    "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
--    "fname": "string", ~/~/ Имя файла
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента
--    "beginCalc": "2025-12-04T07:31:23.082Z", ~/~/ Дата начала расчетов для геозоны
--    "endCalc": "2025-12-04T07:31:23.082Z", ~/~/ Дата окончания расчетов для геозоны
--    "description": "string",  ~/~/ Описание объекта геозоны
--    "area": 0, ~/~/ Площадь, м2
--    "perimetr": 0, ~/~/ Периметр, м
--    "createDate": "2025-12-04T07:31:23.082Z" ~/~/ Дата создания в бд
++    "geozoneId": 0, ~/~/ ID геообъекта
++    "geozoneName": "string", ~/~/ Название геообъекта
++    "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
++    "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
++    "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
++    "vehicleId": 0, ~/~/ ID объекта
++    "vehicleName": "string" ~/~/ Имя объекта
    }
  ]
--)))
--)))
--(((
--
--)))
--== **Создание геообъекта** ==
++== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
--(((
--
--)))
--
  (% class="box successmessage" %)
  (((
--**POST /api/v3/gis**
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
  )))
--(((
--(((
++(% style="color:#000000" %)Метод запроса: **PUT**
++
  Пример запроса:
--\\{
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента
--  "name": "string", ~/~/ Наименование объекта геозоны
--  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
--  "description": "string", ~/~/ Описание объекта геозоны
--  "beginCalc": "2025-12-04T07:35:07.395Z", ~/~/ Дата начала расчетов для геозоны
--  "endCalc": "2025-12-04T07:35:07.395Z",  ~/~/ Дата окончания расчетов для геозоны
--  "settingsData": "string",  ~/~/ Параметры отображения в формате XML
--  "type": 0, ~/~/ Тип геозоны - линия,полигон
--  "radius": 0, ~/~/ Радиус геозоны
--  "shape": "string", ~/~/ Координаты геозоны
--  "shape_format": "string" ~/~/ Формат xml,json,
--}
--)))
--)))
  (((
--
--)))
--
--(((
--Пример ответа:
--)))
--
--(((
--
--)))
--
--(((
--200 ~/~/ Success
--)))
--
--(((
--
--)))
--
--== **Редактирование геообъекта ** ==
--
--(((
--
--)))
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/gis**
--)))
--
--(((
--(((
--Пример запроса:
  {
--  "id": 0, ~/~/ Идентификатор объекта геозоны
--  "name": "string", ~/~/ Наименование объекта геозоны
--  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
--  "description": "string", ~/~/ Описание объекта геозоны
--  "beginCalc": "2025-12-04T07:38:55.221Z", ~/~/ Дата начала расчетов для геозоны
--  "endCalc": "2025-12-04T07:38:55.221Z", ~/~/ Дата окончания расчетов для геозоны
--  "settingsData": "string", ~/~/ Параметры отображения в формате XML.
--  "type": 0, ~/~/ Тип геозоны - линия,полигон
--  "radius": 0, ~/~/ Радиус геозоны
--  "shape": "string", ~/~/ Координаты геозоны
--  "shape_format": "string" ~/~/Формат xml,json
++  "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.
  }
  )))
--)))
--(((
--
--)))
--(((
--Пример ответа:
--)))
++Пример ответа:
--(((
--
--)))
--
--(((
 ~/~/ Success
--)))
--(((
--
--)))
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
@@ -3097,6 +3097,10 @@
  )))
++(((
++
++)))
++
  Ответ:
  {
@@ -5633,9 +5633,33 @@
  )))
++== **Удаление существующего поля** ==
++
++(% class="box errormessage" %)
  (((
++**DELETE /api/v3/agroLands/{id}**
++)))
++
++Пример запроса:
++id  ~/~/ Идентификатор поля
++
++Пример ответа:
++
  (((
++200 ~/~/ Успех
++)))
++
  (((
++
++)))
++
++(((
++(((
++(((
++
++)))
++
++(((
  == **Изменение поля** ==
  (% class="box infomessage" %)
@@ -5881,102 +5881,9 @@
    "perimetr": 0, ~/~/ ериметр, м
    "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
  }
--
--
--== **Какие поля посещал объект** ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/agroLands/visitingByVehicle**
  )))
--Пример запроса:
--{
--  "vehicleId": 0, ~/~/ id объекта
--  "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
--  "byTime": 0, ~/~/ Объединение событий по времени
--  "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
--  "byDist": 0, ~/~/ Объединение событий по расстоянию
--  "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента)
--  "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента)
--  "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
--}
--
--Пример ответа:
--
--[
--  {
--    "fieldId": 0, ~/~/ id объекта
--    "vehicleName": "string", ~/~/ Наименование объекта
--    "fieldName": "string", ~/~/ Наименование поля
--    "fuelUsage": 0, ~/~/ Расход топлива, л/га
--    "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
--    "vehicleId": 0, ~/~/ Идентификатор ТС
--    "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения
--    "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения
--    "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля
--    "mileage": 0 ~/~/ Пробег
--  }
--]
--)))
--
--
--== **Посещение поля объектами ** ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/agroLands/visitingByField**
--)))
--
--Пример запроса:
--{
--  "fieldId": 0, ~/~/ ID поля
--  "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
--  "byTime": 0, ~/~/ Объединение событий по времени
--  "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
--  "byDist": 0, ~/~/ Объединение событий по расстоянию
--  "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента)
--  "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента)
--  "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
--}
--
--Пример ответа:
--
--[
--  {
--    "fieldId": 0, ~/~/ ID поля
--    "vehicleName": "string", ~/~/ Наименование объекта
--    "fieldName": "string", ~/~/ Имя поля
--    "fuelUsage": 0, ~/~/ Расход топлива, л/га
--    "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
--    "vehicleId": 0, ~/~/ Идентификатор ТС
--    "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения
--    "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения
--    "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля
--    "mileage": 0 ~/~/ Пробег
--  }
--]
--
--
--== **Удаление существующего поля** ==
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/agroLands/{id}**
--)))
--
--Пример запроса:
--id  ~/~/ Идентификатор поля
--
--Пример ответа:
--
--(((
--200 ~/~/ Успех
--
--
--)))
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
  )))
  )))
@@ -6079,6 +6079,7 @@
  В заголовках запроса: X-Auth: Токен авторизации
++
  Пример запроса:
  (((
@@ -6165,6 +6165,7 @@
  }
  )))
++
  Пример ответа:
  {
@@ -6295,9 +6295,11 @@
  )))
  (((
--Пример ответа:
++
  )))
++Пример ответа:
++
  {
    "vehicleId": 0, ~/~/ Идентификатор ТС
    "description": "string", ~/~/ Описание
@@ -6449,30 +6449,35 @@
  )))
++(((
++
++)))
++
  = **Раздел: Локатор ** =
--== **Получение данных по локатору** ==
++== **Получение списка локаторов, доступных пользователю ** ==
  (% class="box infomessage" %)
  (((
--**GET /api/v3/locators/{locatorId}**
++**GET /api/v3/locators **
  )))
--В запросе указывается locatorid - идентификатор локатора
++В заголовках запроса: X-Auth: Токен авторизации
++
  Пример ответа:
  (((
  (((
  {
--  "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую
++  "vehiclesIds": [ ~/~/ Объекты
    ],
--  "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую
++  "geoIds": [ ~/~/ Геозоны
    ],
--  "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую
++  "fieldsIds": [ ~/~/ Поля
    ],
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
@@ -6491,23 +6491,56 @@
    "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
    "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
    "url": "string", ~/~/ Ссылка
--  "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
++  "language": 0, ~/~/ Язык
++  "showVehicleName": true, ~/~/ Наименование объекта
++  "showVehicleDirection": true, ~/~/ Направление движения на треке
++  "allowTrackReport": true, ~/~/ Трек
++  "showTrackTracing": true, ~/~/ Трассировка трека
++  "showSensors": true, ~/~/ Датчик
++  "availableMapLayers": [ ~/~/  Слои на карте
++    0
++  ]
++}
++)))
++)))
-- "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ГИС)
--  1
++== **Получение перечня моделей ** ==
--  ]
--}
++(% 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 successmessage" %)
@@ -6527,29 +6527,26 @@
    "autoProlongation": true, ~/~/ Автопродление срока действия.
    "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую
++  "vehiclesIds": [ ~/~/ Oбъекты
    ],
--  "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую
++  "geoIds": [ ~/~/ Геозоны
    ],
--  "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую
++  "fieldsIds": [ ~/~/ Поля
    ],
--
-- "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ГИС)
--
--    1
--
++  "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ГИС)
        ]
  }
  )))
++
  Пример ответа:
  (((
@@ -6557,64 +6557,7 @@
  )))
--== **Выводит список локаторов ** ==
--(% class="box successmessage" %)
--(((
--**POST /api/v3/locators/find**
--)))
--
--Пример запроса:
--
--(((
--{
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента
--}
--)))
--
--(((
--
--)))
--
--Пример ответа:
--
--(((
--[
--  {
--    "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" %)
@@ -6634,24 +6634,21 @@
    "validity": 0, ~/~/ Срок действия в днях (1-90)
    "autoProlongation": true, ~/~/ Автопродление срока действия
    "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
-- "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую
++  "vehiclesIds": [ ~/~/ Oбъекты
    ],
--  "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую
++  "geoIds": [ ~/~/ Геозоны
    ],
--  "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую
++  "fieldsIds": [ ~/~/ Поля
    ],
    "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
--
++  "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ГИС)
    ]
  }
@@ -6679,15 +6679,216 @@
  )))
--=   =
++= **Раздел: Яндекс Маршруты** =
++
++
++== **Возвращение списка маршрутов** ==
++
++(% 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

Меню