Returns the properties of the folder in the specified path.


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

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


    string infoRouter ticket
    bool An infoRouter folder path
    bool to get folder rules with the results
    bool to get property sets with the results
    bool to get access list with the results
    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 properties has been retrived successfully.
if success attribute is "false", the error attribute indicates the encountered error.

<response success="true" error="">
  <folder FolderID="10124" Name="Accounting" Path="\Accounting" Description="This library stores accounting related documents. It is restricted to authorized users." CreationDate="2007-06-14 10:54:53" OwnerName="System Administrator">
    <User exists="true" Domain="" UserName="sysadmin" FirstName="System" LastName="Administrator" Email="" LastLogonDate="2007-04-11 11:10:00" LastPasswordChangeDate="2007-07-12 11:55:40" AuthenticationAuthority="INFOROUTER" ReadOnlyUser="FALSE" Enabled="TRUE">
      <Rule Name="AllowableFileTypes" Value="*" />
      <Rule Name="Checkins" Value="allows" />
      <Rule Name="Checkouts" Value="allows" />
      <Rule Name="DocumentDeletes" Value="allows" />
      <Rule Name="FolderDeletes" Value="allows" />
      <Rule Name="NewDocuments" Value="allows" />
      <Rule Name="NewFolders" Value="allows" />
      <Rule Name="ClassifiedDocuments" Value="disallows" />
      <Rule Name="RetentionPeriod" Value="0" />
      <Rule Name="AutoPromptPropertsetName" Value="" />
    <Propertysets />
    <AccessList DateApplied="2007-08-03 14:41:58" AppliedBy="System Administrator" InheritedSecurity="false">
      <UserGroup DomainName="" GroupName="Accountants" Right="4" Description="(Add &amp; Read)" />
      <UserGroup DomainName="" GroupName="Auditors" Right="2" Description="(Read)" />
      <User DomainName="" UserName="diannaf" Right="6" Description="(Full Control)" />
      <User DomainName="" UserName="michaely" Right="6" Description="(Full Control)" />


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