MBAPI Element Index
MBAPI Intro → MBAPI Command Index → ProcessCancellation

ProcessCancellation

Description

Command to get product ledger entries and their filter cycles and currencies.

Attributes

Product
modernbill
subProduct
mbapi
version
0.9
author
Kris Bailey

Example Request

	<mbapi>
		<command><!-- string --></command>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<packageIDs>
				<packageID><!-- int --></packageID>
			</packageIDs>
		</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>
			<packageIDs>
				<packageID><!-- int --></packageID>
			</packageIDs>
		</results>
	</mbapi>

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string ProcessCancellation.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

ProcessCancellation parameters.

Children
packageIDs
Type
group
Description

Group containing any package ids that we want to cancel explicitly.

Children
packageID
Type
int
Description

The ID of the package(s) we want to cancel.

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
None
Description
None
Children
packageIDs
Type
group
Description

Group containing any package ids that we cancelled.

Children
packageID
Type
int
Description

The ID of the package(s) we just cancelled.