SOAP API method EmailingDocument_block

Back to API references

Description
A single block of the document.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object EmailingDocument. The method only applies to the emailingdocument with this id.
Parameter 'personalize_profile' : int
Profile ID for which the object should be personalized
Parameter 'personalize_subprofile' : int
Subprofile ID for which the object should be personalized
Parameter 'personalize_timestamp' : string
The timestamp for the personalization
Parameter 'identifier' : string
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'webdocumentimageblock' : Structure of type 'webdocumentimageblock'
Return value 'emailingdocumentimageblock' : Structure of type 'emailingdocumentimageblock'
Return value 'emailingdocumentloopblock' : Structure of type 'emailingdocumentloopblock'
Return value 'webdocumentloopblock' : Structure of type 'webdocumentloopblock'
Return value 'webdocumenttextblock' : Structure of type 'webdocumenttextblock'
Return value 'emailingdocumenttextblock' : Structure of type 'emailingdocumenttextblock'

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 'webdocumentimageblock'
This structure webdocumentimageblock was mentioned above. This structure has the following properties:
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 'emailingdocumentimageblock'
This structure emailingdocumentimageblock was mentioned above. This structure has the following properties:
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 '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 'webdocumenttextblock'
This structure webdocumenttextblock was mentioned above. This structure has the following properties:
Property 'content' : string
The content of this textblock.
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 'emailingdocumenttextblock'
This structure emailingdocumenttextblock was mentioned above. This structure has the following properties:
Property 'content' : string
The content of this textblock.
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