infoRouter Document Management System - Web Services API Documentation
AddUsergroupMember
Adds a user to the specified user group.
Syntax
[Visual Basic]
Public Shared Function AddUsergroupMember(ByVal AuthenticationTicket As String, _
Byval DomainName as string, _
Byval GroupName as string, _
Byval UserName as string _
) as xmldocument
Parameters

Authentication Ticket

infoRouter IRAuthentication Ticket

PWD

infoRouter Login user password

DomainName

The domain name of the usergroup if it is local

GroupName

The group name of group the user to be added

UserName

The user name to be added to the group



Return Value
returns xml fragment.
<response success="true" error="">
if success = "true", the user has been added to the group successfully
if success = "false", the error attribute returns the error description.
Remarks
The caller must be the system administrator or the domain manager of local usergroup.

Example
Public Function AddUsergroupMember()
Const RAuthenticationTicket As String = "sid-xxxxxxxxxx"
Const IR_DomainName As String = "Knowledge Base"
Const IR_UserGroup As String = "Authors"
Const IR_UserName As String = "JoeD"

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

IR_Obj = New InfoRouter.srv
xmlResponse = IR_Obj.AddUsergroupMember(IRAuthenticationTicket, _
IR_PWD, _
IR_DomainName, _
IR_UserGroup, _
IR_UserName)

If xmlResponse.GetAttribute("success") = "true" Then
Console.WriteLine("The user added to the user group")
Else
Console.WriteLine("The User cannot be added to the group.")
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
See Also
RemoveUserGroupMember | GetUserGroupMembers
Syntax based on infoRouter Document Management System Web Services API Version 7.0
Copyright() 1998-2003 Active Innovations, Inc.
infoRouter Document Management System