GetPackageUsageLog

Description

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

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Andy Christ

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<usageLogID><!-- int --></usageLogID>
			<packageID><!-- int --></packageID>
			<usageLogPackageUsage><!-- float --></usageLogPackageUsage>
			<usageLogDateCreated><!-- int --></usageLogDateCreated>
			<externalID><!-- var --></externalID>
			<configGroupID><!-- int --></configGroupID>
			<bandwdithLogDateBilled><!-- int --></bandwdithLogDateBilled>
			<getTotals><!-- int --></getTotals>
			<usageLogPackageUsageGreaterThan><!-- int --></usageLogPackageUsageGreaterThan>
			<usageLogPackageUsageLessThan><!-- None --></usageLogPackageUsageLessThan>
			<usageLogPackageUsageGreatest><!-- None --></usageLogPackageUsageGreatest>
			<usageLogPackageUsageLeast><!-- None --></usageLogPackageUsageLeast>
			<usageLogDateCreatedGreaterThan><!-- int --></usageLogDateCreatedGreaterThan>
			<usageLogDateCreatedLessThan><!-- None --></usageLogDateCreatedLessThan>
			<usageLogDateCreatedGreatest><!-- None --></usageLogDateCreatedGreatest>
			<usageLogDateCreatedLeast><!-- None --></usageLogDateCreatedLeast>
			<usageLogDateBilledGreaterThan><!-- int --></usageLogDateBilledGreaterThan>
			<usageLogDateBilledLessThan><!-- None --></usageLogDateBilledLessThan>
			<usageLogDateBilledGreatest><!-- None --></usageLogDateBilledGreatest>
			<usageLogDateBilledLeast><!-- None --></usageLogDateBilledLeast>
			<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
usageLogID
Type
int
Description

The ID of the usage log record to fetch. This will always select at most 1 log record.

packageID
Type
int
Description

The ID of a package to fetch. This will select all records for this package.

usageLogPackageUsage
Type
float
Description

An amout to select.

usageLogDateCreated
Type
int
Description

The date of the record to select.

externalID
Type
var
Description

Whatever unique identifier is used to tie this account to an external system.

configGroupID
Type
int
Description

The id of the panel module to gather for.

bandwdithLogDateBilled
Type
int
Description

The date of invoicing to pull. Use -1 for NULL as the search criteria

getTotals
Type
int
Description

1 to send back amount used with the max allowed

usageLogPackageUsageGreaterThan
Type
int
Description

Rage bassed on the usage amount.

usageLogPackageUsageLessThan
Type
None
Description
None
usageLogPackageUsageGreatest
Type
None
Description
None
usageLogPackageUsageLeast
Type
None
Description
None
usageLogDateCreatedGreaterThan
Type
int
Description

Range bassed on the date created.

usageLogDateCreatedLessThan
Type
None
Description
None
usageLogDateCreatedGreatest
Type
None
Description
None
usageLogDateCreatedLeast
Type
None
Description
None
usageLogDateBilledGreaterThan
Type
int
Description

Rage bassed on the date billed.

usageLogDateBilledLessThan
Type
None
Description
None
usageLogDateBilledGreatest
Type
None
Description
None
usageLogDateBilledLeast
Type
None
Description
None
sortDir
Type
None
Description
None
sortColumn
Type
None
Description
None
recordOffset
Type
None
Description
None
numRecords
Type
None
Description
None

Response Elements

None