AcquireCounteragentResult (V2)

Возвращает результат приглашения контрагента к партнерским отношениям, выполненного методом AcquireCounteragent (V3).

GET /V2/AcquireCounteragentResult

Query Parameters:

taskId – идентификатор операции, полученный методом AcquireCounteragent (V3).

Request Headers:

Authorization – данные, необходимые для авторизации.

Status Codes:

200 OK – операция успешно завершена.
204 No Content – операция еще не завершена. В HTTP-заголовке ответа Retry-After указано время в секундах, через которое нужно повторить запрос.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен или у пользователя недостаточно прав для доступа ко всем документам организации.
404 Not Found – в указанном ящике нет документов с указанными идентификаторами.
405 Method Not Allowed – используется неподходящий HTTP-метод.
409 Conflict – не удалось выполнить запрос на приглашение контрагента.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Headers:

Retry-After – если в ответе содержится HTTP-заголовок Retry-After, то предыдущий вызов этого метода с таким же идентификатором операции еще не завершен. В этом случае следует повторить вызов через указанное в заголовке время (в секундах), чтобы убедиться, что операция завершилась без ошибок.

Response Body:

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

message AcquireCounteragentResultV2 {
    required string BoxId = 1;
    optional DocumentId InvitationDocumentId = 2;
}

BoxId — идентификатор ящика приглашенной организации.
InvitationDocumentId — идентификатор документа, отправленного вместе с приглашением. Представлен структурой DocumentId. Заполняется независимо от наличия доступа к документу.

Если отправить приглашение контрагент не удалось, то метод вернет ошибку 409 (Conflict). Возможные причины ошибки:

не удалось создать организацию, если приглашение отправлялось в незарегистрированную организацию;

не удалось проверить подпись, если приглашение отправлялось с вложенным файлом.

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

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

GET /V2/AcquireCounteragentResult?taskId=997818e1-9420-4f8f-857f-c86fb070d0a7 HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}

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

{
    "BoxId": "1f208d03-2a60-4f64-91b1-b7aad54cfaf3",
    "InvitationDocumentId": {
        "MessageId": "88d108be-27ec-4808-8a38-8062e7cf4988",
        "EntityId": "ce1d22da-f9e8-4c4c-af34-09bc94ad1fdd"
    }
}

См. также

Инструкции:

Контрагенты

Методы для работы с контрагентами:

AcquireCounteragent (V3) — отправляет контрагенту приглашение к партнерским отношениям
AcquireCounteragentResult (V2) — возвращает результат приглашения контрагента к партнерским отношениям
BreakWithCounteragent (V2) — разрывает партнерские отношения с контрагентом
GetCounteragent (V3) — возвращает данные контрагента по указанному идентификатору
GetCounteragentCertificates (V2) — возвращает список сертификатов контрагента
GetCounteragents (V3) — выполняет поиск контрагентов по указанным параметрам

Устаревшие версии метода:

AcquireCounteragentResult