Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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

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

 

Gets the number of pages in a document for viewing

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ DocNo

xs:int

nillable

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

â–¡ VersionNo

xs:int

nillable

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

â–¡ StreamNo

xs:int

nillable

The StreamNo of an document to be viewed or 0 if an 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

â–  FromPage

xs:int

mandatory

The start page which should be returned

â–  PageCount

xs:int

mandatory

the number of pages to be returned

â–¡ SizeInPixels

xs:int

nillable

Sets the size of the thumbnail in pixels. Nil or 0 (zero) value means that default size will be used.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ ViewingPages

 

mandatory nillable

The dashboards and their order for the user

≡ WSViewingPage

 

list nillable


â–  PageHeight

xs:int

 

Height in pixels

â–¡ PageHtml

xs:string

nillable

Html content of the page

â–  PageNo

xs:int

 

Number of the current page

â–  PageWidth

xs:int

 

Width in pixels

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2023 Therefore Corporation, all rights reserved.