Zimbra REST API Reference:Get Calendar: Difference between revisions
No edit summary |
No edit summary |
||
Line 3: | Line 3: | ||
== REST API Method: Get Calendar == | == REST API Method: Get Calendar == | ||
Gets the calendar. | Gets the appointments from the calendar. The default folder is "calendar" but user-defined folders are also supported. | ||
=== URL === | === URL === | ||
Line 89: | Line 89: | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/calendar?fmt=xml | http://localhost:7070/home/john.doe/calendar?fmt=xml | ||
</pre> | |||
Retrieve the calendar from the user-defined folder "MyHolidays" in JSON format: | |||
<pre> | |||
http://localhost:7070/home/john.doe/myholidays?fmt=json | |||
</pre> | </pre> | ||
Revision as of 16:08, 19 January 2010
<< Back to Zimbra REST API Reference
REST API Method: Get Calendar
Gets the appointments from the calendar. The default folder is "calendar" but user-defined folders are also supported.
URL
http://localhost:7070/home/john.doe/calendar?{params}
HTTP Method
GET
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
start
. Optional. The start time range (milliseconds | yyyy/dd/mm | mm/dd/yyy).end
. Optional. The end time range (milliseconds | yyyy/dd/mm | mm/dd/yyy).query
. Optional. A query keyword.
HTML Format Parameters
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
.notoolbar
. Optional. Specifies to not include the toolbar (notoolbar=1
)color
. Optional. The color of the appointment text. Options include:Value Color 0 defaultColor 1 blue 2 cyan 3 green 4 purple 5 red 6 yellow 7 pink 8 gray 9 orange
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 from the user-defined folder "MyHolidays" in JSON format:
http://localhost:7070/home/john.doe/myholidays?fmt=json
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