SOAP API method WebDocumentTextBlock_parent
Description
This is either a loop block (for nested blocks) or the document.
Parameters
| Name | Type | Description |
|---|---|---|
| id * | string | Unique identifier (id) of the object WebDocumentTextBlock. The method only applies to the webdocumenttextblock with this id. |
| login | Structure of type 'login' | Optional login data (soon deprecated) |
| access_token | string | Optional api access token |
| * required parameters | ||
Return values
| Name | Type | Description |
|---|---|---|
| emailingdocumentloopblock | Structure of type 'emailingdocumentloopblock' | |
| webdocumentloopblock | Structure of type 'webdocumentloopblock' | |
| emailingdocument | Structure of type 'emailingdocument' | |
| webdocument | Structure of type 'webdocument' |
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 'emailingdocumentloopblock'
| Name | Type | Description |
|---|---|---|
| iterations | int | The number of iterations of the loopblock. |
| id | string | The ID of the block. |
| name | string | The name of the block. |
| iteration | int | The iteration of the parent block. |
| condition | string | Get the javascript condition used to determine if the block is shown in the document |
Structure 'webdocumentloopblock'
| Name | Type | Description |
|---|---|---|
| iterations | int | The number of iterations of the loopblock. |
| id | string | The ID of the block. |
| name | string | The name of the block. |
| iteration | int | The iteration of the parent block. |
| condition | string | Get the javascript condition used to determine if the block is shown in the document |
Structure 'emailingdocument'
| Name | Type | Description |
|---|---|---|
| convertedid | int | The converted ID. |
| headers | string | The additional headers. |
| subject | string | The subject of the emailingdocument. |
| fromaddress | EmailAddress | The fromaddress of the emailingdocument. |
| fromaddressstatus | string | Get the status of the from address. When a from address is okay to do |
| bccaddress | EmailAddress | The bccaddress of this emailingdocument. |
| replytoaddress | EmailAddress | The reply-to address of the emailingdocument. |
| textversion | string | The textversion of the emailingdocument. |
| useinlinestyles | string | Should stylesheets in the document be merged into inline styles? This is usefull |
| temporary | boolean | Is this document set as a temporary document. The document will be removed when there are no |
| priority_indicator | string | Getting the priority header for emails who use this document |
| unsubscribe_header | string | Should the list-unsubscribe header be sent with the mailing. |
| size | int | Get the size of the document. |
| charset | string | Gets the charset that should be used when showing/sending this document |
| htmlEscaping | string | Check if the document is escaping HTML code |
| smartyVersion | integer | What smarty version is used to render this document |
| id | int | The ID of the document. |
| templateID | int | The template ID of the document |
| name | string | The name of the document. |
| description | string | The description of the document. |
| archived | boolean | Is this an archived document?. |
| created | timestamp | The date and time when the document was created. |
| modified | timestamp | The date and time when the document was last modified. |
| language | string | The language of the document. |
| timezone | string | Get the time zone of the document. If the timezone is not set, it returns |
Structure 'webdocument'
| Name | Type | Description |
|---|---|---|
| loginrequired | boolean | The page is only available for logged in profiles or subprofiles. |
| enabled | boolean | Page enabled. |
| charset | string | Gets the charset that should be used when showing/sending this document |
| htmlEscaping | string | Check if the document is escaping HTML code |
| smartyVersion | integer | What smarty version is used to render this document |
| id | int | The ID of the document. |
| templateID | int | The template ID of the document |
| name | string | The name of the document. |
| description | string | The description of the document. |
| archived | boolean | Is this an archived document?. |
| created | timestamp | The date and time when the document was created. |
| modified | timestamp | The date and time when the document was last modified. |
| language | string | The language of the document. |
| timezone | string | Get the time zone of the document. If the timezone is not set, it returns |