GetThemes

Description

This class is an instantion of the Command class, that executes a command pertaining to fetching theme information 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 GetThemes command:

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Vic Fryzell
author
Andy Christ

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<themeID><!-- int --></themeID>
			<themeName><!-- string --></themeName>
			<themeDisplayName><!-- string --></themeDisplayName>
			<themeActive><!-- int --></themeActive>
			<adminID><!-- int --></adminID>
			<clientID><!-- int --></clientID>
			<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
themeID
Type
int
Description

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

themeName
Type
string
Description

The name of the theme to fetch. This is also the name of the directory for the theme.

themeDisplayName
Type
string
Description

The name displayed in the interface of the theme to fetch.

themeActive
Type
int
Description

Set to one to retrieve themes that are active.

adminID
Type
int
Description

Set to an admin's ID to retrieve the theme information for that admin.

clientID
Type
int
Description

Set to an client's ID to retrieve the theme information for that client.

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

Response Elements

None