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

GenerateDocumentProtocol

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

GET /GenerateDocumentProtocol

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

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

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

Коды ответа

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

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

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

Тело ответа

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

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

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

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

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

Пример тела ответа:

{
"PrintForm": "JVBERi0xLjQKJdP0zOEKM...E4MTcKJSVFT0YK", // содержимое PDF-файла печатной формы в кодировке Base-64
"Signature": "MIINIAYJKoZIhvcNAQcCo...M4qZkbzpR34Q==" // содержимое XML-файла с данными подписанта в кодировке Base-64
}

См. также

Инструкции:

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

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

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

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

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