MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetAdminGroups

GetAdminGroups

Description

This command is used to retrieve admin group data including the admins of that group and actions that can be performed by that group. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetAdminGroups command:

Attributes

package
modernbill
subpackage
mbapi
version
0.9
author
Andy Christ

Example Request

	<mbapi>
		<command><!-- string --></command>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<adminGroupID><!-- int --></adminGroupID>
			<adminGroupName><!-- string --></adminGroupName>
			<getAdminData><!-- int --></getAdminData>
			<getActionData><!-- int --></getActionData>
		</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>
			<adminGroups>
				<adminGroup>
					<adminGroupID><!-- int --></adminGroupID>
					<adminGroupName><!-- string --></adminGroupName>
					<admins>
						<admin>
							<adminID><!-- int --></adminID>
							<adminFirstName><!-- string --></adminFirstName>
							<adminLastName><!-- string --></adminLastName>
							<adminEmail><!-- string --></adminEmail>
							<adminUsername><!-- string --></adminUsername>
							<adminPassword><!-- string --></adminPassword>
							<adminTempPassword><!-- string --></adminTempPassword>
							<adminRemoteAccessHash><!-- string --></adminRemoteAccessHash>
							<active)>
								<adminActive><!-- None --></adminActive>
								<themeID><!-- int --></themeID>
								<languageID><!-- int --></languageID>
								<countriesID><!-- int --></countriesID>
							</active)>
						</admin>
						<actions><!-- group --></actions>
						<actionName><!-- string --></actionName>
					</admins>
				</adminGroup>
			</adminGroups>
		</results>
	</mbapi>

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string GetBans.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

GetAdminGroups parameters.

Children
adminGroupID
Type
int
Description

The ID of the admin group to fetch. This will always select at most 1 group.

adminGroupName
Type
string
Description

The name of the admin group to fetch.

getAdminData
Type
int
Description

Set to 1 to retieve all data for the admins associated with this group.

getActionData
Type
int
Description

Set to 1 to retieve all actions that admins associated with this group can perform.

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
adminGroups
Type
group
Description

Contains all admin group results.

Children
adminGroup
Type
group
Description

Contains all results for a single admin group. Occurs header numResults times.

Children
adminGroupID
Type
int
Description

The ID of the admin group.

adminGroupName
Type
string
Description

The admin group name for the order form. Names need not be unique. Operations are performed on IDs. Names are merely for display.

admins
Type
group
Description

Contains admins in group

Children
admin
Type
group
Description

Contals all admins for a single admin group.

Children
adminID
Type
int
Description

The ID of the admin.

adminFirstName
Type
string
Description

The first name of the admin.

adminLastName
Type
string
Description

The last name of the admin.

adminEmail
Type
string
Description

The email address of the admin.

adminUsername
Type
string
Description

The username of the admin.

adminPassword
Type
string
Description

The encrypted admin user password.

adminTempPassword
Type
string
Description

The temporary password if user has envoked the "forgotten password" process.

adminRemoteAccessHash
Type
string
Description

Admin remote access hash.

active)
Type
int
Description

Is admin active. (0 =

Children
adminActive
Type
None
Description
None
themeID
Type
int
Description

Theme id user is set to use.

languageID
Type
int
Description

Language id user is set to use.

countriesID
Type
int
Description

Set country id of the admin.

actions
Type
group
Description

Contains action's the admin is permited to access.

actionName
Type
string
Description

The permited action Name.