PrepareDocumentsToSign

Подготавливает документы к подписанию.

POST /PrepareDocumentsToSign
Query Parameters:

  • excludeContent – параметр, указывающий, что при получении ответа не нужно скачивать содержимое обработанных документов. Если указать значение true, то в ответе метода в структуре PrepareDocumentsToSignResponse поле DocumentPatchedContents.Content будет пустым. Необязательный параметр. По умолчанию имеет значение false.

Request Headers:
Request Body:

Тело запроса должно содержать структуру PrepareDocumentsToSignRequest.

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

Тело ответа содержит подготовленные к подписанию документы, представленные структурой PrepareDocumentsToSignResponse. Метод вернет только те документы, которые поддерживают подготовку к подписанию. Проверить возможность подготовки к подписанию можно с помощью свойства SupportsContentPatching структуры DocumentVersionV2 для типа этого документа, полученной методом GetDocumentTypes (V2). Инструкция о получении данных из метода GetDocumentTypes приведена на странице Получение информации о типе документа.

Метод не меняет переданное содержимое документа. Он генерирует новое содержимое, помещает его во временное хранилище и возвращает указатель на него в поле PrepareDocumentsToSignResponse.DocumentPatchedContents.PatchedContentId. Этот указатель можно использовать при отправке документа в поле PatchedContentId в структурах DocumentSignature и DocumentSenderSignature.

Метод позволяет указать информацию только об одном подписанте. При этом количество подписей под документом не ограничено.

См. также

Инструкции: