API Method /events/rss
This function handles event search and returns the results in an RSS 2.0 (Specification) XML format.
Arguments
- authentication
- This method controls access via optional user authentication.
- keywords string
- The search keywords. (optional)
- location string
- A location name to use in filtering the search results. Locations in the form "San Diego", "San Diego, TX", "London, United Kingdom", and "Calgary, Alberta, Canada" are accepted, as are postal codes ("92122"). Full addresses ("1 Infinite Loop, Cupertino, CA") and common geocoordinate formats ("32.746682, -117.162741") are also accepted, but the "within" parameter is recommended in order to set a search radius. (optional)
- 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)
- within integer
- If within is set and the "location" parameter resolves to a specific geolocation, the search will be restricted to the specified radius. If the "location" parameter does not resolve to a specific location, this parameter is ignored. (optional)
- units string
- One of "mi" or "km", the units of the "within" parameter. Defaults to "mi".(optional)
- sort_order string
- One of 'popularity', 'date', 'title', 'relevance', or 'venue_name'. Default is 'date'.
(optional)
- sort_direction string
- One of 'ascending' or 'descending'. Default varies by sort_order.
(optional)
- page_size integer
- The desired number of results per page. Default: 50, Maximum: 50.(optional)
Example Request
Here's an example search URL:
http://api.eventful.com/rest/events/rss?...&keywords=concerts&location=san+diego
Output Parameters
Output from this function is an XML-formed RSS 2.0 channel with the following constructs:
- title string
- Summary of search query passed from input parameters.
- link string
- Source of RSS feed. (http://eventful.com/)
- description string
- Required by RSS 2.0 format.
- language string
- Default "en-US".
- copyright string
- Required by RSS 2.0 format.
- category string
- Required by RSS 2.0 format.
- generator string
- Required by RSS 2.0 format.
- docs string
- Required by RSS 2.0 format.
- ttl string
- Required by RSS 2.0 format.
-
-
- item tag
- Each item entry has the following structure:
-
-
- title string
- The event title.
- description string
- The event description. In RSS, this includes the start time, end time, venue, venueid, tags, and description.
- category string
- Unused.
-
-
-
- pubDate string
- The timestampt of the most recent modification. (e.g. "Mon, 26 Sep 2005 08:33:28 -0700")
-
- guid string
- The unique ID for this event, it is the event's Eventful URL.
-
-
-
- link string
- URL of associated event on Eventful site.
-
-
- pubDate string
- Required by RSS 2.0 format.
- lastBuildDate string
- Required by RSS 2.0 format.
Example RSS 2.0 Response
<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0">
<channel>
<title>Eventful results for "concerts" in "San Diego"</title>
<link>http://eventful.com</link>
<description>...</description>
<language>en-US</language>
<copyright>...</copyright>
<category>Events</category>
<generator>EVDB RSS Generator v1.2</generator>
<docs>http://blogs.law.harvard.edu/tech/rss</docs>
<ttl>60</ttl>
<item>
<title>Rolling Stones</title>
<link>http://eventful.com/events/E0-001-000318135-0</link>
<description>...</description>
<category></category>
<pubDate>Fri, 02 Sep 2005 11:34:53 -0700</pubDate>
<guid isPermaLink="true">http://eventful.com/events/E0-001-000318135-0</guid>
</item>
...
<pubDate>Fri, 02 Sep 2005 11:34:53 -0700</pubDate>
<lastBuildDate>Fri, 02 Sep 2005 11:34:53 -0700</lastBuildDate>
</channel>
</rss>
Error Codes
This method may return these errors in an error document:
- Authentication error
- The specified user was not found or provided invalid credentials.