GeneratePrintForm

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

GET /GeneratePrintForm

Query Parameters:

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

Request Headers:

Authorization – данные, необходимые для авторизации.
Content-Type – тип возвращаемого содержимого.

Status Codes:

200 OK – операция успешно завершена.
204 No Content – операция еще не завершена. В HTTP-заголовке ответа Retry-After указано время в секундах, через которое нужно повторить запрос.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
402 Payment Required – у указанного ящика закончилась подписка на API.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен или у пользователя недостаточно прав для доступа к указанному документу.
404 Not Found – не найден ящик с указанным идентификатором, не найдено сообщение с идентификатором messageId или не найдена сущность с идентификатором documentId.
405 Method Not Allowed – используется неподходящий HTTP-метод.
409 Conflict – невозможно сформировать печатную форму для указанного документа.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Headers:

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

Response Body:

Тело ответа может содержать следующие данные:

если печатная форма уже сгенерирована, тело ответа содержит файл сгенерированной печатной формы документа в формате PDF;
если формирование печатной формы для указанного документа невозможно, тело ответа содержит текстовое сообщение об ошибке.

Примеры использования

Пример HTTP-запроса:

GET /GeneratePrintForm?boxId={{boxId}}&messageId={{messageId}}&documentId={{documentId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8

См. также

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

DetectCustomPrintForms — определяет нестандартную печатную форму для документов из указанного списка
GenerateDocumentProtocol — генерирует печатную форму протокола передачи документа и подпись к ней
GenerateDocumentZip — формирует ZIP-архив, содержащий файлы документооборота указанного документа
GeneratePrintForm — генерирует печатную форму документа
GeneratePrintFormFromAttachment — возвращает идентификатор, с помощью которого можно получить печатную форму документа по его содержимому
GetGeneratedPrintForm — генерирует печатную форму документа по идентификатору, полученному методом GeneratePrintFormFromAttachment