NGOGetThumbnail

This call is used to fetch the Thumbnail of a particular page of a document.

 

Input Parameter description

View sample InputXml

Output Parameter description

View sample OutputXml

Errors and Warnings

 

 

Input Parameters description

Name

Parent Tag

Description

Valid Values

Default

Values

Option

Root

Unique option for the call.

NGOGet

Thumbnail

N/A

CabinetName

Root

Name of the Cabinet to which the User wants to connect.

The name of the Cabinet.

N/A

UserDBId

Root

UserDatabase ID that is returned in the NGOConnect

Cabinet call.

 

N/A

DocumentIndex

Root

The Document Index of the document whose Thumbnail is to be retrieved.

Integer >= 0

N/A

PageNo

Root

The Page Number for which the Thumbnail is being retrieved.

Integer > 0

NULL to get all the pages.

Current

DateTime

Root

Date and time when the thumbnail is requested.

 

Current date time

VersionNo

Root

Version of the document for which the thumbnail is to be fetched for the given page.

 

 

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

NGOGetThumbnail

CabinetName

Root

The Cabinet to which the document belongs.

Status

Root

Status of the call. If the Status is 0, then the call is successful.

Thumbnails

Root

Contains the Thumbnails of the specified pages.

ThumbNail           

ThumbNails

Contains the Thumbnail for a particular page.

PageNo

ThumbNail

The page of the document to which the Thumbnail belong.

ImageData

ThumbNail

The binary Thumbnail data.

 

Errors returned from call

Code

Message

Comments

-50023

Document not found.

The Document Index whose Thumbnail is being set does not exist.

-50056

Page not found.

The document does not have the specified Page in it.

-50022

Insufficient rights for the current operation.

The User does not have sufficient Rights to get the Thumbnail of the Document. User must have Read Rights on the document to perform this operation.

-50132

Document has been deleted.

The document index whose Thumbnail data is to be obtained has been deleted.

-50086

Document has expired.

The Document Index whose Thumbnail data is to be obtained has expired.

-50071

Document has been checked out.

The Document Index whose Thumbnail data is to be obtained is being checked out.

-50027

Properties of the Document has been finalized.

The Document Index whose Thumbnail data is to be obtained has been finalized.

-50026

Document is in use.

The Document Index whose Thumbnail data is to be obtained is being locked.

-50076

Invalid object access type.

Access Type of the document whose Thumbnail data is to be obtained is not valid.