Therefore Web API Programming Interface 1.0

GetViewingThumbnails

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 a document to be viewed or null/undefined 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. Null/undefined 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.
□ ZeroBasedStreamNo	xs:boolean	nillable	Optional bool parameter, that defines if the StreamNos parameter starts at 0 (true) or 1 (false/not-set).

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: