Zimbra REST API Reference:Get Calendar: Difference between revisions
Line 29: | Line 29: | ||
<ul> | <ul> | ||
<li><code>view</code>. Optional. Designates the display when using the <code>html</code> format. Options include: day, week, workWeek, month. | <li><code>view</code>. Optional. Designates the display when using the <code>html</code> format. Options include: <code>day, week, workWeek, month</code>. | ||
<li><code>date</code>. Optional. Designates the date to display when using the <code>html</code> format. Format is date=[yyyymmdd]. For example, 2/15/2010 is <code>date=20100215</code>. | <li><code>date</code>. Optional. Designates the date to display when using the <code>html</code> format. Format is date=[yyyymmdd]. For example, 2/15/2010 is <code>date=20100215</code>. | ||
<li><code>color</code>. Optional. The color of the appointment text. | <li><code>color</code>. 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 | |||
|} | |||
</li> | |||
</ul> | |||
</li> | </li> | ||
<li><code>notoolbar</code>. Optional. Specifies to not include the toolbar (<code>notoolbar=1</code>)</li> | <li><code>notoolbar</code>. Optional. Specifies to not include the toolbar (<code>notoolbar=1</code>)</li> |
Revision as of 18:00, 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
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
.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
notoolbar
. Optional. Specifies to not include the toolbar (notoolbar=1
)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