Формат ошибок

Пример детали ошибки

{
  "code": 400,
  "message": "Страхователь должен быть старше 18 лет",
  "errors": [
    {
      "domain": "policy",
      "field": "policyHolder.dateOfBirth"
    }
  ]
}

Свойство	Описание	Обязательное
code	Числовой код ошибки	Нет
message	Краткое описание ошибки	Да
errors	Детализация ошибки	Нет
domain	Где произошла ошибка	Нет
reason	Причина ошибки	Нет
field	Место в данных, вызвавшее ошибку	Нет

Категории кодов ответа

Категория	Диапазон	Описание
Successful	2xx	Запрос был получен, проверен и принят в обработку
Client error	4xx	Запрос содержит ошибки и не может быть выполнен из-за ошибок клиента
Server error	5xx	Сервер не смог обработать годный запрос

Используемые коды ошибок

Код	Наименование	Описание
200	OK	Request succeeded
201	Created	Resource created successfully
204	No Content	Successful request with no response body
400	Bad Request	Ошибка валидации
401	Unauthorized	Не аутентифицирован
403	Forbidden	Доступ запрещён
404	Not Found	Ресурс не найден
409	Conflict	Request conflicts with current state
422	Unprocessable Entity	Нарушение бизнес-правил
429	Too Many Requests	Rate limit exceeded
500	Internal Server Error	Внутренняя ошибка.
503	Service Unavailable	Service temporarily unavailable

Ошибки авторизации

401 Unauthorized

Возвращается, если:

• Отсутствует токен
• Токен невалиден или истёк

403 Forbidden

Возвращается, если:

• AuthorizationService отклонил доступ
• Недостаточно прав
• Нарушена tenant-граница