This is the newer, REST-based version of this API. If you are maintaining an older application, it might be using the legacy, non-RESTful version of this API, which can be found documented here.
Returns a page of calendar entries for the given project, ordered by due date. Each page contains up to 50 time entry records. To select a different page of data, set the “page” query parameter to a value greater than zero.
<calendar-entries>
<calendar-entry>
...
</calendar-entry>
<calendar-entry>
...
</calendar-entry>
...
</calendar-entries>
Returns a list of milestones for the given project. You can either return all milestones, or only those that are late, completed, or upcoming.
<request>
<!-- optional, defaults to all -->
<find>#{all|late|completed|upcoming}</find>
</request>
<calendar-entries>
<calendar-entry>
...
</calendar-entry>
<calendar-entry>
...
</calendar-entry>
...
</calendar-entries>
Returns a page of calendar events for the given project, ordered by due date. Each page contains up to 50 time entry records. To select a different page of data, set the “page” query parameter to a value greater than zero.
<calendar-entries>
<calendar-entry>
...
</calendar-entry>
<calendar-entry>
...
</calendar-entry>
...
</calendar-entries>
Creates a new calendar entry. To make the entry a milestone, set type to ‘Milestone’. To make a company responsible for the milestone, prefix the company id with a “c”.
<request>
<calendar-entry>
<title>#{title}</title>
<start-at type="date">#{start_at}</start-at>
<deadline type="{date|datetime}">#{deadline}</deadline>
<type>#{Milestone|CalendarEvent}</type>
<!-- Only applicable to milestones -->
<responsible-party>#{id}</responsible-party>
</calendar-entry>
</request>
<calendar-entry>
...
</calendar-entry>
Modifies a calendar entry. Supplying a different value for ‘type’ can convert a calendar event to a milestone and vice versa. You can use this to shift the deadline of a single milestone, and optionally shift the deadlines of subsequent milestones as well.
<request>
<calendar-entry>
<title>#{title}</title>
<deadline>#{deadline}</deadline>
....
</calendar-entry>
<!-- Only applicable to milestones -->
<move-upcoming-milestones>#{true|false}</move-upcoming-milestones>
<move-upcoming-milestones-off-weekends>#{true|false}</move-upcoming-milestones-off-weekends>
</request>
<calendar-entry>
...
</calendar-entry>
Returns a calendar entry identified by the given ID.
<calendar-entry>
...
</calendar-entry>
Deletes a calendar entry from the project.
Returns HTTP status code 200 on success.
Marks the specified milestone as complete.
<calendar-entry>
...
</calendar-entry>
Marks the specified milestone as uncomplete.
<calendar-entry>
...
</calendar-entry>