GenerateDocumentZip

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

GET /GenerateDocumentZip
Query Parameters:

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

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

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

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

Request Headers:
Status Codes:

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

  • 204 No Content – операция еще не завершена. В HTTP-заголовке ответа Retry-After указано время в секундах, через которое нужно повторить запрос.

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

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

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

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

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

Пример 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 — генерирует печатную форму документа

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

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