API Method /events/get
Given an event ID, returns the event data associated with that event. See http://eventful.com/events/E0-001-000278174-6 for an example interface.
Arguments
- authentication
- This method controls access via optional user authentication.
- id string
- The ID of the requested event.
Example Request
Here's an example request URL:
http://api.evdb.com/rest/events/get?...&id=E0-001-000278174-6
Output Parameters
Output from this function is an XML block with the following constructs.
- id string
- The unique ID for this event. Presented as an object attribute.
See the example below.
- url string
- The page URL for this event on eventful.com.
- title string
- The event title.
- description string
- The event description.
- Time Information.
- The start_time and stop_time fields are provided in "floating" time, which should be interpreted as "the time appropriate for the venue."
- start_time string
- The event start time, in ISO 8601 format (e.g. "2005-03-01 19:00:00").
- stop_time string
- The event stop time, if any, in ISO 8601 format (e.g. "2005-03-01 19:00:00").
- all_day boolean
- A false value (0) indicates that the start_time and stop_time are as listed. If the all_day flag is set to 1 (all day) or 2 (no time specified), then the time should be omitted from start_time and stop_time.
- tz_id integer
- Eventful's internal timezone identifier. Not terribly useful unless you wish to
give this back to Eventful at some time in the future.
- tz_olson_path string
- The event timezone, as listed in the Olson timezones database (e.g. "America/New_York").
Sparsely populated, don't expect time zones on many events
- tz_city string
- tz_country string
- tz_city and tz_country together represent the city/country pair timezone
choice made by the user.
- venue_name string
- The venue name.
- venue_id string
- The venue ID.
- venue_type string
- The venue type (e.g. "Park", "Arena", etc.)
- venue_display boolean
- Based on Venue_type we sometimes do not display the venue name on our site (e.g. "Country","U.S.A.","92122","Postal Code"). this may help you with your presentation
- address string
- The venue address.
- city string
- The venue city.
- region string
- The venue state/province/other name.
- postal_code string
- The venue postal code.
- country string
- The venue country name.
- latitude signed float
- The venue latitude.
- longitude signed float
- The venue longitude.
- geocode_type string
- The method used to geocode the venue latitude and longitude.
- created string
- The date & time the event was initially created.
- modified string
- The date & time the event was last modified.
- owner string
- The username of the event owner.
- privacy integer
- Access level for this event. 1 is public, 2 is private, 3 is private but shareable.
- free boolean
- 1 if the event is free, 0 otherwise, blank if unknown.
- price string
- The price descriptive string, if any.
- withdrawn boolean
- 1 if the event was "withdrawn", 0 otherwise.
- withdrawn_note string
- A note explaining why the event was withdrawn
- parents
- A list of parent events associated with the event. Each parent entry has the
following structure:
- id string
- The event ID for the parent event.
- title string
- The title of the parent event.
- children
- A list of child events associated with the event. Each child entry has the
following structure:
- id string
- The event ID for the child event.
- title string
- The title of the child event.
- links
- A list of links associated with the event. Each link entry has the
following structure:
- id integer
- This ID plus the Event ID is the unique identifer for a link.
- url string
- The URL of this link.
- type string
- The link type string.
- description string
- The link description.
- username string
- The username of the owner this link
- time string
- Time the Link was added in ISO 8601 format (e.g. "2005-03-01 19:00:00")
- comments
- A list of comments associated with the event. Each comment entry has
the following structure:
- id integer
- This ID plus the Event ID is the unique identifer for a Comment.
- text string
- The text of the comment.
- username string
- The username of the user who posted the comment.
- time string
- The time the user submitted the comment. in ISO 8601 format (e.g. "2005-03-01 19:00:00")
- trackbacks
- A list of trackback URLs associated with the event. Each trackback entry
has the following structure:
- id integer
- This ID plus the Event ID is the unique identifer for a Trackback.
- blog_name string
- The name of the website the trackback is from.
- excerpt string
- The comment associated with the trackback.
- trackback_url string
- The URL of the website the trackback is from.
- time string
- The timestamp when we received the trackback in ISO 8601 format (e.g. "2005-03-01 19:00:00")
- images
- A list of images associated with the event. Each image entry has
the following structure:
- id integer
- Image id + the Event id is the unique identifer for a Image
- url string
- The image URL.
- width integer
- The image width, in pixels.
- height integer
- The image height, in pixels.
- caption string
- The image caption. A short description of the image.
- tags
- A list of tags associated with the event. Each tag entry has the
following structure:
- id string
- The tag ID. (Useful for URLs.)
- title string
- The tag as it should be displayed.
- owner string
- The username who created this tag
- calendars
- A list of calendars associated with the event. Each calendar entry has the
following structure:
- id string
- The calendar ID.
- name string
- The calendar name
- privacy integer
- Access level for this calendar. 1 is public, 2 is private, 3 is private but shareable. (Calendars will only appear in this list if the authenticated user has access rights.)
- smart boolean
- If true, this calendar is a saved search.
- going
- A list of users going to the event. Each user entry has the
following structure:
- usernamestring
- The username of this user.
- properties
- A list of properties for the event. Each property entry has the
following structure:
- idinteger
- The ID of this property (used when removing).
- namestring
- The name of this property.
- valuestring
- The value of this property.
- categories
- A list of categories this event is part of. Each category entry has the following structure:
- id string
- The ID of this category.
- name string
- The display name of this category.
Example XML Response
<?xml version="1.0" encoding="UTF-8"?>
<event id="E0-001-000278174-6">
<title>Martini Tasting</title>
<url>http://eventful.com/events/west-chester/ music-martini-tasting-/E0-001-000278174-6?utm_source=apis& utm_medium=apim&utm_campaign=apic</url>
<description>Sample drinks made with featured vodkas.</description>
<start_time>2005-08-24 12:00:00</start_time>
<stop_time></stop_time>
<all_day>0</all_day>
<tz_id>127</tz_id>
<tz_olson_path></tz_olson_path>
<tz_country></tz_country>
<tz_city></tz_city>
<venue_name>Encore Cafe - West Chester</venue_name>
<venue_id>V0-001-000108360-1</venue_id>
<venue_type></venue_type>
<venue_display>1</venue_display>
<address></address>
<city>West Chester</city>
<region>Ohio</region>
<postal_code>45069</postal_code>
<country>United States</country>
<latitude>39.3361</latitude>
<longitude>-84.4054</longitude>
<geocode_type>Zip Code Based GeoCodes</geocode_type>
<created>2005-07-28 13:09:09</created>
<modified>2005-10-03 12:10:37</modified>
<owner>evdb</owner>
<privacy>1</privacy>
<free></free>
<price></price>
<withdrawn>0</withdrawn>
<withdrawn_note></withdrawn_note>
<parents></parents>
<children></children>
<links>
<link id="312146">
<url>http://frontier.cincinnati.com/calendar/proddisplay.asp?prodid=28356</url>
<type>Official Site</type>
<description>Details</description>
<username>evdb</username>
<time>2005-07-28 13:09:09.372445</time>
</link>
</links>
<comments></comments>
<trackbacks></trackbacks>
<images></images>
<tags>
<tag id="dining">
<title>Dining</title>
<owner>evdb</owner>
</tag>
</tags>
<calendars></calendars>
<going></going>
<properties>
<property>
<id>123</id>
<name>Rating</name>
<value>5 stars</value>
</property>
</properties>
<categories>
<category>
<id>business</id>
<name>Business, Finance, Investing</name>
</category>
</categories>
</event>
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 required parameter was not provided.
- Not found
- There is no event with the specified identifier.
- Read Access Denied
- The specified event is private and the authenticated user has not been granted access.