Follow

ListEnvelopeTemplates

Last updated 2017-08-15 19:40:02 UTC

Code Sample in C#

The ListEnvelopeTemplates operation makes it possible to provide a menu or list of available envelope templates available for integration to the AssureSign user who is querying. In this way, it will not be necessary to have knowledge of the AssureSign envelope template ID in order to pre-configure an envelope to make use of envelope notifications defined in an envelope template. The ListEnvelopeTemplates operation will return a list of envelope template IDs (and descriptions) from which an appropriate envelope template ID can be selected and used to automate the creation of envelope notifications when creating a new envelope using an envelope creation operation.

It is also possible to enter information into a Tag field when creating envelope templates for integration purposes from within the AssureSign administrative application; the value of the Tag on a particular envelope template will be returned and could possibly be used to help create a mapping or filtering mechanism in a CRM or custom client application.

The ListEnvelopeTemplates operation requires knowledge of the following:

  • The AssureSign account ContextIdentifier (this is exposed in the AssureSign administrative application account settings and serves to provide some security to the transaction)
  • the UserName of the AssureSign user that will be the owner of the new document envelope within AssureSign

Sample XML

<?xml version="1.0" encoding="utf-8"?> 
<ListEnvelopeTemplates xmlns="https://www.assuresign.net/Services/DocumentNOW/Envelopes"> 
    <ListEnvelopeTemplatesRequest ContextIdentifier="06C4A84A-693C-46CB-8DF2-40A8215AA056" UserName="georgeuser@company.com" /> 
</ListEnvelopeTemplates>

The SOAP Action header is

https://www.assuresign.net/Services/DocumentNOW/Envelopes/IEnvelopeService/ListEnvelopeTemplates

The result returned will contain information about each envelope template that can be used when selecting an appropriate envelope template to use with a call to an envelope creation operation:

<?xml version="1.0" encoding="utf-8"?> 
<ListEnvelopeTemplatesResponse xmlns="https://www.assuresign.net/Services/DocumentNOW/Envelopes"> 
    <ListEnvelopeTemplatesResult> 
        <Templates> 
            <EnvelopeTemplate EnvelopeTemplateId="19c1a800-42e8-df11-9b14-0022195a8cb4" Name="Envelope Template 1" Description="Description for Envelope Template 1." Tag="Tag 1" CreatedDate="2011-10-14T20:23:40.3684104Z" ModifiedDate="2011-11-18T20:23:40.3684104Z" /> 
            <EnvelopeTemplate EnvelopeTemplateId="28b1a800-42e8-df11-9b14-0022195a8cb4" Name="Envelope Template 2" Description="Description for Envelope Template 2." Tag="Tag 2" CreatedDate="2011-10-31T20:23:40.3684104Z" ModifiedDate="2011-11-11T20:23:40.3684104Z" /> 
            <EnvelopeTemplate EnvelopeTemplateId="37a1a800-42e8-df11-9b14-0022195a8cb4" Name="Envelope Template 3" Description="Description for Envelope Template 3." Tag="Tag 3" CreatedDate="2011-11-26T20:23:40.3684104Z" ModifiedDate="2011-12-03T20:23:40.3684104Z" /> 
        </Templates> 
    </ListEnvelopeTemplatesResult> 
</ListEnvelopeTemplatesResponse>

The ListEnvelopeTemplatesResult should be checked for the presence of an Exceptions element, which may contain multiple EnvelopeException items.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.