infoRouter Document Management System Web Services API

infoRouter Document Management System - Web Services API Documentation

FolderExists

Determines whether the given path refers to an existing folder.

Syntax

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

Parameters

AuthenticationTicket: infoRouter Authentication Ticket
PWD: infoRouter Login user password
Path: A folder path in inforouter to test

Return Value

returns xml fragment.
<response success="true" error="">
if success = "true", the folder has been found.
if success = "false", the error returns the error description.

Remarks

The caller must have at least "List" permissions on the specified folder.
if the folder does not exist or if the calling user has "No Access" permissions, the function returns the error message "Folder does not exist".
Please note that the folder may in fact exist. If the calling user does not have access, the returned message will be "Folder does not exist".

Example

Public Sub FolderExists()
        Const IRAuthenticationTicket As String = "sid-xxxxxxxxxxx"
        Const IR_FolderPath As String = "/public/samples"

        Dim IR_Obj As InfoRouter.srv
        Dim xmlResponse As System.Xml.XmlElement
        Try

            IR_Obj = New InfoRouter.srv
            xmlResponse = IR_Obj.FolderExists(IRAuthenticationTicket, IR_FolderPath)
            If xmlResponse.GetAttribute("success") = "true" Then
                Console.WriteLine("The folder '" & IR_FolderPath & "' exists")
            Else
                Console.WriteLine("'" & IR_FolderPath & "'")
                Console.WriteLine("server response:" & xmlResponse.GetAttribute("error"))
            End If
            xmlResponse = Nothing

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