Методы для работы c документами в черновике 

Данный раздел посвящен методам, с помощью которых можно работать с документами в черновике. Для работы с этими методами должен быть предварительно создан черновик.

Подробная спецификация методов показана в Swagger в разделе Черновики и конструктор черновиков (draftsbuilder).

Список доступных методов

Методы для работы c документами в черновике

Добавление документа 

Метод: POST Add Document

Допускается добавление документа без подписи. Например, вы не уверены в валидности сформированного xml-файла документа, и чтобы не генерировать лишний раз подпись к нему, хотите сначала его проверить отдельно. И если проверка прошла успешно, то подпись можно отдельно добавить к документу с помощью метода Создание подписи к документу.

Удаление документа 

Метод: DELETE Document

Получение документа 

Метод: GET Document

С помощью данного метода можно получить конкретный документ из черновика, с его мета-информацией и контентами самого документа и подписи, если она уже была добавлена

Редактирование документа 

Метод: PUT Document

Используется для добавления каких-либо данных в документ, например, добавление подписи к нему. Если документ с переданным идентификатором не существует, метод создаст его.

Получение подписи под документом 

Метод: GET SignatureContent

Добавление подписи под документ 

Метод: PUT DocumentSignature

Печать документа 

Метод: GET DocumentPrint

Метод позволяет получить печатную форму формализованного документа в черновике. Метод поддерживает печать не всех типов документов и контентов. Ограничения, особенности работы метода и пример работы описаны в статье Печать документов.

Особенности печати в черновике:

Если черновик не отправлен, то документ будет напечатан без штампов.

Если черновик отправлен и найден документооборот, то документ будет напечатан как в документообороте — со штампами.

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

deferred — флаг асинхронного выполнения запроса. Принимает только значение true. Тогда запрос будет выполнен асинхронно: будет создана задача, статус выполнения которой можно посмотреть по task-id.

Предупреждение

Значение false для синхронного вызова метода устарело и больше не используется в методах API. При таком значении вернется ошибка 400 BadRequest.

Возможные коды ответов

202 Accepted — поставлена задача на печать документа, результат можно получить в методе Get DraftDocumentTask.
400 BadRequest — печать невозможна: тип контента или тип документа не поддерживается, либо передано значение флага асинхронного вызова метода deferred — false.

Проверка статуса задачи документа черновика по TaskId 

Метод: GET DraftDocumentTask

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

Получение расшифрованного контента документа (deprecated)

Метод: GET DocumentContent

Внимание

Метод устарел. Вместо него используйте Сервис контентов. Идентификатор контента лежит в параметре content-id.

Максимальный размер возвращаемого контента 32 МБ для тестовой и 64 МБ для рабочей площадки.

Получение зашифрованного контента документа (deprecated)

Метод: GET EncryptedDocumentContent

Внимание

Метод устарел. Вместо него используйте Сервис контентов. Идентификатор контента лежит в параметре content-id.

Если над черновиком был вызван метод Подготовка документов в черновике к отправке, то в черновике появился зашифрованный контент документа, с помощью данного метода его можно получить. Максимальный размер возвращаемого контента 32 МБ для тестовой и 64 МБ для рабочей площадки.