Therefore Web API Programming Interface 1.0

StartViewingSession

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/StartViewingSession

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/StartViewingSession

Starts a viewing session for a specified document stream or for a file from the upload session. Also creates a thumbnail if required.

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/StartViewingSession

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
□ StreamNo	xs:int	nillable	The StreamNo of an document to be viewed or 0 if a newly uploaded document should be viewed
□ 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 no thumbnail file should be created.
□ 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 StreamNo parameter starts at 0 (true) or 1 (false/not-set).

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/StartViewingSessionResponse

Element Name	Element Type	Restrictions	Description
■ parameters
□ DocProperties		mandatory nillable	Document properties of the loaded file.
□ PageSizes		mandatory nillable	Width and height for every page of the file
≡ ArrayOfint		list nillable
≡ int	xs:int	list
□ TabNames		nillable	Tab names for document types with tabbed-viewing.
≡ string	xs:string	list nillable
□ 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.

Legend: