MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetFAQCategories

GetFAQCategories

Description

This class retrives information about FAQ categories. It does not retrieve the child FAQs, so is of limited usefulness. 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 GetFAQCategories command:

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Mark Garrett
author
Andy Christ

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<faqCategoryID><!-- int --></faqCategoryID>
			<faqCategoryName><!-- string --></faqCategoryName>
			<faqCategoryType><!-- int --></faqCategoryType>
			<getFAQData><!-- int --></getFAQData>
			<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
faqCategoryID
Type
int
Description

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

faqCategoryName
Type
string
Description

The name of the category to fetch. This is searched using a LIKE statement.

faqCategoryType
Type
int
Description

The type of category to fetch. While by default this will be 1 for admin and 0 for user, it can be any user-defined tinyint.

getFAQData
Type
int
Description

Set this to 1 to fetch all FAQs in each category, and return them in the result set.

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

Response Elements

None