This call is used to search folders and sub folders depending on the specified Data Classes associated with the documents inside it. User can also specify the list of LookIn folders. User can also specify a flag that indicates whether to return those folders and subfolders that match the given criteria or list of folders other than that.
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOSearch FolderOnDocumentData |
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 NGOConnect Cabinet call. |
|
N/A |
|
LookInFolder |
Root |
Index of the folder in which search is to be made based on the input criterions. More than one LookInFolders can be specified .In that case, Search will be made in all the specified folders. |
Integer > = 0 |
Search will be made on entire cabinet |
|
IncludeSubFolder |
Root |
Indicates if search is to be made on the subfolders of the specified LookInFolder or not. This tag is of significance only when LookInFolder is specified. |
‘Y’ – Yes ‘N’ – No |
‘N’ |
|
IncludeExcludeFlag |
Root |
Indicates whether to return those folders and sub folders that match the given criteria or those that does not match the criteria. |
‘Y’ – return those folders which does not match criteria. ‘N’ – return those folders which match the given criteria |
‘N’ |
|
DataDefinitions |
Root |
List of Data Definitions on the basis of which search will be made. |
|
|
|
DataDefIndex |
Data Definitions |
Index of Data Definition on the basis of which search will be made. |
|
|
|
OrderBy |
Root |
Indicates the field on which the search results will be sorted. For example, Name of folder, Owner, CreatedDate Time etc. |
1-FolderIndex 2-Name 3-Owner 4-Created Datetime 5-Revised DateTime 6-Accessed DateTime 7-Data Definition Index 8-FolderType 9- FolderLock 10-ExpiryDate Time 11-Finalised Flag |
N/A |
|
SortOrder |
Root |
Indicates whether Search Results are to be sorted in ascending order or descending order. |
‘A’- Ascending ‘D’- Descending |
‘A’ |
|
NoOfRecordsToFetch |
Root |
Specifies the Number of records to be fetched in the current batch. |
|
N/A |
|
PreviousIndex |
Root |
This tag is meant for the last Index of the folder received in the previous batch. 0 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 |
|
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 |
Used for getting Search Results in batches. The value for the TotalNoOfRecords fetched in output will be one greater than the NoOfRecordsFetched if more records exist in the database otherwise both the values will be same. |
|
Results |
Root |
Encloses information about the folders fetched in the current batch. |
|
Result |
Results |
Outer tag that contains information about a single folder of the current batch. |
|
FolderIndex |
Folder |
Index of the folder. |
|
ParentFolderIndex |
Folder |
Index of parent of 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 / Inherits its Access Type from its Parent Folder. |
|
ImageVolumeIndex |
Folder |
Volume Index of the Image Server where the documents of this folder will be added. |
|
FolderType |
Folder |
Indicates the Type of the folder. |
|
FolderLock |
Folder |
Indicates if any User has locked the folder. |
|
Location |
Folder |
It specifies the location where the folder is present. |
|
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. |
|
FinalizedBy |
Folder |
Index of the User who has finalized the folder. |
|
FinalizedDateTime |
Folder |
Date and Time when the folder was finalized. |
|
LoginUserRights |
Folder |
Rights of the logged in User on the folder. |
|
LockByUser |
Folder |
User by whom the Folder is locked. |
|
ACL |
Folder |
Not Used. |
|
DataDefinitions |
Result |
Information of the Data Class associated with the folder. |
|
DataDefIndex |
DataDefinitions |
Index of the Data Class associated with the folder. |
|
Code |
Message |
Comments |
|
-50074 |
Invalid Parameter |
This Exception occurs when the list of Data Definition Index is not passed in input. |