Ответы на запросы к API Одометр и топливо
Получение данных по показаниям одометра
Ответы, которые могут прийти от API:
| Код | Описание | Содержание Response Body | Что означает |
|---|---|---|---|
| 200 | ОК |
JSON, описанный в таблице Описание пакета данных |
Запрос выполнен успешно и вернул некоторые данные |
| 400 | The request is invalid |
Массив описаний для всех некорректных значений в запросе: Пример{ "message": "The request is invalid.", "modelState": { "unitRequest.BeginDateTime": ["The value ’2017/01/49 12:43:50’ is not valid for BeginDateTime."], "unitRequest.EndDateTime": ["The value ’2017/01/49 12:43:50’ is not valid for EndDateTime."] } } |
|
| 401 | Unauthorized | "Authorization has been denied for this request" | Нет прав для выполнения запроса |
| 403 | Forbidden | "This unitId is unavailable to your account" |
Запрошены данные по ТС, которого нет в списке доступных ТС (отсутствует в ответе метода GET /api/units/availableIds). В запросе не указан unitId. |
| 500 | Internal Server Error |
Массив с описанием ошибки на сервере Пример "message":"System.InvalidOperationException: лог ошибки" |
Ошибка на сервере. |
Получение данных по уровню топлива
Ответы, которые могут прийти от API при получении значений по уровню топлива:
| Код | Описание | Содержание Response Body | Что означает |
|---|---|---|---|
| 200 | ОК |
JSON, описанный в таблице Описание пакета данных |
Запрос выполнен успешно и вернул некоторые данные |
| 400 | The request is invalid |
Массив описаний для всех некорректных значений в запросе: Пример{ "message": "The request is invalid.", "modelState": { "unitRequest.BeginDateTime": ["The value ’2017/01/49 12:43:50’ is not valid for BeginDateTime."], "unitRequest.EndDateTime": ["The value ’2017/01/49 12:43:50’ is not valid for EndDateTime."] } } |
|
| 401 | Unauthorized | "Authorization has been denied for this request" | Нет прав для выполнения запроса |
| 403 | Forbidden | "This unitId is unavailable to your account" |
Запрошены данные по ТС, которого нет в списке доступных ТС (отсутствует в ответе метода GET /api/units/availableIds). В запросе не указан unitId. |
| 500 | Internal Server Error |
Массив с описанием ошибки на сервере Пример"message":"System.InvalidOperationException: лог ошибки" |
Ошибка на сервере. В запросе не указаны beginDateTime и/или endDateTime. |