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

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

From version < 162.1 >

edited by Андрей Калиновский
on 2024/07/25 10:15

To version < 178.1 >

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -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" %)
  (((
@@ -971,7 +971,7 @@
  Ответ: В случае успеха **Success 200**
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
@@ -1366,6 +1366,10 @@
        "summaryMaxValue": 0 ~/~/ Макс. значение
      }
    ],
++
++  "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
++
++
    "customFields": [ ~/~/ Произвольные поля
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -1380,52 +1380,157 @@
  (% 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", ~/~/ Каким цветом
++  (% style="background-color:inherit; color:inherit; font-family:Menlo,Monaco,Consolas,~"Courier New~",monospace; font-size:inherit; white-space:pre" %)"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" %)**Получение параметров объектов**(%%) ==
++== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
  (% class="box infomessage" %)
  (((
@@ -1690,6 +1690,11 @@
        "summaryMaxValue": 0 ~/~/ Макс. значение
      }
    ],
++
++(((
++ "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
++)))
++
    "customFields": [ ~/~/ Произвольные поля
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -1704,49 +1704,174 @@
  (% 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
++}
++)))
  **Валидация:**
  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
@@ -2021,10 +2021,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 ~/~/ Моточасы на окончание периода, секунды
        }
      ]
    }
@@ -2073,6 +2073,12 @@
    }
  ]
++(% class="box warningmessage" %)
++(((
++Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
++\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
++)))
++
  == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
  (% class="box infomessage" %)
@@ -2515,6 +2515,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" %)
@@ -3705,7 +3705,7 @@
  **POST /api/v3/vehicles/import/{agentId}**
  )))
--Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
++Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
  В пути указывается **agentId** - id клиента.
@@ -3717,7 +3717,7 @@
  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
  |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
--|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
++|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
  В теле использовать тип **form-data,** тип значения** file**
@@ -3979,7 +3979,7 @@
  |dangerousDrivingViolations|Резкое вождение
  |sensorViolations|Нарушение по датчику
  |moveTime|Время в движении
--|mileage|Пробег
++|mileage|Пробег (км)
  |tripsCount|Количество рейсов
  |motohours|Моточасы
  |maxSpeed|Максимальная скорость

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

Summary

Details

Меню