| Input Variable |
Input Value |
Description |
| tid |
Integer value |
The exact ticket number to search for. You may also use * as a wildcard. |
| keyword |
String value |
All or part of a word to search by. |
| status |
String value |
A valid ticket status to limit the returned values by. |
| uid |
String value |
A valid technician ID to limit the returned values by. This will be the assigned technician of the tickets. |
| group |
String value |
A valid technician group name to limit the returned values by. This will be the assigned group of the tickets. |
| cid |
String value |
A valid customer ID to limit the returned values by. This will be the customer associated with the ticket. |
| start_tid |
String value |
The first ticket ID to return. The returned records will start with this value and go to the last record, unless you include the end_tid and/or count variables. Example: If you include start_tid=45 in your request, only tickets with an ID of 45 or higher will be returned. |
| end_tid |
String value |
The first ticket ID to return. The returned records will end at this value, unless you include the count variable. Example: If you include end_tid=45 in your request, all records from 1 to 45 will be returned. If you were to also include "count=5", only the first 5 records would be returned. |
| start_date |
String value as date/time |
The first ticket open date/time to return. The returned records will start with this value and go to the last record, unless you include the end_date and/or count variables. Example: If you include start_date=2/1/2014 00:00:00 in your request, only tickets with an open date of 2/1/2014 00:00:00 or later will be returned. |
| end_date |
String value |
The last ticket open date/time to return. The returned records will end with this value. Example: If you include end_date=2/1/2014 00:00:00 in your request, only tickets with an open date of 2/1/2014 00:00:00 or earlier 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 "tid=*" 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 history entry ID. |
| history_tid |
Yes |
The ticket ID associated with the history entry. |
| history_date_added |
No |
The date/time of the history entry. |
| history_updatedby |
Yes |
The ID of the customer or technician that made the history entry. |
| history_update_type |
Yes |
The type of user that made the history entry. Possible return values are "customer", "technician" and "ADMIN" (witohut the quotes). |
| history_source |
Yes |
The source of the history entry. Possible return values are "Customer Portal", "Email", "Tech Interface" and "Admin Console" (witohut the quotes). |
| history_status |
Yes |
The ticket status at the time of the history entry. |
| history_assigned_tech |
Yes |
The assigned technician at the time of the history entry |
| history_assigned_group_id |
No |
The unique ID of the assigned group at the time of the history entry. |
| history_assigned_group_name |
No |
The name of the assigned group at the time of the history entry. |
| history_text |
Yes |
The text of the history entry. |
| history_attachments |
Yes |
A comma separated list of file attachment names that were added with the history entry. |
| history_internal |
Yes |
Denotes whether the history entry was marked as private. |
| history_msg_id |
Yes |
The message ID of the email that the history entry was generated from. This is used internally to prevent duplicate entries from emails stuck in the inbox. |
| Example Usage |
| http://localhost/API/default.aspx?key=your key here&action=get_history&tid=* |
| Example Response |
| XML: |
<?xml version="1.0"?>
<history>
<record>
<id>21447</id>
<history_tid>34</history_tid>
<history_date_added>09/01/2014 3:47:57 PM</history_date_added>
<history_updatedby>guest</history_updatedby>
<history_update_type>technician</history_update_type>
<history_source>Tech Interface</history_source>
<history_status>Open</history_status>
<history_assigned_tech>guest</history_assigned_tech>
<history_assigned_group_id>0</history_assigned_group_id>
<history_assigned_group_name></history_assigned_group_name>
<history_text>Example+text</history_text>
<history_attachments></history_attachments>
<history_internal></history_internal>
<history_msg_id></history_msg_id>
</record>
</history> |
| JSON: |
{
"history": [
{
"id" : "21447",
"history_tid" : "34",
"history_date_added" : "09/01/2014 3:47:57 PM",
"history_updatedby" : "guest",
"history_update_type" : "technician",
"history_source" : "Tech Interface",
"history_status" : "Open",
"history_assigned_tech" : "guest",
"history_assigned_group_id" : "0",
"history_assigned_group_name" : "",
"history_text" : "Example+text",
"history_attachments" : "",
"history_internal" : "",
"history_msg_id" : ""
}
]
} |
| URL DELIMITED: |
id=21447&history_tid=34&history_date_added=09/01/2014 3:47:57 PM&history_updatedby=guest
&history_update_type=technician&history_source=Tech Interface&history_status=Open&history_assigned_tech=guest
&history_assigned_group_id=0&history_assigned_group_name=&history_text=Example+text&history_attachments=
&history_internal=&history_msg_id= |
