Counteragent

message CounteragentList {
    required int32 TotalCount = 1;
    repeated Counteragent Counteragents = 2;
    required TotalCountType TotalCountType = 3;
}

message Counteragent {
    optional string IndexKey = 1;
    required Organization Organization = 2;
    optional CounteragentStatus CurrentStatus = 3 [default = UnknownCounteragentStatus];
    required sfixed64 LastEventTimestampTicks = 4;
    optional string MessageFromCounteragent = 6;
    optional string MessageToCounteragent = 7;
    optional DocumentId InvitationDocumentId = 8;
    optional string CounteragentGroupId = 9;
}

enum CounteragentStatus {
    UnknownCounteragentStatus = 0;
    IsMyCounteragent = 1;
    InvitesMe = 2;
    IsInvitedByMe = 3;
    RejectsMe = 5;
    IsRejectedByMe = 6;
    NotInCounteragentList = 7;
}

enum TotalCountType {
    UnknownCountType = 0;
    Equal = 1;
    GreaterThanOrEqual = 2;
}

message CounteragentCertificateList {
    repeated Certificate Certificates = 1;
}

message Certificate {
    required bytes RawCertificateData = 1;
}

Структура данных CounteragentList представляет собой список контрагентов, возвращаемый методом GetCounteragents. Поле CounteragentList.TotalCount содержит общее количество контрагентов, удовлетворяющих фильтру.

• TotalCountType — параметр, отражающий, какое значение содержит поле TotalCount. Принимает одно из значений перечисления TotalCountType:

• Equal — поле TotalCount содержит точное количество контрагентов, удовлетворяющих запросу. Этот параметр используется при количестве контрагентов меньше 10000.

• GreaterThanOrEqual — поле TotalCount возвращает значение 10000, при этом реальное количество контрагентов может быть больше. Это ограничение введено для того, чтобы увеличить производительность метода при больших количествах контрагентов. При этом ограничение влияет только на значение поля TotalCount, но вы по-прежнему можете получить весь список контрагентов, используя параметр IndexKey.

Структура данных Counteragent содержит информацию об одном контрагенте:

• IndexKey - уникальный ключ контрагента, который можно передавать в метод GetCounteragents в качестве параметра afterIndexKey для итерирования по всему отфильтрованному списку.

• Organization - информация об организации-контрагенте, представленная в виде структуры Organization.

• CurrentStatus - текущий статус отношения партнерства с данным контрагентом; может меняться со временем; возможные значения:

  • UnknownCounteragentStatus (неизвестный статус, может выдаваться лишь в случае, когда клиент использует устаревшую версию SDK и не может интерпретировать статус контрагента, переданный сервером),

  • IsMyCounteragent (отношение партнерства установлено и действует),

  • InvitesMe (данный контрагент прислал запрос на установление отношения партнерства),

  • IsInvitedByMe (в адрес данного контрагента был отправлен запрос на установление отношения партнерства),

  • RejectsMe (отношение партнерства было разорвано со стороны контрагента, либо запрос на установление отношения партнерства был отклонен контрагентом),

  • IsRejectedByMe (отношение партнерства было разорвано со стороны текущей организации, либо запрос на установление отношения партнерства был отклонен текущей организацией),

  • NotInCounteragentList (специальное значение, выдаваемое для организаций, которые отсутствуют в списке контрагентов текущей организации; не может выдаваться при получении структур Counteragent методами GetCounteragent и GetCounteragents).

• LastEventTimestampTicks - метка времени последнего события из истории взаимодействия с данным контрагентом.

• MessageFromCounteragent - текст последнего комментария, полученного от контрагента, из истории взаимодействия ним.

• MessageToCounteragent - текст последнего комментария, отправленного контрагенту, из истории взаимодействия ним.

• InvitationDocumentId - ссылка на документ, который был отправлен вместе с приглашением. Данное поле заполняется независимо от наличия доступа к документу и, только в случае, если статус контрагента один из IsMyCounteragent, InvitesMe, IsInvitedByMe. Список статусов, для которых возвращается документ, может быть расширен в будущем.

• CounteragentGroupId — идентификатор группы, в которую добавлен контрагент. Возвращается, если статус контрагента CounteragentStatus = IsMyCounteragent. Группа контрагентов представлена структурой CounteragentGroup.

Структура данных CounteragentCertificateList представляет собой список сертификатов контрагента представленных в виде структуры Certificate.

Структура Certificate представляет собой один сертификат:

• RawCertificateData - сам сертификат, сериализованный в массив байтов в DER-кодировке.