Zimbra REST API Reference:Get Calendar: Difference between revisions
Line 30: | Line 30: | ||
=== Usage Examples === | === Usage Examples === | ||
Download the calendar as | Download the calendar as an iCalendar (ICS) file: | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/calendar | http://localhost:7070/home/john.doe/calendar |
Revision as of 17:34, 17 January 2010
<< Back to Zimbra REST API Reference
REST API Method: Get Calendar
Gets the calendar.
URL
http://localhost:7070/home/john.doe/calendar?{params}
Formats
ics,json,xml,rss,atom,html
(Go to Response Formats)
Requires Authentication
true
(Go to Authentication)
Parameters
fmt
. Optional. The response format. Defaults toics
view
. Optional. Designates the display when using thehtml
format. Options include: day, week, workWeek, month.date
. Optional. Designates the date to display when using thehtml
format. Format is date=[yyyymmdd]. For example, 2/15/2010 isdate=20100215
.query
. Optional. A query keyword.
Usage Examples
Download the calendar as an iCalendar (ICS) file:
http://localhost:7070/home/john.doe/calendar
http://localhost:7070/home/john.doe/calendar?fmt=ics
Retrieve the calendar in XML format:
http://localhost:7070/home/john.doe/calendar?fmt=xml
Retrieve the calendar in JSON format:
http://localhost:7070/home/john.doe/calendar?fmt=json
Retrieve the calendar HTML "month" view:
http://localhost:7070/home/john.doe/calendar.html
http://localhost:7070/home/john.doe/calendar?fmt=html
Retrieve the calendar HTML "workWeek" view:
http://localhost:7070/home/john.doe/calendar?fmt=html&view=workWeek
Retrieve the calendar HTML "day" view on January 23, 2009 (01/23/2009):
http://localhost:7070/home/john.doe/calendar?fmt=html&view=day&date=20090123