Zimbra REST API Reference:Get FreeBusy: Difference between revisions
Malte Stretz (talk | contribs) (Remove old ZCS_6.0 prefixes) |
|||
(10 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]] | {{Template:TabHeader}} | ||
{{Template:Tab2|[[Zimbra_REST_API_Reference|Introduction]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Folder|Method: Get Folder]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Message|Method: Import Message]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Contacts|Method: Get Contacts]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Contacts|Method: Import Contacts]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Calendar|Method: Get Calendar]]}} | |||
{{Template:Tab1|[[Zimbra_REST_API_Reference:Get_FreeBusy|Method: Get FreeBusy]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Appointments|Method: Import Appointments]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Tasks|Method: Get Tasks]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Item|Method: Get Item]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase|Method: Get Briefcase]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase_Item|Method: Get Briefcase Item]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Export_Mailbox|Method: Export Mailbox]]}} | |||
{{Template:TabFooter}} | |||
{{Article Infobox|{{devel}}|{{ZCS 8.0}}|{{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 10: | Line 26: | ||
http://localhost:7070/home/john.doe/calendar.ifb?{params} | http://localhost:7070/home/john.doe/calendar.ifb?{params} | ||
</pre> | </pre> | ||
Go to [[ZCS_6.0:Zimbra_REST_API_Reference#Command_Format|Command Format]] | |||
=== HTTP Method === | === HTTP Method === | ||
Line 58: | Line 76: | ||
=== Usage Examples === | === Usage Examples === | ||
Export free/busy data | Export free/busy data for all calendars that are configured to be included in free/busy data: | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/calendar.ifb | http://localhost:7070/home/john.doe/calendar.ifb | ||
</pre> | </pre> | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/calendar?fmt= | http://localhost:7070/home/john.doe/calendar?fmt=ifb | ||
</pre> | </pre> | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/?fmt=ifb | http://localhost:7070/home/john.doe/?fmt=ifb | ||
</pre> | </pre> | ||
Export free/busy data | Export free/busy data for all calendars that are configured to be included in free/busy data for the next 60 days: | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/calendar.ifb?start=0d&end=60d | http://localhost:7070/home/john.doe/calendar.ifb?start=0d&end=60d | ||
Line 78: | Line 94: | ||
{{Article Footer|Zimbra Collaboration | {{Article Footer|Zimbra Collaboration Server 7.0|01/16/2010}} | ||
[[Category:REST]] | |||
[[Category:ZCS 7.0]] | |||
[[Category:ZCS 6.0]] | |||
[[Category:Developers]] |
Latest revision as of 17:25, 5 August 2014
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 for all calendars that are configured to be included in free/busy data:
http://localhost:7070/home/john.doe/calendar.ifb
http://localhost:7070/home/john.doe/calendar?fmt=ifb
http://localhost:7070/home/john.doe/?fmt=ifb
Export free/busy data for all calendars that are configured to be included in free/busy data for the next 60 days:
http://localhost:7070/home/john.doe/calendar.ifb?start=0d&end=60d