infoRouter Document Management System Web Services API

infoRouter Document Management System - Web Services API Documentation

Move

Moves a document or folder to the specified destination path.

Syntax

[Visual Basic]
Public Shared Function Move(ByVal AuthenticationTicket As String, _
                            Byval SourcePath as string, _
                            Byval DestinationPath as string) as xmldocument

Parameters

AuthenticationTicket: infoRouter Authentication Ticket
SourcePath: A document or a folder path to be moved.
DestinationPath: New Path for the document or the folder.

Return Value

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

Remarks

The caller must have "Full Control" permissions on source document or folder and "Add" permissions on the destination folder.
The source Folder must allow deletes and the destination folder must allow adds (Folder Rules).

Example

Public Sub Move()
        Const IRAuthenticationTicket As String = "sid-xxxxxxxxxxxxxx"

        Const IR_SourcePath As String = "/Public/sample/ninepeople.jpg"
        Const IR_DestinationPath As String = "/Public/Images/"
        Dim IR_Obj As InfoRouter.srv
        Dim xmlResponse As System.Xml.XmlElement
        Try

            IR_Obj = New InfoRouter.srv

            xmlResponse = IR_Obj.Move(IR_AuthenticationTicket, _
                                      IR_SourcePath, _
                                      IR_DestinationPath)

            If xmlResponse.GetAttribute("success") = "true" Then
                Console.WriteLine("The document has been successfully moved.")
            Else
                Console.WriteLine("The document cannot be moved.")
                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