|
GetViewingThumbnails |
Scroll |
REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetViewingThumbnails
SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetViewingThumbnails
Gets the thumbnails for specified streams of a document or for a file from the upload session
Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetViewingThumbnails
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â–¡ DocNo |
xs:int |
nillable |
The number of the document to be viewed or 0 if a newly uploaded document should be viewed |
â–¡ VersionNo |
xs:int |
nillable |
The version of the document to be viewed or 0 if a newly uploaded document should be viewed |
â–¡ StreamNos |
|
nillable |
The StreamNos of an document to be viewed or 0 if a newly uploaded document should be viewed |
≡ int |
xs:int |
list |
|
â–¡ UploadSessionId |
xs:string |
nillable GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} |
The upload session guid to be viewed or null/undefined if an existing document should be viewed |
â–¡ SizeInPixels |
xs:int |
nillable |
Sets the size of the thumbnail in pixels. Nil or 0 (zero) value means that default size will be used. |
â–¡ ConversionOptions |
|
nillable |
Conversion options that should be applied to the document when converting to HTML. |
â–¡ RenderWordComments |
xs:boolean |
nillable |
Enables rendering of review comments in Word documents. |
â–¡ Password |
xs:string |
nillable |
Password for encrypted files. |
Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetViewingThumbnailsResponse
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â–¡ Thumbnails |
|
mandatory nillable |
List of thumbnails, containing the byte data, extension and a bool if the thumbnail could be obtained. |
≡ GetThumbnailResponse |
|
list nillable |
|
â– 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. |
