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

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

From version < 164.1 >

edited by Михаил Жучков
on 2024/08/09 14:29

To version < 157.1 >

edited by Андрей Калиновский
on 2024/07/19 14:27

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

Content

@@ -16,11 +16,6 @@
  (% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
--
--(% style="color:#000000; font-size:16px" %)**Рекомендации**
--
--- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
@@ -49,8 +49,12 @@
  (% lang="en-US" %)
  (% style="color:#000000" %){
--    "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" ,  ~/~/ токен авторизации
--    "User": "testuser" ,  ~/~/ имя пользователя(%%)
++
++(% lang="en-US" %)
++(% style="color:#000000" %)    "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" ,  ~/~/ токен авторизации
++    "User": "testuser" ,  ~/~/ имя пользователя
++
++(% lang="en-US" %)
  }
  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
@@ -230,6 +230,7 @@
    "bankKS": "string" ~/~/ корр. счёт
  }
++
  Ответ:
  {
@@ -423,6 +423,7 @@
      ],
      "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
  }
++
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "lastName": "string",
@@ -436,8 +436,12 @@
  (% style="text-align:left" %)
  (% style="color:#000000; font-weight:normal" %)Ответ:
--{
--    "id": "" ,  ~/~/ ID пользователя
++
++(% style="text-align:left" %)
++(% style="color:#000000; font-weight:normal" %){
++
++(% style="text-align:left" %)
++(% style="color:#000000; font-weight:normal" %)    "id": "" ,  ~/~/ ID пользователя
      "lastName": "" ,  ~/~/ Фамилия ,
      "firstName": "" ,  ~/~/ Имя
      "position": "" ,  ~/~/ Должность
@@ -454,9 +454,11 @@
      "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" %)
@@ -476,16 +476,19 @@
  (% 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": "" ,  ~/~/ имя
@@ -499,6 +499,7 @@
      "sessionDuration":"", ~/~/ длительность сессии в минутах
      "status": "1",  ~/~/ статус пользователя
      "lastLogged": "", ~/~/ дата/время последней авторизации
++
  (% style="color:#000000" %)}
  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
@@ -572,8 +572,10 @@
  (% 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" %){
--    "id": "" ,  ~/~/ ID пользователя
++(% 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 пользователя
      "lastName": "" ,  ~/~/ фамилия
      "firstName": "" ,  ~/~/ имя
      "position": "" ,  ~/~/ должность
@@ -595,7 +595,9 @@
          "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
      },
      "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
--    "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя(%%)
++    "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
++
++(% lang="en-US" style="text-align:left" %)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
  (% lang="en-US" style="text-align:left" %)
@@ -602,8 +602,10 @@
  (% 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" %){
++
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "id": "" ,  ~/~/ идентификатор пользователя
      "lastName": "" ,  ~/~/ фамилия
      "firstName": "" ,  ~/~/ имя
      "position": "" ,  ~/~/ должность
@@ -624,8 +624,10 @@
      "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" %)
@@ -645,10 +645,12 @@
  (% 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" %)
@@ -670,7 +670,7 @@
  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
   [
--   "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
++    "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
      "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
    ]
@@ -1012,15 +1012,19 @@
      "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 поля
@@ -1043,7 +1043,8 @@
       "consumptionPerHourSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
       "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
       "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
--     "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
++     "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
++
    "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
    "mileageCoeff": 0, ~/~/ коэффициент пробега
    "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
@@ -1073,6 +1073,7 @@
        "retries": 0 ~/~/ Количество попыток
      }
    ],
++
     "sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
@@ -1113,19 +1113,31 @@
        },
  ~/~/ Характерные для произвольного:
++
  ~/~/                "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",
@@ -1134,6 +1134,7 @@
           "isDefault": true ~/~/ По умолчанию
            }
      ],
++
      "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
          {
              "id": "", ~/~/ ID  задания
@@ -1150,7 +1150,8 @@
              "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
          }
      ],
--"statusHistory": [ ~/~/ История статусов
++
++ "statusHistory": [ ~/~/ История статусов
      {
        "status": 0,
        "date": "2023-05-22T09:57:39.562Z",
@@ -1158,6 +1158,7 @@
        "additionalInfo": "string"
      }
    ]
++
  }
  )))
