Sun Java System Calendar Server 6 2005Q4 Developer's Guide

Parameters

Table 7–7 deletetodos_by_id Parameters

Parameter  

Type  

Purpose  

Required  

Default  

appid

string 

A runtime parameter that is not stored in the database. This parameter 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 System Communications Services 6 2005Q4 Event Notification Service Guide

N/A 

calid

string 

Calendar identifier of the todos 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. 

N/A 

mod

integer 

A modifier indicating which recurrences to delete, or semicolon-separated list of modifiers. If a list, must have same number of elements as uid list.

One of the following values: 

1 = THISINSTANCE

2 = THISANDFUTURE

3 = THISANDPRIOR

4 = THISANDALL

N/A 

notify

integer (0,1)

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

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

0

rid

string 

The recurrence identifier of the todo, or a semicolon-separated list of recurrence identifiers. 

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

If there are no recurrences, the value is 0.

N/A 

tzid

time zone ID string 

Default time zone to use if dtstart, or dtend parameters do not have a time zone specified.

For example, “America/Los_Angeles” 

server’s default time zone 

uid

string 

The unique identifier of a todo to be deleted, or a semicolon-separated list of unique identifiers. 

N/A