The API work with a few terms from the area of ticketing, booking, reservations. This document describes the individual terms and their exact meaning within this API to avoid any confusion and misunderstanding in other documentation texts.
An event represents a show, attraction, concert or anything else you can buy a ticket for. There are multiple types of event (referred to as “event types”) - the complete list is available through a dedicated system API call.
The “event” entity in the whole API means the production itself, not a particular performance date. An event is typically bound to a venue (where the show takes place). If a show is being presented in more venues (for instance a popular musical that is played in both London and New York), a separate “event” record/entity exists for every venue. (this is because the event played in more cities have usually a different set of performance dates, different descriptive texts, multimedia content etc).
A performance is one occurrence of an event in a certain date and time. A performance is therefore bound to an event by an 1:N binding. Each live show on sale has at least one performance.
A performance could be “The Lion King on 2nd February 2016 at 19:30”.
A venue refers to a place where an event is performed. Each event takes place in one venue. A venue is typically a theatre, concert hall, attraction location etc.
The LondonTheatreDirect API works with tickets as how we know them from the real world. A ticket is therefore bound to a specific performance of a specific event. Where applicable (events with numbered seats), the ticket is bound to one specific seat.
A typical ticket can then represent an information like this: “The Lion Kind on 2nd February 2016 at 19:30, Dress Circle, Row A, Seat 36”.
Tickets usually have
- a Face Value - a “nominal” price that describes the ticket itself in comparison with other tickets
- a Selling Price - the real price for which the ticket is sold
Based on the real structure of the venue (theatre, concert hall, …), the seats are divided in one or more sections referred to as Ticket Areas or simply Areas by this API.
Most theatres offers areas like Stalls, Dress Circle, Royal Circle, Balcony, … Some events are performed in venues that aren’t divided into seating areas. Tickets for these events are therefore bound to one single area covering the whole venue. The data structured are then straightforward and consistent over the whole API.
This API process bookings in a standard shopping flow - a Basket can be created to start a booking session. Each basket can contain multiple bookings - multiple tickets for even multiple performances or shows. The basket than (except from the actually booked tickets :) ) carries information about the customer (first name, last name, e-mail, …) and selected delivery option.
TicketPlan refers to a cancelation protection that can be purchased within a transaction under given terms and conditions.