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

Command: verifytodos_by_ids

Purpose

This command is used to verify if the todo specified with the uid and rid pair exists in the database.

Parameters

Table 7–36 verifytodos_by_ids Parameters

Parameter  

Type  

Purpose  

Required  

Default  

calid

string 

Calendar from which to fetch todos. 

User’s default calendar 

fmt-out

string 

The format for the returned data. 

The three format types: 

text/calendar

text/xml

text/calendar

id

string 

Uniquely identifies the session (session ID). 

The id must be specified with the command unless the calendar to fetch from is public calendar.

""

rid

ISO 8601 Date Time string 

Corresponding set of comma separated todo rids.

If this is a non-recurring todo, rid=0.

N/A 

tzid

time zone ID string 

Time zone, such as “America/Los_Angeles” 

Server’s default time zone 

uid

string 

Comma separated set of todo uids.

N/A 

Description

This command tries to fetch todos matching the passed in uid-rid pairs.

Returns

If the todos are found, the data is returned in the format specified by the fmt-out parameter. If no format was specified, the output defaults to text/calendar.

If the todos are not found, and if the rids were not zero, then the uids and rids are returned.

If the todos are not found and the rids were zero (0), then only the uids are returned.

Example

http://calendarserver/verifytodos_by_ids.wcap
                     ?id=bo35r2pr3e5po35r
                     &calid=jdoe
                     &uid=3bde188f0000472d0000000b00000399
                     &rid=20021029T200200Z
                     &fmt-out=text/xml
<?xml version="1.0" encoding="UTF-8"?\>
 <iCalendar\>
 <iCal version="6.0" prodid="-//SunONE/Calendar Hosting Server//EN"\>
 <TODO\>
 <UID\>3bde188f0000472d0000000b00000399</UID\>
 <RECURID\>20021029T200200Z</RECURID\>
 </TODO\>
 </iCal\>
 </iCalendar\>