@@ -1168,23 +1168,6 @@
 - «Блокировка» 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": "",  ~/~/идентификатор произвольного поля
--"command": "", ~/~/  Текст команды
--"retries": "",  ~/~/ Количество попыток
--"idTemplate": "" ~/~/ ID шаблона команды
--}
--
--
  == **Получить ответ на отправленную на ТС команду** ==
  (% class="box infomessage" %)
@@ -1194,19 +1194,31 @@
  Идентификатор команды: cmdid
++
  Запрос от терминала на ответ команды
++
  Пример ответ от терминала:
++
  ID= "" ~/~/ идентификатор произвольного поля
++
  Soft="" ~/~/ версия софта
++
  GPS=4 ~/~/ тип трекера
++
  Time=11:05:43 28.06.24 ~/~/ время запроса
++
  Lat=45.056221 ~/~/ широта
++
  Lon=39.035938 ~/~/ долгота
++
  Speed=0.0 ~/~/ скорость
++
  Course=181.4 ~/~/направление
++
++
  (((
  == **Список отправленных объекту команд с ответами** ==
@@ -1217,21 +1217,36 @@
  Идентификатор ТС: vehicleId
++
  В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
++
  Пример ответа терминала
--[
--{
--"id": "",  ~/~/ идентификатор пользователя
++
++[
++
++{
++
++"id": "",  ~/~/ идентификатор пользователя
++
  "commandText": "",   ~/~/Текст команды.
++
  "templateId": "",    ~/~/Идентификатор шаблона
--"updated": "",  ~/~/ Время отправки
--"tryCount": 0,  ~/~/ Количество попыток отправки команды
++
++"updated": "",  ~/~/ Время отправки
++
++"tryCount": 0,  ~/~/ Количество попыток отправки команды
++
  "answer": "",    ~/~/ Ответ терминала.
++
  "status": "" ~/~/ Статус отправки
++
  }
++
  ]
++
++
  )))
  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
@@ -1251,7 +1251,8 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
--(% style="color:#000000" %){(%%)
++(% style="color:#000000" %){
++
      "parentId": "" ,  ~/~/ ID клиента
      "name": "" ,  ~/~/ имя ТС
      "imei": "" ,  ~/~/ IMEI
@@ -1272,6 +1272,7 @@
       "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
       "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
       "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
++
       "mileageCalcMethod": 0,
       "mileageCoeff": 0,
       "locationByCellId": true,
@@ -1304,6 +1304,7 @@
        "lastInspectionDate": "" ,  ~/~/ Дата последнего ТО (null - не указано)
        "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
        }
++
  "drivers": [ ~/~/ Водители
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -1318,7 +1318,8 @@
        "retries": 0
      }
    ],
--"sensors": [ ~/~/ Датчики
++
++ "sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
        "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
@@ -1356,17 +1356,29 @@
          "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 ~/~/ Макс. значение
      }
@@ -1385,7 +1385,8 @@
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){(%%)
++(% style="color:#000000" %){
++
      "vehicleId": "", ~/~/ID ТС
      "parentId": "", ~/~/Guid владельца ТС
      "name": "", ~/~/Имя объекта
@@ -1423,6 +1423,8 @@
      "kind": "", ~/~/ Вид периодичности по времени
      "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
      }
++
++(% style="text-align:left" %)
  (% style="color:#000000" %)}
  **Валидация:**
@@ -1481,7 +1481,8 @@
  (% style="color:#000000" %)Ответ:
  (% style="color:#000000" %){
--    "vehicleId": "" ~/~/ идентификатор объекта
++
++(% style="color:#000000" %)    "vehicleId": "" ~/~/ идентификатор объекта
      "name": "" ~/~/ наименование объекта
      "imei": "" ~/~/ IMEI объекта
      "deviceTypeId": "" ~/~/ идентификатор типа устройства
@@ -1540,11 +1540,13 @@
    "data": "", ~/~/ Данные
    "overwrite": false, ~/~/ Флаг перезаписи
    "stage": "", ~/~/ Состояние, может быть null
++
  (% style="color:#000000" %)}
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){(%%)
++(% style="color:#000000" %){
++
    "status": "", ~/~/ значение статуса
    "date": "", ~/~/ Дата смены статуса
    "description": "", ~/~/ Описание
@@ -1551,10 +1551,34 @@
    "data": "", ~/~/ Данные
    "overwrite": false, ~/~/ Флаг перезаписи
    "stage": "", ~/~/ Состояние
++
++(% style="text-align:left" %)
  (% style="color:#000000" %)  }
--==   ==
++(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %)
++**Отправить команду на терминал**
++(% class="box successmessage" %)
++(((
++(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
++)))
++
++Команда для отправки на тс.
++
++
++{
++
++"id": "",  ~/~/идентификатор произвольного поля
++
++"command": "", ~/~/  Текст команды
++
++"retries": "",  ~/~/ Количество попыток
++
++"idTemplate": "" ~/~/ ID шаблона команды
++
++}
++
++
  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
  (% class="box warningmessage" %)
@@ -1642,7 +1642,8 @@
        "retries": 0
      }
    ],
