Sun Java System Calendar Server 6.3 WCAP Developer's Guide

Parameters

Table 3–16 fetchevents_by_id Parameters

Parameter  

Type  

Purpose  

Required  

Default  

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

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

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

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.

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.

0

fetchattach

integer (0, 1)

0 = Returns information about the attachments.

1 = Returns the attachment itself.

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 

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.


1

(THISINSTANCE)

recurring

integer (0, 1)

1 = Returns all components in compressed form , which contains a master entry plus exceptions

0 = Returns components expanded into individual instances.

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)

rid

ISO 8601 Date Time string 

The recurrence identifier for the event. For a nonrecurring event, set to 0.

0

tzid

time zone ID string 

Time zone to use if the rid parameter is not in Zulu time.

For example, “America/Los_Angeles” 

server’s default time zone 

tzidout

time zone ID string 

Time zone that returned data should be translated to. 

Returns data in Zulu time 

uid

string 

The unique identifier for the event. 

N/A