GenerateRevocationRequestXml (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 – у указанного ящика закончилась подписка на API.

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

  • 404 Not Found – не найдены документ или сообщение с указанным идентификатором, или указанная сущность имеет неверный тип, или у указанной сущности нет дочерней сущности типа 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/instruction_revocation.png

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

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

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

POST V2/GenerateRevocationRequestXml?boxId={{boxId}}&messageId={{messageId}}&attachmentId={{attachmentId}}&contentTypeId=revocation_request_02 HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Content-Type: application/json charset=utf-8

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

{ 
    "Comment": "Текстовый комментарий", 
    "Signer": { 
        "SignerDetails": { 
            "Surname": "Иванов", 
            "FirstName": "Иван", 
            "Patronymic": "Иванович", 
            "JobTitle": "Сотрудник", 
            "Inn": "7713964071" 
        } 
    } 
}

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

<?xml version="1.0" encoding="windows-1251"?><Файл ИдФайл="DP_PRANNUL_2BM-9147414342-757645784-202407101104400484330_2BM-1839264655-732644841-202407101103418496883_20250423_3d2a09bf-748d-4583-b4b3-fd91bf0092b3" ВерсПрог="Diadoc 1.0" ВерсФорм="1.02"><Документ><УчастЭДО ИдУчастЭДО="2BM-1839264655-732644841-202407101103418496883">
<ЮЛ НаимОрг="Отправитель" ИННЮЛ="1839264655" КПП="732644841" />
</УчастЭДО><СвПредАн><СведАнФайл ИмяАнФайла="ON_NSCHFDOPPR_2BM-9147414342-757645784-202407101104400484330_2BM-1839264655-732644841-202407101103418496883_20250207_30f13ccc-deb2-4d49-8201-0ab211e8683d"><ЭЦПАнФайл>MIINLgYLwVeXpzCZ25uwFn
</ЭЦПАнФайл>
</СведАнФайл><ТекстПредАн>Текстовый комментарий
</ТекстПредАн>
</СвПредАн><НапрПредАн ИдУчастЭДО="2BM-9147414342-757645784-202407101104400484330">
<ЮЛ НаимОрг="Получатель" ИННЮЛ="9147414342" КПП="757645784" />
</НапрПредАн><Подписант Должность="Сотрудник">
<ФИО Фамилия="Иванов" Имя="Иван" Отчество="Иванович" />
</Подписант>
</Документ>
</Файл>

См. также

Инструкции:
Устаревшие версии метода: