Returns information on the specified user group.

Syntax

Visual Basic (declaration)
Public Function GetUserGroup( _ 
ByVal AuthenticationTicket as String, _ ByVal DomainName as String, _ ByVal GroupName as String) as XmlNode

C# (declaration)
public XmlNode GetUserGroup( 
string AuthenticationTicket, string DomainName, string GroupName)

Parameters

AuthenticationTicket
    string infoRouter ticket
DomainName
    string The domain of the usergroup if it is local
GroupName
    string The Name of the user group to be retrieved

Return Value

returns xml fragment.
<response success="true" error="">
if success attribute is "true", the user group has been retrieved successfully.
if success attribute is "false", the error attribute indicates the encountered error.
The sub nodes return information about user group.

<response success="false" error="">
  <usergroup GroupName="Accountants" />
</response>

Remarks

To retrieve global user groups specify do not specify a domain name.