NGOGetDocumentListExt

This call is used to retrieve either the List of all the Documents available in a Folder or Linked documents of the specified Document. The documents can be fetched, sorted on Name, Index, Order, and Date etc. The documents can be sorted in ascending or descending order. The Document List is fetched in batches. User has to specify the Previous Index value and Previous Sort field value. If more records exist in the database, then the value for the TotalNoOfRecords fetched in the output will be one greater than the NoOfRecordsFetched; otherwise, both the values will be same. If the User needs to get the documents of the specified folder, then FolderIndex is mandatory and if User wants to get the linked documents of the specified document, then the DocumentIndex is mandatory (both are mutually exclusive).

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 Document ListExt	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
CurrentDateTime	Root		yyyy-mm-dd hh:mm:ss
FolderIndex	Root	Unique Index of the folder.	Integer >= 1	User has to specify this when a list of documents within a folder is required.
DocumentIndex	Root	Index of the document whose linked document List has to be fetched.	Integer >= 1	User has to specify this when a list of linked documents is required.
PreviousIndex	Root	This tag is used for fetching objects in batches. It specifies the Index of the last object in the previous batch. For the first batch, value of the field is 0.	Integer >= 0	0
LastSortField	Root	It specifies the value of that object on which sorting is done. It is basically the last object in the previous batch of objects and is sent blank for the first batch.
StartPos	Root	It is an integer that specifies the number, starting from which, the objects are to be taken from the records in the Result Set.	Integer > 0	1
NoOfRecords ToFetch	Root	Total number of records to be fetched in the call.	Integer > 0	N/A
OrderBy	Root	A number which specifies the field on which sorting is to be done.	1 – Index 2 – Object Name 3 – Owner 5 – RevisedDate Time 9 – CreatedBy AppName 10 – NoOfPages 11 – DocumentSize 18 – DocOrderNo	1
SortOrder	Root	Order of records to be fetched. (Ascending or descending)	A – Ascending D – Descending	A
DataAlsoFlag	Root	Flag that specifies whether the Data Class associated with Document is to be fetched or not.	Y/N	N
ReferenceFlag	Root	Reference Flag of the document	O – Original R – Reference
PreviousRefIndex	Root	This tag is used for fetching References objects in batches. It specifies the Index of the last object in the previous batch. For the first batch, value of the field is 0.	Integer >= 0	0
LastRefField	Root	It specifies the value of that References, on which sorting is done. It is basically the last object in the previous batch of References and is sent blank for the first batch.
RefOrderBy	Root	A number that specifies the field on which sorting is to be done.	Integer > 0	1
RefSortOrder	Root	Order of References to be fetched. (Ascending or descending)	A – Ascending D – Descending	A
NoOfReference ToFetch	Root	Specifies the number of Referenced objects to be fetched.	Integer > 0	50
RecursiveFlag	Root	It specifies whether the subfolders are to be considered for getting the results.	Y – subfolders are considered N – subfolders not considered	‘N’
DocumentType	Root	Specifies the Type of the document.	N, I, A (Reserved).	Blank
LinkDocFlag	Root	Flag that specifies whether Link document information should be fetched.	Y or N	N
AnnotationFlag	Root	Annotation flag of the document.	Y/N	N
ThumbNailAlsoFlag	Root	Flag that indicates whether to fetch the Thumbnail data or not.	Y/N	N

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. Else if less than zero, error is reported. Else warning is reported.
NoOfRecordsFetched	Root	Numbers of records fetched.
TotalNoOfRecords	Root	Total numbers of records present.
Documents	Root	Starting tag for the list of documents.
Document	Documents	Starting tag for the details of the document.
DocumentIndex	Document	Unique Index of the document.
ParentFolderIndex	Document	Folder Index of the document where the document resides.
DocumentVersionNo	Document	Version Number of the document.
NoOfPages	Document	Numbers of pages associated with the document.
DocumentName	Document	Name of the document.
Owner	Document	Owner of the document.
OwnerIndex	Document	Owner Index of the document.
CreationDateTime	Document	Creation Date and Time of the document
RevisedDateTime	Document	Revised Date and Time of the document
AccessDateTime	Document	Access Date and Time of the document
ExpiryDateTime	Document	Expiry Date and Time of the document.
FiledDateTime	Document	Date and Time when the document was filed in its Parent Folder.
ReferenceFlag	Document	Reference flag of the document.
VersionFlag	Document	Version flag of the document.
DocumentType	Document	Type of the document.
CreatedByApp	Document	Reserved for internal use.
CreatedByAppName	Document	The extension of the document.
ISIndex	Document	Image Index of the document.
TextISIndex	Document	Reserved for internal use.
DocumentSize	Document	Size of the document.
DocOrderNo	Document	The order in which, the document is added in the folder.
FTSDocumentIndex	Document	Reserved for internal use.
ODMADocumentIndex	Document	Reserved for internal use.
EnableLog	Document	Enable log flag.
DocumentLock	Document	Flag that indicates whether any User has locked the document.
Comment	Document	Any comment associated with the document.
CheckoutStatus	Document	Indicates whether the document has been checked out or not. ‘N’ – No, ‘Y’ – Yes
UsefulInfo	Document	Useful information associated with the document.
Location	Document	Location of the document.
CheckoutBy	Document	Index of the User who has checked out the document.
FiledByUser	Document	Index of the User who has filed the document.
FTSFlag	Document	Reserved for internal use.
DocStatus	Document	Status of the document.
LockByUser	Document	User by whom the Document is Locked.
FinalizedFlag	Document	Finalized flag of the document.
FinalizedBy	Document	User by whom the document has been finalized.
FinalizedDateTime	Document	Finalized Date and Time of the document.
LoginUserRights	Document	Rights string of the logged in User.
Author	Document	Author of the document.
LinkDocFlag	Document	Flag that specifies whether Link Document is present with the document.
PullPrintFlag	Document	PullPrint flag associated with the document. Its valid values are: Y – pullprint generated P – Pending F – Failed I – Insoview generated
AnnotationFlag	Document	Flag that specifies whether Annotations are present in the document.
ThumbNailFlag	Document	Flag that specifies whether Thumbnail, is generated for the document.
OriginalFolderIndex	Document	Original folder index of the document.
OriginalFolderLocation	Document	Original folder location of the document.
DataDefinition	Document	Data Class info that is associated with the document.
DataDefIndex	Data Definition	Index of the Data class associated with the document.
DataDefName	Data Definition	Data class name.
Fields	Data Definition	Information about the fields of this data class.
Field	Fields	Information of an individual field.
IndexId	Field	Index of the data field.
IndexName	Field	Name of the data field.
IndexType	Field	Type of the data field.
IndexLength	Field	Length of the data field.
IndexFlag	Field	Global (G) or Data(D).
UsefulInfoFlag	Field	UsefulInfo flag of the data field.
UsefulInfoSize	Field	UsefulInfo size of the data field.
IndexAttribute	Field	Attribute of the data field.
IndexValue	Field	Value of the data field.
GlobalIndexes	Document	Contains the information about Global Indexes associated with the document.
ThumbNail	Document	The information about the Thumbnail of the document.
PageNo	ThumbNail	Page Number of the document whose Thumbnail data has been retrieved.
ImageData	ThumbNail	Binary data about the Thumbnail of the document.
FolderReferences	Root	This outer tag contains the folder references of the requested document list.
Reference	Folder References	Contains a particular reference.
FolderIndex	Reference	Index of the folder.
FolderName	Reference	Name of the folder.
FileDatetime	Reference	Filed date time of this folder.
LoginUserRights	Reference	Rights string of the Loged-in User.
Rights	Reference	Rights associated with this folder.
NoOfReferenceFetched	Root	Number of the referenced document fetched.
TotalNoOfReference	Root	Total number of References present for the document.

Errors returned from call

Code	Message	Comments
-50074	Invalid parameters.	Invalid parameter is passed in the input.
-50017	Folder not found.	Given Folder Index not found.
-50018	Insufficient rights for the current operation.	Insufficient Rights on the given folder.
-50023	Document not found.	Document not found.
-50022	Insufficient rights for the current operation.	Insufficient Rights on document.
-50076	Invalid object access type.	Access type of folder whose document list is to be obtained is improper.This error arises in the process of rights checking on the folder. This error can also occur, while checking rights on data definition associated with the documents to be returned if access type of data definition is improper. This error can also occur if rights checking for some documents fails if they have improper access type.
-50028	Data Class not found.	This error occurs while checking rights on data definition associated with the documents to be returned , if data class doesn’t exist in the system.