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

Last modified by Михаил Жучков on 2025/10/30 11:26

From version < 264.2 >

edited by Андрей Калиновский
on 2025/10/23 09:54

To version < 251.2 >

edited by Андрей Калиновский
on 2025/07/29 13:53

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -202,7 +202,7 @@
  (% style="color:#000000" %)Параметр запроса:
  (% style="color:#000000" %){
--  "parentId": "(%%)string(% style="color:#000000" %)" ~/~/ для получение собственного parentId отправьте пустой запрос (пример "parentId": "" )
++  "parentId": "string"
  }
  (% style="color:#000000" %)Ответ:
@@ -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" %)
@@ -744,10 +744,7 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
--(% class="wikigeneratedid" id="H" %)
--(((
--
--)))
++=   =
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
@@ -1057,12 +1057,6 @@
        "forTooltip": true, ~/~/ Отображать в подсказке
        "forReport": true ~/~/ Отображать в отчете
      }
--  ],
--  "vehicleGroups": [  ~/~/ Группы ТС
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
--      "name": "string" ~/~/ Наименование группы ТС
--    }
  ], ~/~/ Данные с вкладки нормы
      "consumptionPer100Km": "" ,  ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
@@ -1113,7 +1113,7 @@
        "type": 0, ~/~/ Тип датчика
        "name": "string", ~/~/ Имя датчика
        "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
--      "parameterName": "string", ~/~/ Имя параметра (взамен связки Input type + port number)
++      "inputNumber": 0, ~/~/ Номер входа
        "pseudonym": "string", ~/~/ Псевдоним
        "medianDegree": 0, ~/~/ Медианная фильтрация
        "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
@@ -1146,31 +1146,27 @@
          "additionalProp3": "string"
        },
--      "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
--      "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
--        {
--          "from": 0, ~/~/ С какого значения
--          "color": "string", ~/~/ Каким цветом
--          "text": "string" ~/~/ Текст подписи к этому интервалу
--        }
--      ],
--      "disableEmissionsValidation": true, ~/~/ Нужно ли валидировать выбросы значений. Применяется для датчиков с типом "Накопительный"
--      "unitOfMeasure": 0 ~/~/ Единица измерения значений датчика. (0 - по умолчанию, 1 - секунды, 2 - часы)
--    }
--  ],
++~/~/ Характерные для произвольного:
++~/~/                "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
++~/~/                "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
++~/~/                "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
++~/~/                "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
++~/~/               "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
++~/~/                "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
++~/~/               "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
++~/~/                "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
++~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
++~/~/ "ValueOn": "Вкл.",
++~/~/ "ValueOff": "Выкл."
++      "summaryMaxValue": 0 ~/~/ Макс. значение
++    }
      "drivers": [ ~/~/ Водители
            {
           "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
           "name": "string", ~/~/ Наименование
--         "description": "string", ~/~/ Описание
--      "assignments": [   ~/~/ Информация по назначениям
--        {
--          "beginTime": "2025-10-21T12:28:41.021Z", ~/~/Момент времени начала назначения.
--          "endTime": "2025-10-21T12:28:41.021Z", ~/~/ Момент времени окончания назначения.
--          "createTime": "2025-10-21T12:28:41.021Z" ~/~/ Момент времени создания назначения.
++         "description": "string",
++         "isDefault": true ~/~/ По умолчанию
            }
--      ]
--    }
      ],
      "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
          {
@@ -2429,6 +2429,7 @@
  Тело запроса:
  {
++  "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
    "vehicleIds": [0], ~/~/ Список ID объектов
    "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
    "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
@@ -2461,6 +2461,7 @@
  (% class="box warningmessage" %)
  (((
  Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
++\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
  )))
  == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
@@ -2499,19 +2499,11 @@
        {
          "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 ~/~/ Долгота.
--)))
--
        }
      ]
    }
@@ -2631,8 +2631,163 @@
    }
--=   =
++= (% 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" %)**Запрос списка уведомлений клиента**(%%) ==
@@ -5292,9 +5292,14 @@
  )))
++
  (((
++
++)))
++
  (((
  (((
++(((
  == **Изменение поля** ==
  (% class="box infomessage" %)
@@ -5540,84 +5540,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" %)
@@ -6296,6 +6296,7 @@
  )))
++
  == **Изменение локатора** ==
  (% class="box infomessage" %)
@@ -6360,6 +6360,7 @@
  )))
++
  = **Раздел: Яндекс Маршруты** =
@@ -6373,6 +6373,7 @@
  Пример запроса:
  Id  ~/~/ Идентификатор поля
++
  Пример ответа:
  (((
@@ -6390,6 +6390,7 @@
  )))
++
  == **Добавить маршрут** ==
  (% class="box infomessage" %)
@@ -6444,6 +6444,7 @@
  }
  )))
++
  Пример ответа:
  (((
@@ -6474,6 +6474,7 @@
  ]
  )))
++
  Пример ответа:
  (((
@@ -6497,6 +6497,7 @@
  Id  ~/~/ Идентификатор поля
++
  = **Раздел: Управление доступа к машинам** =
@@ -6518,6 +6518,7 @@
  )))
++
  == Задает видимость транспортных средств пользователю ==
  (% class="box infomessage" %)
@@ -6542,6 +6542,10 @@
  )))
  (((
++
++)))
++
++(((
  Пример ответа :
  )))
@@ -6555,6 +6555,11 @@
  )))
++==   ==
++
++
++
++
  (% 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

Меню