GetBookmarks

Description

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

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Andy Christ

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<bookmarkID><!-- int --></bookmarkID>
			<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
bookmarkID
Type
int
Description

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

adminID
Type
int
Description

The ID of the admin whose bookmarks you want to fetch.

clientID
Type
int
Description

The ID of the client whose bookmarks you want to fetch.

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

Response Elements

None