MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetHelpdeskDepartments

GetHelpdeskDepartments

Description

This class retrieves information about helpdesk departments and optionally information about the buckets and tickets under the department. It can also return email templates associated with the department and admin data. 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 GetHelpdeskDepartments command:

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Vic Fryzel
author
Mark Garrett

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<hdDepartmentID><!-- int --></hdDepartmentID>
			<hdDepartmentName><!-- string --></hdDepartmentName>
			<hdDepartmentDescription><!-- string --></hdDepartmentDescription>
			<adminIDs>
				<adminID><!-- int --></adminID>
			</adminIDs>
			<getHelpdeskResponseTemplateData><!-- int --></getHelpdeskResponseTemplateData>
			<getHelpdeskEmailTemplateData><!-- int --></getHelpdeskEmailTemplateData>
			<getHelpdeskBucketData><!-- int --></getHelpdeskBucketData>
			<getAdminData><!-- int --></getAdminData>
			<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
hdDepartmentID
Type
int
Description

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

hdDepartmentName
Type
string
Description

The name of the department to fetch. This is a searched using a LIKE clause.

hdDepartmentDescription
Type
string
Description

The description of the department to fetch. This is a searched using a LIKE clause.

adminIDs
Type
int[]
Description

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

Children
adminID
Type
int
Description

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

getHelpdeskResponseTemplateData
Type
int
Description

Set to 1 to return all email response template data for the departments selected. This can return substantial amounts of data depending on the number of templates as the data includes the template body. Use with caution.

getHelpdeskEmailTemplateData
Type
int
Description

Set to 1 to return all email template data for the departments selected. This can return substantial amounts of data depending on the number of templates as the data includes the template body. Use with caution.

getHelpdeskBucketData
Type
int
Description

Set to return bucket data for helpdesk buckets associated with the departments selected. Options: 1: Get all Data; 2: Count, group by departmentID; 3: Get all data and all open ticket data

getAdminData
Type
int
Description

Set to return admin data for admins associated with the departments selected. Options: 1: Get all Data; 2: Count, group by departmentID

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