Skip to content

Latest commit

 

History

History
54 lines (45 loc) · 2.86 KB

File metadata and controls

54 lines (45 loc) · 2.86 KB

DetailedParticipantSetInfo

Properties

Name Type Description Notes
id String The unique identifier of the participant set. This cannot be changed as part of the PUT call. [optional]
memberInfos List<DetailedParticipantInfo> Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set [optional]
name String Name of ParticipantSet (it can be empty, but needs not to be unique in a single agreement). Maximum no of characters in participant set name is restricted to 255. This cannot be changed as part of the PUT call. [optional]
order Integer Index indicating sequential signing group (specified for hybrid routing). This cannot be changed as part of the PUT call. [optional]
privateMessage String Participant set's private message - all participants in the set will receive the same message. This cannot be changed as part of the PUT call. [optional]
role RoleEnum Role assumed by all participants in the set (signer, approver etc.). This cannot be changed as part of the PUT call. [optional]
status StatusEnum The agreement status with respect to the participant set. This cannot be changed as part of the PUT call. [optional]

Enum: RoleEnum

Name Value
SIGNER "SIGNER"
SENDER "SENDER"
APPROVER "APPROVER"
ACCEPTOR "ACCEPTOR"
CERTIFIED_RECIPIENT "CERTIFIED_RECIPIENT"
FORM_FILLER "FORM_FILLER"
DELEGATE_TO_SIGNER "DELEGATE_TO_SIGNER"
DELEGATE_TO_APPROVER "DELEGATE_TO_APPROVER"
DELEGATE_TO_ACCEPTOR "DELEGATE_TO_ACCEPTOR"
DELEGATE_TO_CERTIFIED_RECIPIENT "DELEGATE_TO_CERTIFIED_RECIPIENT"
DELEGATE_TO_FORM_FILLER "DELEGATE_TO_FORM_FILLER"
SHARE "SHARE"

Enum: StatusEnum

Name Value
CANCELLED "CANCELLED"
COMPLETED "COMPLETED"
EXPIRED "EXPIRED"
NOT_YET_VISIBLE "NOT_YET_VISIBLE"
WAITING_FOR_OTHERS "WAITING_FOR_OTHERS"
WAITING_FOR_MY_APPROVAL "WAITING_FOR_MY_APPROVAL"
WAITING_FOR_AUTHORING "WAITING_FOR_AUTHORING"
WAITING_FOR_MY_ACKNOWLEDGEMENT "WAITING_FOR_MY_ACKNOWLEDGEMENT"
WAITING_FOR_MY_ACCEPTANCE "WAITING_FOR_MY_ACCEPTANCE"
WAITING_FOR_MY_FORM_FILLING "WAITING_FOR_MY_FORM_FILLING"
WAITING_FOR_MY_DELEGATION "WAITING_FOR_MY_DELEGATION"
WAITING_FOR_MY_SIGNATURE "WAITING_FOR_MY_SIGNATURE"
WAITING_FOR_MY_VERIFICATION "WAITING_FOR_MY_VERIFICATION"
WAITING_FOR_PREFILL "WAITING_FOR_PREFILL"