From b94ea9399169aa3a53649a87c3075761253b590b Mon Sep 17 00:00:00 2001 From: Mike Koch Date: Sun, 29 Nov 2015 11:50:47 -0500 Subject: [PATCH] Update some documentation --- api/ticket/index.php | 24 ------------------------ 1 file changed, 24 deletions(-) diff --git a/api/ticket/index.php b/api/ticket/index.php index 25e2575d..30cf1470 100644 --- a/api/ticket/index.php +++ b/api/ticket/index.php @@ -33,25 +33,13 @@ $request_method = $_SERVER['REQUEST_METHOD']; * @apiSuccess {String} subject The subject of the ticket * @apiSuccess {String} message The original message of the ticket * @apiSuccess {String} dt The date and time the ticket was submitted, in `YYYY-MM-DD hh:mm:ss` - * @apiSuccess {Integer} articles The knowledgebase article IDs suggested when the user created the ticket - * @apiSuccess {String} ip The IP address of the submitter - * @apiSuccess {String} language The language the ticket was submitted in * @apiSuccess {Integer} status The ID of the status the ticket is set to - * @apiSuccess {Integer} owner The user ID of the ticket owner - * @apiSuccess {String} time_worked The total time worked on the ticket, in `hh:mm:ss` * @apiSuccess {Boolean} archive `true` if the ticket is tagged
`false` otherwise * @apiSuccess {Boolean} locked `true` if the ticket is locked
`false` otherwise * @apiSuccess {Binary[]} attachments Array of attachments, in base-64 encoded binary * @apiSuccess {Integer[]} merged Array of merged ticket IDs - * @apiSuccess {String} history HTML markup of the entire "Audit Trail" section * @apiSuccess {String} custom1-20 Custom fields 1-20's values. - * @apiSuccess {Integer} parent The ID of the ticket linked to this ticket - * @apiSuccess {String} latitude The latitudinal coordinate of the user's location, or one of the corresponding error codes. - * @apiSuccess {String} longitude The longitudinal coordinate of the user's location, or one of the corresponding error codes. * @apiSuccess {Boolean} html `true` if the ticket was created with HTML encoding
`false` otherwise - * @apiSuccess {String} user_agent The user agent of the user who submitted the ticket - * @apiSuccess {Integer} screen_resolution_width The width of the screen resolution of the user who submitted the ticket - * @apiSuccess {Integer} screen_resolution_height The height of the screen resolution of the user who submitted the ticket * * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK @@ -65,17 +53,11 @@ $request_method = $_SERVER['REQUEST_METHOD']; * "subject": "test", * "message": "test", * "dt": "2014-12-28 00:57:26", - * "articles": null, - * "ip": "127.0.0.1", - * "language": null, * "status": 3, - * "owner": 1, - * "time_worked": "00:05:07", * "archive": true, * "locked": true, * "attachments": "", * "merged": "", - * "history": "
  • 2014-12-28 06:57:28 | ticket created by Your name (mkoch)
  • 2014-12-31 21:00:59 | closed by Your name (mkoch)
  • 2014-12-31 21:01:05 | status changed to Waiting reply by Your name (mkoch)
  • 2014-12-31 21:01:58 | closed by Your name (mkoch)
  • 2015-01-17 16:21:18 | closed by Your name (mkoch)
  • 2015-01-17 16:21:31 | closed by Your name (mkoch)
  • 2015-01-17 16:22:05 | closed by Your name (mkoch)
  • 2015-01-17 16:24:06 | status changed to by Your name (mkoch)
  • 2015-01-17 16:25:40 | status changed to On Hold by Your name (mkoch)
  • 2015-01-17 16:25:53 | status changed to In Progress by Your name (mkoch)
  • 2015-01-17 21:39:11 | locked by Your name (mkoch)
  • ", * "custom1": "1420671600", * "custom2": "", * "custom3": "", @@ -96,13 +78,7 @@ $request_method = $_SERVER['REQUEST_METHOD']; * "custom18": "", * "custom19": "", * "custom20": "", - * "parent": 139, - * "latitude": "E-0", - * "longitude": "E-0", * "html": false, - * "user_agent": null, - * "screen_resolution_width": null, - * "screen_resolution_height": null * } * * @apiError (noTokenProvided) 400 No `X-Auth-Token` was provided where it is required