Netsyms/Mods-for-HESK-Netsyms
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Some improvements on category, more API documentation

Browse Source
This commit is contained in:
Mike Koch 2015-11-27 22:12:20 -05:00
parent 4d75b39766
commit 16d365bcad
4 changed files with 45 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
api/category/index.php
View File

@ -13,6 +13,31 @@ hesk_dbConnect();
// Routing // Routing
$request_method = $_SERVER['REQUEST_METHOD']; $request_method = $_SERVER['REQUEST_METHOD'];
/**
* @api {get} /category Retrieve a ticket category
*
* @apiParam {Number} [id] The ID of the category. Omit for all categories.
*
* @apiSuccess {Number} id ID of the category
* @apiSuccess {String} name The name of the category
* @apiSuccess {Integer} cat_order The order of the category (in multiples of 10)
* @apiSuccess {Boolean} autoassign `true` if tickets set to this category are automatically assigned.<br>`false` otherwise
* @apiSuccess {Integer} type `0` - Public<br>`1` - Private
* @apiSuccess {Integer} priority Default priority of tickets created in this category
* @apiSuccess {Integer} manager User ID of the category manager, or `null` if there is no manager.
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
* "id": 1,
* "name": "General",
* "cat_order": 10,
* "autoassign": true,
* "type": 0,
* "priority": 2,
* "manager": 0
* }
*/
if ($request_method == 'GET') { if ($request_method == 'GET') {
if (isset($_GET['id'])) { if (isset($_GET['id'])) {
$results = get_category($hesk_settings, $_GET['id']); $results = get_category($hesk_settings, $_GET['id']);

4
api/dao/category_dao.php
View File

@ -16,10 +16,10 @@ function get_category($hesk_settings, $id = NULL) {
while ($row = hesk_dbFetchAssoc($response)) { while ($row = hesk_dbFetchAssoc($response)) {
$row['id'] = intval($row['id']); $row['id'] = intval($row['id']);
$row['cat_order'] = intval($row['cat_order']); $row['cat_order'] = intval($row['cat_order']);
$row['autoassign'] = intval($row['autoassign']); $row['autoassign'] = $row['autoassign'] == 1;
$row['type'] = intval($row['type']); $row['type'] = intval($row['type']);
$row['priority'] = intval($row['priority']); $row['priority'] = intval($row['priority']);
$row['manager'] = intval($row['manager']); $row['manager'] = intval($row['manager']) == 0 ? NULL : intval($row['manager']);
$results[] = $row; $results[] = $row;
} }

15
api/priority/index.php
View File

@ -7,6 +7,21 @@ require_once(API_PATH . 'core/output.php');
// Routing // Routing
$request_method = $_SERVER['REQUEST_METHOD']; $request_method = $_SERVER['REQUEST_METHOD'];
/**
* @api {get} /priority Retrieve a ticket priority
*
* @apiParam {Number} [id] The ID of the priority. Omit for all priorities.
*
* @apiSuccess {Number} id ID of the priority
* @apiSuccess {String} key The language file key of the priority
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
* "id": 0,
* "key": "critical"
* }
*/
if ($request_method == 'GET') { if ($request_method == 'GET') {
$results = []; $results = [];
$critical['id'] = 0; $critical['id'] = 0;

5
api/status/index.php
View File

@ -14,9 +14,9 @@ hesk_dbConnect();
$request_method = $_SERVER['REQUEST_METHOD']; $request_method = $_SERVER['REQUEST_METHOD'];
/** /**
* @api {get} /status Retrieve a status * @api {get} /status Retrieve a ticket status
* *
* @apiParam {Number} [id] The ID of the status * @apiParam {Number} [id] The ID of the status. Omit for all statuses.
* *
* @apiSuccess {Number} id ID of the status * @apiSuccess {Number} id ID of the status
* @apiSuccess {String} textColor The text color used for the status on the web interface * @apiSuccess {String} textColor The text color used for the status on the web interface
@ -40,6 +40,7 @@ $request_method = $_SERVER['REQUEST_METHOD'];
* @apiSuccess {String} keys.text The translated string of the status * @apiSuccess {String} keys.text The translated string of the status
* *
* @apiSuccessExample {json} Success-Response: * @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* { * {
* "id": 0, * "id": 0,
* "textColor": "#FF0000", * "textColor": "#FF0000",