| Input Variable |
Input Value |
Description |
| id |
Integer value |
A valid time entry ID. You may also use * as a wildcard. |
| cid |
String value Required |
A valid customer ID to limit the returned values by. You may use * as a wildcard. |
| start_cid |
String value |
This can be a single letter or the first few letters of a customer ID. The returned records will have a customer ID that starts with this value and go to the last record, unless you include the end_cid and/or count variables. Example: If you include start_cid=j in your request, only time entries with a customer ID starting with j or later in the alphabet will be returned. |
| end_cid |
String value |
This can be a single letter or the first few letters of a customer ID. The returned records will stop at time entries that have a customer ID that starts with this value. It can be used in conjunction with start_cid or alone. When used alone the returned records will start with first record in the database. Example: If you include end_cid=j in your request, only time entries with a customer ID starting with j or earlier in the alphabet will be returned. |
| start_date |
String value as date/time |
The first time entry 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 time entries with a date of 2/1/2014 00:00:00 or later will be returned. |
| end_date |
String value |
The last time entry 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 time entries with a 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 "id=*" 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 time entry. |
| ticket_id |
Yes |
The ticket ID associated with the time entry. |
| customer_id |
No |
The customer ID associated with the time entry. |
| technician_id |
No |
The technician ID associated with the time entry. |
| date |
Yes |
The date the time entry was added. |
| time_entered |
No |
The amount of time that was entered. |
| category |
Yes |
The category of the time entry. |
| notes |
Yes |
Basic notes about the time entry. |
| Example Usage |
| http://localhost/API/default.aspx?key=your key here&action=get_time&cid=* |
| Example Response |
| XML: |
<?xml version="1.0"?>
<time_entries>
<time>
<id>5</id>
<ticket_id>1186</ticket_id>
<customer_id>demo</customer_id>
<technician_id>guest</technician_id>
<date>1/7/2013</date>
<time_entered>60</time_entered>
<category></category>
<notes>Example+notes</notes>
</time>
</time_entries> |
| JSON: |
{
"time_entries": [
{
"id" : "5",
"ticket_id" : "1186",
"customer_id" : "demo",
"technician_id" : "guest",
"date" : "1/7/2013",
"time_entered" : "60",
"category" : "",
"notes" : "Example+notes"
}
]
} |
| URL DELIMITED: |
id=5&ticket_id=1186&customer_id=demo&technician_id=guest&date=1/7/2013
&time_entered=60&category=¬es=Example+notes |
