AcquireCounteragentResult
warning
Метод устарел и будет удален из API после 10 ноября 2026 года. Подробнее в истории изменений. Используйте актуальную версию метода — AcquireCounteragentResult (V3).
Метод AcquireCounteragentResult возвращает идентификатор приглашенной организации.
GET /AcquireCounteragentResult
Параметры запроса
taskId— идентификатор операции, полученный методом AcquireCounteragent.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.204— операция еще не завершена. В HTTP-заголовке ответаRetry-Afterуказано время в секундах, через которое нужно повторить запрос.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.403— доступ к ящику с предоставленным авторизационным токеном запрещен или у пользователя недостаточно прав для доступа ко всем документам организации.404— в указанном ящике нет документов с указанными идентификаторами.405— используется неподходящий HTTP-метод.409— не удалось выполнить запрос на приглашение контрагента.500— при обработке запроса возникла непредвиденная ошибка.
Заголовки ответа
Retry-After— если в ответе содержится HTTP-заголовокRetry-After, то операция с указанным идентификатором еще не завершена. В этом случае повторите вызов через указанное в заголовке время (в секундах).
Тело ответа
Тело ответа содержит результат выполнения операции, представленный структурой AcquireCounteragentResult:
message AcquireCounteragentResult {
required string OrgId = 1;
optional DocumentId InvitationDocumentId = 2;
}
orgId— идентификатор приглашенной организации.InvitationDocumentId— ссылка на документ, отправленный вместе с приглашением. Представлена структурой DocumentId. Заполняется независимо от наличия доступа к документу.
Если отправить приглашение контрагенту не удалось, то метод вернет ошибку 409 (Conflict). Возможные причины ошибки:
- не удалось создать организацию, если приглашение отправлялось в незарегистрированную организацию;
- не удалось проверить подпись, если приглашение отправлялось с вложенным файлом.