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

Last modified by Андрей Калиновский on 2025/01/28 12:59

From version < 115.1 >

edited by Илья Крайнов
on 2023/11/14 14:29

To version < 197.1 >

edited by Андрей Калиновский
on 2024/12/20 14:57

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.krainovim
++XWiki.Gadmin

Content

@@ -1,5 +1,21 @@
  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
  (((
++(% class="box warningmessage" %)
++(((
++
++
++
++
++(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
++просим вас соблюдать несколько простых правил при использовании API-команд:##
++)))
++
++* Формировать не более 3 отчётов одновременно.
++* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
++
++В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
++
++
  **Содержание страницы:**
  )))
@@ -14,11 +14,20 @@
  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
--(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
++(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
++
++(% style="color:#000000; font-size:16px" %)**Рекомендации**
++
++- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
--== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
++(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
++(((
++(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
++(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
++)))
  (% class="box successmessage" %)
  (((
@@ -44,12 +44,8 @@
  (% lang="en-US" %)
  (% style="color:#000000" %){
--
--(% lang="en-US" %)
--(% style="color:#000000" %)    "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" ,  ~/~/ токен авторизации
--    "User": "testuser" ,  ~/~/ имя пользователя
--
--(% lang="en-US" %)
++    "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" ,  ~/~/ токен авторизации
++    "User": "testuser" ,  ~/~/ имя пользователя(%%)
  }
  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
@@ -60,6 +60,9 @@
  |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
  |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
++(% class="wikigeneratedid" %)
++Также  имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] /  [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации -  {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
++
  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
  (% class="box infomessage" %)
@@ -173,7 +173,6 @@
  {
      "agentId": "",(% style="color:#000000" %)   (%%)
      "parentId": "",
--    "parentName": "string",
      "name": "string",
      "fullName": "string",
      "agentInfoType": 0,
@@ -184,7 +184,6 @@
  |=(% 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 - Договор)
@@ -228,7 +228,6 @@
    "bankKS": "string" ~/~/ корр. счёт
  }
--
  Ответ:
  {
@@ -356,6 +356,21 @@
  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
++== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
++
++(% class="box warningmessage" %)
++(((
++**PUT /api/v3/agents/{id}/changeStatus/{status}**
++)))
++
++Метод позволяет изменить статус клиента, указанного в запросе.
++
++В пути указывается GUID клиента и статус клиента.
++
++**status **- значение 0 - заблокирован, 1 - активен.
++
++Ответ: Code 204
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
@@ -407,7 +407,6 @@
      ],
      "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
  }
--
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "lastName": "string",
@@ -421,12 +421,8 @@
  (% style="text-align:left" %)
  (% style="color:#000000; font-weight:normal" %)Ответ:
--
--(% style="text-align:left" %)
--(% style="color:#000000; font-weight:normal" %){
--
--(% style="text-align:left" %)
--(% style="color:#000000; font-weight:normal" %)    "id": "" ,  ~/~/ ID пользователя
++{
++    "id": "" ,  ~/~/ ID пользователя
      "lastName": "" ,  ~/~/ Фамилия ,
      "firstName": "" ,  ~/~/ Имя
      "position": "" ,  ~/~/ Должность
@@ -443,11 +443,9 @@
      "kind": "" ,  ~/~/ тип аутентификации
      "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
      "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %),  ~/~/ роли пользователя, перечислены названия групп пользователя
++}
--(% style="text-align:left" %)
--(% style="color:#000000; font-weight:normal" %)}
--
  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
  (% class="box infomessage" %)
@@ -467,19 +467,16 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
--(% style="color:#000000" %){
--
++(% style="color:#000000" %){(%%)
    "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303",  ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
    "userId": "11111111-c384-43f8-8562-1c3d79a32303",  ~/~/ ID пользователя, по которому фильтруется, null - неважно
    "login": "qqqqqq",  ~/~/ Логин пользователя, по которому фильтруется, null - неважно
    "email": "eee",  ~/~/ Email пользователя, по которому фильтруется, null - неважно
--
  (% style="color:#000000" %)}
  (% style="color:#000000" %)Ответ:
  (% style="color:#000000" %){         (%%)
--
      "id": "" ,  ~/~/ идентификатор пользователя
      "lastName": "" ,  ~/~/ фамилия
      "firstName": "" ,  ~/~/ имя
@@ -493,7 +493,6 @@
      "sessionDuration":"", ~/~/ длительность сессии в минутах
      "status": "1",  ~/~/ статус пользователя
      "lastLogged": "", ~/~/ дата/время последней авторизации
--
  (% style="color:#000000" %)}
  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
@@ -567,10 +567,8 @@
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
--
--(% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "id": "" ,  ~/~/ ID пользователя
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
++    "id": "" ,  ~/~/ ID пользователя
      "lastName": "" ,  ~/~/ фамилия
      "firstName": "" ,  ~/~/ имя
      "position": "" ,  ~/~/ должность
@@ -592,9 +592,7 @@
          "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
      },
      "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
--    "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
--
--(% lang="en-US" style="text-align:left" %)
++    "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя(%%)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
  (% lang="en-US" style="text-align:left" %)
@@ -601,10 +601,8 @@
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
--
--(% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "id": "" ,  ~/~/ идентификатор пользователя
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
++    "id": "" ,  ~/~/ идентификатор пользователя
      "lastName": "" ,  ~/~/ фамилия
      "firstName": "" ,  ~/~/ имя
      "position": "" ,  ~/~/ должность
@@ -625,10 +625,8 @@
      "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
      "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
      "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
++}
--(% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
--
  == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
  (% class="box warningmessage" %)
@@ -648,12 +648,10 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
--(% style="color:#000000" %){
--
++(% style="color:#000000" %){(%%)
      "status": "" ,  ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
      "description": "" ,  ~/~/ описание
      "data": "" ,  ~/~/ данные, связанные со сменой статуса
--
  (% style="color:#000000" %)}
  (% style="text-align:left" %)
@@ -675,7 +675,7 @@
  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
   [
--    "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
++   "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
      "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
    ]
@@ -981,7 +981,7 @@
  Ответ: В случае успеха **Success 200**
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
@@ -1017,19 +1017,15 @@
      "deviceTypeName": "", ~/~/ Название типа устройства
      "sim1": "", ~/~/ Номер SIM1
      "sim2": "", ~/~/ Номер SIM2
--
      "parentId": "", ~/~/ ID клиента-родителя
      "parentName": "", ~/~/ Наименование клиента-родителя
      "modelId": "", ~/~/ ID модели объекта
      "modelName": "", ~/~/ Имя модели объекта
--
      "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
      "unitName": "string", ~/~/ Наименование подразделения
      "status": 0, ~/~/ Статус объекта
--
      "createdAt": "", ~/~/ Дата создания объекта
      },
--
  "customFields": [ ~/~/ Произвольные поля
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
@@ -1052,8 +1052,7 @@
       "consumptionPerHourSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
       "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
       "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
--     "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
--
++     "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
    "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
    "mileageCoeff": 0, ~/~/ коэффициент пробега
    "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
@@ -1083,7 +1083,6 @@
        "retries": 0 ~/~/ Количество попыток
      }
    ],
--
     "sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
@@ -1124,31 +1124,19 @@
        },
  ~/~/ Характерные для произвольного:
--
  ~/~/                "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",
@@ -1157,7 +1157,6 @@
           "isDefault": true ~/~/ По умолчанию
            }
      ],
--
      "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
          {
              "id": "", ~/~/ ID  задания
@@ -1174,8 +1174,7 @@
              "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
          }
      ],
--
-- "statusHistory": [ ~/~/ История статусов
++"statusHistory": [ ~/~/ История статусов
      {
        "status": 0,
        "date": "2023-05-22T09:57:39.562Z",
@@ -1183,7 +1183,6 @@
        "additionalInfo": "string"
      }
    ]
--
  }
  )))
@@ -1193,6 +1193,75 @@
  (% style="text-align:left" %)
 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
++
++== **Отправить команду на терминал** ==
++
++(% class="box successmessage" %)
++(((
++(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
++)))
++
++Команда для отправки на тс.
++
++{
++"id": "",  ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
++"command": "", ~/~/  Текст отправляемой команды
++"retries": "",  ~/~/ Количество попыток отправки на терминал
++"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов).
++}
++
++В ответ получаем cmdid
++
++
++== **Получить ответ на отправленную на ТС команду** ==
++
++(% class="box infomessage" %)
++(((
++(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
++)))
++
++Идентификатор команды: cmdId
++
++Запрос от терминала на ответ команды
++
++Пример ответ от терминала:
++
++ID= "" ~/~/ идентификатор объекта
++Soft="" ~/~/ версия софта
++GPS=4 ~/~/ тип трекера
++Time=11:05:43 28.06.24 ~/~/ время запроса
++Lat=45.056221 ~/~/ широта
++Lon=39.035938 ~/~/ долгота
++Speed=0.0 ~/~/ скорость
++Course=181.4 ~/~/направление
++
++(((
++== **Список отправленных объекту команд с ответами** ==
++
++(% class="box infomessage" %)
++(((
++(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
++)))
++
++Идентификатор ТС: vehicleId
++
++В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
++
++Пример ответа терминала
++
++[
++{
++"id": "",  ~/~/ идентификатор пользователя
++"commandText": "",   ~/~/Текст команды.
++"templateId": "",    ~/~/Идентификатор шаблона
++"updated": "",  ~/~/ Время отправки
++"tryCount": 0,  ~/~/ Количество попыток отправки команды
++"answer": "",    ~/~/ Ответ терминала.
++"status": "" ~/~/ Статус отправки
++}
++]
++)))
++
  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
  (% class="box successmessage" %)
@@ -1210,8 +1210,7 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
--(% style="color:#000000" %){
--
++(% style="color:#000000" %){(%%)
      "parentId": "" ,  ~/~/ ID клиента
      "name": "" ,  ~/~/ имя ТС
      "imei": "" ,  ~/~/ IMEI
@@ -1232,7 +1232,6 @@
       "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
       "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
       "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
--
       "mileageCalcMethod": 0,
       "mileageCoeff": 0,
       "locationByCellId": true,
@@ -1265,7 +1265,6 @@
        "lastInspectionDate": "" ,  ~/~/ Дата последнего ТО (null - не указано)
        "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
        }
--
  "drivers": [ ~/~/ Водители
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -1280,8 +1280,7 @@
        "retries": 0
      }
    ],
--
-- "sensors": [ ~/~/ Датчики
++"sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
        "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
@@ -1319,41 +1319,43 @@
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
--
  ~/~/ Характерные для произвольного:
--
  ~/~/                "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 ~/~/ Макс. значение
++      "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
++
++(((
++      "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
++        {
++          "from": 0, ~/~/ С какого значения
++          "color": "string", ~/~/ Каким цветом
++          "text": "string" ~/~/ Текст подписи к этому интервалу
++        }
++      ]
      }
    ],
++)))
++
++  "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
++
++
    "customFields": [ ~/~/ Произвольные поля
      {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "name": "string",
--      "value": "string",
--      "forClient": true,
--      "forTooltip": true,
--      "forReport": true
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
++      "name": "string", ~/~/ Наименование произвольного поля
++      "value": "string", ~/~/ Значение произвольного поля
++      "forClient": true, ~/~/ Отобразить произвольное поле у клиента
++      "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
++      "forReport": true ~/~/ Отобразить произвольное поле в отчете
      }
    ]
  }
@@ -1360,62 +1360,240 @@
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){
--    "vehicleId": "", ~/~/ID ТС
--    "parentId": "", ~/~/Guid владельца ТС
--    "name": "", ~/~/Имя объекта
--    "imei": "", ~/~/IMEI
--    "deviceTypeId": "", ~/~/ID типа устройства
--    "modelId": "", ~/~/ID модели
--    "unitId": "", ~/~/ID подразделения
--    "sim1": "", ~/~/SIM1
--    "sim2": "", ~/~/SIM2
--    "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
--    "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
-- "counters": { ~/~/Счётчики
--    "mileageEnabled": true,
--    "motohoursEnabled": true,
--    "mileage": "",
--    "motohours": 345.0
--    },
-- "cmsv6Parameters": { ~/~/Параметры CmsV6
--    "id": null,
--    "enabled": true, ~/~/флаг включения
--    "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
--    "login": "", ~/~/ имя учетной записи
--    "password": "" ~/~/ пароль учетной записи
--    },
--  "inspectionTasks": { ~/~/ задания на ТО
--    "id": "", ~/~/ ID задачи
--    "enabled": false, ~/~/ Признак включения
--    "name": "", ~/~/ Имя задания
--    "description": "", ~/~/ Описание задания
--    "mileageCondition": "", ~/~/ Условие по пробегу
--    "lastMileage": "", ~/~/ Пробег (в метрах)
--    "motohoursCondition": "", ~/~/ Условие по моточасам
--    "lastMotohours": "", ~/~/ Моточасы
--    "periodicCondition": "", ~/~/ Условие периодичности по времени
--    "kind": "", ~/~/ Вид периодичности по времени
--    "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
++(((
++(((
++(((
++{
++  "vehicleId": 0,  ~/~/ ID ТС
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
++  "name": "string", ~/~/ Имя объекта
++  "imei": "string", ~/~/ IMEI
++  "deviceTypeId": 0, ~/~/ ID типа устройства
++  "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
++  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
++  "sim1": "string", ~/~/ SIM1
++  "sim2": "string", ~/~/ SIM2
++  "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
++  "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
++  "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
++  "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
++  "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
++  "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
++  "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
++  "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
++  "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
++  "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
++  "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
++  "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
++  "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
++  "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
++  "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
++  "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
++  "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
++  "counters": {  ~/~/ Dto для состояний счётчиков
++    "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
++    "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
++    "mileage": 0, ~/~/ Пробег
++    "motohours": 0 ~/~/ Моточасы
++  },
++  "cmsv6Parameters": { ~/~/ Dto для CMSv6
++    "id": "string", ~/~/ CMSV6 Идентификатор
++    "enabled": true, ~/~/ Признак включения
++    "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
++    "login": "string", ~/~/ CMSV6 имя учетной записи
++    "password": "string" ~/~/ CMSV6 — пароль учетной записи
++  },
++  "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
++    {
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
++      "enabled": true, ~/~/ Признак включения
++      "name": "string", ~/~/ Имя задания
++      "description": "string", ~/~/ Описание задания
++      "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
++      "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
++      "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
++      "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
++      "periodicCondition": 0, ~/~/ Условие периодичности по времени
++      "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
++      "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
++      "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
      }
++  ],
++  "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
++    {
++      "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
++      "inputNumber": 0, ~/~/ № входа.
++      "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
++      "comment": "string", ~/~/ Комментарий
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
++      "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
++      "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
++      "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
++    }
++  ],
++  "commandTemplates": [  ~/~/ Список шаблонов команд
++    {
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
++      "name": "string", ~/~/ Название шаблона команд
++      "command": "string", ~/~/ Команда на выполнение
++      "retries": 0 ~/~/ Лимит попыток отправки
++    }
++  ],
++  "sensors": [ ~/~/ Список датчиков
++    {
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
++      "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
++      "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
++      "name": "string",  ~/~/ Имя датчика
++      "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
++      "inputNumber": 0, ~/~/ Номер входа
++      "pseudonym": "string", ~/~/ Псевдоним
++      "medianDegree": 0, ~/~/ Степень медианной фильтрации
++      "isInverted": true, ~/~/  Признак инверсии
++      "disabled": true, ~/~/ Датчик не участвует в обработке
++      "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
++      "gradesTables": [ ~/~/ Тарировка
++        {
++          "grades": [ ~/~/ Таблицы тарировки
++            {
++              "input": 0, ~/~/ Вход
++              "output": 0 ~/~/ Выход
++            }
++          ],
++          "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
++        }
++      ],
++      "showInTooltip": true, ~/~/ Отображение в подсказке
++      "showLastValid": true, ~/~/ Отображать последнее валидное значение
++      "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
++      "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
++      "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
++      "expr": "string", ~/~/ Выражение
++      "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
++        "string"
++      ],
++      "customParams": {
++        "additionalProp1": "string",
++        "additionalProp2": "string",
++        "additionalProp3": "string"
++      },
++      "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
++      "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
++        {
++          "from": 0, ~/~/ С какого значения
++          "color": "string", ~/~/ Каким цветом
++)))
--(% style="text-align:left" %)
--(% style="color:#000000" %)}
++(((
++          "text": "string" ~/~/ Текст подписи к этому интервалу
++         }
++      ]
++    }
++  ],
++  "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
++  "customFields": [ ~/~/ Список произвольных полей
++    {
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
++      "name": "string", ~/~/ Наименование произвольного поля
++      "value": "string", ~/~/ Значение произвольного поля
++      "forClient": true, ~/~/ Отобразить произвольное поле у клиента
++      "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
++      "forReport": true ~/~/ Отобразить произвольное поле в отчете
++    }
++  ],
++  "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
++}
++)))
++)))
++)))
++
  **Валидация:**
  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
--== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
++== **Импортировать историю ТС (Асинхронный запрос)** ==
++
++(% class="box successmessage" %)
++(((
++**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
++)))
++
++Метод запроса: **POST**
++
++URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
++
++Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
++
++
++Ответ:
++
++{
++
++  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
++
++  "Status": 0, ~/~/ Перечисление состояний выполнения запроса
++
++~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
++
++  "Message": "string", ~/~/ Информация о выполнении запроса
++
++  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
++
++  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
++
++  "Data": "string" ~/~/ Данные
++
++}
++
++
++== **Возвращает статус асинхронного запроса импорта истории ТС** ==
++
  (% class="box infomessage" %)
  (((
++**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
++)))
++
++Метод запроса: **GET**
++
++URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
++
++Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
++
++
++Ответ:
++
++{
++
++  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
++
++  "Status": 0, ~/~/ Перечисление состояний выполения запроса
++~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
++
++  "Message": "string", ~/~/ Информация о выполнении запроса
++
++  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
++
++~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
++
++  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
++
++  "Data": "string" ~/~/ Данные
++
++}
++
++
++== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
++
++(% class="box infomessage" %)
++(((
  (% lang="en-US" %)**POST /api/v3/vehicles/find**
  )))
--(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
++(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
@@ -1449,9 +1449,12 @@
      "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
      "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
      "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
--    "parentId": null, ~/~/ ID клиента (Guid, опционально)
--    "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
--    "customFields": null ~/~/ значение любого из произвольных полей ТС
++     "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
++      "unitName": "string",  ~/~/ Название подразделения (опционально)
++    "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
++    "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
++    "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
++     "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
  }
  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
@@ -1458,8 +1458,14 @@
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){
++(% style="color:#000000" %)[
++{
++(((
++    "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
++)))
++
++(((
  (% style="color:#000000" %)    "vehicleId": "" ~/~/ идентификатор объекта
      "name": "" ~/~/ наименование объекта
      "imei": "" ~/~/ IMEI объекта
@@ -1485,9 +1485,21 @@
                  "forClient": true, ~/~/ право на отображение у клиента
                  "forTooltip": false, ~/~/ право на отображение в подсказке
                  "forReport": false ~/~/ право на отображение в отчетах
--            }(%%)
--(% style="color:#000000" %)}
++)))
++(((
++      }
++    ],
++    "vehicleGroups": [  ~/~/ Группы ТС
++      {
++        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
++        "name": "string" ~/~/ Наименование группы ТС
++      }
++    ]
++  }
++]
++)))
++
  (% style="color:#000000" %)          Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
