GenerateDocumentZip

Метод позволяет сформировать zip-архив, содержащий документ и относящиеся к нему подписи, а также (опционально) все файлы документооборота по данному документу.

Имя ресурса: /GenerateDocumentZip

HTTP метод: GET

Параметры строки запроса:

  • boxId: идентификатор ящика;
  • messageId: идентификатор сообщения;
  • documentId: идентификатор сущности документа, для которого требуется сгенерировать архив;
  • fullDocflow: признак того, что в формируемый архив требуется добавить все файлы документооборота. В значение необходимо передавать либо true, либо false

В запросе должен присутствовать HTTP-заголовок Authorization с необходимыми данными для авторизации.

В теле ответа содержится структура DocumentZipGenerationResult. Если запрошенный архив уже сгенерирован, данная структура содержит данные, необходимые для его скачивания методом ShelfDownload.

Если архив еще не создан, то запрос на его формирование ставится в очередь, а в ответе в HTTP-заголовке Retry-After указывается время (в секундах), по прошествии которого имеет смысл повторить запрос.

Возможные HTTP-коды возврата:

  • 200 (OK) - операция успешно завершена;
  • 400 (Bad Request) - данные в запросе имеют неверный формат или отсутствуют обязательные параметры;
  • 401 (Unauthorized) - в запросе отсутствует HTTP-заголовок Authorization, или в этом заголовке содержатся некорректные авторизационные данные;
  • 403 (Forbidden) - доступ к ящику с предоставленным авторизационным токеном запрещен, либо у пользователя нет доступа к запрашиваемому документу;
  • 404 (Not Found) - в указанном ящике нет сообщения с идентификатором messageId, либо в указанном сообщении нет сущности с идентификатором documentId;
  • 405 (Method not allowed) - используется неподходящий HTTP-метод;
  • 409 (Conflict) - формирование архива для данного документа невозможно;
  • 500 (Internal server error) - при обработке запроса возникла непредвиденная ошибка.