Публичный API [3.0]: Уровень топлива

Содержание

Описание метода

Метод применяется для получения статистик уровня топлива за период.

Предусловия

Допустимое количество машино-дней для метода - не более 100 000

Формат запроса (Request body)

Метод запроса: POST/statistics/units/fuel-level
Метод доступен по ссылке.

Атрибут Тип Обязательность Описание
unitIds UUID[] Да Массив идентификаторов ТС, для которых строится отчёт
dateFrom String Да Дата и время начала периода, за который строится отчёт. ISO 8601 с обязательным указанием offset
dateTo String Да Дата и время конца периода, за который строится отчёт. ISO 8601 с обязательным указанием offset

Пример запроса:

{
"unitIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"dateFrom": "2026-05-06T06:53:32.256Z",
"dateTo": "2026-05-06T06:53:32.256Z"
}

Формат ответа (Responses Code)

В случае успеха метод возвращает ответ с кодом 200 и телом ответа в формате JSON:

Атрибут Тип Обязательность Описание
units Object[] Да Массив результатов по ТС
  id UUID Да Идентификатор ТС
  status enum
UnitReportStatus
Success
FailureNotFound
FailureNoTerminal
FailureNoSettings
NoData
Да Статус
  result Object "Да" для status = Success, 
не заполняется для остальных
Результаты запроса по ТС
    firstFuelLevel Object Нет Первое показание FuelLevel за период
      timestamp String Да Дата и время показания. ISO 8601
      value Double Да Показание датчика
    lastFuelLevel Object Нет Последнее показание FuelLevel за период
      timestamp String Да Дата и время показания. ISO 8601
      value Double Да Показание датчика

Пример ответа:

{
"units": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "Success",
"result": {
"firstFuelLevel": {
"timestamp": "2026-05-06T06:53:32.258Z",
"value": 0
},
"lastFuelLevel": {
"timestamp": "2026-05-06T06:53:32.258Z",
"value": 0
}
}
}
]
}

В случае ошибок авторизации или валидации запроса метод возвращает код, соответствующий ошибке, и тело в формате JSON, соответствующее формату Problem Details:

Тело ответа Тип Обязательность Описание
type String Да Тип ошибки
title String Да Человекочитаемая расшифровка типа ошибки (универсальная для всех запросов)
detail String Нет Комментарий к ошибке (специфичный для этого запроса)
errors Object[] Нет Массив детализированных ошибок
  key String[] Да Тип ошибки
401  Unautorized     Токен невалидный или истек срок действия
400 Format     Некорректный формат query параметра
500 InternalError     Произвольная ошибка на сервере
  values String[] Да Список сообщений к данной ошибке

Author: - Mon, Apr 20, 2026. This article has been viewed 29 times.

Online URL: https://kb.skai.online/article/%d0%9f%d1%83%d0%b1%d0%bb%d0%b8%d1%87%d0%bd%d1%8b%d0%b9-api-3-0-%d0%a3%d1%80%d0%be%d0%b2%d0%b5%d0%bd%d1%8c-%d1%82%d0%be%d0%bf%d0%bb%d0%b8%d0%b2%d0%b0-5724.html

Powered by PHPKB (Knowledge Base Software)