1. Home / Web Services API Version 8.x / GetFolders

GetFolders

Returns the list of sub folders and properties in the specified path.

Syntax

Visual Basic (declaration) 
Public Function GetFolders( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal Path as String, _ 
	ByVal WithRules as bool, _ 
	ByVal withPropertySets as bool, _ 
	ByVal withSecurity as bool, _ 
	ByVal withOwner as bool) as XmlNode

C# (declaration) 
public XmlNode GetFolders( 
	string AuthenticationTicket,
	string Path,
	bool WithRules,
	bool withPropertySets,
	bool withSecurity,
	bool withOwner)

Parameters

AuthenticationTicket
    string infoRouter ticket
Path
    string An infoRouter folder path
WithRules
    bool to get folder rules with the results
withPropertySets
    bool to get property sets with the results
withSecurity
    bool to get access list with the results
withOwner
    bool to get owner information of the folder with the results

Return Value

returns xml fragment.
<response success="true" error="">
if success attribute is "true", the folder list has been retrived successfully like the xml sample below.
if success attribute is "false", the error attribute indicates the encountered error.

<response success="true" error="">
  <folder FolderID="10137" Name="General Ledger" Path="\Accounting\General Ledger" Description="" CreationDate="2007-06-14 11:00:14" OwnerName="System Administrator" />
  <folder FolderID="10286" Name="Incoming Invoices" Path="\Accounting\Incoming Invoices" Description="This folder stores all incoming invoices. You can search for invoices in the system using the INVOICE custom property. You can also perform content searches on PDF documents." CreationDate="2007-08-03 12:07:44" OwnerName="System Administrator" />
  <folder FolderID="10138" Name="Payables" Path="\Accounting\Payables" Description="" CreationDate="2007-06-14 11:00:15" OwnerName="System Administrator" />
  <folder FolderID="10139" Name="Receivables" Path="\Accounting\Receivables" Description="" CreationDate="2007-06-14 11:00:15" OwnerName="System Administrator" />
</response>

Remarks

The caller must have at least "List" right on the folder.

See Also