GetBillingAccountShares

Description

Command to get ban data, how other data is related to bans, and some data related to bans.

Attributes

package

modernbill

subpackage

mbapi

version

0.9

author

Kris Bailey

Example Request

	<mbapi>
		<command><!-- string --></command>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<billingAccountShareID><!-- int --></billingAccountShareID>
			<billingAccountID><!-- string --></billingAccountID>
			<packageID><!-- int --></packageID>
			<billingAccountFallbackGroup><!-- boolean --></billingAccountFallbackGroup>
			<billingAccountShareGroup><!-- int --></billingAccountShareGroup>
			<billingAccountShareValue><!-- int --></billingAccountShareValue>
			<getPackageData><!-- boolean --></getPackageData>
			<verifyBillingAccount><!-- boolean --></verifyBillingAccount>
		</params>
	</mbapi>

		

Example Response

	<mbapi>
		<header>
			<remoteSessionID><!-- hex --></remoteSessionID>
			<errorCount><!-- int --></errorCount>
			<errors>
				<error>
					<title><!-- string --></title>
					<message><!-- string --></message>
				</error>
			</errors>
			<numResults><!-- int --></numResults>
			<numAffectedRows><!-- int --></numAffectedRows>
		</header>
		<results>
			<billingAccountShares>
				<billingAccountShare>
					<billingAccountShareID><!-- int --></billingAccountShareID>
					<billingAccountID><!-- string --></billingAccountID>
					<packageID><!-- int --></packageID>
					<billingAccountFallbackGroup><!-- boolean --></billingAccountFallbackGroup>
					<billingAccountShareGroup><!-- int --></billingAccountShareGroup>
					<billingAccountShareValue><!-- int --></billingAccountShareValue>
				</billingAccountShare>
			</billingAccountShares>
		</results>
	</mbapi>

		

Request Elements

mbapi

Type

group

Description

MBAPI request document root.

Children

command

Type

string

Description

Required. The string GetBillingAccountShares.

showXMLHeader

Type

boolean

Description

Whether to show an XML header in the results.

params

Type

group

Description

GetBillingAccountShares parameters.

Children

billingAccountShareID

Type

int

Description

The ID of the billing Account Share.

billingAccountID

Type

string

Description

The ID of the billing Account.

packageID

Type

int

Description

The ID of the package.

billingAccountFallbackGroup

Type

boolean

Description

The billing account fallback group.

billingAccountShareGroup

Type

int

Description

The billing account share group.

billingAccountShareValue

Type

int

Description

The billing account share value.

getPackageData

Type

boolean

Description

Whether to join in the package or not.

verifyBillingAccount

Type

boolean

Description

Whether or not to join the billing account to make sure there is a valid billing account for the share.

Response Elements

mbapi

Type

group

Description

MBAPI response document root.

Children

header

Type

group

Description

Contains result meta data: data about the result itself.

Children

remoteSessionID

Type

hex

Description

A session ID that may be used for authentication instead of a remote access hash.

errorCount

Type

int

Description

The number of errors that occured.

errors

Type

group

Description

Contains any errors that occured.

Children

error

Type

group

Description

Contains information relating to a single error. Occurs header errorCount times.

Children

title

Type

string

Description

The title of the error.

message

Type

string

Description

The error message.

numResults

Type

int

Description

The number of results that have been returned. For Get commands.

numAffectedRows

Type

int

Description

The number of rows that have been affected. For Set commands.

results

Type

group

Description

Contains any results.

Children

billingAccountShares

Type

group

Description

Contains all billing Account Share results.

Children

billingAccountShare

Type

group

Description

Contains all results for a single billing Account Share. Occurs header numResults times.

Children

billingAccountShareID

Type

int

Description

The ID of the billing Account Share.

billingAccountID

Type

string

Description

The ID of the billing Account.

packageID

Type

int

Description

The ID of the package.

billingAccountFallbackGroup

Type

boolean

Description

The billing account fallback group.

billingAccountShareGroup

Type

int

Description

The billing account share group.

billingAccountShareValue

Type

int

Description

The billing account share value.