Общая ошибка при обработке запроса (common error)

Обновлено 22 мая 2023

Структура описывает общую ошибку. Эта ошибка возвращается, только если нельзя вернуть ошибку о конкретном устройстве: если ошибка может быть локализована до конкретного устройства, нужно передавать именно ее.

Поле	Тип	Обязательное?	Описание
code	integer	✔︎	Код ошибки. Могут использоваться следующие коды: 400 — ошибка валидации запроса 401 — ошибка авторизации 403 — ошибка проверки токена 500 — внутренняя ошибка системы 503 — сервер недоступен
message	string	✔︎	Произвольное описание ошибки
details	list<string>		Дополнительная информация об ошибке

{
    "code": integer,
    "message": string,
    "details": list<string>
}

Пример описания ошибки

В примере описана ситуация, когда запрос не был обработан из-за ошибки 500 Internal Server Error. Например, не был выполнен запрос на удаление устройств.

{
    "code": 500,
    "message": "System error",
    "details": [{"key1", "key2"}]
}