@@ -1519,13 +1519,11 @@
    "data": "", ~/~/ Данные
    "overwrite": false, ~/~/ Флаг перезаписи
    "stage": "", ~/~/ Состояние, может быть null
--
  (% style="color:#000000" %)}
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){
--
++(% style="color:#000000" %){(%%)
    "status": "", ~/~/ значение статуса
    "date": "", ~/~/ Дата смены статуса
    "description": "", ~/~/ Описание
@@ -1532,10 +1532,10 @@
    "data": "", ~/~/ Данные
    "overwrite": false, ~/~/ Флаг перезаписи
    "stage": "", ~/~/ Состояние
--
--(% style="text-align:left" %)
  (% style="color:#000000" %)  }
++==   ==
++
  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
  (% class="box warningmessage" %)
@@ -1623,8 +1623,7 @@
        "retries": 0
      }
    ],
--
-- "sensors": [ ~/~/ Датчики
++"sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
        "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
@@ -1662,95 +1662,215 @@
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
--
  ~/~/ Характерные для произвольного:
--
  ~/~/                "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 ~/~/ Макс. значение
++
++      "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
++        {
++          "from": 0, ~/~/ С какого значения
++          "color": "string", ~/~/ Каким цветом
++          "text": "string" ~/~/ Текст подписи к этому интервалу
++        }
++      ]
      }
    ],
++ "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
++
    "customFields": [ ~/~/ Произвольные поля
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "name": "string",
--      "value": "string",
--      "forClient": true,
--      "forTooltip": true,
--      "forReport": true
++    {
++     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
++      "name": "string", ~/~/ Наименование произвольного поля
++      "value": "string", ~/~/ Значение произвольного поля
++      "forClient": true, ~/~/ Отобразить произвольное поле у клиента
++      "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
++      "forReport": true ~/~/ Отобразить произвольное поле в отчете
      }
    ]
  }
++
  (% style="color:#000000" %)Ответ:
--(% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
++(((
++{
++  "vehicleId": 0, ~/~/ ID ТС
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
++  "name": "string", ~/~/ Имя объекта
++  "imei": "string", ~/~/ IMEI
++  "deviceTypeId": 0, ~/~/ ID типа устройства
++  "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
++  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
++  "sim1": "string", ~/~/ SIM1
++  "sim2": "string", ~/~/ SIM2
++  "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
++  "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
++  "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
++  "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
++  "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
++  "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
++  "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
++  "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
++  "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
++  "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
++  "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
++  "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
++  "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
++  "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
++  "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
++  "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
++  "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
++  "counters": { ~/~/ состояний счётчиков
++    "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
++    "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
++    "mileage": 0, ~/~/ Пробег
++    "motohours": 0 ~/~/ Моточасы
++  },
++  "cmsv6Parameters": { ~/~/ Dto для CMSv6
++    "id": "string", ~/~/ CMSV6 Идентификатор
++    "enabled": true, ~/~/ Признак включения
++    "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6.
++)))
--(% lang="en-US" style="text-align:left" %)
--    "vehicleId": "", ~/~/ ID ТС
--    "parentId": "", ~/~/ ID клиента
--    "name": "", ~/~/ имя ТС
--    "imei": "", ~/~/ IMEI
--    "deviceTypeId": "", ~/~/  типа устройства
--    "modelId": "", ~/~/ ID модели
--    "unitId": "", ~/~/ ID подразделения
--    "sim1": "", ~/~/ SIM 1
--    "sim2": "", ~/~/ SIM2
--    "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
--    "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
--        "counters":
--        {
--        "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
--        "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
--        "mileage": "", ~/~/ пробег
--        "motohours": "", ~/~/ моточасы
--        }
--        "cmsv6Parameters": ~/~/  параметры CMSv6
++
++(((
++~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
++    "login": "string", ~/~/ CMSV6 имя учетной записи
++    "password": "string" ~/~/ CMSV6 — пароль учетной записи
++  },
++  "inspectionTasks": [ ~/~/ Задания на ТО
++    {
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
++      "enabled": true, ~/~/ Признак включения
++      "name": "string", ~/~/ Имя задания
++      "description": "string", ~/~/ Описание задания
++      "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
++      "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
++      "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
++      "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
++      "periodicCondition": 0, ~/~/ Условие периодичности по времени
++      "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
++      "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
++      "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
++    }
++  ],
++  "drivers": [  ~/~/ Список водителей
++    {
++      "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
++      "inputNumber": 0, ~/~/ № входа.
++      "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
++      "comment": "string", ~/~/ Комментарий.
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
++      "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
++      "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
++      "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
++    }
++  ],
++  "commandTemplates": [ ~/~/ Список шаблонов команд
++    {
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
++      "name": "string", ~/~/ Название шаблона команд
++      "command": "string", ~/~/ Команда на выполнение
++      "retries": 0 ~/~/ Лимит попыток отправки
++    }
++  ],
++  "sensors": [  ~/~/ Список датчиков
++    {
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
++      "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
++      "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
++)))
++
++(((
++~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
++)))
++
++(((
++~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
++)))
++
++(((
++~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
++)))
++
++(((
++~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
++)))
++
++(((
++~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
++      "name": "string", ~/~/ Имя датчика
++      "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
++)))
++
++(((
++~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
++      "inputNumber": 0, ~/~/ Номер входа
++      "pseudonym": "string", ~/~/ Псевдоним
++      "medianDegree": 0, ~/~/ Степень медианной фильтрации
++      "isInverted": true, ~/~/ Признак инверсии
++      "disabled": true, ~/~/ Датчик не участвует в обработке
++      "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
++      "gradesTables": [ ~/~/ Тарировка
          {
--        "id": ~/~/  идентификатор
--        "enabled": true, ~/~/ флаг включения
--        "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
--        "login": "", ~/~/ имя учетной записи
--        "password": "", ~/~/ пароль учетной записи
--        }
--        "inspectionTasks": ~/~/ задания на ТО
++          "grades": [ ~/~/ Таблицы тарировки
++            {
++              "input": 0, ~/~/ Вход
++              "output": 0 ~/~/ Выход
++            }
++          ],
++          "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
++        }
++      ],
++      "showInTooltip": true, ~/~/ Отображение в подсказке
++      "showLastValid": true, ~/~/ Отображать последнее валидное значение
++      "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
++      "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
++      "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
++      "expr": "string", ~/~/ Выражение
++      "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
++        "string"
++      ],
++      "customParams": { ~/~/ Дополнительные настройки
++        "additionalProp1": "string",
++        "additionalProp2": "string",
++        "additionalProp3": "string"
++      },
++      "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
++      "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
          {
--        "id": "", ~/~/ ID задания
--        "enabled": false, ~/~/ Признак включения
--        "name": "", ~/~/ Имя задания
--        "description": "", ~/~/ Описание задания
--        "mileageCondition": "", ~/~/ Условие по пробегу
--        "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
--        "motohoursCondition": "", ~/~/ Условие по моточасам
--        "lastMotohours": "", ~/~/ Моточасы
--        "periodicCondition": "", ~/~/ Условие периодичности по времени
--        "kind": "", ~/~/ Вид периодичности по времени
--        "maxQuantity": "", ~/~/ Сколько раз выполнить задание
++          "from": 0, ~/~/ С какого значения
++          "color": "string", ~/~/ Каким цветом
++          "text": "string" ~/~/ Текст подписи к этому интервалу
          }
++      ]
++    }
++  ],
++  "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
++  "customFields": [ ~/~/ Список произвольных полей
++    {
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
++      "name": "string", ~/~/ Наименование произвольного поля
++      "value": "string", ~/~/ Значение произвольного поля
++      "forClient": true, ~/~/ Отобразить произвольное поле у клиента
++      "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
++      "forReport": true ~/~/ Отобразить произвольное поле в отчете
++    }
++  ],
++  "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
++}
++)))
--(% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
--
  **Валидация:**
  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
@@ -1789,18 +1789,15 @@
  (% style="color:#000000" %)Метод запроса: **GET**
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){
--
++(% style="color:#000000" %){(%%)
      "deviceTypeId" : "", ~/~/ ID типа устройства
      "deviceTypeName" : "" ~/~/ Название типа устройства
--
--(% style="text-align:left" %)
  (% style="color:#000000" %)}
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
@@ -1822,13 +1822,10 @@
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){
--
++(% style="color:#000000" %){(%%)
      "id": "", ~/~/ ID типа датчика
      "name": "", ~/~/ Название
      "description": "", ~/~/ Описание
--
--(% style="text-align:left" %)
  (% style="color:#000000" %)}
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
@@ -1872,6 +1872,56 @@
    }
  ]
++== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
++
++(% class="box infomessage" style="text-align: left;" %)
++(((
++**POST /api/v3/terminalMessages/mapping**
++)))
++
++Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
++
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
++
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++{
++  "protocolType": 0,
++  "params": ["string"]
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|protocolType|ID типа протокола
++|params|(((
++Массив наименований параметров в сообщении
++)))
++
++Ответ:
++
++{
++  "protocolType": 0,
++  "mapping": {
++    "additionalProp1": {
++      "inputType": 0,
++      "inputNumber": 0
++    },
++    "additionalProp2": {
++      "inputType": 0,
++      "inputNumber": 0
++    }
++  }
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|protocolType|Тип протокола
++|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
++|inputNumber|(((
++Номер входа
++)))
++
++(% class="wikigeneratedid" %)
++Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
++
  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
  (% class="box infomessage" %)
@@ -1896,6 +1896,11 @@
    "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
  }
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|vehicleId|ID объекта
++|from|Дата и время начала периода запроса
++|to|Дата и время окончания периода запроса
++
  Ответ:
  [
@@ -1902,80 +1902,43 @@
    {
      "messages": [
        {
--        "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
--        "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
--        "speed": 0, ~/~/ Скорость, км/ч
--        "altitude": 0, ~/~/ Высота, м
--        "latitude": 0, ~/~/ Широта [-90°;90°]
--        "longitude": 0, ~/~/ Долгота [-180°;180°]
--        "satellites": 0, ~/~/ Кол-во спутников
--        "voltage": 0, ~/~/ Напряжение
--        "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
++        "deviceTime": "2023-11-29T07:40:44.052Z",
++        "serverTime": "2023-11-29T07:40:44.052Z",
++        "speed": 0,
++        "altitude": 0,
++        "latitude": 0,
++        "longitude": 0,
++        "satellites": 0,
++        "course": 0,
++        "voltage": 0,
++        "parameters": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
--        "photoCount": 0 ~/~/ Кол-во фото
++        "photoCount": 0,
++        "lbsCorrectedCoords": true,
++        "protocolType": 0
        }
      ]
    }
  ]
--== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|deviceTime|Время сообщения терминала
++|serverTime|Время когда сообщение поступило на сервер
++|speed|Скорость
++|altitude|Высота над уровнем моря
++|latitude|Широта
++|longitude|Долгота
++|satellites|Кол-во спутников
++|course|Курс
++|voltage|Бортовое напряжение
++|parameters|Список параметров и их значений
++|photoCount|Количество фото
++|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
++|protocolType|ID типа протокола
--(% class="box infomessage" %)
--(((
--**POST /api/v3/vehicles/export/history**
--)))
--
--Метод возвращает список сообщений терминала объекта за выбранный период.
--
--(% style="text-align: left;" %)
--Метод запроса **POST**
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--{
--  "vehicleId": 0, ~/~/ ID объекта
--  "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
--  "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
--  "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
--}
--
--Ответ:
--
--Получаете файл. Сообщение: Code 200/Success
--
--== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/vehicles/export/history/status**
--)))
--
--Метод возвращает список сообщений терминала объекта за выбранный период.
--
--(% style="text-align: left;" %)
--Метод запроса **GET**
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--Ответ:
--
--{
--  "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
--  "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
--  "message": "string" ~/~/ текст описывающий статус.
--}
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
@@ -2012,10 +2012,12 @@
        {
          "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало
          "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
--        "mileageBegin": 0, ~/~/ Пробег на начало периода
--        "mileageEnd": 0, ~/~/ Пробег на окончание периода
--        "motohoursBegin": 0, ~/~/ Моточасы на начало периода
--        "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
++        "mileage": 0, ~/~/ Пробег за период, километры
++        "mileageBegin": 0, ~/~/ Пробег на начало периода, километры
++        "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
++        "motohours": 0, ~/~/ Моточасы за период, секунды
++        "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
++        "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
        }
      ]
    }
@@ -2064,6 +2064,12 @@
    }
  ]
++(% class="box warningmessage" %)
++(((
++Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
++\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
++)))
++
  == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
  (% class="box infomessage" %)
@@ -2109,6 +2109,96 @@
    }
  ]
++
++== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/vehicles/moveStop**
++)))
++
++Метод запроса: **POST**
++
++URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++
++Тело запроса:
++
++{
++  "vehicleIds": [ ], ~/~/ Список ID объектов
++  "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
++  "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
++  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
++}
++
++Ответ:
++
++[
++  {
++    "vehicleId": 0, ~/~/ ID объекта
++    "vehicleName": "string", ~/~/ Имя объекта
++    "moves": [      ~/~/ Событие движения
++      {
++        "mileage": 0, ~/~/ Пробег, км
++        "eventId": 0, ~/~/ Идентификатор события
++        "eventName": "string", ~/~/ Название события
++        "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
++        "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
++        "duration": 0 ~/~/ Продолжительность события, секунд
++      }
++    ],
++    "stops": [       ~/~/ События стоянок
++      {
++        "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
++        "eventId": 0, ~/~/ Идентификатор события
++        "eventName": "string", ~/~/ Название события
++        "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
++        "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
++        "duration": 0 ~/~/ Продолжительность события, секунд
++      }
++    ]
++  }
++]
++
++
++== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/vehicles/getlastdata**
++)))
++
++Метод запроса: **POST**
++
++URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++
++В теле запроса перечисляете массив 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": [ ~/~/Сведения по геозонам.
++      {
++        "id": 0,
++        "name": "string"
++      }
++
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
@@ -2416,6 +2416,32 @@
  Success
