MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetHelpdeskBuckets

GetHelpdeskBuckets

Description

This class retrieves information about a helpdesk bucket and optionally the admin info for the admin who owns the bucket. It can also retrieve the helpdesk department information for the bucket. This class should only be instantiated by dispatchMBAPI() found in include/mbapi/mbapi.php. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetHelpdeskBuckets command:

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Vic Fryzel
author
Andy Christ

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<hdBucketID><!-- int --></hdBucketID>
			<hdBucketName><!-- string --></hdBucketName>
			<adminIDs>
				<adminID><!-- int --></adminID>
			</adminIDs>
			<getAdminData><!-- int --></getAdminData>
			<getHelpdeskDepartmentData><!-- int --></getHelpdeskDepartmentData>
			<getTicketData><!-- int --></getTicketData>
			<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
hdBucketID
Type
int
Description

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

hdBucketName
Type
string
Description

The name of the helpdesk bucket to fetch. This is a searched using a LIKE clause, so an exact, full name is not necessary.

adminIDs
Type
int[]
Description

A list of admin IDs whose helpdesk buckets to search for.

Children
adminID
Type
int
Description

The ID of an admin whose related helpdesk buckets should be returned in the result set.

getAdminData
Type
int
Description

Set to 1 to return a list of all admin IDs associated with this bucket. Set to 2 to return a list of all admins and all of their data associated with this bucket.

getHelpdeskDepartmentData
Type
int
Description

Set to 1 to return a list of department IDs associated with this bucket. Set this to 2 to return a list of all departments and all of their data associated with this bucket.

getTicketData
Type
int
Description

Set to 1 to return all helpdesk ticket data for the departments selected. This can return substantial amounts of data depending on the number of tickets. Use with caution. Options: 1: Get all Data; 2: Count, group by departmentID; 3: Get all tickets NOT closed.

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

Response Elements

None