1. Home / Web Services API Version 8.x / GetDomainGroups

GetDomainGroups

Returns a list of all user groups (defined localy or globaly) in the specified domain/library .

Syntax

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

C# (declaration) 
public XmlNode GetDomainGroups( 
	string AuthenticationTicket,
	string DomainName)

Parameters

AuthenticationTicket
    string infoRouter ticket
DomainName
    string The domain/library name of the user groups to be listed

Return Value

returns xml fragment.
<response success="true" error="">
if success = "true", the <usergroups> sub nodes to be returned.
if success = "false", the error attribute returns the error description. 


    <response success="true" error="">
        <usergroups>
            <usergroup GroupID="1009" GroupName="Reviewers" DomainID="0" DomainName="*"/>
            <usergroup GroupID="1033" GroupName="Local Auditors" DomainID="1000" DomainName="Corporate"/>
        </usergroups>
    </response>

Remarks

The caller must be the system administrator or the domain manager of the specified domain.

See Also