++
++== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
++
++(% class="box warningmessage" %)
++(((
++**PUT** /api/v3/notifications/prolongation
++)))
++
++Метод позволяет продлить уведомления.
++
++Метод запроса **PUT**
++
++URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
++
++В заголовках запроса: X-Auth: Токен авторизации.
++
++Тело запроса:
++
++[
++
++0
++
++]
++
++где 0 идентификатор ids.
++
  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
  (% class="box errormessage" %)
@@ -3084,7 +3084,6 @@
  |Number|Название/номер агрегата
  |Description|Текст примечания агрегата
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
@@ -3106,13 +3106,19 @@
    {
      "name": "string",
      "number": 0,
--    "period": 0, ~/~/ Частота трансляции радиометки
++    "period": 0,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "deleted": true
    }
  ]
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|parentId|ID клиента
++|name|Название карты-метки
++|number|Номер
++|period|Период запросов в секундах (работает только для агрегатов)
++|id|ID карты-метки
++
  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
  (% class="box infomessage" %)
@@ -3128,13 +3128,19 @@
    {
      "name": "string",
      "number": 0,
--    "period": 0, ~/~/ Частота трансляции радиометки
++    "period": 0,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "deleted": true
    }
  ]
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|name|Название карты-метки
++|number|Номер
++|period|Период запросов в секундах (работает только для агрегатов)
++|id|ID карты-метки
++|parentId|ID клиента
++
  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
  (% class="box successmessage" %)
@@ -3149,7 +3149,6 @@
    "number": 0,
    "period": 0,
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
  }
  Ответ:
@@ -3160,9 +3160,15 @@
    "period": 0,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
  }
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|name|Название карты-метки
++|number|Номер
++|period|Период запросов в секундах (работает только для агрегатов)
++|id|ID карты-метки
++|parentId|ID клиента
++
  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
  (% class="box warningmessage" %)
@@ -3178,7 +3178,6 @@
    "period": 0,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
  }
  Ответ:
@@ -3189,9 +3189,15 @@
    "period": 0,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
  }
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|name|Название карты-метки
++|number|Номер
++|period|Период запросов в секундах (работает только для агрегатов)
++|id|ID карты-метки
++|parentId|ID клиента
++
  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
  (% class="box errormessage" %)
@@ -3440,6 +3440,8 @@
  **PUT /api/v3/Billing/client/balance**
  )))
++Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
++
  Тело запроса:
  {
@@ -3453,6 +3453,50 @@
  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
++== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
++
++(% class="box warningmessage" %)
++(((
++**PUT /api/v3/billing/client/balance/deposit**
++)))
++
++Создает операцию **Пополнение **с указанной суммой
++
++Тело запроса:
++
++{
++  "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" %)
++(((
++**PUT /api/v3/billing/client/balance/withdraw**
++)))
++
++Тело запроса:
++
++{
++  "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" %)
@@ -3525,6 +3525,1229 @@
  |PeriodValue|Значение периода.
  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
++
++(% class="box warningmessage" %)
++(((
++Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
++)))
++
++== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/vehicles/import/{agentId}**
++)))
++
++Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
++
++В пути указывается **agentId** - id клиента.
++
++**Заголовок**
++
++**X-Auth: [токен авторизации]**
++
++**Параметры**
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
++|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
++
++В теле использовать тип **form-data,** тип значения** file**
++
++**Ключи**
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|data|В значении передаем файл объекта, формат **xml** или **wlp **
++|csv|В значении передаем файл датчиков, формат **csv**
++
++Ответ:
++
++{
++  "vehicleId": 0,
++  "name": "string",
++  "errors": ["string"]
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|vehicleId|ID созданного объекта
++|name|Имя созданного объекта
++|errors|Ошибки и их описание
++
++== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST** **/api/v3/vehicles/import/history/{vehicleId}**
++)))
++
++(% class="wikigeneratedid" %)
++Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
++
++(% class="wikigeneratedid" %)
++В пути указывается **vehicleId **- id объекта.
++
++**Заголовок**
++
++**X-Auth: [токен авторизации]**
++
++В теле использовать тип **form-data.**
++
++Ключи:
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|**history**|В значении передавать файл с историей
++
++В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
++
++Ответ:
++
++{
++  "results": [
++    {
++      "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++      "vehicleId": 0,
++      "errors": [
++        "string"
++      ],
++      "firstMessageDate": "2023-11-28T09:27:58.949Z",
++      "lastMessageDate": "2023-11-28T09:27:58.949Z",
++      "producedCount": 0,
++      "msgCount": 0
++    }
++  ]
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|results|Результаты импорта в разрезе ТС
++|vehicleGuid|Guid ТС
++|vehicleId|ID ТС
++|errors|Список ошибок импорта истории (если пустой - нет ошибок)
++|firstMessageDate|Дата первого импортированного сообщения (UTC)
++|lastMessageDate|Дата последнего импортированного сообщения (UTC)
++|producedCount|Кол-во успешно отправленных в шину данных сообщений
++|msgCount|Кол-во обработанных сообщений всего
++
++== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/vehicles/import/history/status**
++)))
++
++Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
++
++Ответ:
++
++{
++  "activity": true,
++  "progress": 0,
++  "message": "string"
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
++|progress|Guid ТС
++
++== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/vehicles/export**
++)))
++
++Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
++
++Тело запроса:
++
++[
++  id
++]
++
++Ответ: Success 200, получаете файлы с настройками.
++
++== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/vehicles/export/history**
++)))
++
++Метод возвращает список сообщений терминала объекта за выбранный период.
++
++Тело запроса:
++
++{
++  "vehicleId": 0,
++  "asArchive": true,
++  "from": "2023-09-27T12:17:45.973Z",
++  "to": "2023-09-27T12:17:45.973Z"
++}
++
++Ответ:
++
++Получаете файл. Сообщение: Code 200/Success
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|vehicleId|ID объекта
++|asArchive|true - Архивировать файл, False - не архивировать
++|from|Дата и время начала запроса
++|to|Дата и время окончания запроса
++
++== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/vehicles/export/history/status**
++)))
++
++Метод возвращает список сообщений терминала объекта за выбранный период.
++
++Ответ:
++
++{
++  "activity": true,
++  "progress": 0,
++  "message": "string"
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
++|progress|Прогресс экспорта, от 0 до 100%
++|message|Текст описывающий статус
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/EcoDriving/rating**
++)))
++
++Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
++
++Тело запроса:
++
++{
++  "vehicleIds": [vehicleId], ~/~/Массив ID объектов
++  "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
++  "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
++}
++
++Ответ:
++
++{
++  "items": [  ~/~/ Список в разрезе ТС
++    {
++      "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
++      "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
++      "vehicleId": 0, ~/~/ ID ТС
++      "vehicleName": "string", ~/~/ Название ТС
++      "vehicleModel": "string", ~/~/ Модель ТС
++      "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
++      "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
++      "totalViolations": 0, ~/~/ Нарушений всего
++      "violationsByType": { ~/~/ Информация о нарушениях по типу
++        "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
++        "accelerationViolations": 0, ~/~/ Нарушений ускорения
++        "brakingViolations": 0, ~/~/ Нарушений торможения
++        "turningViolations": 0, ~/~/ Нарушений опасного поворота
++        "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
++        "sensorViolations": 0 ~/~/ Нарушений по датчику
++      },
++
++(((
++
++)))
++
++      "moveTime": 0, ~/~/ Продолжительность движения, сек
++      "mileage": 0, ~/~/ Пробег, м
++      "tripsCount": 0, ~/~/ Кол-во рейсов
++      "trips": [  ~/~/ Информация по рейсу
++        {
++          "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
++          "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
++          "violationsCount": 0, ~/~/ Всего нарушений
++          "violationsByType": { ~/~/ Информация о нарушениях по типу
++            "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
++            "accelerationViolations": 0, ~/~/ Нарушений ускорения
++            "brakingViolations": 0, ~/~/ Нарушений торможения
++            "turningViolations": 0, ~/~/ Нарушений опасного поворота
++            "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
++            "sensorViolations": 0 ~/~/ Нарушений по датчику
++          },
++
++         "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
++          "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
++          "moveTime": 0, ~/~/ Продолжительность движения, сек
++          "mileage": 0, ~/~/ Пробег, м
++          "motohours": 0, ~/~/ Моточасы, секунды
++          "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
++          "startAddress": "string", ~/~/ Адрес начала рейса
++          "endAddress": "string", ~/~/ Адрес конца рейса
++          "drivers": [  ~/~/ Список водителей
++            {
++              "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
++              "driverName": "string", ~/~/ФИО водителя
++              "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
++            }
++          ]
++        }
++      ]
++    }
++  ]
++}
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
++
++Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
++
++(% class="box infomessage" %)
++(((
++POST /api/v3/fuelcards/transactions
++)))
++
++Метод запроса: POST
++
++URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
++\\В заголовках запроса: X-Auth: Токен авторизации
++
++Параметры в теле запроса (JSON):
++
++{
++  "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
++  "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
++  "ids": [
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
++  ],
++  "timezone": 0 ~/~/ Часовой пояс
++}
++
++
++Ответ:
++  {
++    "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
++    "driver": "string", ~/~/ Водители, привязанные к ТК
++    "object": "string", ~/~/ Наименование ТС
++    "amount": 0, ~/~/ Количество топлива
++    "amountDut": 0, ~/~/ Количество по ДУТ
++    "amountDiff": 0, ~/~/ Разница, л
++    "amountDiffPerc": 0, ~/~/ Разница, %
++    "summa": 0, ~/~/ Стоимость, руб
++    "serviceName": "string", ~/~/ Тип топлива
++    "price": 0, ~/~/ Цена за литр, руб
++    "cardName": "string", ~/~/ Наименование ТК
++    "cardNum": "string", ~/~/ Номер ТК
++    "operator": "string", ~/~/ Оператор ТК
++    "address": "string" ~/~/ Адрес АЗС
++  }
++
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
++
++
++== **Получение полных данных о ретрансляторе** ==
++
++(% class="box infomessage" %)
++(((
++**GET ** **/api/v3/retranslations/{id}**
++)))
++
++id - Идентификатор ретранслятора
++
++
++Пример ответа:
++
++{
++"description": "",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"isEnabled": true,  ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
++"address": "string",  ~/~/ Адрес и порт принимающего сервера
++"objects": [    ~/~/ Объекты для ретрансляции
++{
++"id": "",  ~/~/ Идентификатор объекта ретрансляции
++"name": "",   ~/~/ Наименование объекта ретрансляции
++"imei": "",     ~/~/ IMEI объекта  ретрансляции
++"isEnabled": true    ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
++}
++  ],
++"id": "",  ~/~/ Идентификатор ретранслятора
++"parentId": "",  ~/~/ Идентификатор родителя (вышестоящего клиента)
++"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
++}
++
++
++== **Удаление данных ретранслятора** ==
++
++(% class="box infomessage" %)
++(((
++**DELETE** **/api/v3/retranslations/{id}**
++)))
++
++id - Идентификатор ретранслятора
++
++
++== **Создание ретранслятора** ==
++
++(% class="box infomessage" %)
++(((
++**POST ** **/api/v3/retranslations/{id}**
++)))
++
++Запрос:
++
++{
++"description": "",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"address": "",  ~/~/ Адрес и порт принимающего сервера
++"isEnabled": "",  ~/~/ Признак включения ретранслятора, true - включен, false - отключен
++"objects": [    ~/~/Объекты для ретрансляции
++{
++"id": "",  ~/~/ Идентификатор ретранслятора
++"imei": "",     ~/~/ IMEI объекта ретрансляции
++"isEnabled":  ""  ~/~/ Признак включения объекта  ретрансляции: true - включен, false - отключен
++}
++  ]
++}
++
++
++Ответ:
++
++{
++"description": "",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"isEnabled": true,  ~/~/ Признак включения ретранслятора: true - включен, false - отключен
++"address": "string",  ~/~/ Адрес и порт принимающего сервера
++"objects": [     ~/~/ Объекты для ретрансляции
++{
++"id": "",    ~/~/ Идентификатор объекта ретрансляции
++"name": "string",  ~/~/ Наименование объекта ретрансляции
++"imei": "",      ~/~/ IMEI объекта ретрансляции
++"isEnabled": true    ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
++}
++  ],
++"id": "",  ~/~/ Идентификатор ретранслятора
++"parentId": "",  ~/~/ Идентификатор родителя (вышестоящего клиента)
++"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
++}
++
++
++== **Редактирование ретранслятора** ==
++
++(% class="box infomessage" %)
++(((
++**PUT** **/api/v3/retranslations**
++)))
++
++Пример запроса:
++
++{
++"id": "",  ~/~/ Идентификатор ретранслятора
++"description": "string",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"isEnabled": true,  ~/~/ Признак включения ретранслятора: true - включен, false - отключен
++"address": "string",   ~/~/ Адрес и порт принимающего сервера
++"objects":  ~/~/ Объекты для ретрансляции
++[
++{
++"id": "",  ~/~/ Идентификатор объекта ретрансляции
++"imei": "",       ~/~/ IMEI объекта  ретрансляции
++"isEnabled": true    ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
++}
++  ]
++}
++
++
++Пример ответа:
++
++{
++"description": "",  ~/~/ Поле описания ретранслятора
++"subscriberId": "",  ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
++"protocolType": 0,  ~/~/ Тип протокола ретрансляции
++"isEnabled": true,  ~/~/ Признак включения ретранслятора: true - включен, false - отключен
++"address": "string",  ~/~/ Адрес и порт принимающего сервера
++"objects": [     ~/~/ Объекты для ретрансляции
++{
++"id": "",    ~/~/ Идентификатор объекта ретрансляции
++"name": "string",  ~/~/ Наименование объекта ретрансляции
++"imei": "",      ~/~/ IMEI объекта ретрансляции
++"isEnabled": true    ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
++}
++  ],
++"id": "",  ~/~/ Идентификатор ретранслятора
++"parentId": "",  ~/~/ Идентификатор родителя (вышестоящего клиента)
++"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
++}
++
++
++== **Получение списка ретранслятора клиента** ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/retranslations/find**
++)))
++
++Пример запроса:
++
++{
++"id": "",  ~/~/ Идентификатор ретранслятора
++"search": "string",  ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
++"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
++}
++
++Ответ:
++
++[
++{
++"description": "",    ~/~/ Поле описания ретранслятора
++"subscriberId": "",    ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
++"protocolType": 0,     ~/~/ Тип протокола ретрансляции
++"isEnabled": true,    ~/~/ Признак включения ретранслятора: true - включен, false - отключен
++"address": "string",    ~/~/ Адрес и порт принимающего сервера
++"id": "",    ~/~/ Идентификатор ретранслятора
++"parentId": "",    ~/~/ Идентификатор родителя (вышестоящего клиента)
++"deleted": true   ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
++}
++]
++
++
++= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
++
++== **API для отчета по выгрузке комбайнов** ==
++
++(% class="box infomessage" %)
++(((
++POST **/api/v3/Reports/harvesterUnloading**
++)))
++
++Пример запроса:
++
++{
++  "byTime": 0, ~/~/ Объединение событий по времени
++  "byDist": 0,  ~/~/ Объединение событий по расстоянию
++  "filterByTime": 0,   ~/~/ Фильтрация событий по времени нахождения
++  "filterByHalfPerimeter": true,  ~/~/ Фильтрация событий по пробегу половины периметра
++  "showNearestObjects": true,  ~/~/Показывать объекты рядом?
++  "vehicleIds": [   ~/~/ Список id объектов для анализа
++    0
++  ],
++  "from": "", ~/~/ Дата и время начало запроса
++  "to": "",  ~/~/ Дата и время окончания запроса
++  "timezone": 0  ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
++}
++
++Пример ответа:
++
++[
++  {
++    "harvesterName": "",  ~/~/Комбайн, номер
++    "harvesterId": 0, ~/~/Комбайн, id
++"harvesterModel": "", ~/~/ Модель комбайна
++"hopperCapacity": 0, ~/~/ Объем бункера м3
++    "hopperDischargeSpeed": 0,  ~/~/ Скорость выгрузки из бункера, л/сек
++    "events": [  ~/~/Список событий в разрезе комбайна
++      {
++        "driverId": "",  ~/~/Идентификатор водителя
++        "driverName": "", ~/~/Водитель комбайна, ФИО
++        "RFID": "", ~/~/ идентификатор карты-метки
++        "rfidName": "", ~/~/Водитель комбайна, имя метки
++        "vehicleId": 0, ~/~/идентификатор объекта
++        "vehicleName": "string", ~/~/ Имя объекта
++        "modelName": "string", ~/~/  Имя модели объекта
++        "nearestVehicles": [  ~/~/Объекты рядом
++          {
++            "vehicleId": 0, ~/~/идентификатор объекта
++            "vehicleName": "string" ~/~/ Имя объекта
++          }
++        ],
++        "fields": [  ~/~/Поля, где происходила выгрузка
++          {
++            "id": 0, ~/~/ идентификатор пользователя
++            "name": "string" ~/~/ имя пользователя
++          }
++        ],
++        "event": "string", ~/~/Событие
++        "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
++        "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
++        "durationSeconds": 0,  ~/~/Продолжительность события, в секундах
++        "cultureName": "string",  ~/~/ название культуры
++        "bunkerLowLevelStart": 0,  ~/~/Бункер, нижний уровень (на начало события)
++        "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
++        "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
++        "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
++        "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
++        "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
++        "issued": 0, ~/~/Выдано, бункеров
++        "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
++        "latitude": 0,  ~/~/Широта
++        "longitude": 0, ~/~/ Долгота
++        "litresAway": 0, ~/~/Отдано, л
++        "m3Away": 0 ~/~/Отдано, м3
++      }
++    ]
++  }
++]
++
++
++= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
++
++== **Получение поля по id** ==
++
++(% class="box infomessage" %)
++(((
++GET **/api/v3/agroLands/{id}**
++)))
++
++Пример запроса:
++id  ~/~/ Идентификатор поля
++
++Пример ответа:
++
++(((
++{
++  "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
++  "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
++  "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
++  "sourceId": 0, ~/~/ Ссылка на участок прошлого года
++  "cropRotations": [ ~/~/ Данные по севообороту
++    {
++      "landId": 0, ~/~/ ID поля
++      "landName": "string", ~/~/ Название поля
++      "year": 0, ~/~/ Год урожая
++      "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
++      "cultureName": "string", ~/~/ Название культуры
++      "productivity": 0, ~/~/ Урожайность
++      "area": 0, ~/~/ Площадь поля, Га
++      "total": 0, ~/~/ Валовый сбор
++      "productivityFact": 0, ~/~/ Фактическая урожайность
++      "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
++      "totalFact": 0, ~/~/ Фактический валовый сбор
++      "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
++      "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
++      "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
++      "isyearplan": true, ~/~/ План года
++      "comment": "string" ~/~/ Комментарий
++    }
++  ],
++  "cropVegetation": [ ~/~/ История вегетации поля
++    {
++      "values": [ ~/~/ Данные вегетации и состояния посева
++        {
++          "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
++          "ndvi": 0 ~/~/ Индекс вегетации
++        }
++      ],
++      "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
++        {
++          "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
++          "type": "string", ~/~/ Тип
++          "pictureid": "string" ~/~/ Идентификатор ресурса
++        }
++      ],
++      "states": [ ~/~/ Ключевые даты развития поля
++        {
++          "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
++          "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
++        }
++      ]
++    }
++  ],
++  "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
++  "counts": {
++    "fieldOperations": 0, ~/~/ Количество операций на поле
++    "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
++    "facts": 0 ~/~/ Счётчик факта
++  },
++  "planComment": "string", ~/~/ Комментарий к полю
++  "productivity": 0, ~/~/ Урожайность.
++  "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
++)))
++
++(((
++(((
++ "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
++  "year": 0, ~/~/ Год поля
++  "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
++  "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
++  "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
++  "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
++  "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
++  "id": 0, ~/~/ Идентификатор объекта геозоны
++  "name": "string", ~/~/ Название объекта геозоны
++  "type": 0, ~/~/ Тип объекта геозоны
++  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
++  "fname": "string", ~/~/ Имя файла
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
++  "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
++  "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
++  "description": "string", ~/~/ Описание объекта геозоны
++  "area": 0, ~/~/ Площадь, м2
++  "perimetr": 0, ~/~/ Периметр, м
++  "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
++}
++)))
++
++
++== **Удалить поле** ==
++
++(% class="box errormessage" %)
++(((
++DELETE **/api/v3/agroLands/{id}**
++)))
++
++Пример запроса:
++id  ~/~/ Идентификатор поля
++
++Пример ответа:
++
++(((
++200 ~/~/ Успех
++)))
++
++(((
++
++)))
++
++(((
++== **Сохранение поля** ==
++
++(% class="box successmessage" %)
++(((
++POST **/api/v3/agroLands**
++)))
++
++Пример запроса:
++
++(((
++{
++  "extId": "string",
++  "shape": "string", ~/~/ Форма поля
++  "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
++  "display": "string", ~/~/ Настройки отображения
++  "year": 0, ~/~/ Год поля
++  "name": "string", ~/~/ Наименование
++  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
++  "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
++  "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
++  "planComment": "string", ~/~/ Комментарий к полю
++  "cropRotations": [ ~/~/ Данные по севообороту
++    {
++      "landId": 0, ~/~/ ID поля
++      "landName": "string", ~/~/ Название поля
++      "year": 0, ~/~/ Год урожая
++      "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
++      "cultureName": "string", ~/~/ Название культуры
++      "productivity": 0, ~/~/ Урожайность
++      "area": 0, ~/~/ Площадь поля, Га
++      "total": 0, ~/~/ Валовый сбор
++      "productivityFact": 0, ~/~/ Фактическая урожайность
++      "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
++      "totalFact": 0, ~/~/ Фактический валовый сбор
++      "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
++      "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
++      "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
++      "isyearplan": true, ~/~/ Годовой план
++      "comment": "string" ~/~/ Комментарий
++    }
++  ]
++}
++)))
++
++(((
++
++)))
++
++Пример ответа:
++
++(((
++(((
++{
++  "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
++  "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
++  "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
++  "sourceId": 0, ~/~/ Ссылка на участок прошлого года
++  "cropRotations": [ ~/~/ Данные по севообороту
++    {
++      "landId": 0, ~/~/ ID поля
++      "landName": "string", ~/~/ Название поля
++      "year": 0, ~/~/ Год урожая
++      "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
++      "cultureName": "string", ~/~/ Название культуры
++      "productivity": 0, ~/~/ Урожайность
++      "area": 0, ~/~/ Площадь поля, Га.
++      "total": 0, ~/~/ Валовый сбор
++      "productivityFact": 0, ~/~/ Фактическая урожайность
++      "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
++      "totalFact": 0, ~/~/ Фактический валовый сбор
++      "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
++      "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
++      "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
++      "isyearplan": true, ~/~/ годовой план
++      "comment": "string" ~/~/ Комментарий
++    }
++  ],
++  "cropVegetation": [ ~/~/ История вегетации поля
++    {
++      "values": [  ~/~/ Данные вегетации и состояния посева
++        {
++          "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
++          "ndvi": 0 ~/~/ Индекс вегетации
++        }
++      ],
++      "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
++        {
++          "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
++          "type": "string", ~/~/ Тип
++          "pictureid": "string" ~/~/ Идентификатор ресурса
++        }
++      ],
++      "states": [ ~/~/ Ключевые даты развития поля
++        {
++          "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
++          "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
++        }
++      ]
++    }
++  ],
++  "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
++  "counts": {
++    "fieldOperations": 0, ~/~/ Количество операций на поле
++    "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
++    "facts": 0 ~/~/ Счётчик факта
++  },
++  "planComment": "string", ~/~/ Комментарий к полю
++)))
++
++(((
++  "productivity": 0, ~/~/ Урожайность.
++  "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
++  "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
++  "year": 0, ~/~/ Год поля
++  "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
++  "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
++  "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
++  "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
++  "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
++  "id": 0, ~/~/ Идентификатор объекта геозоны
++  "name": "string", ~/~/ Название объекта геозоны
++  "type": 0, ~/~/ Тип объекта геозоны
++  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
++  "fname": "string", ~/~/ Имя файла
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
++  "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
++  "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
++  "description": "string", ~/~/ Описание объекта геозоны
++  "area": 0, ~/~/ Площадь, м2
++  "perimetr": 0, ~/~/ Периметр, м
++  "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
++}
++)))
++
++(((
++
++)))
++
++(((
++== **Изменение поля** ==
++
++(% class="box infomessage" %)
++(((
++PUT **/api/v3/agroLands**
++)))
++
++Пример запроса:
++
++(((
++(((
++{
++  "id": 0, ~/~/ Идентификатор поля
++  "extId": "string", ~/~/ ExtId
++  "shape": "string", ~/~/ Форма поля
++  "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
++  "display": "string", ~/~/ Настройки отображения
++  "year": 0, ~/~/ Год поля
++  "name": "string", ~/~/ Наименование
++  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
++  "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
++  "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
++  "planComment": "string", ~/~/Комментарий к полю
++  "cropRotations": [  ~/~/ Данные по севообороту
++    {
++      "landId": 0, ~/~/ ID поля
++      "landName": "string", ~/~/ Название поля
++      "year": 0, ~/~/ Год урожая
++      "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
++      "cultureName": "string", ~/~/ Название культуры
++      "productivity": 0, ~/~/ Урожайность
++      "area": 0, ~/~/ Площадь поля, Га.
++      "total": 0, ~/~/ Валовый сбор
++      "productivityFact": 0, ~/~/ Фактическая урожайность
++      "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
++      "totalFact": 0, ~/~/ Фактический валовый сбор
++      "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
++      "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
++      "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
++      "isyearplan": true,
++      "comment": "string" ~/~/ Комментарий
++    }
++  ],
++  "deleteStatistic": true ~/~/ Нужно ли удалять статистику
++}
++)))
++)))
++
++(((
++
++)))
++
++Пример ответа:
++
++(((
++(((
++(((
++{
++  "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
++  "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
++  "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
++  "sourceId": 0, ~/~/ Ссылка на участок прошлого года
++  "cropRotations": [ ~/~/ Данные по севообороту
++    {
++      "landId": 0, ~/~/ ID поля
++      "landName": "string", ~/~/ Название поля
++      "year": 0, ~/~/  Год урожая
++      "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
++      "cultureName": "string", ~/~/ Название культуры
++      "productivity": 0, ~/~/ Урожайность
++      "area": 0, ~/~/ Площадь поля, Га
++      "total": 0, ~/~/ Валовый сбор
++      "productivityFact": 0, ~/~/ Фактическая урожайность
++      "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
++      "totalFact": 0, ~/~/ Фактический валовый сбор
++      "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
++      "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
++      "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
++      "isyearplan": true, ~/~/
++      "comment": "string" ~/~/ Комментарий
++    }
++  ],
++  "cropVegetation": [ ~/~/ История вегетации поля
++    {
++      "values": [ ~/~/ Данные вегетации и состояния посева
++        {
++          "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
++          "ndvi": 0 ~/~/ Индекс вегетации
++        }
++      ],
++      "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
++        {
++          "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
++          "type": "string", ~/~/ Тип
++          "pictureid": "string" ~/~/ Идентификатор ресурса
++        }
++      ],
++      "states": [ ~/~/ Ключевые даты развития поля
++        {
++          "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
++          "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
++        }
++      ]
++    }
++  ],
++  "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
++  "counts": {
++    "fieldOperations": 0, ~/~/ Количество операций на поле
++    "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
++    "facts": 0 ~/~/ Счётчик факта
++  },
++  "planComment": "string", ~/~/ Комментарий к полю
++  "productivity": 0, ~/~/ Урожайность.
++  "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
++  "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
++  "year": 0, ~/~/ Год поля
++  "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
++  "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
++  "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
++  "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
++  "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
++  "id": 0, ~/~/ Идентификатор объекта геозоны
++  "name": "string", ~/~/ Название объекта геозоны
++  "type": 0, ~/~/ Тип объекта геозоны
++  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
++  "fname": "string", ~/~/ Имя файла
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
++  "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
++  "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
++  "description": "string", ~/~/ Описание объекта геозоны
++  "area": 0, ~/~/ Площадь, м2
++  "perimetr": 0, ~/~/ Периметр, м
++  "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
++}
++)))
++)))
++)))
++)))
++)))
++
++
++== **Возвращает список полей** ==
++
++(% class="box successmessage" %)
++(((
++POST **/api/v3/agroLands/updateOpenCloseYear**
++)))
++
++Пример запроса:
++
++(((
++(((
++{
++  "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
++    0
++  ],
++  "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
++  "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
++}
++)))
++
++
++)))
++
++Пример ответа:
++
++(((
++(((
++{
++  "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
++  "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
++  "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
++  "sourceId": 0, ~/~/ Ссылка на участок прошлого года
++  "cropRotations": [ ~/~/ Данные по севообороту
++    {
++      "landId": 0, ~/~/ ID поля
++      "landName": "string", ~/~/ Название поля
++      "year": 0, ~/~/ Год урожая
++      "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
++      "cultureName": "string", ~/~/ Название культуры
++      "productivity": 0, ~/~/ Урожайность
++      "area": 0, ~/~/ Площадь поля, Га.
++      "total": 0, ~/~/ Валовый сбор
++      "productivityFact": 0, ~/~/ Фактическая урожайность
++      "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
++      "totalFact": 0, ~/~/ Фактический валовый сбор
++      "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
++      "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
++      "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
++      "isyearplan": true, ~/~/
++      "comment": "string" ~/~/ Комментарий
++    }
++  ],
++  "cropVegetation": [ ~/~/ История вегетации поля
++    {
++      "values": [ ~/~/ Данные вегетации и состояния посева
++        {
++          "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
++          "ndvi": 0 ~/~/ Индекс вегетации
++        }
++      ],
++      "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
++        {
++          "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
++          "type": "string", ~/~/ Тип
++          "pictureid": "string" ~/~/ Идентификатор ресурса
++        }
++      ],
++      "states": [ ~/~/ Ключевые даты развития поля
++        {
++          "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
++          "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
++        }
++      ]
++    }
++  ],
++  "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
++  "counts": {
++    "fieldOperations": 0, ~/~/ Количество операций на поле
++    "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
++    "facts": 0 ~/~/ Счётчик факта
++  },
++  "planComment": "string", ~/~/ Комментарий к полю
++  "productivity": 0, ~/~/ Урожайность.
++  "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
++  "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
++  "year": 0, ~/~/ Год поля
++  "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
++  "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
++  "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
++  "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
++  "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
++  "id": 0, ~/~/ Идентификатор объекта геозоны
++  "name": "string", ~/~/ Название объекта геозоны
++  "type": 0, ~/~/ Тип объекта геозоны
++  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
++  "fname": "string", ~/~/ Имя файла
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
++  "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
++  "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
++  "description": "string", ~/~/ Описание объекта геозоны
++  "area": 0, ~/~/ Площадь, м2
++  "perimetr": 0, ~/~/ ериметр, м
++  "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
++}
++)))
++
++
++)))
++)))
++)))
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
++
++
++(% class="box infomessage" %)
++(((
++GET api/v3/Vehicles/recyclebin/all
++)))
++
++Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
++
++Параметр запроса: {parentId} - идентификатор агента
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++Ответ:
++
++[
++  {
++    "recordTime": "",  ~/~/Время записи
++    "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
++    "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
++    "objectId": 0, ~/~/ID объекта, помещённого в корзину
++    "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
++    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
++    "details": { ~/~/Список деталей объекта, помещённого в корзину
++      "items": [ ~/~/
++nullable: true  ~/~/Детали
++        {
++          "name": "string", ~/~/наименование столбца
++          "value": "string" ~/~/содержание столбца
++        }
++      ]
++    },
++   "errors": [  ~/~/Список ошибок удаления/восстановления объекта
++      "string"
++    ]
++  }
++]
++
++
++(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
++
++(% class="box infomessage" %)
++(((
++POST/api/v3/Vehicles/recyclebin/erase
++)))
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++Пример запроса:
++
++[
++0
++]
++
++
++Пример ответа:
++
++[
++{
++    "recordTime": "", ~/~/Время записи
++    "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
++    "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
++    "objectId": 0, ~/~/ID объекта, помещённого в корзин
++    "objectGuid": "",  ~/~/Guid объекта, помещённого в корзину
++    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
++    "details": { ~/~/Список деталей объекта, помещённого в корзину
++      "items": [ ~/~/Детали
++        {
++          "name": "", ~/~/Имя свойства
++          "value": "" ~/~/Значение свойства
++        }
++      ]
++    },
++    "errors": [  ~/~/Список ошибок удаления/восстановления объекта
++      ""
++    ]
++  }
++]
++
++Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
++
++== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
++
++(% class="box infomessage" %)
++(((
++POST/api/v3/Vehicles/recyclebin/restore
++)))
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++Параметры в теле запроса (JSON):
++
++Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++
++Пример запроса:
++
++(((
++[
++)))
++
++(((
++  0
++)))
++
++(((
++]
++)))
++
++
++Пример ответа:
++
++[
++{
++    "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
++    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/Guid пользователя, добавившего объект в корзину
++    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
++    "objectId": 0, ~/~/ID объекта, помещённого в корзину
++    "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
++    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
++    "details": { ~/~/Список деталей объекта, помещённого в корзину
++      "items": [ ~/~/Детали
++        {
++          "name": "string",  ~/~/Имя свойства
++          "value": "string" ~/~/Значение свойства
++        }
++      ]
++    },
++    "errors": [ ~/~/Список ошибок удаления/восстановления объекта
++      "string"
++    ]
++  }
++]
++
++
++
  (% 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

Меню