|
GetThumbnail |
Scroll |
REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetThumbnail
SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetThumbnail
Returns the thumbnail of an existing Thereforeâ„¢ document.
Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetThumbnail
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â– DocNo |
xs:int |
mandatory |
Sets the number of the document. |
â–¡ SizeInPixels |
xs:int |
nillable |
Sets the size of the thumbnail in pixels. Nil or 0 (zero) value means that default size will be used. |
â–¡ RequestedThumbnailFormat |
xs:string |
nillable |
Set format in which the thumbnail should be returned. If not set the default format is used (png). Accepted strings: "jpeg", "png". |
Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetThumbnailResponse
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â– Exists |
xs:boolean |
|
Returns true if the thumbnail can be obtained for given document. |
â–¡ ThumbnailFileData |
xs:base64Binary |
nillable |
Gets binary data of the thumbnail file. Nothing is returned if the thumbnail can not be obtained for a given document. It uses a base64 encoded string in XML messages and a byte array in JSON messages. |
â–¡ ThumbnailFileExtension |
xs:string |
nillable |
Gets the extension for the thumbnail file (including the period "."). Nothing is returned if thumbnail cannot be obtained for the given document. |
Legend:
â– |
Not nillable element. |
â–¡ |
Nillable element. |
≡ |
List of elements. |
Bold |
Mandatory element. |
