SOAP API method PdfDocument_template
Description
The template on which the document is based. This method will retrun an EmailingTemplate, WebTemplate or PdfTemplate.
Parameters
Name | Type | Description |
---|---|---|
id * | int | Unique identifier (id) of the object PdfDocument. The method only applies to the pdfdocument with this id. |
personalize_profile | int | Profile ID for which the object should be personalized |
personalize_subprofile | int | Subprofile ID for which the object should be personalized |
personalize_timestamp | string | The timestamp for the personalization |
login | Structure of type 'login' | Optional login data (soon deprecated) |
access_token | string | Optional api access token |
* required parameters |
Return values
Name | Type | Description |
---|---|---|
pdftemplate | Structure of type 'pdftemplate' | |
webtemplate | Structure of type 'webtemplate' | |
emailingtemplate | Structure of type 'emailingtemplate' |
Structure 'login'
Name | Type | Description |
---|---|---|
username | string | The username of the login attempt |
account | string | The account name of the login attempt |
password | string | The password for the login attempt |
Structure 'pdftemplate'
Name | Type | Description |
---|---|---|
hashcode | string | Hashcode of the template |
source | binary | The source of the template. The data is base64 encoded. |
pagecount | int | The number of pages of the template. |
size | int | The size of the template. |
id | int | The ID of the template. |
name | string | The name of the template. |
description | string | The description of the template. |
archived | boolean | The template is archived. |
created | timestamp | When the template was created. |
modified | timestamp | When the template was last modified. |
language | string | The language of the template. |
timezone | string | Get the timezone of the template |
Structure 'webtemplate'
Name | Type | Description |
---|---|---|
charset | string | The charset of the htmltemplate. |
htmlEscaping | string | Check if the template is escaping HTML code |
smartyVersion | integer | What smarty version is used to render this template |
upgradeSmartyVersion | integer | Upgrade smartyversion 2 to 3 |
id | int | The ID of the template. |
name | string | The name of the template. |
description | string | The description of the template. |
archived | boolean | The template is archived. |
created | timestamp | When the template was created. |
modified | timestamp | When the template was last modified. |
language | string | The language of the template. |
timezone | string | Get the timezone of the template |
Structure 'emailingtemplate'
Name | Type | Description |
---|---|---|
convertedid | int | The converted ID of the emailingtemplate. |
headers | string | The additional headers of the emailingtemplate. |
textversion | string | The textversion of the template. |
useinlinestyles | string | Should stylesheets in document based on the template be merged into inline |
priority_indicator | string | Getting the priority header for emails who use this template |
unsubscribe_header | string | Should the list-unsubscribe header be sent with the mailing. |
fromaddress | EmailAddress | The fromaddress of the emailingtemplate. |
bccaddress | EmailAddress | The default bcc address of this emailing template. |
replytoaddress | EmailAddress | The default reply-to address of the emailing template. |
charset | string | The charset of the htmltemplate. |
htmlEscaping | string | Check if the template is escaping HTML code |
smartyVersion | integer | What smarty version is used to render this template |
upgradeSmartyVersion | integer | Upgrade smartyversion 2 to 3 |
id | int | The ID of the template. |
name | string | The name of the template. |
description | string | The description of the template. |
archived | boolean | The template is archived. |
created | timestamp | When the template was created. |
modified | timestamp | When the template was last modified. |
language | string | The language of the template. |
timezone | string | Get the timezone of the template |