GetClientGroups

Description

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:

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Michael Fountain
author
Andy Christ

Example Request

	<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>

		

Example Response

None
		

Request Elements

mbapi
Type
None
Description
None
Children
command
Type
None
Description
None
showXMLHeader
Type
None
Description
None
params
Type
None
Description
None
Children
clientGroupID
Type
int
Description

The ID of the client group to fetch. This will always select at most 1 client group.

clientGroupName
Type
string
Description

The name of the client group. This is retrieved with a LIKE statement.

sortDir
Type
None
Description
None
sortColumn
Type
None
Description
None
recordOffset
Type
None
Description
None
numRecords
Type
None
Description
None

Response Elements

None