Sun Java System Calendar Server 6.3 WCAP Developer's Guide

Parameters.

Table 3–12 fetchcomponents_by_attendee_error Parameters

Parameter  

Type  

Purpose  

Required  

Default  

attendee

string 

The attendee’s calid to search on. The command searches the calendars specified in the calid parameter for all errors in events for this attendee.

If this parameter is not specified, the command searches the primary owner’s calendars for all event errors for any attendee. 

Refer to Calendar Server WCAP Attendee Overview for a list of possible sub-parameters to pass-in.

N/A 

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

Current user’s calid

component-type

keyword (event, todo, all)

Indicates which components to return: event returns only events

todo returns only todos

all returns both events and todos

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

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.

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.

0

fetchorder 

integer 

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

The values are: 

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 ATTENDE or ORGANIZER property, and returns the calid in X-S1CS-CALID.

0

fmt-out

string 

The format for the returned data. 

Two format types: 

text/calendar

text/xml

text/calendar

id

unique identifier string 

The session identifier. 

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.

0

recurring

integer (0, 1)

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

0 = Returns components expanded, but without master record and exceptions.

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.

0 (absolute)

tzidout

standard time zone string 

The time zone returned data is translated to. 

Returns data in Zulu time