SOAP API method WebDocumentImageBlockOption_setImage

Description

Set the image this imageblock option.

Parameters

Name	Type	Description
id *	int	Unique identifier (id) of the object WebDocumentImageBlockOption. The method only applies to the webdocumentimageblockoption with this id.
filedata	Structure of type 'filedata'
image	Structure of type 'image'
linkedimage	Structure of type 'linkedimage'
emailingdocumentsnapshotimage	Structure of type 'emailingdocumentsnapshotimage'
emailingdocumentimageblockoption	Structure of type 'emailingdocumentimageblockoption'
webdocumentimageblockoption	Structure of type 'webdocumentimageblockoption'
xsltimage	Structure of type 'xsltimage'
medialibraryimage	Structure of type 'medialibraryimage'
webtemplateimage	Structure of type 'webtemplateimage'
emailingtemplateimage	Structure of type 'emailingtemplateimage'
webdocumentimage	Structure of type 'webdocumentimage'
emailingdocumentimage	Structure of type 'emailingdocumentimage'
surveyimage	Structure of type 'surveyimage'
litmustestresultimage	Structure of type 'litmustestresultimage'
stylesnapshotimage	Structure of type 'stylesnapshotimage'
styleimage	Structure of type 'styleimage'
login	Structure of type 'login'	Optional login data (soon deprecated)
access_token	string	Optional api access token
* required parameters

Structure 'filedata'

Name	Type	Description
name	string	The name of the data of the file.
mimetype	string	The mimetype of the data of the file.
data	binary	The data of the file. The data is base64 encoded.

Structure 'image'

Name	Type	Description
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

Structure 'linkedimage'

Name	Type	Description
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

Structure 'emailingdocumentsnapshotimage'

Name	Type	Description
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

Structure 'emailingdocumentimageblockoption'

Name	Type	Description
url	string	The url of the imageblock.
style_class	string	The style class for styling the imageblock
target	string	The target for the link. This is only used when the image is also
title	string	The title of the image in the block
alternative	string	The alternative when the image can't be displayed
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

Structure 'webdocumentimageblockoption'

Name	Type	Description
url	string	The url of the imageblock.
style_class	string	The style class for styling the imageblock
target	string	The target for the link. This is only used when the image is also
title	string	The title of the image in the block
alternative	string	The alternative when the image can't be displayed
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

Structure 'xsltimage'

Name	Type	Description
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

Structure 'medialibraryimage'

Name	Type	Description
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

Structure 'webtemplateimage'

Name	Type	Description
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

Structure 'emailingtemplateimage'

Name	Type	Description
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

Structure 'webdocumentimage'

Name	Type	Description
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

Structure 'emailingdocumentimage'

Name	Type	Description
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

Structure 'surveyimage'

Name	Type	Description
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

Structure 'litmustestresultimage'

Name	Type	Description
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

Structure 'stylesnapshotimage'

Name	Type	Description
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

Structure 'styleimage'

Name	Type	Description
id	int	The ID of the image.
name	string	The filename of the image.
extension	string	The extension of this image.
width	int	The width of the image.
height	int	The height of the image.
size	int	The size of the image.
hashcode	string	Expose the data hashcode
data	binary	The data of the image. The data is base64 encoded.
mimetype	string	The mime type of the image.
thumbwidth	int	The width of the thumbnail of the image.
thumbheight	int	The height of the thumbnail of the image.
thumbdata	binary	The data of the thumbnail of the image. The data is base64 encoded.

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