Documentation

Short intro describing the information in this document.

For information about how to use the Leeds Inspired logo, please refer to the Brand Guidelines.

Events

Short description of what a 'Event' is.

Resource Description
GET events Returns summarised info for all 'active' events. By 'active' we mean events with today's date or future dates.
Example: http://api.leedsinspired.co.uk/1.0/events.xml?key={your-key}
GET events/event_id Returns full public dataset for specified events. Events are specified by including the event_id parameter in the query string.
Example: http://api.leedsinspired.co.uk/1.0/events.xml?key={your-key}&event_id={your-event-id}
GET events/date_range Returns full public dataset for events found that match the specified dates. Start and end dates are specified by including the start_date and end_date parameters in the query string. It is possible to specify a start date from the past, making this the only way to access past events that were listed on www.leedsinspired.co.uk that have now been archived.
Example: http://api.leedsinspired.co.uk/1.0/events.xml?key={your-key}&start_date={dd-mm-yyyy}&end_date={dd-mm-yyyy}
Important: Dates must be specified in the format "dd-mm-yyyy". Day, Month and Year elements must be separated by hyphens ("-") and trailing zeros must be included for days and months 01 - 09 i.e. 7th January 2013 = 07-01-2013
Categories

Short description of what a 'Category' is.

Resource Description
GET categories Lists all Leeds Inspired Categories. These categoried are used by Leeds Inspired to tag events, thereby grouping them by common cultural characteristics. Example: http://api.leedsinspired.co.uk/1.0/categories.xml?key={your-key}
GET events/category_id Get a list of events grouped by category. Categories are specified by including the category_id parameter in the query string.
Example: http://api.leedsinspired.co.uk/1.0/events.xml?key={your-key}&category_id={your-category-id}
Event Organisers

Short description of what an 'Event Organiser' is.

Resource Description
GET organisers Lists all organisers who have created a profile on leedsinspired.co.uk N.B. this does not necessarily mean that the organiser has published any events yet. Example: http://api.leedsinspired.co.uk/1.0/organisers.xml?key={your-key}
GET organisers/organiser_id Coming Soon... This resource will allow api users to obtain the full public dataset for the profile of any specified Event Organiser. Event Organiser Profiles are specified by including the organiser_id parameter in the query string.
Example: http://api.leedsinspired.co.uk/1.0/organisers.xml?key={your-key}&organiser_id={organiser-id-1,organiser-id-2}
GET events/organiser_id Get a list of all events published by an Event Organiser. Event Organisers are specified by including the organiser_id parameter in the query string.
Example: http://api.leedsinspired.co.uk/1.0/events.xml?key={your-key}&organiser_id={organiser-id}
Places

Short description of what a 'Place' is.

Resource Description
GET places Returns summarised info for all Places published on leedsinspired.co.uk N.B. while we try to ensure that places are not duplicated in the site it is possible that some places have more than one entry. Example: http://api.leedsinspired.co.uk/1.0/places.xml?key={your-key}
GET places/place_id This resource will allow api users to obtain the full public dataset of information about a specified Place. Places are specified by including the place_id parameter in the query string.
Example: http://api.leedsinspired.co.uk/1.0/places.xml?key={your-key}&place_id={place-id}
GET events/place_id Get a list of all events related to a specified place. Places are specified by including the place_id parameter in the query string.
Example: http://api.leedsinspired.co.uk/1.0/events.xml?key={your-key}&place_id={place-id}