NGOGetFTSText

This call gets the extracted Text for a specified 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.

NGOGetFTS

Text

N/A

CabinetName

Root

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

 

N/A

UserDBId

Root

UserDatabase ID that is returned in the NGOConnect

Cabinet call.

 

N/A

DocumentIndex

Root

Index of the document for which Extracted Text is to be obtained.

 

N/A

EncryptionFlag

Root

Indicates whether the Extracted Text that is returned, should be in encrypted form or not.

‘Y’ – Yes

‘N’ – No

‘N’

VersionNo

Root

Specifies the version number of the document whose text has to be extracted.

 

 

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

Unique option for the call.

Status

Root

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

EncryptionFlag

Root

Indicates whether the Extracted Text that is returned, is in encrypted form or not.

FTSDataList

Root

Outer tag for the List of Extracted Text fetched for all objects of the document.

FTSData

FTSData

List

Outer tag for eExtracted Text of a single object of the document.

ObjectType

FTSData

Specifies the object related to the document, for which the text was extracted. For example,  whether the text was extracted from document content, or Notes or Keywords or Owner, or Author etc.

ObjectIndex

FTSData

Index of the object.

Text

FTSData

Actual extracted Text.

 

Errors returned from call

Code

Message

Comments

-50023

Document not found.

Document for which extracted Text is to be obtained does not exist.

-50076

Invalid object access type.

 

Access Type of document whose text is to be obtained is improper. This error occurs in the process of checking Rights on the document.