GenerateRevocationRequestXml

Метод GenerateRevocationRequestXml генерирует предложение об аннулировании.

Версии метода:
  • v2 — поддерживает несколько версий предложения об аннулировании.

  • v1 — устаревшая версия.

v2

POST /V2/GenerateRevocationRequestXml
Query Parameters:
  • boxId – идентификатор ящика организации.

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

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

  • contentTypeId

    версия предложения об аннулировании, которое нужно сгенерировать. Принимает значения:

    • revocation_request_01 — для предложения об аннулировании версии 1.01,

    • revocation_request_02 — для предложения об аннулировании версии 1.02.

Request Headers:
Request Body:

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

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

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у организации с указанным идентификатором boxId закончилась подписка на API.

  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.

  • 404 Not Found – в указанном ящике нет сообщения с идентификатором messageId, или в указанном сообщении нет сущности с идентификатором attachmentId, или указанная сущность имеет неверный тип, или у указанной сущности нет дочерней сущности типа Signature.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 409 Conflict – невозможно сгенерировать предложение об аннулировании.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Headers:
  • Content-Disposition – имя файла с предложением об аннулировании.

Response Body:

Тело ответа содержит XML-файл с предложением об аннулировании документа attachmentId из сообщения messageId в ящике boxId. Файл с предложением генерируется в соответствии с XML-схемой.

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

Поведение метода зависит от того, кому отправляется предложение об аннулировании (ПОА):

../_images/generaterevocationrequestxml_contenttypeid.png

В случае с роуминговым оператором используйте метод GetRoamingOperators, чтобы узнать, поддерживает ли он аннулирование и какой версии.

v1

POST /GenerateRevocationRequestXml
Query Parameters:
  • boxId – идентификатор ящика организации.

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

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

Request Headers:
Request Body:

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

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

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.

  • 404 Not Found – в указанном ящике нет сообщения с идентификатором messageId, или в указанном сообщении нет сущности с идентификатором attachmentId, или указанная сущность имеет неверный тип, или у указанной сущности нет дочерней сущности типа Signature.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 409 Conflict – невозможно сгенерировать предложение об аннулировании.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Headers:
  • Content-Disposition – имя файла с предложением об аннулировании.

Response Body:

Тело ответа содержит XML-файл с предложением об аннулировании документа attachmentId из сообщения messageId в ящике boxId. Файл с предложением генерируется в соответствии с XML-схемой.

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