Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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

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

 

Prepares viewing/conversion of a document to html5

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ DocNo

xs:int

optional nillable

The number of the document to be viewed or 0 if an newly uploaded document should be viewed

â–¡ VersionNo

xs:int

optional nillable

The version of the document to be viewed or 0 if an newly uploaded document should be viewed

â–¡ UploadSessionId

xs:string

optional 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

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ Streams

 

optional nillable

List of file streams in that document.

≡ WSViewingPagesStream

 

optional unbounded nillable


â–¡ FilenName

xs:string

optional nillable

The original name of the file.

â–  FileSize

xs:long

optional

The file size in bytes.

â–  PageCount

xs:int

optional

The amount of pages in this file.

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

Unbounded element (List of elements).

Normal

Optional element.

Bold

Mandatory element.

 

 

© 2024 Therefore Corporation, all rights reserved.