Sun Java System Calendar Server 6.3 WCAP Developer's Guide

Parameters

Table 3–5 deleteevents_by_id Parameters

Parameter  

Type  

Purpose  

Required  

Default  

appid

string 

A runtime parameter (not stored in the database) that specifies which application is making the request. ENS uses this parameter to determine which X-Tokens to return. Does not affect WCAP command output. 

For more information on the ENS X-Tokens, see theSun Java Communications Suite 5 Event Notification Service Guide

N/A 

calid

string 

Calendar identifier of event to delete. 

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/A 

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. Required unless the calendar is public. 

NULL

mod

integer 

1,2,3,4

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/A 

notify

integer 

0,1

A boolean indicating whether or not to notify attendees of this change. 

1 = Notify attendees. 0 = Do not notify attendees.

0

rid

string 

Recurrence identifier of the event, or semicolon-separated list of recurrence identifiers. 

If a list, it must have same number of elements as the uid list.

If there are no recurrences, the value is 0.

N/A 

smtp

integer (0, 1)

Send email cancellation to user with no calendar. 

0 = No

1 = Yes

1

tzid

time zone ID string 

Default time zone to use if the rid parameter does not have a time zone specified.

For example, “America/Los_Angeles” 

server’s default time zone 

uid

string 

Unique Identifier of an event to be deleted, or semicolon-separated list of unique identifiers. 

N/A