busyonly
|
Integer (0, 1)
|
0 = return both busy and free periods1 =
return only busy periods
|
N
|
1
|
calid
|
string
|
The calendar identifier.
he calid can be supplied in two formats:
-
string - calendar identifier
-
mailto:rfc822addr - An email
address appended to “mailto:”. The address is mapped to a user with an
LDAP lookup, and then the user’s default calendar ID is used. Returns: X-SICS-EMAIL and X-NSCP-CALPROPS-RELATIVE-CALID
|
Y
|
Current user’s default calendar
|
dtstart
|
Date Time string
|
Start time of free-busy search.
|
Y
|
N/A
|
dtend
|
Date Time string
|
End time of free-busy search.
|
Y
|
N/A
|
duration
|
Integer
|
Free busy duration time in number of days.
|
N
|
60 or Default taken from ics.conf
|
fmt-out
|
string
|
The format for the returned data.
Two format types:
text/calendar
text/xml
|
Y
|
text/calendar
|
freebusybegin
|
integer
|
Offset in number of days from the value of ics.conf setting service.wcap.freebusybegin. Backs off the date range by the value of this
parameter. For example, a value of 30 would start the free-busy
range 30 days before the current time found in the ics.conf parameter.
|
N
|
Default ics.conf value is 30 (days)
|
freebusyend
|
integer
|
Offset in number of days from the value of ics.conf setting service.wcap.freebusyend to calculate the end of the free-busy range. Extends
the date found in the ics.conf parameter. For example, a value
of 30 would put the end date 30 days beyond the current setting.
|
N
|
Default ics.conf value is 30 (days)
|
id
|
unique identifier string
|
The session identifier.
|
Y
|
N/A
|
mail
|
email address
|
An email address used to compute free/busy time. The address must be present
in the LDAP. When an email address is passed in, all of the user's eligible calendars
are used in computing free-busy time. Eligible calendars are those for which this
user is the primary owner and havefbinclude=1.
|
Y/N
|
Either calid or mail must be specified
|
noredirect
|
boolean (0, 1)
|
Parameter passed in with command. When calendar can’t be found in the
Calendar Server database, if this parameter is set to 0, the server
passes back the redirect URL, if one is present, in the ics.conf parameter service.wcap.freebusy.redirecturl
If this parameter is set to 1, the server does not check
for the redirect URL, instead, it returns an error.
|
N
|
0
|
mail
|
RFC 822 address
|
Can be specified instead of calid. But must be a valid user
or group email address in the Calendar Server’s LDAP.
For free-busy lookup, all calendars that have this user as primary owner and
have the fbinclude calendar property set to 1 are
used in computing free-busy time.
|
Y/N
|
No default. But must be specified if the calid is not specified
|
tzid
|
time zone-ID string
|
Default time zone to use if dtstart, or dtend parameters
do not have a time zone specified.
For example, “America/Los_Angeles”
|
N
|
Server’s default time zone
|
tzidout
|
time zone ID string
|
Time zone to report returned data in.
|
N
|
Zulu time
|