.. _Integration_IntegrationApi_Helpers_WorkingWithDocuments_GettingDocumentAccessStatus:

Получение статуса доступа к документам
######################################

| Запрос: ``POST /documents/accessStatuses``
| HTTP-заголовки:

.. code-block::

    Authorization: Bearer access_token
    Content-Type: application/json
    Accept: application/json

Тело запроса:

.. code-block:: JSON

    {
        "DocumentIds": [                    // идентификаторы документов
            "guid"
        ]
        "ThrowOnForbiddenDocuments": false  // признак того, что если есть недоступные документы, 
                                            // то нужно прервать выполнение запроса
    }


Описание запроса
****************

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

Идентификаторы документов передаются в поле ``DocumentIds``.

Поле ``ThrowOnForbiddenDocuments`` управляет поведением запроса в случае, если к одному из документов нет доступа.

Если поле установлено в ``true``, и хотя бы к одному из документов нет доступа, то выполнение запроса прерывается
и возвращается :ref:`HTTP-статус 400 (Bad Request) <Integration_Common_ApiHttpStatuses_BadRequest>` с сообщением об ошибке.

Если поле установлено в ``false``, то выполнение запроса не прерывается и Integration API вернет статус доступа для всех документов.

Ответ на запрос
***************

Ответ на запрос содержит словарь элементов вида:

.. code-block:: JSON

    {
        "DocumentStatuses": {          
            "guid" : true           // идентификатор документа и статус доступа к нему 
        }           
    }

Ключ словаря - индентификатор документа.

| Значение словаря - статус доступа к документу.
| Если статус равен ``true``, то документ доступен для пользователя.
| Если статус равен ``false``, то документ недоступен для пользователя.