MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetWebsiteWidgets

GetWebsiteWidgets

Description

Command to get website widgets and their respective products.

Attributes

Product
modernbill
subProduct
mbapi
version
0.9
author
Kris Bailey

Example Request

	<mbapi>
		<command><!-- string --></command>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<websiteWidgetID><!-- int --></websiteWidgetID>
			<websiteWidgetName><!-- int --></websiteWidgetName>
			<websiteWidgetTpl><!-- int --></websiteWidgetTpl>
			<orderFormID><!-- string --></orderFormID>
			<getProductInformation><!-- int --></getProductInformation>
		</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>
			<websiteWidgets>
				<websiteWidget>
					<websiteWidgetID><!-- int --></websiteWidgetID>
					<websiteWidgetName><!-- int --></websiteWidgetName>
					<websiteWidgetTpl><!-- int --></websiteWidgetTpl>
					<orderFormID><!-- string --></orderFormID>
					<products>
						<product>
							<productID><!-- string --></productID>
						</product>
					</products>
				</websiteWidget>
			</websiteWidgets>
		</results>
	</mbapi>

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string GetWebsiteWidgets.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

GetWebsiteWidgets parameters.

Children
websiteWidgetID
Type
int
Description

Website Widget ID, if you want just one

websiteWidgetName
Type
int
Description

Website Widget name to search with.

websiteWidgetTpl
Type
int
Description

Website Widget tpl name to search by.

orderFormID
Type
string
Description

Order form id of this widget.

getProductInformation
Type
int
Description

Whether to return the product information or not.

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
websiteWidgets
Type
None
Description
None
Children
websiteWidget
Type
None
Description
None
Children
websiteWidgetID
Type
int
Description

Website Widget ID, if you want just one

websiteWidgetName
Type
int
Description

Website Widget name to search with.

websiteWidgetTpl
Type
int
Description

Website Widget tpl name to search by.

orderFormID
Type
string
Description

Order form ID for this widget.

products
Type
group
Description

Contains the associated product ids

Children
product
Type
group
Description

Contains

Children
productID
Type
string
Description

Product ID