Untitled Page
API Overview
Example
Customers  
Companies  
Technicians  
Technician Groups  
Tickets  
Ticket History  
Ticket Attachments  
Billing Line Items  
Billing Invoices  
Time Tracking  
Knowledge Base Articles  
Scheduling  
Asset Managements  
 
add_schedule and update_schedule
The variables and values are the same for both add_schedule and update_schedule (with the exception of "id", which is only used by update_schedule). However, when using update_schedule, only the variables and values you supply will be updated.
Input Variable Input Value Description
title String value, limited to 255 characters. Required The title of the schedule.
category String value The category name of the schedule.
status String value The status of the schedule. Accepted values are "A" (active), "H" (on hold), "C" (canceled) and "D" (complete).
cids String value A comma separated list of customer IDs to associate the schedule with.
uids String value A comma separated list of technician IDs to associate the schedule with.
groups String value A comma separated list of technician group names to associate the schedule with.
start_date String value as a date/time value. Required The start date of the schedule.
end_date String value as a date/time value. The end date of the schedule.
date_completed String value as a date/time value. The date the schedule was completed.
recurring String value Defines if the schedule is a recurring schedule. Accepted values are "N" and "Y".
recurrence_type String value Defines which type of recurring schedule to create. Accepted values are "I" (an interval) and "W" (certain days of the week).
interval Integer value A number that defines at which interval the schedule should reoccur.
interval_unit String value Defines the interval unit. Accepted values are "MINUTES", "HOURS", "DAYS", "WEEKS", "MONTHS" and "YEARS" (without the quotes).
weekdays String value A comma separated list of the number of the days of the week the schedule should roccur. Accepted values are 1-7, where the number 1 represents to Sunday and 7 represents Saturday. For example, to have the schedule reoccur every Monday, Wednesday and Friday, the value would be 2,4,6.
remind_date String value as a date/time value. The date/time prior to the schedule start to email a reminder to the associated technicians and/or groups.
duration Integer value Defines the expected duration, in minutes.
duration_unit String value. The expected duration unit. Accepted values are "DAYS", "HOURS" and "MINS" (without the quotes).
actual_duration Integer value Defines the actual duration of the schedule, in minutes.
actual_duration_unit String value. The actual duration unit. Accepted values are "DAYS", "HOURS" and "MINS" (without the quotes).
additional_email String value. Additional email address to send email notifications to about the schedule.
notes String value. Basic notes about the schedule.

Output Variable URL Encoded Description
add_schedule No Schedule ID that was added.
Example Usage
http://localhost/API/default.aspx?key=your key here&action=add_schedule&title=Sample title&start_date=4/30/2014 02:00 PM&end_date=4/30/2014 03:00 PM
Example Response
XML: 
<?xml version="1.0"?>
<response>
    <added_schedule>5</added_schedule>
</response>
JSON: 
{
	"response": [
		{
			"added_schedule" : "5"
		}
	]
}
URL DELIMITED: 
added_schedule=5