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

Command: deletetodos_by_range

Purpose

Delete todos in a range from a calendar.

Note –

ENS notifications for appid are not yet implemented.

Parameters

Table 7–8 deletetodos_by_range Parameters


Parameter	Type	Purpose	Required	Default
`appid`	string	A runtime parameter that is not stored in the database. The 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	N/A
`calid`	string	Semicolon-separated list of calendar identifiers from which to delete todos. 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`
`dtstart`	Date Time string	Start time and date of todos to be deleted. A value of `0` means delete all todos from the beginning of time.	N	`0`
`dtend`	Date Time string	End time and date of todos to be deleted. A value of `0` means delete all todos up to the latest time.	N	`0`
`id`	unique identifier string	The session identifier.	Y	N/A
`smtp`	integer (`0`, `1`)	Send email cancellation to user with no calendar. `0` = No `1` = Yes	N	`1`

Description

Use this command to delete the todos that fall completely within the specified range from the specified calendars. If a range is not specified, it deletes all todos. For example, the following URL would delete just the todos that occur on the date March 1, 2002.

http://calendarserver/deletetodos_by_range.wcap?id=23423423434abc
              &calid=jdoe
              &dtstart=20020301T000000Z
              &dtend=20020301T235959Z

You must specify the id parameter with the command unless the specified calendar is a public calendar. The server returns data in the format specified by the fmt-out parameter. If this parameter is not passed, the data is returned in the default text/calendar.

Error Codes

If the operation is successful, the error number of 0 is appended to the error string. If an error occurs, the errno variable contains the error: FAILED: DELETETODOS_BY_RANGE_FAILED (23).