Welcome Developers!
In line with the AV10 theme, we have introduced a RESTful API that can be used by application developers to build applications that integrate our content.
You can get data out of AV Festival via XML or JSON
Making a Request
Requests for data are sent over HTTP using a GET request. Because of the nature of our content, we provide a read only service.
The first thing we need to do with any call into the API is construct an appropriate URL format:
http://www.avfestival.co.uk/api/request/format/[unique]
There are several types of data you can request. See below for all options.
The format you want returned to you. Can be xml or json
If you need a particular piece of content you can reference it here.
If you are carrying an index ID from one request and into another request, it is good practice use the unique method to speed up your application by lowering bandwidth consumption and parsing time on the client.
Requests
Below is a list of all requests you can make on our data. You can see more information on each one further down this page.
With our programme content it is important to understand the relationship between events and instances. Every event is effectively a 'wrapper' for instances. Therefore, when querying events, it is a good idea to match the event with its instances using the event_id node to get a complete picture of the Event and all of its Instances
Event information from our programme
Event Instances
The different type of events we have in our programme
Artist Collective Information
We have a wide variety of Art Forms in our Programme
Festival events and instances are grouped into strands
Geographical locations where events occur
Information about the venues we work with
Example
Example Request
http://www.avfestival.co.uk/api/events/xml/20
In this request we are looking for an event with an ID of 20 and asking for the data in XML format
Example Response
<?xml version="1.0" encoding="utf-8"?> <xml> <slug>events</slug> <resultset> <entity> <id>20</id> <name><![CDATA[ Liliane Lijn: Power Game ]]></name> <eventtype_id>13</eventtype_id> <start_date>1267747200</start_date> <end_date>1267747200</end_date> <website_description><![CDATA[ <p>Power Game is a dynamic card game and improvised art performance, devised and performed by Liliane Lijn. Originally staged in 1974, and restaged at the ICA, London, in 2009, it explores the power of words and the politics of identity. Enter the casino: a glamorous setting of leafy palms, music, cocktails and cross-dressers. At the heart of the game are the invited players, who have been chosen for their wit, originality and status. The players, who in 1974 included Derek Jarman, bet their own money on the comparative power of two words, which is decided by a vote. You can buy chips (to enter the casino and play) or watch the action live in the BALTIC Café Bar. Part of AV Late Shows.</p> <p>Produced by AV Festival 10 and BALTIC Centre for Contemporary Art. Liliane Lijn’s work is represented by Riflemaker London.</p> ]]></website_description> <programme_strand_idcsv>17,5,11,</programme_strand_idcsv> <venue_id></venue_id> <artform_idcsv></artform_idcsv> <collective_idcsv></collective_idcsv> </entity> </resultset> <resultcount>1</resultcount> <format>xml</format> </xml>
From this response we can then make further enquiries based on the returned data. For example, you may want to call http://www.avfestival.co.uk/api/event-types/xml/13 to retrieve information about the type of event this is.
You may find it useful integrating a caching facilty, depending on your application deployment circumstances.
Reponses
events
| Node | Format | Description |
|---|---|---|
| id | INTEGER | Unique Event ID |
| name | STRING (CDATA) | This events name |
| eventtype_id | INTEGER | A event type ID's for this Event |
| start_date | INTEGER | UNIX Start time |
| end_date | INTEGER | UNIX End Time |
| website_description | STRING (CDATA) | The Description of this event in HTML format |
| programme_strand_idcsv | STRING (COMMA SEPARATED) | The Highlights this event belongs to |
| venueid | INTEGER | The Venu ID that this event occurs in |
| artform_idcsv | STRING (COMMA SEPARATED) | The artforms this event belongs to |
instances
| Node | Format | Description |
|---|---|---|
| id | INTEGER | Unique Instance ID |
| event_id | INTEGER | The Event this instance belongs to |
| name | STRING (CDATA) | The Name of this instance |
| event_id | INTEGER | The Event this instance belongs to |
| eventtype_id | INTEGER | The Event Type this instance belongs to |
| start_date | INTEGER | Unix Timestamp |
| end_date | INTEGER | Unix Timestamp |
| website_description | STRING (CDATA) | If we have additional content for this instance it is here |
| programme_strand_idcsv | STRING (COMMA SEPARATED) | The Highlights this instance belongs to |
| venueid | INTEGER | The Venu ID that this instance occurs in |
| artform_idcsv | STRING (COMMA SEPARATED) | The artforms this instance belongs to |
event-types
| Node | Format | Description |
|---|---|---|
| id | INTEGER | unique event type ID |
| name | STRING (CDATA) | event type name |
Artforms
| Node | Format | Description |
|---|---|---|
| id | INTEGER | unique artform ID |
| name | STRING (CDATA) | artform name |
Highlights
| Node | Format | Description |
|---|---|---|
| id | INTEGER | Unique Highlight ID |
| name | STRING (CDATA) | Highlight name |
Cities
| Node | Format | Description |
|---|---|---|
| id | INTEGER | unique city ID |
| name | STRING (CDATA) | city name |
Venues
| Node | Format | Description |
|---|---|---|
| id | INTEGER | Unique Venue ID |
| name | STRING (CDATA) | The Venue name |
| longitude | FLOAT | The Longitude of this venue |
| latitude | FLOAT | The Latitude of this venue |
| add1 | STRING (CDATA) | Address Line 1 |
| add2 | STRING (CDATA) | Address Line 2 |
| add3 | STRING (CDATA) | Address Line 3 |
| city | INTEGER | Venue City |
| postcode | STRING | Venue Postcode |
| tel | STRING | Information telephone number |
| url | STRING (CDATA) | Venue URL |
| STRING (CDATA) | Twitter Username | |
| STRING (CDATA) | Facebook URL | |
| vimeo | STRING (CDATA) | Vimeo Username |
| flickr | STRING (CDATA) | Flickr Username |
| myspace | STRING (CDATA) | MySpace Username |
| audioboo | STRING (CDATA) | Audioboo Username |
| soundcloud | STRING (CDATA) | Soundcloud Username |
| lastfm | STRING (CDATA) | Last FM Username |
| boxOfficeHours | STRING | An associative date string. Day 1 is Monday. Takes format DAYNUMBER:OPENHOUR-CLOSEHOUR; eg 3:1030-2115; means Wednesday 10.30 am until 9.15pm. Note: if 0000-0000 is used, it means the venue box office is closed all day |
| boxOfficeUrl | STRING (CDATA) | A URL to the box office website |
| boxOfficeTel | STRING | The telephone number for this venues box office |
