Parameter |
Type |
Purpose |
Required |
Default |
---|---|---|---|---|
calid |
string |
A semicolon-separated list of calendar identifiers. The calid can be supplied in two formats:
|
N |
Current user’s calid |
compressed |
integer (0,1) |
This parameter is deprecated in this release and might be deleted in future releases. For compressed=0, returns less data. Specifically, it does not return the following parameters:rrules, rdates, exrules, and exdates. For compressed=1, all recurrence data is returned. |
N |
0 |
compstate |
semicolon- separated list of component state keywords |
The list of component states to fetch. For compstate values, see Fetching Component State Data Using Calendar Server WCAP |
N |
ALL |
emailorcalid |
integer (0, 1) |
0 = The calid is returned in the calendar address part of the ATTENDEE and ORGANIZER properties. The X-Token X-S1CS-EMAIL has the RFC 822 email address of the invitee or organization. 1 = The email address is returned in the calendar address part of the ATTENDEE and ORGANIZER properties. The X-Token X-S1CS-CALID contains the calid value. |
N |
0 |
fetchattach |
integer (0, 1) |
0 = Returns information about the attachments. 1 = Returns the attachment itself. |
N |
0 |
fmt-out |
string |
The format for the returned data. Two format types: text/calendar text/xml |
Y |
text/calendar |
id |
unique identifier string |
The session identifier. |
Y |
N/A |
mod |
integer |
A modifier indicating which recurrences to retrieve. One of the following values: 1 = THISINSTANCE 2 = Deprecated, see note. 3 = Deprecated, see note. 4 = THISANDALL Note – Values 2 and 3 were deprecated. Using these values results in undetermined behavior. |
N |
1 (THISINSTANCE) |
recurring |
integer (0, 1) |
1 = Returns all components in compressed form, with a master entry plus exceptions. 0 = Returns components in expanded form as individual instances. |
N |
0 (not compressed) |
relativealarm |
integer (0, 4) |
Return the alarm as relative or absolute. 0 = Return alarm values as absolute. 4 = Return alarms as originally created. |
N |
0 (absolute) |
rid |
ISO 8601 Date Time string |
The recurrence identifier for the todo. For a nonrecurring todo, set to 0. |
N |
0 |
tzid |
time zone ID string |
Time zone to use if the rid parameter is not in Zulu time. For example, “America/Los_Angeles” |
N |
server’s default time zone |
tzidout |
time zone ID string |
Time zone the returned data should be translated to. |
N |
Returns data in Zulu time |
uid |
string |
The unique identifier for the todo. |
Y |
N/A |