test

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

Command: verifyevents_by_ids

Purpose

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

Parameters

Table 7–35 verifyevents_by_ids Parameters

Parameter  

Type  

Purpose  

Required  

Default  

calid

string 

Calendar from which to fetch events.  

N 

User’s default calendar 

fmt-out

string 

The format for the returned data. 

The three format types: 

text/calendartext/xml

N 

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 a public calendar.

N 

null 

rid

ISO 8601 Date Time string 

Corresponding set of comma separated event rids.

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

Y 

N/A 

tzid

time zone ID string 

Time zone, such as “America/Los_Angeles” 

N 

Server’s default time zone 

uid

string 

Comma separated set of event uids.

Y 

N/A 

Description

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

Returns

If the events 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 events are not found, if the rids were not zero (0), then the uids and rids are returned.

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

Example

Example 1 is in text/calendar format, and example 2 is in text/xml output.

Example 1 

http://calendarserver/verifyevents_by_ids.wcap
              ?id=$n3o2m05sx9v6t98t8u2p
              &calid=jdoe
              &uid=3bd9e72f000027cf0000000600002113;
                   3bd9e717000045030000000100002113;
                   3bd9e717000045030000000100002113;
                   3bd9cd4700002206000000010000202d
              &rid=0;20021027T230000Z;20021026T230000Z;0
              &fmt-out=text/calendar
BEGIN:VCALENDAR
  PRODID:-//SunONE/Calendar Hosting Server//EN
  VERSION:6.0
    BEGIN:VEVENT
  UID:3bd9e717000045030000000100002113
  RECURRENCE-ID:20021027T230000Z
  END:VEVENT
BEGIN:VEVENT
  UID:3bd9cd4700002206000000010000202d
  END:VEVENT
 END:VCALENDAR

Example 2 

http://calendarserver/verifyevents_by_ids.wcap
                     ?id=$n3o2m05sx9v6t98t8u2p
                     &calid=savri
                     &uid=3bd9e72f000027cf0000000600002113;
                          3bd9e717000045030000000100002113;
                          3bd9e717000045030000000100002113;
                          3bd9cd4700002206000000010000202d
                          &rid=0;20021027T230000Z;20021026T230000Z;0
                          &fmt-out=text/xml
<?xml version="1.0" encoding="UTF-8"?\>
 <iCalendar\>
 <iCal version="6.0" prodid="-//SunONE/Calendar Hosting Server//EN"\>
 <EVENT\>
 <UID\>3bd9e717000045030000000100002113</UID\>
 <RECURID\>20021027T230000Z</RECURID\>
 </EVENT\>
 <EVENT\>
 <UID\>3bd9cd4700002206000000010000202d</UID\>
 </EVENT\>
 </iCal\>
 </iCalendar\>