attrset

integer (0,1)

Allows the user to indicate to the server if they want to retrieve the complete event or task data from the server, or if they only want a subset of the data for each matching component returned. 

Intended to minimize the amount of data returned and thereby the amount of processing a client must do. 

0 = Returns the following parameters: uid, dtstart, dtend, summary.

1 = Returns the following parameters: uid, rrule, dtstart, dtend, summary, class, location, valarm.

2 = Returns the full event.

N 

2

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 todosall 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 = 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

filter

string 

A string containing a name-value pair representing a filter for an event or todo.

The name can be any valid event or todo RFC 2445 compliant property.

The value is what to match in the component.

Only single valued filters are supported.  

For example: CATEGORY=birthday

Various partial matches are allowed using *, for example:

• For contains: *string*

• For begins with: string*

• For ends with: *string

  For the name-value pair ALL=string, the following components are checked for a match to string: DESCRIPTION, SUMMARY, ATTENDEE, LOCATION, ORGANIZER.

N 

NULL

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

filter

string 

Name/value pair that represents a filter for an event. The left side is any valid property of an event or todo from RFC 2445. Only single valued filters are currently supported. For example: filter=(ATTENDEE=jdoe@sesta.com) where the left side of the value is a property from RFC 2445 and the right side is the value to match in the events and todos. The following are the only supported properties for filtering:

• ATTENDEE

• ORGANIZER

• SUMMARY

• DESCRIPTION

• LOCATION

• CLASS

• CATEGORY

N 

NULL

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 

invitecount

integer (0, 1)

1 = Requests the server to return the open invitations count, that is, events where PARSTAT=needs-action. The integer count is returned in the X-Token X-S1CS-CALPROPS-INVITATION-COUNT.

if more than one calid is specified in the calid parameter, the open invitation count for each calendar is returned in the corresponding iCal or XML block.

0 = Count not requested.

N 

0

invitecount

integer (0, 1)

0 = Do not return a count of the open invitations. Open invitations are events and todos where PARTSTAT=needs-action.

1 = Returns the count of open invitations in X-S1CS-CALPROPS-INVITATION-COUNT

If more than one calid is specified, the open invitation count for each calendar is returned in the corresponding iCal or XML block. 

N 

0

maxResults

integer 

Currently not implemented. 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 = Return all components in compressed form. The compressed form has master entry plus exceptions.

0 = Return components as individual instances, without master record and 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)

searchOpts

integer 

(0,1,2,3)

How to perform the search. One of the following: 

0 = CONTAINS

1 = BEGINS_WITH

2 = ENDS_WITH

3 = EXACT

N 

0

tzid

time zone ID string 

Default 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