DocumentParticipantV2

Данные участника документооборота.

message DocumentParticipantV2
{
    required string BoxId = 1;
    optional string DepartmentId = 2;
    required string Role = 3;
    required DocumentParticipantFlags Flags = 4;
    required ParticipantType Type = 5;
    required bool IsCurrentBox = 6;
}

message DocumentParticipantFlags
{
    required bool IsRoaming = 1;
    required bool IsCrossborder = 2;
    required bool IsForeign = 3;
}

enum ParticipantType
{
    Unknown = 0;
    Sender = 1;
    Recipient = 2;
    Proxy = 3;
}

  • BoxId — идентификатор ящика.

  • DepartmentId — идентификатор подразделения.

  • Role — машиночитаемая роль участника в бизнес-процессе согласно предметной области в формате namespace:name, например logistics:consignor. Допустимые значения для этого поля задаются настройками конкретного типа документа и его вида документооборота.

  • Flags — признаки участника, представленные структурой DocumentParticipantFlags с полями:

    • IsRoaming — признак того, что участник является роуминговым;

    • IsCrossborder — признак того, что участник задействован в трансграничном документообороте (ТЭДО);

    • IsForeign — признак того, что участник является иностранным.

  • Type — тип участника, принимает значения из перечисления ParticipantType:

    • Unknown — неизвестное значение;

    • Sender — отправитель;

    • Proxy — промежуточный получатель;

    • Recipient — конечный получатель.

  • IsCurrentBox — признак того, что текущий запрос к API выполнен от имени этого участника.

См. также

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