Перейти к основному содержимому

GeneratePrintForm

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

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

GET /GeneratePrintForm

Параметры запроса

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

Заголовки запроса

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

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у указанного ящика закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен или у пользователя недостаточно прав для доступа к указанному документу.
  • 404 — не найден ящик с указанным идентификатором, не найдено сообщение с идентификатором messageId или не найдена сущность с идентификатором documentId.
  • 405 — используется неподходящий HTTP-метод.
  • 409 — невозможно сформировать печатную форму для указанного документа.
  • 429 — превышено ограничение на количество запросов в единицу времени. Повторите запрос через время, указанное в HTTP-заголовке Retry-After.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Заголовки ответа

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

Тело ответа

Тело ответа может содержать следующие данные: - если печатная форма уже сгенерирована, тело ответа содержит файл сгенерированной печатной формы документа в формате 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 — возвращает статус и результат генерации печатной формы

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года