.. _Integration_Common_ApiHttpStatuses:

Возвращаемые статусы HTTP
#########################

.. _Integration_Common_ApiHttpStatuses_OK:

Успешное выполнение запроса
***************************

В случае успешного выполнения запроса API возвращает HTTP-статусы `2XX <https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#successful_responses>`_.

Ошибки аутентификации
*********************

| В случае ошибок аутентификации API возвращает HTTP-статус 401 (``Unauthorized``).
| Подробнее см. :ref:`Integration_Common_Authentication_TokenCachingAndUpdate`.

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

| В случае ошибок авторизации API возвращает HTTP-статус 403 (``Forbidden``).
| Подробнее см. :ref:`Integration_Common_Authentication_TokenCachingAndUpdate`.

.. _Integration_Common_ApiHttpStatuses_BadRequest:

Ошибки при выполнении запросов
******************************

В случае ошибок при выполнении запросов, в том числе, если есть ошибки в параметрах либо если выполнить запрос нельзя в текущем состоянии системы, 
API возвращает HTTP-статус 400 (``Bad Request``).
Тело ответа при этом содержит JSON вида:

.. code-block:: JSON

    {
        "RequestId": "0HMLN2KKRM6E3:00000002",      // уникальный идентификатор запроса на стороне сервиса
        "Path": "/resourcename",                    // запрошенный ресурс
        "Method": "POST",                           // HTTP-метод, указанный в запросе
        "Message": "Не найден ...",                 // текст ошибки
        "Details": "Api.ValidationException: ..."   // подробная информация об ошибке
    }

Уникальный идентификатор запроса на стороне сервиса может использоваться для поиска дополнительной инфомации в логах сервиса.

Подробная информация об ошибке включается в ответ только случае, если HTTP-сервис запущен в 
`Development-окружении <https://learn.microsoft.com/en-us/aspnet/core/fundamentals/environments#set-environment-on-the-command-line>`_.

Прочие ошибки
*************

В случае внутренних ошибок сервера или хостинга API возвращает HTTP-статусы `5XX <https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses>`_.

Прочие коды статусов
********************

Возврат прочих кодов статусов не предусмотрен и должен рассматриваться как нештатная ситуация.