Перейти к основному содержимому

BoxCounteragentEventList

Список событий по изменению партнерских отношений с контрагентами.

message BoxCounteragentEventList {
repeated BoxCounteragentEvent Events = 1;
optional int32 TotalCount = 2;
required TotalCountType TotalCountType = 3;
}

message BoxCounteragentEvent {
required string EventId = 1;
optional CounteragentInfo Counteragent = 2;
optional string IndexKey = 3;
repeated CounteragentEventType EventTypes = 4;
}

enum CounteragentEventType {
UnknownCounteragentEventType = 0;
IInvitedCounteragent = 1;
CounteragentInvitedMe = 2;
CounteragentAcceptedInvitation = 3;
IAcceptedInvitation = 4;
IWithdrewInvitation = 5;
CounteragentWithdrewInvitation = 6;
IRejectedInvitation = 7;
CounteragentRejectedInvitation = 8;
IBrokeUpWithCounteragent = 9;
CounteragentBrokeUpWithMe = 10;
IForgotCounteragent = 11;
CounteragentForgotMe = 12;
IMadeCounteragent = 13;
CounteragentMadeMe = 14;
}
  • Events — список событий по изменению отношений с контрагентами. Каждое событие представлено структурой BoxCounteragentEvent с полями:
    • EventId — идентификатор события.
    • Counteragent — информация о контрагенте, представленная структурой CounteragentInfo.
    • IndexKey — ключ для постраничного получения списка найденных событий. Его можно передавать в качестве параметра afterIndexKey в метод GetCounteragentEvents (V1): ключ может содержать недопустимые символы, поэтому при вызове метода должен быть закодирован в URL-формат.
    • EventTypes — тип события, произошедшего с контрагентом. Принимает значение из перечисления CounteragentEventType:
      • UnknownCounteragentEventType — неизвестное значение;
      • IInvitedCounteragent — я отправил приглашение контрагенту;
      • CounteragentInvitedMe — контрагент отправил мне приглашение;
      • CounteragentAcceptedInvitation — контрагент принял мое приглашение;
      • IAcceptedInvitation — я принял приглашение контрагента;
      • IWithdrewInvitation — я отменил свое приглашение;
      • CounteragentWithdrewInvitation — контрагент отменил свое приглашение;
      • IRejectedInvitation — я отклонил приглашеие контрагента;
      • CounteragentRejectedInvitation — контрагент отклонил мое приглашение;
      • IBrokeUpWithCounteragent — я разорвал отношения с контрагентом;
      • CounteragentBrokeUpWithMe — контрагент разорвал отношения со мной;
      • IForgotCounteragent — отношения с контрагентом разорваны завершенным документооборотом или через настройку роуминга;
      • CounteragentForgotMe — отношения контрагента со мной разорваны завершенным документооборотом или через настройку роуминга;
      • IMadeCounteragent — отношения с контрагентом установлены:
        • начатым документооборотом;
        • через настройку роуминга;
        • автоматически, если его ящик имеет свойство Sociability = AllOrganizations, а приглашение отправлено без запроса подписи, независимо от наличия вложения.
      • CounteragentMadeMe — отношения контрагента со мной установлены:
        • начатым документооборотом;
        • через настройку роуминга;
        • автоматически, если мой ящик имеет свойство Sociability = AllOrganizations, а приглашение получено без запроса подписи, независимо от наличия вложения.
  • TotalCount — общее количество найденных событий, соответствующих заданным параметрам.
  • TotalCountType — параметр, указывающий, является ли значение TotalCount точным или подсчет был ограничен. Принимает значения из перечисления TotalCountType.

См. также

Структура используется:

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года