SOAP API methode WebDocumentImageBlock_option

Terug naar de indexpagina

Beschrijving
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 'smsmailingdestination' : Structure of type 'smsmailingdestination'
Parameter 'faxmailingdestination' : Structure of type 'faxmailingdestination'
Parameter 'emailingdestination' : Structure of type 'emailingdestination'
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'

Structuur 'subprofile'
De structuur 'subprofile' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'id' : int
The ID of the subprofile.
Eigenschap 'code' : string
The code of the subprofile.
Eigenschap 'created' : timestamp
The timestamp when the subprofile was created.
Eigenschap 'modified' : timestamp
The timestamp when the subprofile was last modified.
Eigenschap 'lastexport' : timestamp
The last timestamp when the subprofile was exported.
Eigenschap 'fields' : Map
Map of all fields of the subprofile, this property is only returned when the parameter 'allproperties' is set to true

Structuur 'profile'
De structuur 'profile' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'id' : int
The ID of the profile.
Eigenschap 'code' : string
The code of the profile.
Eigenschap 'extra' : string
The extra data of the profile.
Eigenschap 'created' : timestamp
The timestamp when the profile was created.
Eigenschap 'modified' : timestamp
The timestamp when the profile was last modified.
Eigenschap 'lastexport' : timestamp
The last timestamp when the profile was exported.
Eigenschap 'fields' : Map
Map of all fields of the profile, this property is only returned when the parameter 'allproperties' is set to true
Eigenschap 'interests' : Map
Map of all interests of the profile, this property is only returned when the parameter 'allproperties' is set to true

Structuur 'smsmailingdestination'
De structuur 'smsmailingdestination' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'id' : string
The ID of the destination.
Eigenschap 'timestamp' : timestamp
The timestamp of the sent mailing.
Eigenschap 'result' : string
The result for this destination.

Structuur 'faxmailingdestination'
De structuur 'faxmailingdestination' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'id' : string
The ID of the destination.
Eigenschap 'timestamp' : timestamp
The timestamp of the sent mailing.
Eigenschap 'result' : string
The result for this destination.

Structuur 'emailingdestination'
De structuur 'emailingdestination' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'emailclient' : string
Get the last registered email client for this destination
Eigenschap 'id' : string
The ID of the destination.
Eigenschap 'timestamp' : timestamp
The timestamp of the sent mailing.
Eigenschap 'result' : string
The result for this destination.

Structuur 'login'
De structuur 'login' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'username' : string
The username of the login attempt
Eigenschap 'account' : string
The account name of the login attempt
Eigenschap 'password' : string
The password for the login attempt

Structuur 'emailingdocumentimageblockoption'
De structuur 'emailingdocumentimageblockoption' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'url' : string
The url of the imageblock.
Eigenschap 'style_class' : string
The style class for styling the imageblock
Eigenschap 'target' : string
The target for the link. This is only used when the image is also
Eigenschap 'title' : string
The title of the image in the block
Eigenschap 'alternative' : string
The alternative when the image can't be displayed
Eigenschap 'id' : int
The ID of the image.
Eigenschap 'name' : string
The filename of the image.
Eigenschap 'extension' : string
The extension of this image.
Eigenschap 'width' : int
The width of the image.
Eigenschap 'height' : int
The height of the image.
Eigenschap 'hashcode' : string
Expose the data hashcode
Eigenschap 'data' : binary
The data of the image. The data is base64 encoded.
Eigenschap 'mimetype' : string
The mime type of the image.
Eigenschap 'thumbwidth' : int
The width of the thumbnail of the image.
Eigenschap 'thumbheight' : int
The height of the thumbnail of the image.
Eigenschap 'thumbdata' : binary
The data of the thumbnail of the image. The data is base64 encoded.

Structuur 'webdocumentimageblockoption'
De structuur 'webdocumentimageblockoption' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'url' : string
The url of the imageblock.
Eigenschap 'style_class' : string
The style class for styling the imageblock
Eigenschap 'target' : string
The target for the link. This is only used when the image is also
Eigenschap 'title' : string
The title of the image in the block
Eigenschap 'alternative' : string
The alternative when the image can't be displayed
Eigenschap 'id' : int
The ID of the image.
Eigenschap 'name' : string
The filename of the image.
Eigenschap 'extension' : string
The extension of this image.
Eigenschap 'width' : int
The width of the image.
Eigenschap 'height' : int
The height of the image.
Eigenschap 'hashcode' : string
Expose the data hashcode
Eigenschap 'data' : binary
The data of the image. The data is base64 encoded.
Eigenschap 'mimetype' : string
The mime type of the image.
Eigenschap 'thumbwidth' : int
The width of the thumbnail of the image.
Eigenschap 'thumbheight' : int
The height of the thumbnail of the image.
Eigenschap 'thumbdata' : binary
The data of the thumbnail of the image. The data is base64 encoded.