This call is
used to get the list of the folders available in the Cabinet. The folders can
be fetched and sorted by Name or Index. Sorting can be done on ascending or
descending order. The Folder List is fetched in batches. User has to specify
the Previous Index value and Previous sort field value to fetch the
list in batches. Specifying DataalsoFlag can also fetch Data Fields associated
with the corresponding folders. It also fetches the Sub Folders along with the
Folder List.
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOGetFolder ListExt |
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 |
|
CurrentDateTime |
Root |
Current Date and Time when the call
is made. |
Valid date in the format yyyy-mm-dd
hh:mm:ss |
Current Date and time |
|
FolderIndex |
|
Index of the folder whose Folder
List is to be fetched in this call. If it is 0, then list of all the folders is fetched. |
Integer >= 0 |
0 |
|
RecursiveFlag |
|
Indicates whether the subfolders should be fetched
recursively or not with the corresponding Folders. |
‘Y’ – Yes ‘N’ - No |
‘N’ |
|
PreviousIndex |
Root |
This tag is meant for the last Index of the Folder
received in the previous batch. Should be sent for the first batch. |
Integer >= 0 |
0 |
|
LastSortField |
Root |
This tag is meant for the value of the sorted
column of the last Folder received in the previous batch. |
|
Blank |
|
NoOfRecordsTo Fetch |
Root |
Specifies the Number of records to
be fetched in the current batch. |
Integer > 0 |
All records are fetched. |
|
OrderBy |
Root |
Indicates the field (Folder Name,
Folder Index etc) on the basis of which the Folder List will be sorted. |
1- Folder Index 2- Folder Name |
1 |
|
SortOrder |
Root |
Indicates whether the Folder List is
to be sorted in ascending order or descending order. |
‘A’- Ascending ‘D’- Descending |
‘A’ |
|
DataAlsoFlag |
Root |
Specifies whether to retrieve the
Data Class field values associated with a folder. |
‘Y’- yes ‘N’ – No |
‘N’ |
|
AccessType |
Root |
Indicates the Access Type of folders
to be fetched in the result. |
‘S’- Shared ‘P’- Private ‘I’ –Inherited |
‘S’ |
|
FolderType |
Root |
Indicates the type of folders to be fetched in the
result. |
‘S’ – System ‘G’ – General ‘A’ – Reserved |
‘G’ |
|
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. |
|
NoOfRecordsFetched |
Root |
Number of records fetched in the
current batch. |
|
TotalNoOfRecords |
Root |
The value of this tag will be one
greater than the NoOfRecordsFetched, if more records exist in the database,
otherwise, both the values will be the same. |
|
Folders |
Root |
Outer tag containing information
about all the Folders fetched in the current batch. |
|
Folder |
Folders |
Outer tag containing information
about a single Folder. |
|
FolderIndex |
Folder |
Index of the Folder. |
|
ParentFolderIndex |
Folder |
Index of the Parent Folder of the
current Folder. |
|
NoOfSubFolders |
Folder |
Number of subfolders present in the
Folder. |
|
NoOfDocuments |
Folder |
Number of documents present in the
Folder. |
|
FolderName |
Folder |
Name of the Folder. |
|
Owner |
Folder |
Owner of the Folder. |
|
OwnerIndex |
Folder |
Index of the Owner of the 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 of deletion of the
Folder. |
|
AccessType |
Folder |
Indicates whether the folder is a
Shared folder, Private folder or Inherits its Access Type from its Parent
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 General,
Inbox, SentItems, Trash etc. |
|
FolderLock |
Folder |
Indicates whether any User has locked the Folder. |
|
Location |
Folder |
Folder Type of the Parent Folder of this folder
namely Root, General, Inbox, SentItems, Trash etc. |
|
ExpiryDateTime |
Folder |
Date and Time after which the folder will expire. |
|
VersionFlag |
Folder |
Indicates whether Versioning will be allowed for
the documents added in this 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 when the folder was finalized. |
|
LoginUserRights |
Folder |
Rights of the login User on the folder. |
|
ACLMoreFlag |
Folder |
Not Used. |
|
EnableFtsFlag |
Folder |
Reserved for internal use. |
|
LockByUserId |
Folder |
Index of the User who has locked the
Folder. |
|
ACL |
Folder |
Reserved for Internal use. |
|
LockByUser |
Folder |
Name of the user who has locked the Folder. |
|
FinalizedBy |
Folder |
User by whom the Object has been Finalized. |
|
DataDefinition |
Folder |
Contains information about the Data Class
associated with the folder, if any. |
|
DataDefIndex |
Data Definition |
Index of the Data Class associated
with the folder, if any. |
|
DataDefName |
Data Definition |
Name of the Data Class associated
with the folder, if any. |
|
Fields |
Data Definition |
Outer Tag containing information
about the fields of this Data Class. |
|
Field |
Fields |
Outer Tag containing information
about a single field of this data class. |
|
IndexId |
Field |
Index of the Data Class field. |
|
IndexValue |
Field |
Value of the Data class field
associated with the folder. |
|
Code |
Message |
Comments |
|
-50017 |
Folder not found. |
The folder, for which the Folder List is to be
fetched, does not exist. |
|
-50018 |
Insufficient Rights for the current operation. |
Logged in User does not have sufficient Rights on the
folder, for which the Folder List is to be fetched. User should have at least
Read Right on the folder. |
|
-50076 |
Invalid object access type. |
Either Access type of
folder whose list is to be obtained
is improper or Access type of
DataClass associated with a folder in the folder list to be retreived is
improper. |
|
-50028 |
Data Class not found. |
Some Data Class associated with a folder in the folder
list to be retreived doesn’t exist. |