EventLister.com XML API
The purpose of this API is to allow other sites to display listings of events in their area
or to intermingle our listings with any they may already have.
The API allows free access to the raw XML data for all events upcoming within the next 6 months.
I hope that many Tourism sites, Newspaper sites, Community Event sites,
Competitors' sites, Printed Guides/Directories etc. take advantage of this.
This will give more exposure to all events in the long run. Please spread the word!
API - Abbreviation of Application Program Interface, a set of routines, protocols, and tools for
building software applications. In this case, around our site/database. more info on APIs
XML - Extensible Markup Language is used to pass data in and out. more info on XML
Overview
- Each method has a unique URL and can be called over HTTP or HTTPS.
- Variables and URLs are CaSe SENsitiVE!
- Variables are passed in as HTTP variables. i.e. url.htm?Var1=A&Var2=Cya
- Results are the content of the method HTTP request and are in XML format.
- Your APIKey must be passed with every method call.
- There are no usage limits. You can make a method call for each pageview on your site. Caching data is not required or banned.
- SQL_DATE format=YYYY-MM-DD
- This is a beta version and is not stable. Future releases will be... Each will have a seperate directory
so updates will not break your site.
API Methods
EventSearch - Returns the Event Listing Search Results for a Given Query
EventDetails - Returns the Full Details of an Event Listing
EventAdd - Adds an Event Listing to our main database
Method: EventSearch - Returns the Event Listing Search Results for a Given Query
Description: Returns the Event Listing Search Results for a Given Query
Location: http://www.EventLister.com/api/v0.1b/EventSearch.php
Input Variables:
DisplayNumber - INTEGER - defaults to 100
StartNumber - INTEGER - defaults to 0
TotalNumber - INTEGER - defaults to the total number
KeyWords - STRING - space seperated ANDed keyword
StartDate - SQL_DATE YYYY-MM-DD - defaults to Today
or can pass as 3 variables: StartDate_year, StartDate_month, and StartDate_day
EndDate - SQL_DATE YYYY-MM-DD - defaults to far far away
or can pass as 3 variables: EndDate_year, EndDate_month, and EndDate_day
AddedSince - SQL_DATE YYYY-MM-DD - defaults to 0000-00-00
or can pass as 3 variables: AddedSince, AddedSince_month, and AddedSince_day
UpdatedSince - SQL_DATE YYYY-MM-DD - defaults to 0000-00-00
or can pass as 3 variables: UpdatedSince_year, UpdatedSince_month, and UpdatedSince_day
SearchLocationMethod - SET_STRINGS - ( Zip, CityState, CountryRegion ) - defaults to everywhere
'Zip' Option - Seaches a specified radius around a zip code
Radius - INTEGER - search radius in miles
Zip - STRING - 5 Digit US zip codes only right now
'CityState' Option - Seaches a specified radius around a city, state
Radius - INTEGER - search radius in miles
City - STRING - US City name
State - STRING - US 2 digit state abreviation
CityState - STRING - 'City, ST' format or 'City,ST'
'CountryRegion' Option - Seaches an entire country or region (states in the US)
Radius - INTEGER - search radius in miles
Country - STRING - Country name
Region - STRING - Region/State name
CountryRegion - STRING - 'Country, Region' or 'Country,Region'
RequirePicture - Y or unset
OnlyIndoor - Y or unset
OnlyOutdoor - Y or unset
OnlyJuried - Y or unset
OnlyNonJuried - Y or unset
OnlyRetailAllowed - Y or unset
OnlyFoodAllowed - Y or unset
Description: This method is set up to automatically handle pageing of the search results for you.
It defaults to returning only page at a time.
The results include a TotalNumber variable, indicating the total number of results available for subsequent method calls.
Each call accepts a StartNumber and DisplayNumber variable to identify the results to return.
Samples Code:
Sample PHP Code
Live Example / Sample Output
Sample XML Output
Method: EventDetails - Returns the Full Details of an Event Listing
Description: - Returns the Full Details of an Event Listing from either of our databases:
The Main Database that has all the events in it that you see on our site
OR the raw Import Data Database from other sites (tourism, coc, venues, etc.)
Location: http://www.EventLister.com/api/v0.1b/EventDetails.php
Input Variables:
EventNumber - INTEGER - Returns Event from our Main Database of Approved Listings
OR
ImportedEventListingIDNumber - INTEGER - Returns an event from the import dabatase, it
indexes by ImportedEventListingIDNumber, but one field returned for each listing is the 'EventNumber'
that we use, if this field is set, it is in our main database. These are NOT APPROVED as accurate!
Samples Code:
Sample PHP Code
Start of Sample C# ASP Code
Live Example / Sample Output
Sample XML Output
Method: EventAdd - Adds an Event Listing to our main database
Description: - Adds an Event Listing to our main database
Location: http://www.EventLister.com/api/v0.1b/EventAdd.php
To be added soon!
|
w Links