Follow

RetrieveTemplateInfo

Last updated 2017-04-27 15:17:43 UTC

RetrieveTemplateInfo returns a combination of the template metadata, the parameters, the signatories, and the pre-defined JotBlock definitions on a specific template. The template metadata is separately available for all available templates through accessing the TemplateItem element returned in a ListTemplates method call, and the parameters may be separately retrieved for a specific template within the Parameters collection via a ListParameters call.

A typical reason for using the RetrieveTemplateInfo method would be the need to override properties of pre-defined JotBlocks through the use of dynamic JotBlocks. Pre-defined JotBlocks of a template are returned within a JotBlockItems collection from a call to RetrieveTemplateInfo.

The RetrieveTemplateInfo 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 document within AssureSign
  • the Template ID of the Template to query

Sample XML

<?xml version="1.0" encoding="utf-8"?> 
<RetrieveTemplateInfo xmlns="https://www.assuresign.net/Services/DocumentNOW/RetrieveTemplateInfo"> 
    <TemplateInfoQuery ContextIdentifier="06C4A84A-693C-46CB-8DF2-40A8215AA056" UserName="georgeuser@company.com" TemplateId="DCB79445-4D39-DD11-8735-00065B8CE99B" /> 
</RetrieveTemplateInfo>

The SOAP Action header is

https://www.assuresign.net/Services/DocumentNOW/RetrieveTemplateInfo/IRetrieveTemplateInfoService/RetrieveTemplateInfo

The result returned will include a detailed list of all JotBlocks, signer attachments, parameters and metadata for the template:

<?xml version="1.0" encoding="utf-8"?> 
<RetrieveTemplateInfoResponse xmlns="https://www.assuresign.net/Services/DocumentNOW/RetrieveTemplateInfo"> 
    <TemplateInfoQueryResult TemplateId="DCB79445-4D39-DD11-8735-00065B8CE99B"> 
        <TemplateInfo> 
            <TemplateMetadata Id="DCB79445-4D39-DD11-8735-00065B8CE99B" Name="Sample" Tag="Documents Tag" Description="Sample" CreationDate="2010-01-08T15:46:03.6566705-05:00" Accessibility="User" Owner="Joe" ImmediatePresentment="true" PasswordRequired="false" DocumentTemplateType="Standard" Culture="en-US" SignatureDeviceSupportEnabled="false" ModifiedDate="2010-02-13T08:43:11.0124923-04:00" PageCount="0"/> 
            <JotBlocks> 
                <JotBlockInfo SigningStep="1" SigningOrder="1" FieldType="Typed" InputType="Signatory" Height="0.08259587" Width="0.23282443" PositionX="0.4351145" PositionY="0.4351145" Page="1" Name="JotBlock 1" Instructions="Please Sign Below" Border="All" InkColor="0" TypedData="" ParameterName="" FontName="" FontSize="0" FontBold="false" FontItalic="false" FontUnderline="false" HorizontalAlignment="Left" VerticalAlignment="Bottom" WordWrap="false" TypedFieldSignatoryInputType="FreeText" Signatory="Signatory 1" /> 
            </JotBlocks>
            <SignerAttachments>
                <SignerAttachment Label="Photo ID" Instructions="Please upload your drivers license" Signatory="Signatory 1" SigningStep="1" Required="true" AllowMultiple="false" />
            </SignerAttachments>
            <Parameters> 
                <TypedParameterInfo Name="Customer Full Name" Prompt="Please enter the full name of the customer" Tag="CustomerFullName" Required="true" DefaultValue="Default Value" Regex="^([a-zA-Z'-]+\s+){1,4}[a-zA-z'-]+$" ValidationMessage="The name you entered does not appear to be in a valid form" SystemName="Signatory 1 Full Name" /> 
                <TypedParameterInfo Name="Customer Email Address" Prompt="Please enter the email address of the customer" Tag="CustomerEmailAddress" Regex="^[_a-zA-Z0-9-]+(\.[_a-zA-Z0-9-]+)*@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*\*(([0-9]{1,3})|([a-ZA-Z]{2,3})|(aero|coop|info|museum|name))$" ValidationMessage="The email address you entered does not appear to be in a valid form" SystemName="Signatory 1 Email Address" /> 
                <TypedParameterInfo Name="Customer Password" Prompt="Please enter a password for the customer." Tag="CustomerPassword" SystemName="Signatory 1 Password" /> 
                <TypedParameterInfo Name="Other Parameter" Prompt="Write your own prompt in the AssureSign template designer for Parameter 2" Tag="Parameter2Tag" Required="false" /> 
            </Parameters> 
            <Signatories> 
                <SignatoryInfo Signatory="Signatory 1" FullNameParameterName="Customer Full Name" EmailAddressParameterName="Customer Email Address" PasswordParameterName="Customer Password" /> 
            </Signatories>
            <TermsAndConditions> 
                <AdditionalComplianceStatement>
                Terms Sample Text
                </AdditionalComplianceStatement> 
                <AdditionalAgreementStatement>
                Agreement Sample Text
                </AdditionalAgreementStatement>
                <AdditionalExtendedDisclosures>
                Disclosure Sample Text
                </AdditionalExtendedDisclosures> 
            </TermsAndConditions> 
        </TemplateInfo> 
    </TemplateInfoQueryResult> 
</RetrieveTemplateInfoResponse>

See specific element descriptions:

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

Note: if the DocumentTemplateType attribute is “WorkflowOnly” rather than “Standard” then the template does not contain any pre-defined JotBlocks; this type of template requires passing in dynamic JotBlocks on any document submission operation.

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

0 Comments

Article is closed for comments.