GetProductGroups

Description

This class is an instantion of the Command class, that executes a command pertaining to fetching product group information, in the default case from the database. This class should only be instantiated by dispatchMBAPI() found in include/mbapi/mbapi.php. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetProductGroups 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>
			<productGroupID><!-- int --></productGroupID>
			<productGroupApiName><!-- string --></productGroupApiName>
			<productGroupName><!-- string --></productGroupName>
			<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
productGroupID
Type
int
Description

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

productGroupApiName
Type
string
Description

The api name of the product group to fetch. Retrieved using a LIKE statement

productGroupName
Type
string
Description

The name of the product group to fetch. Retrieved using 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