Folder 2.5 GetSubFolders
This method returns the subfolders of the specified root folder. The returned FolderList XML contains some hard-coded metadata of the folder and the subfolders.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| psAuthContext | String | InOut | Deprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services making this parameter redundant. |
| peBaseFolder | eBaseFolder | In | Indicates the root folder to use as starting point for folder actions |
| psOutXMLFolderList | String | Out | The FolderList XML structure containing the metadata of the folder and the subfolders |
Requirements are:
- The user must have read access for the object.
Note that:
- Only subfolders for which the user has read access are returned.
- The method will only return one level of subfolders. So, only the subfolders of the current folder are returned. If you want to get the subfolders of a subfolder, you have to call the same function again for that subfolder.
- Currently the following hard-coded metadata is returned:
- The folder name (= FNAME)
- The folder content type (= FDOCUMENTTYPE)
- The creation date (= CREATED-ON)
- The modification date (= MODIFIED-ON)
- The query xml (= FISHQUERY). When the folder is no query folder, the value will be empty.
- The owner (= FUSERGROUP)
- The read access (= READ-ACCESS)