GenerateForwardedDocumentProtocol (V2)

Внимание

Метод устарел и будет удален из API после 01 ноября 2025. Подробнее в истории изменений.

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

Протокол отражает состояние документа на момент пересылки.

Метод работает аналогично методу GenerateDocumentProtocol: только идентификатор документа, для которого генерируется протокол, задается набором параметров fromBoxId, messageId, documentId, forwardEventId.

GET /V2/GenerateForwardedDocumentProtocol
Query Parameters:

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

  • fromBoxId – идентификатор ящика инициатора пересылки документа.

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

  • documentId – идентификатор документа в сообщении.

  • forwardEventId – идентификатор события пересылки документа.

Request Headers:
Status Codes:

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

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

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

  • 402 Payment Required – у указанного ящика закончилась подписка на API.

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

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

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

  • 409 Conflict – невозможно сформировать протокол передачи для указанного документа.

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

Response Headers:

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

Response Body:

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

  • если протокол уже сгенерирован, тело ответа содержит протокол передачи документа с подписью, представленные структурой DocumentProtocol;

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

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

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

GET /V2/GenerateForwardedDocumentProtocol?boxId={{boxId}}&fromBoxId={{fromBoxId}}&messageId={{messageId}}&documentId={{documentId}}&forwardEventId=631cf632-d217-4f7a-8d19-c46d4e054388 HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8

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

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

См. также

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

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

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

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

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

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

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

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