NGOSetThumbnail

This call is used to set thumbnailThumbnail offor a particular page of some document. If the specified pPage happens to be the last page of the,  document then the document is also unlocked. Page Noumber is mandatory when the call is made to for add or modify thumbnailThumbnail is made, but not in case of deletinge thumbnailThumbnail.

 

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.

NGOSet

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, which that is returned in the NGOConnect

Cabinet call.

 

N/A

DocumentIndex

Root

The dDocument iIndex of the document whose thumbnailThumbnail has is to be set.

Integer >= 0

N/A

PageNo

Root

The pPage nNumber for which the thumbnailThumbnail is being set.

Integer > 0

N/A

CreationDate

Time

Root

The Date and Time onat which the thumbnailThumbnail is being set.

Valid Date in the format- yyyy-mm-dd hh:mm:ss

Current system System date Date and timeTime.

ProcessType

Root

Type of operation being performed on the thumbnailThumbnail.

‘A’ – Add

‘M’ – Modify

‘D’ – Delete

N/A

ImageData

Root

The thumbnailThumbnail data in Binary format.

any string.

NULL

           

Output Parameters description

Name

Parent Tag

Description

Option

Root

NGOSetThumbNailThumbnail

Status

Root

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

 

Errors returned from call

Code

Message

Comments

-50074

Invalid parameters.

Some of the specified parameters are incorrect . This exception comes occurs when document Document index Index is null or page The Page number Number of the document is null or ProcessType is invalid.

-50023

Document not found.

The Ddocument index Index whose thumbnailThumbnail is being set does not exist.

-50056

Page not found.

The document does not have the specified pPage 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.The User who is trying to set the thumbnail does not possess sufficient rights to do so. User must have change rights on document to perform the operation.

-50132

Document has been deleted.

The Document Index document index whose thumbnailThumbnail is being set has been deleted.

-50086

Document has expired.

The Document Index document index whose thumbnailThumbnail is being set has expired.

-50071

Document has been checked out.

The Document Index document index whose thumbnailThumbnail is being set has been is cChecked oOut.

-50027

Properties of the Document has been finalized.

The Document Index document index whose thumbnailThumbnail is being set has been finalized.

-50026

Document is in use.

The Document Index document index whose thumbnailThumbnail is being set is locked.

-50076

Invalid object access type.

Access tType of the document whose thumbnailThumbnail is being set is not valid.