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

PrepareDocumentsToSign

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

POST /PrepareDocumentsToSign

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

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

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

Тело запроса

Тело запроса должно содержать запрос на подготовку документов к подписанию, представленный структурой PrepareDocumentsToSignRequest.

Коды ответа

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

Тело ответа

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

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

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

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

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

POST /PrepareDocumentsToSign HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json; charset=utf-8
Accept: application/json

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

{
"BoxId": "{{boxId}}",
"Documents": [
{
"DocumentId": {
"MessageId": "{{MessageId}}",
"EntityId": "{{EntityId}}"
},
"SignerContent": "PD94bWwgdm...AgPC9TaWduZXJzPg==" // содержимое XML-файла с данными подписанта в кодировке Base-64
}
]
}

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

{
"DocumentPatchedContents":
[
{
"DocumentId": {
"MessageId": "{{MessageId}}",
"EntityId": "{{EntityId}}"
},
"PatchedContentId": "patched-content/...edbb7d2",
"Content": "PD94bWwgdm...ODp6z4="
}
]
}

См. также

Инструкции:

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

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

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