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 выполнен от имени этого участника.
См. также
Структура используется:
- в структуре AmendmentRequestDocflowV5
- в структуре AmendmentRequestRecipientDocflow
- в структуре DocumentParticipantsV2
- в структуре RevocationDocflowV5
- в структуре RevocationResponseDocflowV5
- в структуре TitleDocflow
- в структуре TitleDocflowSummary
- в структуре TitleParticipantDocflow
- в структуре TitleParticipantDocflowSummary