Help Desk API Example

API Options & Examples

company_add company_delete company_delete_list company_edit company_list company_view emailparser_parse group_add group_delete group_delete_list group_edit group_list group_view singlesignon singlesignon_sameserver ticket_add ticket_delete ticket_delete_list ticket_list ticket_reply_admin ticket_reply_public ticket_submit ticket_view user_add user_delete user_delete_list user_edit user_list user_list_group user_view user_view_email user_view_username

Example of using company_delete_list

This is an example of using the company_delete_list call with PHP. You can replicate the same idea in virtually any other programming language. The example shown is using "serialize" as the output format. You can change that to XML or JSON if you would like.

<?php
/**
 * This sample code is designed to connect to your Help Desk Software using the Unserialization method.
 */

// By default, this sample code is designed to get the result from your
// server (where Help Desk is installed) and to print out the result
$url    = 'http://yourdomain.com/path/to/hd';

$params = array(

// the API Username and Password are the same as your login access to the Admin panel
	// replace these with your info
	'api_user'     => 'YOUR_USERNAME',
	'api_pass'     => 'YOUR_PASSWORD',

// this is the action that deletes a company based on the ID you provide
	'api_action'   => 'company_delete_list',

// define the type of output you wish to get back
	// possible values:
	// - 'xml'  :      you have to write your own XML parser
	// - 'json' :      data is returned in JSON format and can be decoded with
	//                 json_decode() function (included in PHP since 5.2.0)
	// - 'serialize' : data is returned in a serialized format and can be decoded with
	//                 a native unserialize() function
	'api_output'   => 'serialize',

// a comma-separated list of IDs of companies you wish to delete
	'ids'          => '4,5,6',
);

// This section takes the input fields and converts them to the proper format
$query = "";
foreach( $params as $key => $value ) $query .= $key . '=' . urlencode($value) . '&';
$query = rtrim($query, '& ');

// clean up the url
$url = rtrim($url, '/ ');

// This sample code uses the CURL library for php to establish a connection,
// submit your request, and show (print out) the response.
if ( !function_exists('curl_init') ) die('CURL not supported. (introduced in PHP 4.0.2)');

// If JSON is used, check if json_decode is present (PHP 5.2.0+)
if ( $params['api_output'] == 'json' && !function_exists('json_decode') ) {
	die('JSON not supported. (introduced in PHP 5.2.0)');
}

// define a final API request - GET
$api = $url . '/admin/api.php?' . $query;

$request = curl_init($api); // initiate curl object
curl_setopt($request, CURLOPT_HEADER, 0); // set to 0 to eliminate header info from response
curl_setopt($request, CURLOPT_RETURNTRANSFER, 1); // Returns response data instead of TRUE(1)
//curl_setopt($request, CURLOPT_SSL_VERIFYPEER, FALSE); // uncomment if you get no gateway response and are using HTTPS

$response = (string)curl_exec($request); // execute curl fetch and store results in $response

// additional options may be required depending upon your server configuration
// you can find documentation on curl options at http://www.php.net/curl_setopt
curl_close($request); // close curl object

if ( !$response ) {
	die('Nothing was returned. Do you have a connection to Help Desk server?');
}

// This line takes the response and breaks it into an array using:
// JSON decoder
//$result = json_decode($response);
// unserializer
$result = unserialize($response);
// XML parser...
// ...

// Result info that is always returned
echo 'Result: ' . ( $result['result_code'] ? 'SUCCESS' : 'FAILED' ) . ' ';
echo 'Message: ' . $result['result_message'] . ' ';

// The entire result printed out
echo 'The entire result printed out: ';
echo '<pre>';
print_r($result);
echo '</pre>';

// Raw response printed out
echo 'Raw response printed out: ';
echo '<pre>';
print_r($response);
echo '</pre>';

// API URL that returned the result
echo 'API URL that returned the result: ';
echo $api;

API: company_delete_list

Example of using company_delete_list