SOAP API method WebDocumentImageBlockOption_setImage

Back to API references

Description
Set the image this imageblock option.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object WebDocumentImageBlockOption. The method only applies to the webdocumentimageblockoption with this id.
Parameter 'filedata' : Structure of type 'filedata'
Parameter 'image' : Structure of type 'image'
Parameter 'linkedimage' : Structure of type 'linkedimage'
Parameter 'medialibraryimage' : Structure of type 'medialibraryimage'
Parameter 'surveyimage' : Structure of type 'surveyimage'
Parameter 'stylesnapshotimage' : Structure of type 'stylesnapshotimage'
Parameter 'webtemplateimage' : Structure of type 'webtemplateimage'
Parameter 'emailingtemplateimage' : Structure of type 'emailingtemplateimage'
Parameter 'webdocumentimage' : Structure of type 'webdocumentimage'
Parameter 'emailingdocumentimage' : Structure of type 'emailingdocumentimage'
Parameter 'emailingdocumentimageblockoption' : Structure of type 'emailingdocumentimageblockoption'
Parameter 'webdocumentimageblockoption' : Structure of type 'webdocumentimageblockoption'
Parameter 'litmustestresultimage' : Structure of type 'litmustestresultimage'
Parameter 'xsltimage' : Structure of type 'xsltimage'
Parameter 'styleimage' : Structure of type 'styleimage'
Parameter 'emailingdocumentsnapshotimage' : Structure of type 'emailingdocumentsnapshotimage'
Parameter 'login' : Structure of type 'login'
Optional login data

Structure 'filedata'
This structure filedata was mentioned above. This structure has the following properties:
Property 'name' : string
The name of the data of the file.
Property 'mimetype' : string
The mimetype of the data of the file.
Property 'data' : binary
The data of the file. The data is base64 encoded.

Structure 'image'
This structure image was mentioned above. This structure has the following properties:
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 'linkedimage'
This structure linkedimage was mentioned above. This structure has the following properties:
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 'medialibraryimage'
This structure medialibraryimage was mentioned above. This structure has the following properties:
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 'surveyimage'
This structure surveyimage was mentioned above. This structure has the following properties:
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 'stylesnapshotimage'
This structure stylesnapshotimage was mentioned above. This structure has the following properties:
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 'webtemplateimage'
This structure webtemplateimage was mentioned above. This structure has the following properties:
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 'emailingtemplateimage'
This structure emailingtemplateimage was mentioned above. This structure has the following properties:
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 'webdocumentimage'
This structure webdocumentimage was mentioned above. This structure has the following properties:
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 'emailingdocumentimage'
This structure emailingdocumentimage was mentioned above. This structure has the following properties:
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 '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.

Structure 'litmustestresultimage'
This structure litmustestresultimage was mentioned above. This structure has the following properties:
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 'xsltimage'
This structure xsltimage was mentioned above. This structure has the following properties:
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 'styleimage'
This structure styleimage was mentioned above. This structure has the following properties:
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 'emailingdocumentsnapshotimage'
This structure emailingdocumentsnapshotimage was mentioned above. This structure has the following properties:
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 '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