MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetTodos

GetTodos

Description

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

Attributes

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

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<todoID><!-- int --></todoID>
			<userID><!-- int --></userID>
			<todoAssignedAdminID><!-- int --></todoAssignedAdminID>
			<todoIsPublic><!-- int --></todoIsPublic>
			<todoTitle><!-- string --></todoTitle>
			<todoDesc><!-- string --></todoDesc>
			<todoStatusID><!-- string/int --></todoStatusID>
			<todoPriority><!-- int --></todoPriority>
			<todoLinkFile><!-- string --></todoLinkFile>
			<todoLinkActionName><!-- string --></todoLinkActionName>
			<todoLinkName><!-- string --></todoLinkName>
			<todoLinkPk><!-- int --></todoLinkPk>
			<todoDateDueLessThan><!-- int --></todoDateDueLessThan>
			<todoDateDue><!-- int --></todoDateDue>
			<todoDateDueGreaterThan><!-- int --></todoDateDueGreaterThan>
			<todoDateCreatedLessThan><!-- int --></todoDateCreatedLessThan>
			<todoDateCreated><!-- int --></todoDateCreated>
			<todoDateCreatedGreaterThan><!-- int --></todoDateCreatedGreaterThan>
			<getAdminData><!-- int --></getAdminData>
			<getAuthorData><!-- int --></getAuthorData>
			<getAssociated><!-- int --></getAssociated>
			<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
todoID
Type
int
Description

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

userID
Type
int
Description

The ID of the admin who authored the todo item.

todoAssignedAdminID
Type
int
Description

The Admin Assinged to todo item.

todoIsPublic
Type
int
Description

1 means todo item is public.

todoTitle
Type
string
Description

The short title of the todo item. This is searched with a LIKE statement.

todoDesc
Type
string
Description

The longer description of the todo item. This is searched with a LIKE statement.

todoStatusID
Type
string/int
Description

The string or integer representation of a status associated with the todo item.

todoPriority
Type
int
Description

The lower the int the higher the priority.

todoLinkFile
Type
string
Description

Link file name.

todoLinkActionName
Type
string
Description

Link Action Name.

todoLinkName
Type
string
Description

Link var name.

todoLinkPk
Type
int
Description

Link primairy key

todoDateDueLessThan
Type
int
Description

The maximum UNIX timestamp for when a todo is due.

todoDateDue
Type
int
Description

The exact UNIX timestamp for when a todo is due.

todoDateDueGreaterThan
Type
int
Description

The minimum UNIX timestamp for when a todo is due.

todoDateCreatedLessThan
Type
int
Description

The maximum UNIX timestamp for when a todo was created.

todoDateCreated
Type
int
Description

The exact UNIX timestamp for when a todo was created.

todoDateCreatedGreaterThan
Type
int
Description

The minimum UNIX timestamp for when a todo was created.

getAdminData
Type
int
Description

Set to 1 obtain all admin user data associated with the todo item.

getAuthorData
Type
int
Description

Set to 1 obtain all admin user data associated with the author of the todo item.

getAssociated
Type
int
Description

Set to 1 changed the userID, todoIsPublic and todoAssignedAdminID to MultOrClauses.

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

Response Elements

None