Zimbra REST API Reference:Get Calendar

<< 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 to ics
  • query. Optional. A query keyword.

HTML Format Parameters

  • view. Optional. Designates the display when using the html format. Options include: day, week, workWeek, month.
  • date. Optional. Designates the date to display when using the html format. Format is date=[yyyymmdd]. For example, 2/15/2010 is date=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


Verified Against: Zimbra Collaboration Suite 6.0 Date Created: 01/16/2010
Article ID: https://wiki.zimbra.com/index.php?title=Zimbra_REST_API_Reference:Get_Calendar Date Modified: 2010-01-17



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »


Jump to: navigation, search