Developer portal

Data Types

This sections contains list of all types that designated web services work incorporate.

First of all, primitive data types are explained. In following part of this section, you will find description of all complex types used in service methods described earlier.

Complex data types written below are serialized JSON Responses for each API call. Each complex type consists of another complex or primitive types.

Content

Primitive data types

This documentation refers to many primitive data types which are described here to give you a full description over used data types.

Please note that some data types may not require a value, so called nullable. It means it can be a null reference.

String

Text represented as a series of Unicode characters. Can be null reference naturally.

Guid (globally unique identifier)

128-bit data structure that is typically used when global uniqueness is required.

Sometimes you can meet a term called “Guid empty” which refers to a Guid where all bits equal to zero. When represented as a String, it is “00000000-0000-0000-0000-000000000000”.

Integer

32-bit signed Integer.

Decimal

128-bit signed Decimal number. Typically used for a prices.

DateTime

ISO 8601 standard representation of the Date and Time.

Boolean

Bit with two possible values – true, false.

Complex data types

EventInfo

Information about an event (e.g. The Lion King, The Phantom of The Opera, ...).

Property Data type Nullable Description
EventId Int no unique event identifier
EventType Int (type id) no see EventType enumeration for further information)
Name String no event name
Description String yes HTML-formatted description
VenueId Int no id of a venue where event is being played
MainImageUrl String yes URL to a very default illustration image
SmallImageUrl String yes URL to a small illustration image
SpecialGraphics String yes id of extra graphics (see SpecialGraphics enumeration for further information)
ShortOfferText String yes text with possible price offer
LongOfferText String yes long text with possible price offer
CurrentPrice Decimal no common/current price
OfferPrice Decimal no offer price for offer tickets
StartDate DateTime yes date and time of the first performance
EndDate DateTime yes date and time of the last performance
Images list of EventImage no gallery images
MultimediaContent list of EventMultimediaContent no attached multimedia resources
EventDetailUrl String yes event detail URL address
TagLine String yes short description tag
PrintAtHomeTicketsEnabled Boolean no if PrintAtHomeTickets are available for this event

VenueInfo

Information about a venue.

Property Data type Nullable Description
VenueId Int no unique identification of a venue
Name String yes name
Info String yes HTML-formatted description
Address String yes street, house number
City String yes city
Postcode String yes postal code
Telephone String yes phone number
Fax String yes fax number
Email String yes e-mail address
NearestTube String yes name of the nearest tube if any
Train String yes name of the nearest train station if any
PlanLink String yes URL to an image that illustrates a seating plan
ImageUrl String yes URL to an image that contains a building picture

PerformanceInfo

Contains information about a performance.

Property Data type Nullable Description
PerformanceId Int no unique performance id
PerformanceDate DateTime no date and time at which performance occurs
TicketCount Int no maximum count of tickets that can be sold
TotalAvailableTickesCount Int no total tickets available in a seat row
ContainsDiscountOfferTickets Boolean no flag indicating whether a seat row contains any discount offer tickets (i.e. selling price < face price)
ContainsNoFeeOfferTickets Boolean no flag indicating whether a seat row contains any no fee tickets (i.e. face price = selling price)
MinimumTicketPrice Decimal no the lowest ticket price in a seat row
MaximumConsecutiveSeatsCount Int no maximum count of tickets that are consecutive
EventId Int no unique event identifier

AvailableTicketsBlockInfo

Serves as a group of available tickets grouped by a ticket area, face and selling price.

Property Data type Nullable Description
AreaName String yes ticket area name which this block refers to
FacePrice Decimal no face price that is same for all tickets within this block
SellingPrice Decimal no selling price that is same for all tickets within this block
AvailableTicketsInfos Collection of AvailableTicketInfo no

AvailableTicketInfo

Contains information about a ticket that is available for sale.

