NGOGetDocListForFts

This call is used to fetch documents with which the given FTSIndex is associated. The FTSDocumentIndexes are sent in the input and corresponding to those indexes, a list of documents along with their properties is returned.

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.	NGOGetDocList ForFts	N/A
CabinetName	Root	Name of the Cabinet to which User wants to connect.		N/A
UserDBId	Root	UserDBId for the user session		N/A
FTSIndex	Root	FTSIndexes those are associated with documents.	Integer > 0

Output Parameters description

Name	Parent Tag	Description
Option	Root	NGOGetDocListForFts
Status	Root	Status of the call. If it is 0, then the call is successful.
Document	Root	Contains the Document Properties of the documents retrieved.
DocumentIndex	Document	The Document Index of the document whose properties have been retrieved.
DocumentVersionNo	Document	The Version Number of the document whose Document Properties have been retrieved.
DocumentName	Document	Name of the document.
OwnerIndex	Document	The Index of the Owner of the document.
CreationDateTime	Document	The Date and Time on which the document was created.
RevisedDateTime	Document	The Date and Time at which the Properties of the document were last changed.
AccessDateTime	Document	The Date and Time at which the document was last accessed.
DataDefIndex	Document	The Index of the Data Definition associated with the document.
VersionFlag	Document	Specifies whether the Auto Versioning is enabled for the document. ‘Y’ – Yes ‘N’ – No
DocumentType	Document	Type of document. ‘I’ – Image, ‘N’ – Non image, ‘X’ – Reserved, A – Reserved
CreatedByApp	Document	Reserved.
ISIndex	Document	The Image and Volume Index of the document on the Image Server.
NoOfPages	Document	Number of pages in the document.
DocumentSize	Document	The size of the document in bytes.
FTSDocumentIndex	Document	Reserved for internal use.
ODMADocument Index	Document	Reserved for internal use.
EnableLog	Document	Flag that indicates whether to enable Log for the document. ‘N’ – No, ‘Y’ – Yes
DocumentLock	Document	Whether any User has locked the document. ‘N’ – No, ‘Y’ – Yes.
Comment	Document	Comments that were added while adding the document or changing the Document Property.
Author	Document	Author of the document.
FTSFlag	Document	Reserved for internal use.
DocStatus	Document	The status of the document. ‘A’ – Added, ‘R’ – Read
ExpiryDateTime	Document	The Date and Time when the document will expire.
FinalizedFlag	Document	Whether the document has been finalized or not. ‘N’ – No, ‘Y’ – Yes
FinalizedDateTime	Document	Date and Time when the document was finalized.
CheckoutStatus	Document	Indicates whether the document has been checked out or not ‘N’ – No, ‘Y’ – Yes
ACL	Document	The ACL string associated with the document.
DocOrderNo	Document	The order in which the document was added in the folder.
ReferenceFlag	Document	‘O’ – Original document ‘R’ – Referenced document
LoginUserRights	Document	The Rights of the logged in User who has retrieved the Properties of the document.
Owner	Document	Name of the Owner of the document.
LockByUser	Document	Index of the User who locked the document.
FinalizedBy	Document	The name of the User who finalized the document.
CheckoutBy	Document	Index of the User who has checked out the document.
DataDefName	Document	Name of the data definition associated with the document.

Errors returned from call

Code	Message	Comments
-50146	Invalid session.	Session corresponding to the UserDBId sent in the call is invalid.
-50006	User account has expired.	The account of the user has expired.
-50010	User not alive.	The user is not alive.
-50125	Cabinet has been locked for Administrative purposes.	The Cabinet has been locked by some user for Administrative purposes.