GetSystemQueue

Description

This command gathers system queue events based upon the given credentials. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetSystemQueue command:

Attributes

package
modernbill
subpackage
mbapi
version
0.2
author
Michael Fountain

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<systemQueueID><!-- int --></systemQueueID>
			<systemQueueParentID><!-- int --></systemQueueParentID>
			<systemQueueCommand><!-- string --></systemQueueCommand>
			<systemQueueStatus><!-- int --></systemQueueStatus>
			<systemQueueMinute><!-- int --></systemQueueMinute>
			<systemQueueHour><!-- int --></systemQueueHour>
			<systemQueueDay><!-- int --></systemQueueDay>
			<systemQueueMonth><!-- int --></systemQueueMonth>
			<systemQueueYear><!-- int --></systemQueueYear>
			<systemQueueIsRecurring><!-- int --></systemQueueIsRecurring>
			<systemQueueDateToRun><!-- int --></systemQueueDateToRun>
			<systemQueueDateToRunLessThan><!-- None --></systemQueueDateToRunLessThan>
			<systemQueueDateToRunGreaterThan><!-- None --></systemQueueDateToRunGreaterThan>
			<systemQueueDateCreated><!-- int --></systemQueueDateCreated>
			<systemQueueDateCreatedLessThan><!-- None --></systemQueueDateCreatedLessThan>
			<systemQueueDateCreatedGreaterThan><!-- None --></systemQueueDateCreatedGreaterThan>
			<systemQueueDateStarted><!-- int --></systemQueueDateStarted>
			<systemQueueDateStartedLessThan><!-- None --></systemQueueDateStartedLessThan>
			<systemQueueDateStartedGreaterThan><!-- None --></systemQueueDateStartedGreaterThan>
			<systemQueueDateFinished><!-- int --></systemQueueDateFinished>
			<systemQueueDateFinishedLessThan><!-- None --></systemQueueDateFinishedLessThan>
			<systemQueueDateFinishedGreaterThan><!-- None --></systemQueueDateFinishedGreaterThan>
			<getSystemQueueLogData><!-- int --></getSystemQueueLogData>
			<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
systemQueueID
Type
int
Description

The ID of the system queue record to fetch.

systemQueueParentID
Type
int
Description

The ID of the PARENT system queue record(s) to fetch.

systemQueueCommand
Type
string
Description

The name of the system queue command to fetch.

systemQueueStatus
Type
int
Description

The status of the system queue command to fetch. 0, 1, 2, 4

systemQueueMinute
Type
int
Description

The minute the system queue is going to run on.

systemQueueHour
Type
int
Description

The hour the system queue is going to run on.

systemQueueDay
Type
int
Description

The day the system queue is going to run on.

systemQueueMonth
Type
int
Description

The month the system queue is going to run on.

systemQueueYear
Type
int
Description

The year the system queue is going to run on.

systemQueueIsRecurring
Type
int
Description

The recurring flag for a system queue record. Values: 1 or 0

systemQueueDateToRun
Type
int
Description

When the system queue is going to run.

systemQueueDateToRunLessThan
Type
None
Description
None
systemQueueDateToRunGreaterThan
Type
None
Description
None
systemQueueDateCreated
Type
int
Description

When the system queue was created.

systemQueueDateCreatedLessThan
Type
None
Description
None
systemQueueDateCreatedGreaterThan
Type
None
Description
None
systemQueueDateStarted
Type
int
Description

When the system queue started running.

systemQueueDateStartedLessThan
Type
None
Description
None
systemQueueDateStartedGreaterThan
Type
None
Description
None
systemQueueDateFinished
Type
int
Description

When the system queue finished.

systemQueueDateFinishedLessThan
Type
None
Description
None
systemQueueDateFinishedGreaterThan
Type
None
Description
None
getSystemQueueLogData
Type
int
Description

The flag for returning system queue logs. Values: 1 or 0

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

Response Elements

None