calid

string 

A semicolon-separated list of calendar identifiers. 

The 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

N 

Current user’s calid

component-type

keyword (event, todo, all)

Indicates which components to return: event returns only eventstodo returns only todos all returns both events and todos

If an invalid value is passed in, the system assumes all.

N 

all

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

dtend

Date Time string 

End time and date of events to be returned. 

A value of 0 means fetch all events.

N 

0

dtstart

Date Time string 

Start time and date of events to be returned. 

A value of 0 means fetch all events from the beginning of time.

N 

0

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

fetchorder

integer 

Specifies the order in which the events and todos are returned. 

The values are: 

• 0 - Special legacy order- mostly ascending order.

• 1 - Ascending order

• 2 - Descending order

  See Sorting Order of Returned Events and Todos in Calendar Server WCAP

N 

0

emailorcalid

integer (0, 1)

0 = Returns calid in calendar address part of the ATTENDEE or ORGANIZER property and returns the RFC 822 address of the invitee or organizer in X-S1CS-EMAIL.

1 = Returns the RFC 822 compliant email address in the calendar address part of the ATTENDEE or ORGANIZER property, and returns the calid in X-S1CS-CALID.

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 

maxResults

integer 

The maximum number of events and todos to be returned. When 0, no maximum is applied and the command returns all events and todos found.

N 

0

recurring

integer (0, 1)

1 = Returns all components in compressed form. Compressed form has master entry plus exceptions.

0 = Returns all components expanded with individual instances, not with a master record plus exceptions.

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)

tzid

time zone ID string 

Time zone to use if dtstart, or dtend parameters are not in Zulu time.

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