Happenr webservice GetEvents
This webservice is called via a single URL, with parameters in the querystring.
The webservice returns a webpage with XML. No SOAP or REST or XMLRPC is used.
The number of results returned is limited to 1000 events maximum.
Note: search results have to be cached. Excessive querying of this webservice is not allowed and will be blocked !
Contact us for more information: info@happenr.com.
Example usage:
http://happenr.com/webservices/getEvents.php?username=xxx&password=xxx&town=London
Parameters in querystring
username
Your username that you received from Happenr in order to query this webservice.
password
Your password that you received from Happenr in order to query this webservice.
channelid
Optional parameter.
Defines the database that will be queried.
Examples:
14: Happenr EU top tourism city destinations (default)
8: Happenr Ireland
9: Happenr Germany
sourceid
Optional parameter.
Integer value to query only one source.
firstrecord
Optional parameter. Default value: 0 (first record).
Integer value to indicate the first record.
Can be used in combination with parameter "limit" to implement paging. Example: limit=10 and firstrecord=0,10,20... on consecutive calls to the webservice.
limit
Optional parameter. Default value: 10. Maximum value: 500.
Integer value to limit the number of results returned.
includedatesxml
Optional parameter. Default value: 0.
If value is 1, detailed XML will be added for each day on which an event takes place.
includeevents
Optional parameter. Default value: 1.
If value is 0, no events are returned in XML (useful if only includefilters=1 is desired).
includeeventdetails
Optional parameter. Default value: 1.
If value is 1, more event fields are returned (e.g. event dates, event content etc.).
Note: event details can also be retrieved using the web service getEventDetails.
includefilters
Optional parameter. Default value: 0.
If value is 1, all possible filters (with event count) are included in the XML.
includedoubles
Optional parameter. Default value: 0.
If value is 0, event doubles are filtered out to only keep unique events.
includepermanentevents
Optional parameter. Default value: 0.
If value is 0, permanent events are filtered out.
includemultipleperformers
Optional parameter. Default value: 0.
If value is 0, performers are shown as one textblog in tag performer.
If value is 1, performers are shown as a list of performer tags in a parent tag performers.
excludecancelled
Optional parameter. Default value: 0.
If value is 1, cancelled events are filtered out.
country
Optional parameter.
Filter on one specific country.
Examples:
Albania
Andorra
Austria
Belarus
Belgium
Bosnia Herzegovina
Bulgaria
Croatia
Cyprus
Czech Republic
Denmark
Estonia
Finland
France
Germany
Greece
Hungary
Iceland
Ireland
Italy
Latvia
Lithuania
Luxembourg
Macedonia
Malta
Montenegro
Norway
Poland
Portugal
Romania
Russia
Serbia
Slovakia
Slovenia
Spain
Sweden
Switzerland
The Netherlands
Turkey
Ukraine
United Kingdom
region
Optional parameter.
Filter on one specific region (typically a province or county).
Examples:
Wales
Nordrhein-Westfalen
Cork
town
Optional parameter.
Filter on one specific town or municipality.
Examples:
Paris
London
Amsterdam
longitude & latitude
If both parameters given, the events closest to the given coordinates will be returned.
Use negative values for latitude South and longitude West.
Examples:
longitude=4.36
latitude=50.85
maxdistance
Only events will be returned with maximum the given distance (in km) from the given longitude/latitude.
Note: if a location is given (town, region and/or country) but no longitude/latitude is given, the location will be converted to a longitude/latitude first,
and the search result will no longer be limited to the given location but will be limited to the given maximum distance from the location.
Example for events maximum 100km away:
longitude=4.36 & latitude=50.85 & maxdistance=100
country=Spain & town=Barcelona & maxdistance=100
category
Optional parameter.
Filter on one specific category (type of events).
Examples:
Architecture
Attractions
Design
Education
Events
Excursions
Expo
Festival
Film
Gay
Going out
Government
Heritage
Kids
Literature
Miscellaneous
Music
Nature
Recreation
Sport
Theatre
date
Optional parameter.
Filter on one specific day.
Examples:
2009-01-25
2009-12-31
fromdate & todate
Optional parameters.
Filter on a period between a from-date and a to-date (both inclusive).
Examples:
2009-01-25
2009-12-31
period
Optional parameter.
Filter on a specific type of period.
Examples:
today
tomorrow
thisweekend
next7days
next30days
searchtext
Optional parameter.
Free text search on title and content.
venue
Optional parameter.
Free text search on venue.
language
Optional parameter. Default value: EN
Language to be used for categories (both in querystring and in XML output).
Examples:
EN
NL
FR
langcode
Optional parameter.
The language code of the events.
Examples:
EN
NL
FR
Theme
Optional parameter.
Filter events by theme. Parameter must be url-encoded
Examples:
music
hobby%20%26%20sports
on%20stage
kids
movies
Sorting
Optional parameter. Default value: no sorting
Allowed values:
alphabetical: sorting by title
date: sorting by date
distance: sorting by distance from a given latitude/longitude
eventranking: main events first
random: random sorting
images: events with images first