Versions Compared

Old Version 13

changes.mady.by.user Unknown User (gierlinger)

Saved on

compared with

New Version 14

changes.mady.by.user Unknown User (gierlinger)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Defining a MetaDataXML sets the value only if AdditionalClientWorkstepInformation is not already set via api. For example:

  1. Setting AdditionalClientWorkstepInformation AND MetaDataXml


    Code Block
    languagejava
    themeEclipse
    "SendEnvelopeDescription": {
    "MetaDataXml": "<Tagging doctype=\"INVOICE\"><InvoiceNr>123456</InvoiceNr></Tagging>",
...
"Recipients": [
    {
        "Email": "##email##",
        ...
    }
],
"RecipientType": "Signer",
"WorkstepConfiguration": {
    "AdditionalClientWorkstepInformation": "<test id='test'>Some Information</test>",
    ...


    1. results in 

      Code Block
      languagexml
      themeEclipse
      <AdditionalClientWorkstepInformation>
    <test id='test'>Some Information</test>
</AdditionalClientWorkstepInformation>

  2. Setting AdditionalClientWorkstepInformation only

    Code Block
    languagejava
    themeEclipse
    "SendEnvelopeDescription": {
...
"Recipients": [
    {
        "Email": "##email##",
        ...
    }
],
"RecipientType": "Signer",
"WorkstepConfiguration": {
    "AdditionalClientWorkstepInformation": "<test id='test'>Some Information</test>",
    ...

    1. results in


      Code Block
      languagexml
      themeEclipse
      <AdditionalClientWorkstepInformation>
    <test id='test'>Some Information</test>
</AdditionalClientWorkstepInformation>


  3. Setting MetaDataXml only


    Code Block
    languagejava
    themeEclipse
    "SendEnvelopeDescription": {
    "MetaDataXml": "<Tagging doctype=\"INVOICE\"><InvoiceNr>123456</InvoiceNr></Tagging>",
...
"Recipients": [
    {
        "Email": "##email##",
        ...
    }
],
"RecipientType": "Signer",
"WorkstepConfiguration": {
    ...


    1. results in

      Code Block
      languagexml
      themeEclipse
      <AdditionalClientWorkstepInformation>
    <signature>
        <Tagging doctype="INVOICE">
            <InvoiceNr>123456</InvoiceNr>
        </Tagging>
    </signature>
</AdditionalClientWorkstepInformation>


Expiration date

Note: The following information is valid for envelopes as well as for drafts: Settings for the relative time:

  • Envelope expiry as relative time, provided in seconds (or milliseconds) after sending the envelope
  • Envelope expiry as relative time, in days after sending the envelope

Settings for the absolute time:

  • Envelope expiry as absolute time, as timestamp in GMT (with Z in the timestamp text) or optional with defined timezone

Please note the following: Defining no option will lead to usage of the default value of 28 days. Moreover, if you configure an absolute expiry time which is already in the past at time of sending the envelope, an error message will be returned. For the draft, it is required to have both options - store absolute or relative time. For the envelopes, only an absolute timestamp is required to be set and considered while being in progress. Please also see the next REST API configuration.

Absolute expiration date:

Code Block
languagejava
themeEclipse
// works with envelope/send
// works with draft/create
"SendEnvelopeDescription": {
	...
	"ExpirationDate": "2021-03-22T08:34:50.775Z",
	...
}
// works with draft/createFromTemplate
// works with envelope/sendFromTemplate
"EnvelopeOverrideOptions": {
	...
	"ExpirationDate": "2021-03-22T08:34:50.775Z",
	...
}
// works with draft/update
{
"ExpirationDate": "2021-03-22T08:34:50.775Z"
}

Relative expiration date:

Code Block
languagejava
themeEclipse
// works with envelope/send
// works with draft/create
"SendEnvelopeDescription": {
  ...
  "DaysUntilExpire": 1,
  // EXCLUSIVE OR!! (Only one is allowed - otherwise error)
  "ExpirationInSecondsAfterSending": 86400,
  ...
}
// works with draft/createFromTemplate
// works with envelope/sendFromTemplate
"EnvelopeOverrideOptions": {
  ...
  "DaysUntilExpire": 1,
  // EXCLUSIVE OR!! (Only one is allowed - otherwise error)
  "ExpirationInSecondsAfterSending": 86400,
...
}
// works with draft/update
{
"ExpirationInSecondsAfterSending": }


Info

Please note the following: An absolute expiration date is used in this example. Please

also note the date format (YYYY-MM-DD[T]HH:mm:ssZ).

For example:

  • 2022-12-24T18:21Z
  • 2022-01-01T12:00:00+01:00

Viewer preferences

Following lines of code show some viewer preferences configurations:

...