MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetPPCCodes

GetPPCCodes

Description

This command fetches PPC Codes based on input params.

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Michael Fountain

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<codeID><!-- int --></codeID>
			<codeRemoteID><!-- int --></codeRemoteID>
			<codeType><!-- int --></codeType>
			<codeToUse><!-- string --></codeToUse>
			<codeStatus><!-- int --></codeStatus>
			<codeValue><!-- decimal --></codeValue>
			<codeCurrencyID><!-- string --></codeCurrencyID>
			<codeClientID><!-- int --></codeClientID>
			<codeClientEmail><!-- string --></codeClientEmail>
			<codeProductID><!-- int --></codeProductID>
			<codeProductName><!-- string --></codeProductName>
			<codeProductPrice><!-- decimal --></codeProductPrice>
			<codeDateDistributed><!-- int --></codeDateDistributed>
			<codeDateDistributedGreaterThan><!-- None --></codeDateDistributedGreaterThan>
			<codeDateDistributedLessThan><!-- None --></codeDateDistributedLessThan>
			<codeDateExpires><!-- int --></codeDateExpires>
			<codeDateExpiresGreaterThan><!-- None --></codeDateExpiresGreaterThan>
			<codeDateExpiresLessThan><!-- None --></codeDateExpiresLessThan>
			<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
codeID
Type
int
Description

The PPC Code ID (local, not remote).

codeRemoteID
Type
int
Description

The PPC Code ID (remote, not local).

codeType
Type
int
Description

The ID of the code type.

codeToUse
Type
string
Description

The actual PPC Code.

codeStatus
Type
int
Description

The status ID of the PPC Code.

codeValue
Type
decimal
Description

The value amount of the PPC Code.

codeCurrencyID
Type
string
Description

The currency ID of the PPC Code.

codeClientID
Type
int
Description

The client ID associated with a PPC Code.

codeClientEmail
Type
string
Description

The email address of the client at the time the PPC Code was distributed.

codeProductID
Type
int
Description

The product ID of the product ordered that triggered the PPC Code distribution.

codeProductName
Type
string
Description

The name of the product ordered that triggered the PPC Code distribution.

codeProductPrice
Type
decimal
Description

The amount of the product ordered that triggered the PPC Code distribution.

codeDateDistributed
Type
int
Description

The unix timestamp of when the PPC Code was distributed.

codeDateDistributedGreaterThan
Type
None
Description
None
codeDateDistributedLessThan
Type
None
Description
None
codeDateExpires
Type
int
Description

The unix timestamp of when the PPC Code expires.

codeDateExpiresGreaterThan
Type
None
Description
None
codeDateExpiresLessThan
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