Retrieve specific calendar events.
Parameter |
Type |
Purpose |
Required |
Default |
---|---|---|---|---|
calid |
string |
A semicolon-separated list of calendar identifiers. The calid can be supplied in two formats:
|
N |
Current user’s calid |
compressed |
integer (0,1) |
This parameter is deprecated in this release and might be deleted in future releases. For compressed=0, returns less data. Specifically, it does not return the following parameters:rrules, rdates, exrules, and exdates. For compressed=1, all recurrence data is returned. |
N |
0 |
compstate |
semicolon- separated list of component state keywords |
The list of component states to fetch. For compstate values, see Fetching Component State Data |
N |
ALL |
emailorcalid |
integer (0, 1) |
0 = The calid is returned in the calendar address part of the ATTENDEE and ORGANIZER properties. The X-Token X-S1CS-EMAIL has the RFC 822 email address of the invitee or organization. 1 = The email address is returned in the calendar address part of the ATTENDEE and ORGANIZER properties. The X-Token X-S1CS-CALID contains the calid value. |
N |
0 |
emailorcalid |
integer (0, 1) |
0 = Returns calid in calendar address part of the attendee or organizer property and returns the RFC 822 address of the invitee or organizer in X-S1CS-EMAIL. 1 = Returns the RFC 822 compliant email address in the calendar address part of the attendee or organizer property, and returns the calid in X-S1CS-CALID. |
N |
0 |
fmt-out |
string |
The format for the returned data. Two format types: text/calendar text/xml |
Y |
text/calendar |
id |
unique identifier string |
The session identifier. |
Y |
N/A |
mod |
integer |
A modifier indicating which recurrences to retrieve. One of the following values: 1 = THISINSTANCE 2 = THISANDFUTURE 3 = THISANDPRIOR 4 = THISANDALL |
N |
1 (THISINSTANCE) |
recurring |
integer (0, 1) |
1 = Returns all components in compressed form , which contains a master entry plus exceptions 0 = Returns components expanded into individual instances. |
N |
0 not compressed |
relativealarm |
integer (0, 4) |
Return the alarm as relative or absolute. 0 = Return alarm values as absolute. 4 = Return alarms as originally created. |
N |
0 (absolute) |
rid |
ISO 8601 Date Time string |
The recurrence identifier for the event. For a nonrecurring event, set to 0. |
N |
0 |
tzid |
time zone ID string |
Time zone to use if the rid parameter is not in Zulu time. For example, “America/Los_Angeles” |
N |
server’s default time zone |
tzidout |
time zone ID string |
Time zone that returned data should be translated to. |
N |
Returns data in Zulu time |
uid |
sting |
The unique identifier for the event. |
Y |
N/A |
Use this command to retrieve the specified events and recurrences from the specified calendar. You must specify the id parameter with the command unless the specified calendar is a public calendar. The command returns recurrences as specified by the mod parameter. See Recurring Components– Overview
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 format.
The system uses the tzidout parameter to determine what time zone to translate retrieved data into before returning it. If the tzidout parameter is missing, the system returns the data in Zulu time.
If the operation is successful, the error number of 0 is appended to the error string. If a calendar cannot be accessed or is missing, the error number is appended to the error string.
This query retrieves an event with a specific id.
http://calendarserver/fetchevents_by_id.wcap ?id=bes6bbe2mu98uw9 &calid=jdoe &uid=3c11625900005ffe00000011000010b7 &fmt-out=text/calendar |
It returns one event:
BEGIN:VCALENDAR PRODID:-//SunONE/Calendar Hosting Server//EN METHOD:PUBLISH VERSION:6.0 X-NSCP-CALPROPS-LAST-MODIFIED:20011208T005613Z X-NSCP-CALPROPS-CREATED:20010913T223336Z X-NSCP-CALPROPS-READ:999 X-NSCP-CALPROPS-WRITE:999 X-NSCP-CALPROPS-RELATIVE-CALID:jdoe X-NSCP-CALPROPS-NAME:John Doe X-NSCP-CALPROPS-LANGUAGE:en X-NSCP-CALPROPS-PRIMARY-OWNER:jdoe X-NSCP-CALPROPS-TZID:America/Los_Angeles X-NSCP-CALPROPS-ACCESS-CONTROL-ENTRY:@@o^c^WDEIC^g X-NSCP-CALPROPS-ACCESS-CONTROL-ENTRY:@@o^a^RSF^g X-NSCP-CALPROPS-ACCESS-CONTROL-ENTRY:@^a^frs^g X-NSCP-CALPROPS-ACCESS-CONTROL-ENTRY:@^c^^g X-NSCP-CALPROPS-ACCESS-CONTROL-ENTRY:lucy^a^frs^g X-NSCP-CALPROPS-ACCESS-CONTROL-ENTRY:lucy^c^dw^g X-NSCP-CALPROPS-ACCESS-CONTROL-ENTRY:jjones^a^rs^g X-NSCP-CALPROPS-ACCESS-CONTROL-ENTRY:jjones^c^w^g X-NSCP-CALPROPS-ACCESS-CONTROL-ENTRY:@^p^r^g X-NSCP-CALPROPS-ACCESS-CONTROL-ENTRY:lucy^p^r^g X-NSCP-CALPROPS-ACCESS-CONTROL-ENTRY:jjones^p^r^g X-NSCP-CALPROPS-RESOURCE:0 BEGIN:VEVENT UID:3c11625900005ffe00000011000010b7 DTSTAMP:20011208T015845Z SUMMARY:eventA DTSTART:20011225T133000Z DTEND:20011225T143000Z CREATED:20011208T004409Z LAST-MODIFIED:20011208T010857Z PRIORITY:0 SEQUENCE:4 ORGANIZER;SENT-BY="jdoe@sesta.com"; X-NSCP-ORGANIZER-UID=jdoe; X-NSCP-ORGANIZER-SENT-BY-UID=jdoe:jdoe STATUS:CONFIRMED TRANSP:OPAQUE ATTENDEE;ROLE=REQ-PARTICIPANT;CUTYPE=INDIVIDUAL; PARTSTAT=ACCEPTED;CN="John Smith";RSVP=TRUE; X-NSCP-ATTENDEE-GSE-STATUS=2:jsmith X-NSCP-ORIGINAL-DTSTART:20020210T190000Z X-NSCP-LANGUAGE:en BEGIN:VALARM ACTION:EMAIL TRIGGER;VALUE=DATE-TIME:20011225T123000Z ATTENDEE:MAILTO:jdoe@sesta.com END:VALARM X-NSCP-DTSTART-TZID:America/Los_Angeles X-NSCP-TOMBSTONE:0 X-NSCP-ONGOING:0 X-NSCP-ORGANIZER-EMAIL:jdoe@sesta.com X-NSCP-GSE-COMPONENT-STATE; X-NSCP-GSE-COMMENT="REQUEST-COMPLETED":31074 END:VEVENT X-NSCP-WCAP-ERRNO:0 END:VCALENDAR