Property Data type Nullable Description
TicketId Int no unique ticket identifier
TicketArea String yes name of a ticket area where ticket resides (e.g. Stalls, Royal Circle)
TicketName1 String yes seat row
TicketName2 String yes seat number
FaceValue Decimal no face price
SellingPrice Decimal no selling price
VenueId Int no id of a venue where this event takes place
VenueName String yes venue name
VenueAddress String yes venue address
VenueCity String yes venue city
DirectBookingUrl String yes booking URL; by calling this URL you get redirected to a booking page for a performance that this ticket belongs to; it also contains a placeholder {0} (number of required tickets) that you must replace with a real value before calling
IsRestrictedView Bool no Indicates, whether related ticket has restricted view
RestrictionDescription String yes restricted view description. Occurs only, when IsRestrictedView is set to true

Review

Contains information about a review.

Property Data type Nullable Description
ConsumerName String no consumer name
Stars Int no count of stars
CreatedAt Date no creation date
Content String no review content

EventPerformances

Property Data type Nullable Description
EventId Integer unique event identifier
Performances Collection of Performance

Performance

Property Data type Nullable Description
PerformanceId Integer
PerformanceDate DateTime
IsUnreserved Boolean

AvailableEventInfo

Property Data type Nullable Description
EventName String
EventId Integer unique event identifier
AvailablePerformanceInfos Collection of AvailablePerformanceInfo

AvailablePerformanceInfo

Property Data type Nullable Description
PerformanceId Integer
PerformanceDate DateTime
MinimumTicketPrice Decimal
AvailableTicketInfos Collection of AvailableTicketInfo
AvailableTicketsBlockInfos Collection of AvailableTicketsBlockInfo

PreliminaryPerformanceInfo

Property Data type Nullable Description
PerformanceId Integer
PerformanceDate DateTime
MinimalTicketPrice Decimal
MaximalTicketPrice Decimal

DeliveryInformation

Property Data type Nullable Description
DeliveryType DeliveryType no
DeliveryPrice Decimal number no
CustomerEmail String
BillingFirstName String
BillingSurname String
BillingAddressLine1 String
BillingAddressLine2 String
BillingPostCode String
BillingPhoneNumber String
BillingCity String
BillingStateCode String
BillingCountry String
BillingCountryName String
DeliveryFirstName String
DeliverySurname String
DeliveryAddressLine1 String
DeliveryAddressLine2 String
DeliveryPostCode String
DeliveryPhoneNumber String
DeliveryCity String
DeliveryStateCode String
DeliveryCountry String
DeliveryCountryName String
DeliveryAddressSame Boolean

BasketItem

Property Data type Nullable Description
BasketItemId Integer
EventId Integer unique event identifier
EventName String
ImageUrl String
PerformanceDate DateTime
AreaName String
Seats Collection of string
Tickets TicketInfo
VenueId Integer
VenueName String
VenueAddress String
VenueCity String
VenuePostCode String
PriceSubTotal Decimal
ReservationValidity Integer
ExpirationDate DateTime

GetBasketContentResult

Property Data type Nullable Description
BasketId Guid
MinExpirationDate DateTime
DeliveryInformation DeliveryInformation
Items Collection of BasketItem

TicketInfo

Property Data type Nullable Description
TicketId Integer
TicketName1 String
TicketName2 String
FaceValue Decimal
SellingPrice Decimal
IsRestrictedView Boolean
RestrictionDescription String

TicketAreaInfo

Property Data type Nullable Description
AreaName String
SellingPrice Decimal
FaceValue Decimal
TicketName1 String
Tickets Collection of TicketInfo
SingleItemBookLink String

Enums

AddItemToBasketFailureReason

Name ID
None 0
TicketNotAvailable 1

SpecialGraphics

Enumeration specifying possible special graphics types.

Special graphics type ID
Auto 1
No Graphics 2
Coming Soon 3
New 4
Closing 5
Special Offer 6
Recommended 7

Language

Enumeration specifying valid system languages.

Language ID
English 1
German 2
Spanish 3
Italian 4
Swedish 5
French 6
Dutch 7
Norwegian 8
Danish 9

EventType

Name ID
Musical 1
Play 2
Attraction 3
Ballet & Dance 4
Opera 5
Comedy 6
Drama 7
Cruise 8
Exhibition 9
Tour 10
Other 11
Concerts 12

DeliveryType

Name ID
BoxOfficeCollection 1
DeliveryUK 2
DeliveryInternational 3

ReviewsOrder

Name ID
DateDescending 0
DateAscending 1
StarsDescending 2
StarsAscending 3