Zimbra REST API Reference:Get FreeBusy: Difference between revisions
(Adding Tabs Templates) |
No edit summary |
||
Line 15: | Line 15: | ||
{{Template:TabFooter}} | {{Template:TabFooter}} | ||
{{Article Infobox|{{ | {{Article Infobox|{{devel}}|{{ZCS 7.0}}|{{ZCS 6.0}}|}}[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]] | ||
== REST API Method: Get FreeBusy == | == REST API Method: Get FreeBusy == | ||
Line 96: | Line 96: | ||
{{Article Footer|Zimbra Collaboration | {{Article Footer|Zimbra Collaboration Server 6.0|01/16/2010}} | ||
[[Category:REST]] | [[Category:REST]] | ||
[[Category:ZCS 7.0]] | |||
[[Category:ZCS 6.0]] | [[Category:ZCS 6.0]] | ||
[[Category:Developers]] | [[Category:Developers]] |
Revision as of 21:20, 6 September 2011
Article Information |
---|
This article applies to the following ZCS versions. |
<< Back to Zimbra REST API Reference
REST API Method: Get FreeBusy
Gets the calendar.
URL
http://localhost:7070/home/john.doe/calendar.ifb?{params}
Go to Command Format
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