infoRouter Document Management System Web Services API

infoRouter Document Management System - Web Services API Documentation

GetFolderRules

Returns the rules of the specified folder

Syntax

[Visual Basic]
Public Shared Function GetFolderRules(ByVal AuthenticationTicket As String, _
                                      Byval Path as string) as xmldocument

Parameters

AuthenticationTicket: infoRouter Authentication Ticket
Path: The Path of the folder to get the rules

Return Value

returns xml fragment.
<response success="true" error="">
if success = "true", the function returns the <rules> subnode.
if success = "false", the error attribute returns the error description.
<response success="true" error="">
<Rules>
<Rule Name="AllowableFileTypes" Value="DOC,XLS,BMP" />
<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" />
</Rules>
</response>

Remarks

The caller must have "Read" permission on the folder.

Example

Sub GetFolderRules()
 
        Const IRAuthenticationTicket As String = "sid-xxxxxxxxxxxxxx"
        Const IR_FolderPath As String = "/Accounting/AP"

        Dim IR_Obj As InfoRouter.srv
        Try
            Dim xmlResponse As System.Xml.XmlElement
            IR_Obj = New InfoRouter.srv
            xmlResponse = IR_Obj.GetFolderRules(IRAuthenticationTicket, IR_FolderPath)
            If xmlResponse.GetAttribute("success") = "true" Then
                'Get <Rules> xml element
                Dim xmlRules As System.Xml.XmlElement = xmlResponse.FirstChild
                Console.WriteLine("---[Folder Rules]----")
                'loop trough the rules
                Dim xmlrule As System.Xml.XmlElement
                For Each xmlrule In xmlRules
                    Console.WriteLine(xmlrule.GetAttribute("Name") & ":" & _
                                      xmlrule.GetAttribute("Value"))
                Next
                xmlRules = Nothing
            Else
                Console.WriteLine("The folder Rules cannot be reached:" & _
                                   xmlResponse.GetAttribute("error"))
            End If
            xmlResponse = Nothing

        Catch ex As Exception
            Console.WriteLine("error:" & ex.Message)
        Finally
            IR_Obj = Nothing
        End Try
End Sub