GeneratePrintForm

Метод GeneratePrintForm генерирует печатную форму документа по его идентификатору.

GET /GeneratePrintForm
Query Parameters:

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

  • messageId – идентификатор сообщения.

  • documentId – идентификатор документа в сообщении, для которого нужно сгенерировать печатную форму.

Request Headers:
Status Codes:

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

  • 204 No Content – операция еще не завершена. В HTTP-заголовке ответа Retry-After указано время в секундах, через которое нужно повторить запрос.

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

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

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

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

  • 404 Not Found – не найден ящик с указанным идентификатором, не найдено сообщение с идентификатором messageId или не найдена сущность с идентификатором documentId.

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

  • 409 Conflict – формирование печатной формы для указанного документа невозможно; тело ответа содержит сообщение Generating print form for this type of document is not supported.

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

Response Headers:

  • Content-Disposition – имя файла печатной формы.

  • Retry-After – если в ответе содержится HTTP-заголовок Retry-After, то запрошенная печатная форма еще не сгенерирована и запрос на ее формирование находится в очереди. В этом случае тело ответа будет пустым. Следует повторить вызов через указанное в заголовке время (в секундах) для получения готовой печатной формы.

Response Body:

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

См. также

Другие методы для работы с печатными формами:

  • DetectCustomPrintForms — выявляет нестандартную печатную форму у документов из списка

  • GenerateForwardedDocumentPrintForm — генерирует печатную форму пересланного документа

  • GeneratePrintFormFromAttachment — возвращает идентификатор, с помощью которого можно получить печатную форму документа по его содержимому

  • GetGeneratedPrintForm — генерирует печатную форму документа