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

Last modified by Андрей Калиновский on 2025/09/11 10:51

From version < 240.1 >

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

To version < 261.1

edited by Андрей Калиновский
on 2025/09/11 10: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

@@ -287,28 +287,6 @@
    "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" %)
@@ -454,7 +454,7 @@
      [
         "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
      ],
--    "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
++    "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
  }
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -766,6 +766,11 @@
  (% 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" %)**Получение информации о модели объекта**(%%) ==
@@ -2389,7 +2389,7 @@
  Тело запроса:
  {
--  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
++  "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
    "vehicleIds": [0], ~/~/ Список ID объектов
    "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
    "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
@@ -2436,7 +2436,7 @@
  Тело запроса:
  {
--  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
++  "sampling": 86400, ~/~/ Частота дискретизации, секунд, минимум - 60 (если передано, то весь период бъётся на подпериоды с указанной частотой)
    "vehicleIds": [0], ~/~/ Список ID объектов
    "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
    "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
@@ -2508,11 +2508,19 @@
        {
          "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, ~/~/ Количество
          "fuelStart": 0, ~/~/ Уровень топлива на начало события
          "fuelEnd": 0 ~/~/ Уровень топливо на конец события
++)))
++
++(((
++        "latitude": 0, ~/~/ Широта.
++        "longitude": 0 ~/~/ Долгота.
++)))
++
        }
      ]
    }
@@ -2586,185 +2586,54 @@
  В заголовках запроса: 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" %)Раздел: **Запрос посещений геообъектов**(%%) =
++=   =
--== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
--)))
--
--(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--(% style="text-align:left" %)
--{
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--}
--
--(% style="text-align:left" %)
--Ответ:
--
--[
--  {
--    "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**
--)))
--
--(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--{
--  "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": "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 infomessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
--)))
--
--(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--{
--  "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": "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" %)
--(((
--(% 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" %)**Запрос списка уведомлений клиента**(%%) ==
@@ -4169,16 +4169,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" %)
@@ -4190,16 +4190,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" %)**Списать с баланса**(%%) ==
@@ -4212,16 +4212,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" %)**Изменить ограничения клиента**(%%) ==
@@ -4232,28 +4232,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" %)**Изменить тариф клиента**(%%) ==
@@ -4265,35 +4265,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" %)Раздел: **Импорт и Экспорт**(%%) =
@@ -5366,33 +5366,9 @@
  )))
--== **Удаление существующего поля** ==
--
--(% class="box errormessage" %)
  (((
--**DELETE /api/v3/agroLands/{id}**
--)))
--
--Пример запроса:
--id  ~/~/ Идентификатор поля
--
--Пример ответа:
--
  (((
--200 ~/~/ Успех
--)))
--
  (((
--
--)))
--
--(((
--(((
--(((
--
--)))
--
--(((
  == **Изменение поля** ==
  (% class="box infomessage" %)
@@ -5638,9 +5638,102 @@
    "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" %)Раздел: **Корзина**(%%) =
  )))
  )))
@@ -6124,14 +6124,14 @@
  = **Раздел: Локатор ** =
--== **Получение списка локаторов, доступных пользователю ** ==
++== **Получение данных по локатору** ==
  (% class="box infomessage" %)
  (((
--**GET /api/v3/locators **
++**GET /api/v3/locators/{locatorId}**
  )))
--В заголовках запроса: X-Auth: Токен авторизации
++В запросе указывается locatorid - идентификатор локатора
  Пример ответа:
@@ -6139,13 +6139,13 @@
  (((
  (((
  {
--  "vehiclesIds": [ ~/~/ Объекты
++  "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую
    ],
--  "geoIds": [ ~/~/ Геозоны
++  "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую
    ],
--  "fieldsIds": [ ~/~/ Поля
++  "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую
    ],
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
@@ -6164,14 +6164,17 @@
    "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
++  "language": 0, ~/~/ ~/~/ Язык (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ГИС)
++
++  1
++
    ]
  }
  )))
@@ -6178,38 +6178,9 @@
  )))
--== **Получение перечня моделей ** ==
--
--(% 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 - Машины)
--  }
--]
  )))
  )))
@@ -6225,7 +6225,6 @@
  (((
  {
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
    "isEnabled": true, ~/~/ Активность
    "name": "string", ~/~/ Наименование локатора
    "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
@@ -6232,26 +6232,28 @@
    "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
    "validity": 0, ~/~/ Срок действия в днях (1-90)
    "autoProlongation": true, ~/~/ Автопродление срока действия.
--  "url": "string", ~/~/ Ссылка
--  "language": 0 ~/~/ Язык
++  "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "vehiclesIds": [ ~/~/ Oбъекты
++  "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую
    ],
--  "geoIds": [ ~/~/ Геозоны
++  "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую
    ],
--  "fieldsIds": [ ~/~/ Поля
++  "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую
    ],
--  "showVehicleName": true, ~/~/ Наименование объекта
--  "showVehicleDirection": true, ~/~/ Направление движения на треке
--  "allowTrackReport": true, ~/~/ Трек
--  "showTrackTracing": true, ~/~/ Трассировка трека
--  "showSensors": true, ~/~/ Датчик
--  "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
--    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
++
++      ]
  }
  )))
@@ -6263,7 +6263,69 @@
  )))
++== **Выводит список локаторов ** ==
++(% 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" %)
@@ -6282,25 +6282,25 @@
    "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
    "validity": 0, ~/~/ Срок действия в днях (1-90)
    "autoProlongation": true, ~/~/ Автопродление срока действия
--  "url": "string", ~/~/ Ссылка
--  "language": 0 ~/~/ Язык
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "vehiclesIds": [ ~/~/ Oбъекты
++  "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
++ "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую
    ],
--  "geoIds": [ ~/~/ Геозоны
++  "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую
    ],
--  "fieldsIds": [ ~/~/ Поля
++  "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую
    ],
    "showVehicleName": true, ~/~/ Наименование объекта
--  "showVehicleDirection": true, ~/~/ Направление движения на треке
--  "allowTrackReport": true, ~/~/ Трек
--  "showTrackTracing": true, ~/~/ Трассировка трека
--  "showSensors": true, ~/~/ Датчик
--  "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
++    "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ГИС)
++
++
    ]
  }
@@ -6328,7 +6328,6 @@
  )))
--
  = **Раздел: Яндекс Маршруты** =
@@ -6342,7 +6342,6 @@
  Пример запроса:
  Id  ~/~/ Идентификатор поля
--
  Пример ответа:
  (((
@@ -6360,7 +6360,6 @@
  )))
--
  == **Добавить маршрут** ==
  (% class="box infomessage" %)
@@ -6415,7 +6415,6 @@
  }
  )))
--
  Пример ответа:
  (((
@@ -6446,7 +6446,6 @@
  ]
  )))
--
  Пример ответа:
  (((
@@ -6470,7 +6470,6 @@
  Id  ~/~/ Идентификатор поля
--
  = **Раздел: Управление доступа к машинам** =
@@ -6492,7 +6492,6 @@
  )))
--
  == Задает видимость транспортных средств пользователю ==
  (% class="box infomessage" %)
@@ -6517,10 +6517,6 @@
  )))
  (((
--
--)))
--
--(((
  Пример ответа :
  )))
@@ -6534,10 +6534,6 @@
  )))
--
--
--
--
  (% 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

Меню