GetFAQs

Description

This class retrieves FAQ information form the database including its parent category. It can be used to search for FAQs on bot question and category criteria. 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 GetFAQs 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>
			<faqID><!-- int --></faqID>
			<faqCategoryID><!-- int --></faqCategoryID>
			<faqQuestion><!-- string --></faqQuestion>
			<faqAnswer><!-- string --></faqAnswer>
			<faqCategoryName><!-- string --></faqCategoryName>
			<faqCategoryType><!-- int --></faqCategoryType>
			<faqDateCreatedLessThan><!-- int --></faqDateCreatedLessThan>
			<faqDateCreated><!-- int --></faqDateCreated>
			<faqDateCreatedGreaterThan><!-- int --></faqDateCreatedGreaterThan>
			<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
faqID
Type
int
Description

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

faqCategoryID
Type
int
Description

The ID of the FAQ category to fetch. This will fetch all questions in the category.

faqQuestion
Type
string
Description

The FAQ question to fetch. This is searched using a LIKE statement.

faqAnswer
Type
string
Description

The FAQ answer to fetch. This is searched using a LIKE statement.

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.

faqDateCreatedLessThan
Type
int
Description

The maximum UNIX timestamp for which a FAQ in the result set was created.

faqDateCreated
Type
int
Description

The exact UNIX timestamp for which a FAQ in the result set was created.

faqDateCreatedGreaterThan
Type
int
Description

The minimum UNIX timestamp for which a FAQ in the result set was created

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

Response Elements

None