MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetAdmins

GetAdmins

Description

This command returns all information about ModernBill administrators including helpdesk information and bookmarks. Retrieving all helpdesk information can take substantial time if there are many tickets and buckets, so use with caution. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetAdmins command:

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Andy Christ

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<adminID><!-- int --></adminID>
			<adminUsername><!-- string --></adminUsername>
			<adminEmail><!-- string --></adminEmail>
			<adminFirstName><!-- string --></adminFirstName>
			<adminLastName><!-- string --></adminLastName>
			<adminActive><!-- int --></adminActive>
			<themeID><!-- int --></themeID>
			<languageID><!-- int --></languageID>
			<countriesID><!-- int --></countriesID>
			<getAdminGroupData><!-- int --></getAdminGroupData>
			<actionName><!-- string --></actionName>
			<getBookmarkData><!-- int --></getBookmarkData>
			<getHelpdeskDepartmentData><!-- int --></getHelpdeskDepartmentData>
			<getHelpdeskBucketData><!-- int --></getHelpdeskBucketData>
			<getAssignedTicketData><!-- int --></getAssignedTicketData>
			<getTransferredTicketData><!-- int --></getTransferredTicketData>
			<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
adminID
Type
int
Description

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

adminUsername
Type
string
Description

The username of the admin to fetch. This is the name that the admin logs into the system as.

adminEmail
Type
string
Description

The email of the admin to fetch.

adminFirstName
Type
string
Description

The given name of the admin to fetch.

adminLastName
Type
string
Description

The surname of the admin to fetch.

adminActive
Type
int
Description

Set to 1 to fetch admins that are active. Set to 0 to fetch admins that are not active.

themeID
Type
int
Description

The ID of the default theme for this admin.

languageID
Type
int
Description

The ID of the default language for this admin. If a language pack is not available, only date/time information will be displayed in this language. If a pack is available, all defined constants will be displayed.

countriesID
Type
int
Description

The ID of the country for this admin. Used in conjucntion with teh language ID to define the locale for this admin.

getAdminGroupData
Type
int
Description

Set to 1 to return all group data to which this admin belongs, 2 to get all actions in those groups.

actionName
Type
string
Description

If getAdminGroupData is set to 2, then you can pass in the current actionName to verify the admin has access to this action.

getBookmarkData
Type
int
Description

Set to 1 to return all bookmark data for this admin.

getHelpdeskDepartmentData
Type
int
Description

Set to 1 to return all helpdesk departments this admin belongs to.

getHelpdeskBucketData
Type
int
Description

Set to 1 to return all helpdesk buckets this admin are assigned to.

getAssignedTicketData
Type
int
Description

Set to 1 to return all helpdesk tickets this admin are assigned to.

getTransferredTicketData
Type
int
Description

Set to 1 to return all helpdesk tickets this admin transfered to another admin.

sortDir
Type
None
Description
None
sortColumn
Type
None
Description
None
recordOffset
Type
None
Description
None
numRecords
Type
None
Description
None

Response Elements

None