SOAP API method WebDocumentLoopBlock_parent

Back to API references

Description
This is either a loop block (for nested blocks) or the document.

Parameters
Parameter 'id' : string
Unique identifier (id) of the object WebDocumentLoopBlock. The method only applies to the webdocumentloopblock with this id.
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'emailingdocumentloopblock' : Structure of type 'emailingdocumentloopblock'
Return value 'webdocumentloopblock' : Structure of type 'webdocumentloopblock'
Return value 'emailingdocument' : Structure of type 'emailingdocument'
Return value 'webdocument' : Structure of type 'webdocument'

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt

Structure 'emailingdocumentloopblock'
This structure emailingdocumentloopblock was mentioned above. This structure has the following properties:
Property 'iterations' : int
The number of iterations of the loopblock.
Property 'id' : string
The ID of the block.
Property 'name' : string
The name of the block.
Property 'iteration' : int
The iteration of the parent block.
Property 'condition' : string
Get the javascript condition used to determine if the block is shown in the document

Structure 'webdocumentloopblock'
This structure webdocumentloopblock was mentioned above. This structure has the following properties:
Property 'iterations' : int
The number of iterations of the loopblock.
Property 'id' : string
The ID of the block.
Property 'name' : string
The name of the block.
Property 'iteration' : int
The iteration of the parent block.
Property 'condition' : string
Get the javascript condition used to determine if the block is shown in the document

Structure 'emailingdocument'
This structure emailingdocument was mentioned above. This structure has the following properties:
Property 'convertedid' : int
The converted ID.
Property 'headers' : string
The additional headers.
Property 'subject' : string
The subject of the emailingdocument.
Property 'fromaddress' : EmailAddress
The fromaddress of the emailingdocument.
Property 'fromaddressstatus' : string
Get the status of the from address. When a from address is okay to do
Property 'bccaddress' : EmailAddress
The bccaddress of this emailingdocument.
Property 'replytoaddress' : EmailAddress
The reply-to address of the emailingdocument.
Property 'textversion' : string
The textversion of the emailingdocument.
Property 'useinlinestyles' : string
Should stylesheets in the document be merged into inline styles? This is usefull
Property 'temporary' : boolean
Is this document set as a temporary document. The document will be removed when there are no
Property 'priority_indicator' : string
Getting the priority header for emails who use this document
Property 'unsubscribe_header' : string
Should the list-unsubscribe header be sent with the mailing.
Property 'charset' : string
Gets the charset that should be used when showing/sending this document
Property 'htmlEscaping' : string
Check if the document is escaping HTML code
Property 'smartyVersion' : integer
What smarty version is used to render this document
Property 'id' : int
The ID of the document.
Property 'templateID' : int
The template ID of the document
Property 'name' : string
The name of the document.
Property 'description' : string
The description of the document.
Property 'archived' : boolean
Is this an archived document?.
Property 'created' : timestamp
The date and time when the document was created.
Property 'modified' : timestamp
The date and time when the document was last modified.
Property 'language' : string
The language of the document.
Property 'timezone' : string
Get the time zone of the document. If the timezone is not set, it returns

Structure 'webdocument'
This structure webdocument was mentioned above. This structure has the following properties:
Property 'loginrequired' : boolean
The page is only available for logged in profiles or subprofiles.
Property 'enabled' : boolean
Page enabled.
Property 'charset' : string
Gets the charset that should be used when showing/sending this document
Property 'htmlEscaping' : string
Check if the document is escaping HTML code
Property 'smartyVersion' : integer
What smarty version is used to render this document
Property 'id' : int
The ID of the document.
Property 'templateID' : int
The template ID of the document
Property 'name' : string
The name of the document.
Property 'description' : string
The description of the document.
Property 'archived' : boolean
Is this an archived document?.
Property 'created' : timestamp
The date and time when the document was created.
Property 'modified' : timestamp
The date and time when the document was last modified.
Property 'language' : string
The language of the document.
Property 'timezone' : string
Get the time zone of the document. If the timezone is not set, it returns