This command is used to retrieve the information about client groups. It will not retrieve the associated clients. Use GetClients for that functionality. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetClientGroups command:
<mbapi> <command><!-- None --></command> <showXMLHeader><!-- None --></showXMLHeader> <params> <clientGroupID><!-- int --></clientGroupID> <clientGroupName><!-- string --></clientGroupName> <sortDir><!-- None --></sortDir> <sortColumn><!-- None --></sortColumn> <recordOffset><!-- None --></recordOffset> <numRecords><!-- None --></numRecords> </params> </mbapi>
None
mbapi
command
showXMLHeader
params
clientGroupID
The ID of the client group to fetch. This will always select at most 1 client group.
clientGroupName
The name of the client group. This is retrieved with a LIKE statement.
sortDir
sortColumn
recordOffset
numRecords