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

GenerateDocumentZip

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

GET /GenerateDocumentZip

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

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

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

Коды ответа

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

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

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

Тело ответа

Тело ответа содержит информацию для скачивания сформированного архива, представленную структурой DocumentZipGenerationResult.

Имена файлов в сгенерированном архиве не позволяют определить их содержимое. Если вы хотите однозначно определить содержимое и параметры каждой сущности в сообщении:

Архив документооборота будет содержать МЧД, приложенную к документу при подписании. Если приложенная МЧД была выпущена в порядке передоверия, то архив будет содержать всю цепочку передоверия.

Для неформализованного договора, подписанного с протоколом разногласий, и для этого протокола в архив будет включено универсальное сообщение с кодом статуса 4002. Сообщение фиксирует связь договора и протокола. Архив одного документа не содержит второй документ пары. Подробнее — на странице Работа с протоколом разногласий.

Метод не включает в архив служебный документ для отмены сведений об отгрузке маркированных товаров.

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

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

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

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

{
"ZipFileNameOnShelf": "__userId__/Diadoc.Documents.1f208d03-2a60-4f64-91b1-b7aad54cfaf3.ba04162c-e26f-448f-a370-299b4f15b6d1.da7cd73e-ff49-4a23-a018-42d27487e536.638747862192156432.FullDocflow_.zip"
}

См. также

Инструкции:

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

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

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

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

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