Skip to content

AcquireCounteragent

koltsov edited this page Jan 21, 2015 · 1 revision

AcquireCounteragent

Имя ресурса: /AcquireCounteragent

HTTP метод: POST

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

  • myOrgId: идентификатор организации, от имени которой производится инициация отношения партнерства;

  • counteragentOrgId: идентификатор организации-контрагента;

  • comment: текст комментария к операции (может отсутствовать).

В запросе должен присутствовать HTTP-заголовок Authorization с необходимыми данными для авторизации. Пользователь имеет право производить манипуляции со списком контрагентов организации myOrgId, если у него есть доступ хотя бы в один из ящиков этой организации.

Метод позволяет добавить организацию counteragentOrgId в список контрагентов организации myOrgId. Алгоритм выполнения запроса:

  • Если между организациями myOrgId и counteragentOrgId нет действующего отношения партнерства, то от имени организации myOrgId отправляется запрос на установление отношения партнерства в адрес организации counteragentOrgId. Контрагент counteragentOrgId переходит в статус IsInvitedByMe.

  • Если в индексе отношений есть входящий запрос на установление отношения партнерства от организации counteragentOrgId к организации myOrgId (то есть контрагент counteragentOrgId находится в статусе InvitesMe), то этот запрос подтверждается и между организациями myOrgId и counteragentOrgId устанавливается действующее отношение партнерства. Контрагент counteragentOrgId переходит в статус IsMyCounteragent.

  • Если между организациями myOrgId и counteragentOrgId отношение партнерства уже установлено, или уже есть исходящий запрос от организации myOrgId к организации counteragentOrgId, то ничего не происходит.

Возможные HTTP-коды возврата:

  • 200 (OK) - операция успешно завершена;

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

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

  • 403 (Forbidden) - доступ к списку контрагентов организации myOrgId с предоставленным авторизационным токеном запрещен;

  • 405 (Method not allowed) - используется неподходящий HTTP-метод;

  • 500 (Internal server error) - при обработке запроса возникла непредвиденная ошибка.

HTTP API

История изменений Diadoc API Обзор возможностей API

Справочное руководство

Clone this wiki locally