| Input Variable |
Input Value |
Description |
| id |
Integer value |
A valid schedule ID. This may be a single schedule ID, a comma separated list of IDs, or you may use * as a wildcard. |
| tid |
Integer value |
A valid ticket ID. This may be a single ticket ID, a comma separated list of ticket IDs, or you may use * as a wildcard |
| cid |
String value |
A valid customer ID. This may be a single customer ID, or you may use * as a wildcard |
| uid |
String value |
A valid technician ID. This may be a single technician ID, or you may use * as a wildcard |
| groups |
String value |
A valid group name. This may be a single group name, or you may use * as a wildcard |
| 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 schedule. |
| title |
Yes |
The title of the schedule. |
| category_id |
No |
The ID of the schedule category. |
| category_name |
No |
The name of the schedule category. |
| status |
No |
The status of the schedule. Possible response values are "A" (active), "H" (on hold), "C" (canceled) and "D" (complete). |
| created_by |
No |
The technician ID of the technician that created the schedule. |
| start_date |
No |
The data/time the schedule starts. |
| end_date |
No |
The data/time the schedule ends. |
| date_completed |
Yes |
The data/time the schedule was completed. |
| expected_duration |
Yes |
The expected duration of the schedule. |
| associated_tickets |
Yes |
A comma separated list of tickets the schedule is associated with. |
| associated_technicians |
Yes |
A comma separated list of technician IDs the schedule is associated with. |
| associated_groups |
Yes |
A comma separated list of group names the schedule is associated with. |
| associated_customers |
Yes |
A comma separated list of customer IDs the schedule is associated with. |
| recurring |
Yes |
A comma separated list of customer IDs the schedule is associated with. |
| recurrence_type |
Yes |
The type of recurring schedule. Possible return values are "I" (an interval) and "W" (certain days of the week). |
| interval |
Yes |
The interval at which the schedule reoccurs. |
| interval_unit |
Yes |
The interval unit. |
| weekdays |
Yes |
A comma separated list of the number of the days of the week the schedule should roccur. Possible return values are 1-7, where the number 1 represents to Sunday and 7 represents Saturday. For example, for a schedule that reoccurs every Monday, Wednesday and Friday, the value would be 2,4,6. |
| generate_ticket |
Yes |
Denotes if a ticket will be generated when the schedule is due. |
| reminder_date |
Yes |
The date/time a reminder will be emailed to the associated technicians. |
| parent_id |
No |
The ID of the schdule that created this occurrence. If the schedule is not an occurrence in a recurring schedule the value will be 0. |
| email |
Yes |
A comma separated list of email addresses that will receive email notifications about the schedule. |
| notes |
Yes |
Basic notes about the schedule. |
| Example Usage |
| http://localhost/API/default.aspx?key=your key here&action=get_kb_articles&id=* |
| Example Response |
| XML: |
<?xml version="1.0"?>
<schedules>
<schedule>
<id>382867</id>
<title>Sample title</title>
<category_id>1</category_id>
<category_name>Sample Category</category_name>
<status>A</status>
<created_by>guest</created_by>
<start_date>5/12/2014 10:00:00 PM</start_date>
<end_date>5/12/2014 10:30:00 PM</end_date>
<date_completed></date_completed>
<expected_duration>15</expected_duration>
<associated_tickets>5183</associated_tickets>
<associated_technicians>guest</associated_technicians>
<associated_groups>,,</associated_groups>
<associated_customers></associated_customers>
<recurring>N</recurring>
<recurrence_type></recurrence_type>
<interval>0</interval>
<interval_unit></interval_unit>
<weekdays></weekdays>
<generate_ticket>N</generate_ticket>
<reminder>5/12/2014 9:55:00 PM</reminder>
<parent_id>0</parent_id>
<email>guest@readydesk.com</email>
<notes>Sample notes</notes>
</schedule>
</schedules> |
| JSON: |
{
"schedules": [
{
"id" : "382867",
"title" : "Sample title",
"category_id" : "N",
"category_name" : "Sample Category",
"status" : "A",
"created_by" : "guest",
"start_date" : "5/12/2014 10:00:00 PM",
"end_date" : "5/12/2014 10:30:00 PM",
"date_completed" : "",
"expected_duration" : "15",
"associated_tickets" : "5183"
"associated_technicians" : "guest",
"associated_groups" : ",,",
"associated_customers" : "",
"recurring" : "N",
"recurrence_type" : "",
"interval" : "0",
"interval_unit" : "",
"weekdays" : "",
"generate_ticket" : "N",
"reminder" : "5/12/2014 9:55:00 PM",
"parent_id" : "0",
"email" : "guest@readydesk.com",
"notes" : "Sample notes",
}
]
} |
| URL DELIMITED: |
id=382867&title=11111111111111111111&category_id=1&category_name=Pet Sitting
&status=A&created_by=guest&start_date=5/12/2014 10:00:00 PM&end_date=5/12/2014 10:30:00 PM
&date_completed=&expected_duration=0&associated_tickets=5183&associated_technicians=guest
&associated_groups=,,&associated_customers=&recurring=N&recurrence_type=&interval=0&interval_unit=
&weekdays=&generate_ticket=N&reminder_date=5/1/2014 9:55:00 PM&parent_id=0&email=guest@readydesk.com
¬es=Sample notes |
