NGOGetAncestorList

This call is used to get the complete path of a folder starting from the Root. This call returns a list of folders where the first component in the list gives information about the Root Folder. Next Component in the list gives information about the folder that is next in hierarchy in the list of Ancestors of the specific folder and so on .The last component of the list contains information about the folder whose Ancestor List is being 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.	NGOGet Ancestor List	N/A
CabinetName	Root	Name of the Cabinet to which the User wants to connect.		N/A
UserDBId	Root	UserDatabase ID, which is returned in the NGOConnectCabinet call.		N/A
FolderIndex	Root	Index of the folder whose full path from the Root is to be found.	Integer >= 0	N/A
RightFlag	Root	Indicates whether the Rights of logged in User are to be returned on all the folders returned in the output of this call.	‘Y’ – Yes ‘N’ – No	‘N’
SubFolderCount	Root	Indicates whether the count of subfolders of the current folder is to be returned or not.	‘Y’ – Yes ‘N’ – No	‘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.
Folders	Root	A List of folders, starting from the Root Folder, is returned between <Folders> and </Folders> tag.
Folder	Folders	Information about the folders is returned between the <Folder> and </Folder> tag.
FolderIndex	Folder	Index of the current folder.
ParentFolderIndex	Folder	Index of the Parent Folder of the current folder.
NoOfSubFolders	Folder	No of subfolders present in the current folder.
FolderName	Folder	Name of the current folder.
OwnerIndex	Folder	Index of the Owner of the current folder.
CreationDateTime	Folder	Date and Time at which the folder was created.
RevisedDateTime	Folder	Date and Time at which the folder was last modified.
AccessDateTime	Folder	Date and Time at which the folder was last accessed
DeletedDateTime	Folder	Date and Time at which the folder was deleted
AccessType	Folder	Indicates whether the folder is a Shared folder / Private folder / Inherits its Access Type from its Parent Folder.
ImageVolumeIndex	Folder	Volume Index of the Image Server where the documents added in this folder will be added, if no Volume Index is supplied in the Add Document call.
FolderType	Folder	Indicates the Type of the folder namely General, Inbox, SentItems and Trash etc.
FolderLock	Folder	Indicates if any User has locked the folder or not.
Location	Folder	Folder Type of the Parent Folder of this folder namely General, Inbox, SentItems, Trash and Root etc.
ExpiryDateTime	Folder	Date and Time after which the current folder will expire.
VersionFlag	Folder	Indicates whether Versioning will be allowed for the documents added in the current folder or not.
Comment	Folder	Comments associated with the folder.
FinalizedFlag	Folder	Indicates whether the Folder is finalized or not.
FinalizedDateTime	Folder	Date and Time at which folder was finalized.
LoginUserRights	Folder	Rights of the logged in User on the current folder.
ACL	Folder	String comprising of the Rights of Users / Groups on the current folder.
ACLMoreFlag	Folder	Reserved for internal use.
DataDefIndex	DataDefinitionFolder	Index of the Data Class associated with the folder, if any.
FinalizedBy	Folder	Index of the User who has finalized the folder.
MappedDirectory	Folder	Reserved.
NoOfDocs	Folder	Number of documents present in the Folder.
NoOfReferencedDocs	Folder	Number of Referenced documents present in the Folder.
Owner	Folder	Owner of the folder.
LockByUser	Folder	Index of the User who has locked the folder.

Errors returned from call

Code	Message	Comments
-50017	Folder not found.	The folder whose Ancestor List is to be fetched, is not found.
-50000	Unknown Error	Some other error, apart from those already listed, has occurred.
-50076	Invalid object access type.	Access type of folder whose ancestorlist is to be obtained is improper . This error arises in the process of rights checking on the folder .