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

Last modified by Андрей Калиновский on 2025/01/14 11:58

From version < 177.1 >

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

To version < 189.1 >

edited by Андрей Калиновский
on 2024/11/22 14:54

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

@@ -1,5 +1,16 @@
  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
  (((
++(% class="box warningmessage" %)
++(((
++(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно просим вас соблюдать несколько простых правил при использовании API-команд:##
++)))
++
++* Формировать не более 3 отчётов одновременно.
++* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
++
++В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить работу команд.
++
++
  **Содержание страницы:**
  )))
@@ -1372,17 +1372,31 @@
  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
  ~/~/ "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 ~/~/ Отобразить произвольное поле в отчете
      }
    ]
  }
@@ -1389,51 +1389,232 @@
  (% 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 ~/~/ Условие по количеству записей для деактивации
      }
--(% style="color:#000000" %)}
++  ],
++  "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", ~/~/ Каким цветом
++)))
++(((
++          "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
++}
++)))
++)))
++)))
++
++
  **Валидация:**
  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
++
++== **Импортировать историю ТС (Асинхронный запрос)** ==
++
++(% 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" %)
@@ -1475,9 +1475,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**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
@@ -1484,8 +1484,15 @@
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){
--    "vehicleId": "" ~/~/ идентификатор объекта
++(% style="color:#000000" %)[
++{
++
++(((
++    "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
++)))
++
++(((
++(% style="color:#000000" %)    "vehicleId": "" ~/~/ идентификатор объекта
      "name": "" ~/~/ наименование объекта
      "imei": "" ~/~/ IMEI объекта
      "deviceTypeId": "" ~/~/ идентификатор типа устройства
@@ -1510,9 +1510,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" %)**Изменение статуса объекта**(%%) ==
@@ -1697,65 +1697,201 @@
  ~/~/ "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": "", ~/~/ 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
++(((
++{
++  "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.
++)))
++
++
++(((
++~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
++    "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" ~/~/ Текст подписи к этому интервалу
          }
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
++      ]
++    }
++  ],
++  "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
++}
++)))
  **Валидация:**
  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
@@ -2177,7 +2177,7 @@
      ],
      "stops": [       ~/~/ События стоянок
        {
--        "address": "string", ~/~/ Адрес события
++        "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
          "eventId": 0, ~/~/ Идентификатор события
          "eventName": "string", ~/~/ Название события
          "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
@@ -3939,64 +3939,67 @@
  Тело запроса:
  {
--  "vehicleIds": [vehicleId],
--  "from": "2023-11-22T09:29:48.051Z",
--  "to": "2023-11-22T09:29:48.051Z"
++  "vehicleIds": [vehicleId], ~/~/Массив ID объектов
++  "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
++  "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
  }
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|vehicleIds|Массив ID объектов
--|from|Дата начала запроса
--|to|Дата окончания запроса
--
  Ответ:
  {
--  "items": [
++  "items": [  ~/~/ Список в разрезе ТС
      {
--      "from": "2023-11-22T09:29:48.052Z",
--      "to": "2023-11-22T09:29:48.052Z",
--      "vehicleId": 0,
--      "vehicleName": "string",
--      "vehicleModel": "string",
--      "penalty": 0,
--      "score": 0,
--      "totalViolations": 0,
--      "violationsByType": {
--        "overspeedingViolations": 0,
--        "accelerationViolations": 0,
--        "brakingViolations": 0,
--        "turningViolations": 0,
--        "dangerousDrivingViolations": 0,
--        "sensorViolations": 0
++      "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": [
++
++(((
++
++)))
++
++      "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
++          "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
++          "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
++          "violationsCount": 0, ~/~/ Всего нарушений
++          "violationsByType": { ~/~/ Информация о нарушениях по типу
++            "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
++            "accelerationViolations": 0, ~/~/ Нарушений ускорения
++            "brakingViolations": 0, ~/~/ Нарушений торможения
++            "turningViolations": 0, ~/~/ Нарушений опасного поворота
++            "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
++            "sensorViolations": 0 ~/~/ Нарушений по датчику
            },
--          "moveTime": 0,
--          "mileage": 0,
--          "motohours": 0,
--          "maxSpeed": 0,
--          "startAddress": "string",
--          "endAddress": "string",
--          "drivers": [
++
++         "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",
--              "driverName": "string",
--              "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
++              "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
++              "driverName": "string", ~/~/ФИО водителя
++              "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
              }
            ]
          }
@@ -4005,34 +4005,6 @@
    ]
  }
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|from|Дата начала запроса
--|to|Дата  окончания
--|vehicleId|ID объекта
--|vehicleName|Имя объекта
--|vehicleModel|Модель объекта
--|penalty|Сумма штрафных баллов
--|score|Оценка
--|totalViolations|Суммарное количество нарушений
--|violationsByType|Список типов нарушений и количество нарушений для каждого типа
--|overspeedingViolations|Превышение скорости
--|accelerationViolations|Ускорение
--|brakingViolations|Торможение
--|turningViolations|Резкий поворот
--|dangerousDrivingViolations|Резкое вождение
--|sensorViolations|Нарушение по датчику
--|moveTime|Время в движении
--|mileage|Пробег (км)
--|tripsCount|Количество рейсов
--|motohours|Моточасы
--|maxSpeed|Максимальная скорость
--|startAddress|Адрес начала рейса
--|endAddress|Адрес окончания рейса
--|drivers|Список водителей, которые были на объекте в течениии рейса
--|driverGuid|Guid водителя
--|driverName|Имя водителя
--|driverRfid|Номер Карты-метки
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

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

Summary

Details

Меню