SOAP API method WebDocumentImageBlock_option

Back to API references

Description
If the the parameter is an integer, the option with that id is returned. If the options is one of the other allowed types, then the condition for each option is evaluated and the first one that matches is returned.

Parameters
Parameter 'id' : string
Unique identifier (id) of the object WebDocumentImageBlock. The method only applies to the webdocumentimageblock with this id.
Parameter 'x' : integer
Parameter 'subprofile' : Structure of type 'subprofile'
Parameter 'profile' : Structure of type 'profile'
Parameter 'faxmailingdestination' : Structure of type 'faxmailingdestination'
Parameter 'emailingdestination' : Structure of type 'emailingdestination'
Parameter 'smsmailingdestination' : Structure of type 'smsmailingdestination'
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'emailingdocumentimageblockoption' : Structure of type 'emailingdocumentimageblockoption'
Return value 'webdocumentimageblockoption' : Structure of type 'webdocumentimageblockoption'

Structure 'subprofile'
This structure subprofile was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the subprofile.
Property 'code' : string
The code of the subprofile.
Property 'created' : timestamp
The timestamp when the subprofile was created.
Property 'modified' : timestamp
The timestamp when the subprofile was last modified.
Property 'lastexport' : timestamp
The last timestamp when the subprofile was exported.
Property 'fields' : Map
Map of all fields of the subprofile, this property is only returned when the parameter 'allproperties' is set to true

Structure 'profile'
This structure profile was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the profile.
Property 'code' : string
The code of the profile.
Property 'extra' : string
The extra data of the profile.
Property 'created' : timestamp
The timestamp when the profile was created.
Property 'modified' : timestamp
The timestamp when the profile was last modified.
Property 'lastexport' : timestamp
The last timestamp when the profile was exported.
Property 'fields' : Map
Map of all fields of the profile, this property is only returned when the parameter 'allproperties' is set to true
Property 'interests' : Map
Map of all interests of the profile, this property is only returned when the parameter 'allproperties' is set to true

Structure 'faxmailingdestination'
This structure faxmailingdestination was mentioned above. This structure has the following properties:
Property 'id' : string
The ID of the destination.
Property 'timestamp' : timestamp
The timestamp of the sent mailing.
Property 'result' : string
The result for this destination.

Structure 'emailingdestination'
This structure emailingdestination was mentioned above. This structure has the following properties:
Property 'emailclient' : string
Get the last registered email client for this destination
Property 'id' : string
The ID of the destination.
Property 'timestamp' : timestamp
The timestamp of the sent mailing.
Property 'result' : string
The result for this destination.

Structure 'smsmailingdestination'
This structure smsmailingdestination was mentioned above. This structure has the following properties:
Property 'id' : string
The ID of the destination.
Property 'timestamp' : timestamp
The timestamp of the sent mailing.
Property 'result' : string
The result for this destination.

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 'emailingdocumentimageblockoption'
This structure emailingdocumentimageblockoption was mentioned above. This structure has the following properties:
Property 'url' : string
The url of the imageblock.
Property 'style_class' : string
The style class for styling the imageblock
Property 'target' : string
The target for the link. This is only used when the image is also
Property 'title' : string
The title of the image in the block
Property 'alternative' : string
The alternative when the image can't be displayed
Property 'id' : int
The ID of the image.
Property 'name' : string
The filename of the image.
Property 'extension' : string
The extension of this image.
Property 'width' : int
The width of the image.
Property 'height' : int
The height of the image.
Property 'hashcode' : string
Expose the data hashcode
Property 'data' : binary
The data of the image. The data is base64 encoded.
Property 'mimetype' : string
The mime type of the image.
Property 'thumbwidth' : int
The width of the thumbnail of the image.
Property 'thumbheight' : int
The height of the thumbnail of the image.
Property 'thumbdata' : binary
The data of the thumnail of the image. The data is base64 encoded.

Structure 'webdocumentimageblockoption'
This structure webdocumentimageblockoption was mentioned above. This structure has the following properties:
Property 'url' : string
The url of the imageblock.
Property 'style_class' : string
The style class for styling the imageblock
Property 'target' : string
The target for the link. This is only used when the image is also
Property 'title' : string
The title of the image in the block
Property 'alternative' : string
The alternative when the image can't be displayed
Property 'id' : int
The ID of the image.
Property 'name' : string
The filename of the image.
Property 'extension' : string
The extension of this image.
Property 'width' : int
The width of the image.
Property 'height' : int
The height of the image.
Property 'hashcode' : string
Expose the data hashcode
Property 'data' : binary
The data of the image. The data is base64 encoded.
Property 'mimetype' : string
The mime type of the image.
Property 'thumbwidth' : int
The width of the thumbnail of the image.
Property 'thumbheight' : int
The height of the thumbnail of the image.
Property 'thumbdata' : binary
The data of the thumnail of the image. The data is base64 encoded.