Versions Compared

Key

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

...

This field is used to provide additional information. Note: Must be written in XML form. See the code below:

Alternative: SOAP implementation (deprecated)
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'
>Information<
  1. >Some Information</test>",
        
Expand
  1. ...
    
    

    1. results in


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


  2. 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

title
    1. Code Block
      languagexml
      themeEclipse
<AdditionalClientWorkstepInformation><test id="test">Information<test><
    1. <AdditionalClientWorkstepInformation>
          <signature>
              <Tagging doctype="INVOICE">
                  <InvoiceNr>123456</InvoiceNr>
              </Tagging>
          </signature>
      </AdditionalClientWorkstepInformation>



Viewer preferences

Following lines of code show some viewer preferences configurations:

...