RequestTemplate

Retrieves a specific template from the server. This method returns EnvelopeTemplate upon execution completion.

Schema

// Request all the templates as shown in linked code
DocuSignWeb.EnvelopeTemplateDefinition[] response = <templates request>;
// Request information about each template definition
foreach (DocuSignWeb.EnvelopeTemplateDefinition def in response)
{
    Console.WriteLine("Retrieved template definition with ID {0}", def.TemplateID);
    // Request the template specified by the template ID
    DocuSignWeb.EnvelopeTemplate template = _apiClient.RequestTemplate(def.TemplateID,
        false);
    // Display information about the returned template
    Console.WriteLine("\tRetrieved template with name \"{0}\" and with {1} pages",
        template.EnvelopeTemplateDefinition.Name,
        template.EnvelopeTemplateDefinition.PageCount);
}

Name	Schema Type	Description
TemplateId	DSXId	Template ID to return.
IncludeDocumentBytes	Boolean	If true, include the document bytes of the template within the Envelope object returned.

EnvelopeTemplate

Name	Schema Type	Description
EnvelopeTemplateDefinition	EnvelopeTemplateDefinition	Defines the attributes of a template. See the EnvelopeTemplateDefinition section for more information.
Envelope	Envelope	Template is contained within an Envelope object defined in the CreateEnvelope section.

MatchBox

Name	Schema Type	Description
PageNumber	Integer	Page to put the matchbox on.
XPosition	Integer	X position of the matchbox.
YPosition	Integer	Y position of the matchbox.
Width	Integer	Width of the matchbox.
Height	Integer	Height of the matchbox.

Matchboxes can be supplied with the document structure within the Envelope. They are used in the matching process when documents are uploaded for creating templates.

EnvelopeTemplateDefinition

Name	Schema Type	Description
TemplateID	DSXId	Unique identifier of the template.
Name	String	Name of the template.
Shared	Boolean	If true, the template is shared with the Everyone group in the account. If false, the template is only shared with the Administrator group.
TemplatePassword	String	Password if the template is locked. Note: This will only be returned if the requesting user is the creator of the template.
TemplateDescription	String	Description of the template.
LastModified	DateTime	Last time the template was modified.
PageCount	Integer	Number of pages in document of the template.

Rules and exceptions for RequestTemplate

Account_Lacks_Permissions – account does not have permissions to use this API.
User_Lacks_Permissions – user does not have permissions to use this API.
Template_Unable_To_Load – template ID provided was invalid.