infoRouter Document Management System Web Services API

infoRouter Document Management System - Web Services API Documentation

CreateFolder

Creates all folders and subfolders as specified by path. The top level folder (domain) must be exists.

Syntax

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

Parameters

AuthenticationTicket: infoRouter Authentication Ticket
Path: Path to be created

Return Value

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

Remarks

The top level folder (domain) must exist. The caller must have at least "Add" permissions on the parent folder.

Example

Public Sub CreateFolder_Sample()
 
        Const IRAuthenticationTicket As String = "sid-xxxxxxxxxx"
 
        Const IR_NewPath As String = "/Public/samples/Misc/Images"
        Dim IR_Obj As InfoRouter.srv
        Dim xmlResponse As System.Xml.XmlElement
        Try
 
            IR_Obj = New InfoRouter.srv
 
            xmlResponse = IR_Obj.CreateFolder(IR_AuthenticationTicket, _
                                              IR_NewPath)
 
            If xmlResponse.GetAttribute("success") = "true" Then
                Console.WriteLine("The Folder Path has been created successfully.")
            Else
                Console.WriteLine("The Folder cannot be created.")
                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