TemplateReferences contains an unbounded array of TemplateReference objects, each a self-contained structure used to satisfy the business rules of a given template, which will be merged into the parent Envelope.
Schema
| Name | Schema Type | Description |
|---|---|---|
| TemplateLocation | TemplateLocation | Enumerated list of options that describe where the Template information resides. Available options include: SOAP (default), PDFMetaData and Server. |
| Template | String | This element will contain different values, depending on the value of TemplateLocation:\n\n“Server”: Template is the TemplateID of the template created in the web console. - “SOAP”: Template will include the Template XML in the format created by Docusign Professional. - “PDFMetaData”: Template can be left blank. It will be disregarded if provided. In this scenario, the Template xml is contained within the xml portion of the PDF document. In either case, the Document pdfBytes can be removed from the Template xml to optimize the payload size. |
| Documents | Document | Refer to Document earlier in this document for details. |
| RoleAssignments | RoleAssignment | Specifies the RoleAssignments that are included in this call. - RoleName – LongString - The name of the Role in the Template to which this Recipient information will be assigned - RecipientID – positiveInteger - The Recipient identifier from the Recipients object that will fulfill this Role. It must be a positive integer and cannot be 0 (zero). |
| FieldData | FieldData | Provides the rules and/or data values that are used with the Template fields. See the FieldData section for more information. |
| AdditionalTabs | Tab | Specifies any Tabs that should be added to a Document.AdditionalTabs enable the request to apply additional Tabs that are not configured in the Template. This would allow for run-time information to be specified as well as the template definitions that are specified at design-time. This could be used with an “open” Template that lacks preconsidered configuration in order to include ad hoc documents to the Envelope. See the Tab section for more information. |
| Sequence | NonNegativeInteger | Specifies the order that the Document(s) included in the Template should be presented in the Envelope. If not provided, the Documents will be presented in the order of the TemplateReferences. |
| TemplateAttachments | Attachment | A mechanism to provide the Document object through a SOAP attachment. |