Zimbra REST API Reference:Get Calendar

Introduction

Method: Get Folder

Method: Import Message

Method: Get Contacts

Method: Import Contacts

Method: Get Calendar

Method: Get FreeBusy

Method: Import Appointments

Method: Get Tasks

Method: Get Item

Method: Get Briefcase

Method: Get Briefcase Item

Method: Export Mailbox

Article Information
This article applies to the following ZCS versions. ZCS 8.0 ZCS 7.0 ZCS 6.0

<< 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}

Go to Command Format

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 to ics format.
• start. Optional. The start time range (milliseconds | yyyy/dd/mm | mm/dd/yyy | relative dates ).
• end. Optional. The end time range (milliseconds | yyyy/dd/mm | mm/dd/yyy | relative dates ).
• query. Optional. A query string.

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.
• 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

Relative Dates

Relative dates are either in the future (p/+/{not-specified}) or the past (m/-), along with a numeric value, followed by the units. For units, everything after the first character is ignored (except for the "mi" case):

• m(onths)
• mi(nutes)
• d(ays)
• w(eeks)
• h(ours)
• y(ears)

Examples:

• start=1day is "1 day from now"
• end=+2days is "2 days from now"
• start=p1day is "1 day from now"
• end=-2days is "2 days ago"
• start=+60mi is "60 minutes from now"
• end=+1week is "1 week from now"
• end=+6mon is "6 months from now"
• start=1year is "1 year from now"

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