GetConfigs

Description

This command is used to retrieve items from the config_params table and optionally the associated values that are used to populate select lists, radio buttons, etc for those parameters. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetConfigs command:

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Vic Fryzel
author
Andy Chirst

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<configGroupID><!-- int --></configGroupID>
			<configGroupName><!-- string --></configGroupName>
			<configParamID><!-- int --></configParamID>
			<configParamName><!-- string --></configParamName>
			<getFormAttributes><!-- int --></getFormAttributes>
			<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
configGroupID
Type
int
Description

The ID of the config group whose parameters that will be fetched.

configGroupName
Type
string
Description

The name of the config group whose parameters that will be fetched. This should be used sparingly as many config groups have the same name.

configParamID
Type
int
Description

The ID of the config parameter to fetch. This will always select at most 1 parameter.

configParamName
Type
string
Description

The name of the config parameter that will be fetched. This cannot be considered a unique identifier and so should be used accordingly.

getFormAttributes
Type
int
Description

Set to 1 to retrieve associated values that are used to populate select lists, radio buttons, etc for selected parameters. This is not a selection criterion, so should be used in conjunction with other criteria listed above.

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

Response Elements

None