API Method /calendars/events/ical

This function returns an iCalendar (RFC-2445) (not XML) document of events contained on a specified calendar.

Arguments

authentication
This method controls access via optional user authentication.
id string
The id of the calendar to use as the feed source.
date string
Limit this list of results to the specified date range. Date ranges are specified by label. Currently supported labels include: "All", "Future", "Past", "Today", "Last Week", "This Week", "Next week", and months by name, e.g. "October". (optional)
page_size integer
The desired number of results per page. Default: 50, Maximum: 50.(optional)
sort_order string
One of 'relevance', 'date', 'title', 'venue_name', or 'distance'. Default is 'date'. (optional)
sort_direction string
One of 'ascending' or 'descending'. Default is 'ascending'. (optional)

Example Request

Here's an example search URL:

http://api.evdb.com/rest/calendars/events/ical?...&id=C0-001-000002446-1

Output Parameters

Output from this function is an VCALENDAR block with the following constructs:
METHOD string
Always "PUBLISH". Required by iCal format.
CALSCALE string
Always "GREGORIAN". Required by iCal format.
PRODID string
Required by iCal format.
VERSION string
Required by iCal format.
X-WR-CALNAME string
The venue name.
VEVENT array
An array of VEVENT events. Each event entry has the following structure:
DTSTART string
The event start time, in ISO 8601 format (e.g. "20050301T190000Z").
DTEND string
The event end time, in ISO 8601 format (e.g. "20050301T190000Z").
DTSTAMP string
The last modified time, in ISO 8601 format (e.g. "20050301T190000Z").
SUMMARY string
The event title.
DESCRIPTION string
The event description.
LOCATION string
The venue name.
SEQUENCE integer
Always 0.
UID string
The unique ID for this event.
URL string
URL of associated event on Eventful site.
 

Example iCalendar Response (indented for clarity, actual response does not contain spaces.)

BEGIN:VCALENDAR
METHOD:PUBLISH
CALSCALE:GREGORIAN
PRODID:-//EVDB//www.evdb.com//EN
VERSION:2.0
X-WR-CALNAME:inging in California
BEGIN:VEVENT BEGIN:VEVENT
DTSTART:20051117T023000Z
DTEND:20051117T060000Z
DTSTAMP:20051103T034653Z
SUMMARY:Los Angeles Ducati Bike Night
DESCRIPTION:...
LOCATION:Ye Olde King's Head
SEQUENCE:0
UID:E0-001-000487927-6
URL:http://eventful.com/E0-001-000487927-6
END:VEVENT ...
END:VCALENDAR

Error Codes

This method may return these errors in an error document:

Authentication error
The specified user was not found or provided invalid credentials.
Missing parameter
A mandatory parameter was not set.
Not found
There is no venue with that identifier.
Read Access Denied
This Calendar is Marked Private.