--"sensors": [ ~/~/ Датчики
++
++ "sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
        "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
@@ -1680,17 +1680,29 @@
          "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 ~/~/ Макс. значение
      }
@@ -1710,7 +1710,9 @@
  (% style="color:#000000" %)Ответ:
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     (%%)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
++
++(% lang="en-US" style="text-align:left" %)
      "vehicleId": "", ~/~/ ID ТС
      "parentId": "", ~/~/ ID клиента
      "name": "", ~/~/ имя ТС
@@ -1751,6 +1751,8 @@
          "kind": "", ~/~/ Вид периодичности по времени
          "maxQuantity": "", ~/~/ Сколько раз выполнить задание
          }
++
++(% lang="en-US" style="text-align:left" %)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
  **Валидация:**
@@ -1797,9 +1797,12 @@
  (% 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" %)Раздел: **Датчики**(%%) =
@@ -1821,10 +1821,13 @@
  (% 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" %)Раздел: **Сообщения**(%%) =
@@ -2141,42 +2141,74 @@
  Тело запроса:
  {
++
    "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": "string", ~/~/ Адрес события
++
          "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" %)
@@ -2213,6 +2213,7 @@
        }
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
@@ -3710,7 +3710,7 @@
  **POST /api/v3/vehicles/import/{agentId}**
  )))
--Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
++Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
  В пути указывается **agentId** - id клиента.
