Zimbra REST API Reference:Get FreeBusy: Difference between revisions
Line 51: | Line 51: | ||
<li><code>end=-2days</code> is "2 days ago"</li> | <li><code>end=-2days</code> is "2 days ago"</li> | ||
<li><code>start=+60mi</code> is "60 minutes from now"</li> | <li><code>start=+60mi</code> is "60 minutes from now"</li> | ||
<li><code>end=+1week</code> is "1 week from now< | <li><code>end=+1week</code> is "1 week from now"</li> | ||
<li><code>end=+6mon</code> is "6 months from now"</li> | <li><code>end=+6mon</code> is "6 months from now"</li> | ||
<li><code>start=1year</code> is "1 year from now"</li> | <li><code>start=1year</code> is "1 year from now"</li> |
Revision as of 17:41, 19 January 2010
<< Back to Zimbra REST API Reference
REST API Method: Get FreeBusy
Gets the calendar.
URL
http://localhost:7070/home/john.doe/calendar.ifb?{params}
HTTP Method
GET
Formats
ifb
(Go to Response Formats)
Requires Authentication
true
(Go to Authentication)
Parameters
fmt
. Optional. The response format. Defaults toifb
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).
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
Export free/busy data from the calendar folder (note: this is the free/busy data for the calendar folder only):
http://localhost:7070/home/john.doe/calendar.ifb
http://localhost:7070/home/john.doe/calendar?fmt=jfb
Export free/busy data across all calendars that are configured to be included in free/busy data:
http://localhost:7070/home/john.doe/?fmt=ifb
Export free/busy data from the calendar folder for the next 60 days:
http://localhost:7070/home/john.doe/calendar.ifb?start=0d&end=60d