Back to API references

SOAP API method WebDocumentImageBlock_createOption

Description

Create a new empty option and return it

Parameters

Name Type Description
id * string Unique identifier (id) of the object WebDocumentImageBlock. The method only applies to the webdocumentimageblock with this id.
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
webdocumentimageblockoption Structure of type 'webdocumentimageblockoption'
emailingdocumentimageblockoption Structure of type 'emailingdocumentimageblockoption'

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

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 '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.