NGOGetFolderProperty

This transaction is used to retrieve the Property of a folder. It takes Folder Index in the input tag. The data associated with the folder is also retrieved if DataAlsoFlag is ‘Y’.

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.	NGOGetFolder Property	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.		N/A
DataAlsoFlag	Root	If ‘Y’, then associated Data Class is returned.	‘Y’ - Yes ‘N’ – No	‘N’
RightsFlag	Root	Not in use.
CurrentDateTime	Root	Current Date and Time.		N/A

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 call is successful.
LoginUserRights	Root	Rights of the Logged in user on the folder.
Folder	Root	Contains information about the folder.
FolderIndex	Folder	Index of the folder.
ParentFolderIndex	Folder	Index of the parent of this folder.
FolderName	Folder	Name of the folder.
Owner	Folder	Owner of the folder.
OwnerIndex	Folder	Index of the Owner.
CreationDateTime	Folder	Creation Date and Time of the folder.
RevisedDateTime	Folder	Last Date and Time when the folder was revised.
AccessDateTime	Folder	Last Date and Time when the folder was accessed.
DeletedDateTime	Folder	Date time when folder was deleted.
AccessType	Folder	Access Type of the folder.
ImageVolumeIndex	Folder	Volume Index of the Folder 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 G-General, A-Reserved.
FolderLock	Folder	Indicates if the folder is locked.
LockByUser	Folder	Index of the User who has locked the folder.
ExpiryDateTime	Folder	Expiry Date and Time of the folder.
Comment	Folder	Comment associated with this folder.
FinalizedFlag	Folder	Indicates if this folder is finalized.
FinalizedBy	Folder	Index of the User who has finalized this folder.
DataDefName	Folder	Name of the Data Class associated with the folder, if any.
FinalizedDateTime	Folder	Date and Time when the folder was finalized.
ACL	Folder	Rights of other Users and Groups on this folder.
ACLMoreFlag	Folder	Reserved for internal use.
Location	Folder	Folder Type of the Parent Folder of this folder namely Root, General, Inbox, SentItems, Trash etc.
EnableFTSFlag	Folder	Reserved for internal use.
LockByUser	Folder	Name of the user who has locked the Folder.
NoOfSubFolders	Folder	Number of subfolders present in the Folder.
NoOfDocuments	Folder	Number of documents present in the Folder.
NoOfReferencedDocuments	Folder	Number of Referenced Documents present in the Folder.
NoOfReferencedFolders	Folder	Number of Referenced Folders present in the Folder.
DataDefinition	Folder	If Data Class is associated with this folder, then the whole description of the Data Class is displayed.
DataDefIndex	DataDefinition	Index of the Data Class associated with the folder, if any.
Fields	Folder	Outer Tag containing information about the fields of the associated Data Class.
Field	Fields	Outer Tag containing information about a single field of this data class.
IndexId	Field	Index of the Data Class field.
IndexName	Field	Name of the Data Class field.
IndexType	Field	Type of the Data Class field.
IndexLength	Field	Length of the Data Class field.
IndexAttribute	Field	Attribute of the Data Class Field.
IndexFlag	Field	Specifies whether the given field is Global or specific to this Data Class.

Errors returned from call

Code	Message	Comments
-50017	Folder not found.	If folder does not exist.
-50018	Invalid Rights for current operation	User does not have Rights on the folder. User must have atleast Read Rights on the folder to retrieve the Folder Property.
-50076	Invalid object access type.	Access type of folder whose property is to be obtained is improper . This error arises in the process of rights checking on the folder .