@@ -3722,7 +3722,7 @@
  |=(% 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 - Добавление
++|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
  В теле использовать тип **form-data,** тип значения** file**
@@ -4014,31 +4014,53 @@
  Параметры в теле запроса (JSON):
  {
++
    "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
++
    "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
--  "ids": [
++
++  "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" ~/~/Адрес АЗС
++
    }
@@ -4057,23 +4057,40 @@
  Пример ответа:
--{
++{
++
  "description": "",  ~/~/ Определяет описание
++
  "subscriberId": "",  ~/~/ Подписчик
++
  "protocolType": 0,  ~/~/ Тип протокола
++
  "isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
++
  "address": "string",  ~/~/ Адрес события
++
  "objects": [    ~/~/Объекты для ретрансляции
--{
--"id": "",  ~/~/ Идентификатор объекта ретрансляции
--"name": "",   ~/~/ Наименование объекта ретрансляции
--"imei": "",     ~/~/ IMEI объекта
++
++{
++
++"id": "",  ~/~/ Идентификатор объекта ретрансляции
++
++"name": "",   ~/~/ Наименование объекта ретрансляции
++
++"imei": "",     ~/~/ IMEI объекта
++
  "isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++
  }
--  ],
--"id": "",  ~/~/ идентификатор пользователя
++
++  ],
++
++"id": "",  ~/~/ идентификатор пользователя
++
  "parentId": "",  ~/~/Guid родителя
++
  "deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
++
  }
@@ -4096,41 +4096,73 @@
  Запрос:
--{
++
++{
++
  "description": "",  ~/~/ Описание
++
  "subscriberId": "",  ~/~/ Подписчик
++
  "protocolType": 0,  ~/~/ Тип протокола
++
  "address": "",  ~/~/ Адрес ретрансляции
++
  "isEnabled": "",  ~/~/ признак включения, Включен, true - включен, false - отключен
++
  "objects": [    ~/~/Объекты для ретрансляции
--{
--"id": "",  ~/~/ идентификатор пользователя
++
++{
++
++"id": "",  ~/~/ идентификатор пользователя
++
  "imei": "",     ~/~/IMEI объекта
--"isEnabled":  ""  ~/~/ признак включения, Включен, true - включен, false - отключен
++
++"isEnabled":  ""  ~/~/ признак включения, Включен, true - включен, false - отключен
++
  }
++
    ]
++
  }
--Ответ:
--{
++Ответ
++
++{
++
  "description": "string",  ~/~/ Определяет описание
++
  "subscriberId": "",  ~/~/ идентификатор запроса
++
  "protocolType": 0,   ~/~/ Тип протокола
++
  "isEnabled":  "",  ~/~/ признак включения, Включен, true - включен, false - отключен
++
  "address": "",  ~/~/ Адрес события
++
  "objects": [    ~/~/Объекты для ретрансляции
--{
--"id": "",     ~/~/ идентификатор пользователя
--"name": "string",     ~/~/ Название уведомления
--"imei": "string",    ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++
++{
++
++"id": "",     ~/~/ идентификатор пользователя
++
++"name": "string",     ~/~/ Название уведомления
++
++"imei": "string",    ~/~/IMEI объекта
++
++"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++
  }
--  ],
--"id": "",  ~/~/ идентификатор пользователя
++
++  ],
++
++"id": "",  ~/~/ идентификатор пользователя
++
  "parentId": "",  ~/~/ Guid идентификатор родителя
++
  "deleted": true ~/~/ Признак удаления
++
  }
@@ -4143,46 +4143,79 @@
  Пример запроса:
--{
--"id": "",  ~/~/ идентификатор пользователя
++{
++
++"id": "",  ~/~/ идентификатор пользователя
++
  "description": "string",  ~/~/ Определяет описание
++
  "subscriberId": "",  ~/~/ идентификатор запроса
++
  "protocolType": 0,  ~/~/ Тип протокола
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
++
++"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
++
  "address": "string",   ~/~/ Адрес события
++
  "objects":  ~/~/Объекты для ретрансляции
--[
--{
--"id": "",  ~/~/ идентификатор пользователя
++
++[
++
++{
++
++"id": "",  ~/~/ идентификатор пользователя
++
  "imei": "",       ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++
++"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++
  }
++
    ]
++
  }
  Пример ответа:
--{
++{
++
  "description": "",  ~/~/ Определяет описание
++
  "subscriberId": "",  ~/~/ идентификатор запроса
++
  "protocolType": 0,  ~/~/ Тип протокола
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
++
++"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
++
  "address": "string",  ~/~/ Адрес события
++
  "objects": [     ~/~/Объекты для ретрансляции
--{
--"id": "",    ~/~/ идентификатор пользователя
--"name": "string",  ~/~/ Название уведомления
++
++{
++
++"id": "",    ~/~/ идентификатор пользователя
++
++"name": "string",  ~/~/ Название уведомления
++
  "imei": "",      ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++
++"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++
  }
++
    ],
--"id": "",  ~/~/ идентификатор пользователя
++
++"id": "",  ~/~/ идентификатор пользователя
++
  "parentId": "",  ~/~/ Guid идентификатор родителя
++
  "deleted": true ~/~/ Признак удаления
++
  }
++
  == **Получение списка ретранслятора клиента** ==
  (% class="box infomessage" %)
@@ -4192,32 +4192,53 @@
  Пример запроса:
--{
--"id": "",  ~/~/ идентификатор пользователя
++
++{
++
++"id": "",  ~/~/ идентификатор пользователя
++
  "search": "string",  ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
++
  "parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
++
  }
--Ответ:
--[
--{
++
++Ответ
++
++
++[
++
++{
++
  "description": "",    ~/~/ Определяет описание
++
  "subscriberId": "",    ~/~/ идентификатор запроса
++
  "protocolType": 0,     ~/~/ Тип протокола
--"isEnabled": true,    ~/~/ признак включения, Включен, true - включен, false - отключен
++
++"isEnabled": true,    ~/~/ признак включения, Включен, true - включен, false - отключен
++
  "address": "string",    ~/~/ Адрес события
--"id": "",    ~/~/ идентификатор пользователя
++
++"id": "",    ~/~/ идентификатор пользователя
++
  "parentId": "",    ~/~/ Guid идентификатор родителя
++
  "deleted": true   ~/~/ Признак удаления
++
  }
++
  ]
--= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =
++
  == **API для отчета по выгрузке комбайнов** ==
++
  (% class="box infomessage" %)
  (((
  POST **/api/v3/Reports/harvesterUnloading**
@@ -4225,70 +4225,134 @@
  Пример запроса:
++
  {
++
    "byTime": 0, ~/~/ Объединение событий по времени
++
    "byDist": 0,  ~/~/ Объединение событий по расстоянию
++
    "filterByTime": 0,   ~/~/ Фильтрация событий по времени нахождения
++
    "filterByHalfPerimeter": true,  ~/~/ Фильтрация событий по пробегу половины периметра
++
    "showNearestObjects": true,  ~/~/Показывать объекты рядом?
++
    "vehicleIds": [   ~/~/ Список id объектов для анализа
++
++
    ],
++
    "from": "", ~/~/ Дата и время начало запроса
++
    "to": "",  ~/~/ Дата и время окончания запроса
++
    "timezone": 0  ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
++
  }
++
++
  Пример ответа:
--[
++
++[
++
    {
++
      "harvesterName": "",  ~/~/Комбайн, номер
++
      "harvesterId": 0, ~/~/Комбайн, id
++
  "harvesterModel": "", ~/~/ Модель комбайна
--"hopperCapacity": 0, ~/~/ Объем бункера м3
++
++ "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" ~/~/ имя пользователя
++
++            "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
++
        }
++
      ]
++
    }
++
  ]
@@ -4310,27 +4310,48 @@
  Ответ:
--[
++[
++
    {
++
      "recordTime": "",  ~/~/Время записи
++
      "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
++
      "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
++
      "objectId": 0, ~/~/ID объекта, помещённого в корзину
++
      "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
++
      "objectType": 1, ~/~/Тип объекта, помещённого в корзину
++
      "details": { ~/~/Список деталей объекта, помещённого в корзину
--      "items": [ ~/~/
++
++      "items": [ ~/~/ [
++
  nullable: true  ~/~/Детали
++
          {
++
            "name": "string", ~/~/наименование столбца
++
            "value": "string" ~/~/содержание столбца
++
          }
++
        ]
++
      },
--   "errors": [  ~/~/Список ошибок удаления/восстановления объекта
++
++    "errors": [  ~/~/Список ошибок удаления/восстановления объекта
++
        "string"
++
      ]
++
    }
++
  ]
@@ -4345,33 +4345,56 @@
  Пример запроса:
++
  [
--0
++
++  0
++
  ]
--
++
  Пример ответа:
--[
--{
++[
++
++  {
++
      "recordTime": "", ~/~/Время записи
++
      "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
++
      "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
++
      "objectId": 0, ~/~/ID объекта, помещённого в корзин
++
      "objectGuid": "",  ~/~/Guid объекта, помещённого в корзину
++
      "objectType": 1, ~/~/Тип объекта, помещённого в корзину
++
      "details": { ~/~/Список деталей объекта, помещённого в корзину
++
        "items": [ ~/~/Детали
++
          {
++
            "name": "", ~/~/Имя свойства
++
            "value": "" ~/~/Значение свойства
++
          }
++
        ]
++
      },
++
      "errors": [  ~/~/Список ошибок удаления/восстановления объекта
++
        ""
++
      ]
++
    }
++
  ]
  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
@@ -4394,41 +4394,55 @@
  Пример запроса:
--(((
  [
--)))
--(((
--)))
--(((
  ]
--)))
  Пример ответа:
  [
--{
++
++  {
++
      "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"
++
      ]
++
    }
++
  ]

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

Summary

Details

Меню