...
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?>\n<AuditTrail <AuditTrail Version="1" CreationDate="2018-10-01T13:07:21.2795797Z">\n <EnvelopeId>[Envelope ID]</EnvelopeId>\n <EnvelopeName>[Envelope Name]</EnvelopeName>\n <EnvelopeStatus>[Envelope Status - possible values: Completed]</EnvelopeStatus> <!-- note: at the moment, the Audit Trail is only generated for completed envelopes -->\n <EnvelopeCreationDate>[Create Date, e.g. 2018-10-01T13:05:10.927Z]</EnvelopeCreationDate>\n <EnvelopeSendDate>[Send Date, e.g. 2018-10-01T13:06:21.13Z]</EnvelopeSendDate>\n <EnvelopeExpirationDate>[Expiration Date, e.g. 2018-10-29T13:06:21.13Z]</EnvelopeExpirationDate>\n <Sender>\n <FirstName>[Sender First Name]</FirstName>\n <LastName>[Sender Last Name]</LastName>\n <EMail>[Sender E-Mail]</EMail>\n </Sender>\n <ElectronicDisclosures>\n <!-- list of "Disclosure" elements (see below) -->\n </ElectronicDisclosures>\n <Recipients>\n <!-- list of "Recipient" elements (see below) -->\n </Recipients>\n <Notifications>\n <!-- list of "Notification" elements (see below) -->\n </Notifications>\n <SendFinishedDocuments>[true|false]</SendFinishedDocuments> \n <PreventMailSending>[true|false]</PreventMailSending>\n< </AuditTrail> |
Electronic Disclosures
Code Block | ||||
---|---|---|---|---|
| ||||
<Disclosure Culture="[language ISO code, e.g. de, de-AT]">\n <Subject>[Message Subject]</Subject>\n <Text>[Message Body]</Text>\n< </Disclosure> |
Recipients
General
Code Block | ||||
---|---|---|---|---|
| ||||
<Recipient Id="[Recipient ID]" OrderIndex="[Recipient OrderIndex]" EMail="[Recipient E-Mail]" Deleted="[true|false]">\n <FirstName>[Recipient FirstName]</FirstName>\n <SealingProfileName />\n <LastName>[Recipient LastName]</LastName>\n <Type>[Recipient Type, possible values see below]</Type>\n <FinishDate>[Finish Date, e.g. 2018-10-01T14:01:32.6354943Z]</FinishDate>\n <Status>[Recipient Status, possible values see below]</Status>\n <RejectReason>[Reject/Delegate reason]</RejectReason>\n <WorkstepId>[Workstep ID]</WorkstepId>\n <History>\n <!-- list of "Entry" elements (see below) - info about previous changes of this recipients -->\n </History>\n <AuthenticationMethods>\n <!-- list of "AuthenticationMethod" elements (see below) -->\n </AuthenticationMethods>\n <MailSubject>[Mail Message Subject]<MailSubject>\n <MailContent>[Mail Message Content]<MailContent>\n <DelegatorId>[OPTIONAL: Recipient ID of the delegator recipient]</DelegatorId>\n <DelegateeId>[OPTIONAL: Recipient ID of the delegatee recipient]</DelegateeId>\n <WorkStepInformation><!-- OPTIONAL: Workstep Information XML - details see below --></WorkStepInformation>\n <auditTrail><!-- OPTIONAL: Workstep Audit Trail XML - details see below --></auditTrail>\n <PreventMailSending>[true|false]</PreventMailSending>\n< </Recipient> |
Values for Type:
...
Code Block | ||||
---|---|---|---|---|
| ||||
<Entry ValidFrom="[When was this recipient setting valid? e.g. 2018-10-01T14:00:41.54Z]" ValidTo="[When was this recipient setting valid? e.g. 9999-12-31T23:59:59.9999999Z]">\n <FirstName>[FirstName]</FirstName>\n <LastName>[LastName]</LastName>\n <EMail>[E-Mail]</EMail>\n <Modifications>\n <!-- List of "Modification" elements -->\n <Modification>[Modification]</Modification>\n </Modifications>\n< </Entry> |
Values for Modification:
...
Code Block | ||||
---|---|---|---|---|
| ||||
<Notification Type="[Notification Type - possible values see below]" Added="[Added Date, e.g. 2018-10-01T14:01:32.6354943Z]" Sent="[Added Date, e.g. 2018-10-01T14:01:32.6354943Z]" Recipient="[OPTIONAL - Recipient ID">\n <ExtraInformation />\n< </Notification> |
Values for Type
...