Untitled Page
API Overview
Example
Customers  
Companies  
Technicians  
Technician Groups  
Tickets  
Ticket History  
Ticket Attachments  
Billing Line Items  
Billing Invoices  
Time Tracking  
Knowledge Base Articles  
Scheduling  
Asset Managements  
 
get_tech_groups
Input Variable Input Value Description
id Integer value The ID number of a group. This can be the exact ID or you can use * as a wildcard.
name String value The name of a technician group. This can be the exact name or you can use * as a wildcard.
start_name String value This can be a single letter or the first few letters of a group name. The returned records will start with this value and go to the last record, unless you include the end_name and/or count variables. Example: If you include start_name=j in your request, only groups names starting with j or later in the alphabet will be returned.
end_name String value This can be a single letter or the first few letters of a group name. The returned records will stop at group names that start with this value. It can be used in conjunction with start_name or alone. When used alone the returned records will start with first record in the database. Example: If you include start_name=j in your request, only group names starting with j or later in the alphabet will be returned.
count Integer value This would be the number of records to return.
count_only String value Defines whether or not to return only the number of records. This is used in conjunction with the "page" variable or just to get the total number of records. Accepted values are "N" and "Y" (without the quotes). The default value is "N", and if this variable is excluded the detailed data is returned.
page Integer value This would be the number of the "page" of records to return. You must use a wildcard like "id=*" or "name=*" to get paged records, and you must also include the "count" variable". Example: &id=*&count=10&page=1.
order String value Defines the sort order of the returned records. You will need to examine the database to determine the exact field names to sort by. You may also include " ASC" (ascending) and " DESC" (descending) in the value for the sort direction (note the precedding blank space). For example, to sort by ID in descending order you would include the following in the URL: &order=ID DESC. You can optionally include the "order_direction" variable separately.
order_direction String value Defines the sort order direction of the returned records. Accepted values are "ASC" (ascending) and "DESC" (descending). THe default values is "ASC". For example, to sort by ID in descending order you would include the following in the URL: &order=ID&order_direction=DESC.

Output Variable URL Encoded Description
id No Unique ID of the database record.
name Yes The group name.
status No A comma separated list of the statuses the group has access to view.
category No A comma separated list of the categories the group has access to view.
source No A comma separated list of the sources the group has access to view.
Example Usage
http://localhost/API/default.aspx?key=your key here&action=get_tech_groups&name=*
Example Response
XML: 
<?xml version="1.0"?>
<technician_groups>
	<group>
		<id>4</id>
		<name>Group+1</name>
		<status>Open,Awating response,Assigned,Closed,Escalated</status>
		<category>Category1,Category2</category>
		<source>Email,Customer Call,Customer Portal,Live Support Chat</source>
	</group>
	<group>
		<id>5</id>
		<name>Group+2</name>
		<status>Open,Awating response,Assigned,Closed,Escalated</status>
		<category>Category1,Category2</category>
		<source>Email,Customer Call,Customer Portal,Live Support Chat</source>
	</group>
	<group>
		<id>6</id>
		<name>Group+3</name>
		<status>Open,Awating response,Assigned,Closed,Escalated</status>
		<category>Category1,Category2</category>
		<source>Email,Customer Call,Customer Portal,Live Support Chat</source>
	</group>
</technician_groups>
JSON: 
{
	"technician_groups": [
		{
			"id" : "4",
			"name" : "Group+1"
			"status" : "Open,Awating response,Assigned,Closed,Escalated"
			"category" : "Category1,Category2"
			"source" : "Email,Customer Call,Customer Portal,Live Support Chat"
		},
		{
			"id" : "5",
			"name" : "Group+2"
			"status" : "Open,Awating response,Closed,Assigned,Assigned,Assigned,Escalated,Escalated"
			"category" : "Category1,Category2"
			"source" : "Email,Customer Call,Customer Portal,Live Support Chat"
		},
		{
			"id" : "6",
			"name" : "Group+3"
			"status" : "Open,Awating response,Closed,Assigned,Assigned,Assigned,Escalated,Escalated"
			"category" : "Category1,Category2"
			"source" : "Email,Customer Call,Customer Portal,Live Support Chat"
		}
	]
}
URL DELIMITED: 
id=4&name=Group+1&status=Open,Awating response,Assigned,Closed,Escalated
&category=Category1,Category2&source=Email,Customer Call,Customer Portal,Live Support Chat
id=6&name=Group+2&status=Open,Awating response,Closed,Assigned,Assigned,Assigned,Escalated,Escalated
&category=Category1,Category2&source=Email,Customer Call,Customer Portal,Live Support Chat
id=5&name=Group+3&status=Open,Awating response,Closed,Assigned,Assigned,Assigned,Escalated,Escalated
&category=Category1,Category2&source=Email,Customer Call,Customer Portal,Live Support Chat