infoRouter Document Management System Web Services API

infoRouter Document Management System - Web Services API Documentation

UserExists

Determines whether the given username refers to an existing user.

Syntax

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

Parameters

AuthenticationTicket: infoRouter Authentication Ticket
UserName: The user to be tested

Return Value

returns xml fragment.
<response success="true" error="">
if success = "true", the specified user exists.
if success = "false", the error attribute returns the error description.

Remarks

Example

Public Sub UserExists()
        Const IRAuthenticationTicket As String = "sid-xxxxxxxxxxxxxxx"
        Const IR_UserToBeTested As String = "JoeD"

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

            IR_Obj = New InfoRouter.srv
            xmlResponse = IR_Obj.UserExists(IRAuthenticationTicket, IR_UserToBeTested)
            If xmlResponse.GetAttribute("success") = "true" Then
                Console.WriteLine("The user '" & IR_UserToBeTested & "' exists")
            Else
                Console.WriteLine("'" & IR_UserToBeTested & "'")
                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