infoRouter Document Management System Web Services API

infoRouter Document Management System - Web Services API Documentation

DeleteUser

Deletes an infoRouter user.

Syntax

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

Parameters

AuthenticationTicket: infoRouter Authentication Ticket
UserName: The UserName of the user to be deleted.

Return Value

returns xml fragment.
<response success="true" error="">
if success = "true", the user has been deleted.
if success = "false", the error attribute returns the error description.

Remarks

The caller must be the system administrator or the domain manager of the domain in which the user is a member.

Example

Public DeleteUser()
        Const IRAuthenticationTicket As String = "sid-xxxxxxxxxxxxx"
        Const UserNameToBeDeleted As String = "JoeD"

        Dim xmlResponse As System.Xml.XmlElement
        Dim IR_Obj As InfoRouter.srv
        Try
            'Create InfoRouter Object
            IR_Obj = New InfoRouter.srv

            xmlResponse = IR_Obj.DeleteUser(IRAuthenticationTicket, UserNameToBeDeleted)
            If xmlResponse.GetAttribute("success") = "true" Then
                Console.WriteLine("'" & UserNameToBeDeleted & "' has been successfully deleted.")
            Else
                Console.WriteLine("'" & UserNameToBeDeleted & "' cannot be deleted.")
                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