GetDocument

GET /V3/GetDocument
Query Parameters:

  • boxId – идентификатор ящика организации.

  • messageId – идентификатор сообщения, содержащего искомый документ.

  • entityId – идентификатор сущности типа LetterAttachment внутри сообщения messageId, представляющей искомый документ.

  • injectEntityContent – параметр, указывающий нужно ли возвращать содержимое документа. Если имеет значение true, то содержимое документа будет добавлено в поле ответа Content.Data. Необязательный параметр, по умолчанию равен true.

Request Headers:
Status Codes:

  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у организации с указанным идентификатором boxId закончилась подписка на API.

  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.

  • 404 Not Found – в указанном ящике не найдено сообщение с идентификатором messageId или в указанном сообщении нет сущности типа LetterAttachment с идентификатором entityId.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит информацию о документе entityId из сообщения messageId в ящике boxId, представленную структурой Document.

Содержимое документа содержится в поле Document.Content. Формат содержимого зависит от типа документа; форматы описаны на странице Entity.

Метод имеет ограничение на размер содержимого документа, хранящегося в поле Content.Data, — он не должен превышать 1048576 байт. Если размер содержимого документа превышает это значение, то оно не будет включено в ответ независимо от значения параметра injectEntityContent. Вы можете получить такое бинарное представление с помощью метода GetEntityContent.

Для выполнения метода текущий пользователь должен иметь доступ к запрашиваемому документу, иначе метод вернет ошибку 403 (Forbidden).