GeneratePrintForm

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

Чтобы получить печатную форму в формате PNG, используйте метод GeneratePrintFormPng.

GET /GeneratePrintForm
Query Parameters:

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

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

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

Request Headers:
Status Codes:

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

  • 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;

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

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

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

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

GET /GeneratePrintForm?boxId={{boxId}}&messageId={{messageId}}&documentId={{documentId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}

См. также

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

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

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

  • GenerateDocumentZip — формирует ZIP-архив, содержащий файлы документооборота указанного документа

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

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

  • GeneratePrintFormPng — запускает генерацию печатной формы документа в формате PNG

  • GeneratePrintFormPngFromAttachment — запускает генерацию печатной формы документа в формате PNG по его содержимому

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

  • GetGeneratedPrintFormResult — возвращает статус и результат генерации печатной формы