AcquireCounteragentResult

Метод AcquireCounteragentResult возвращает идентификатор приглашенной организации.

GET /AcquireCounteragentResult
Query Parameters:

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

Request Headers:
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:

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

message AcquireCounteragentResult {
    required string OrgId = 1;
    optional DocumentId InvitationDocumentId = 2;
}

  • orgId — идентификатор приглашенной организации.

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

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

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

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