Data Types
Complex data types
EventInfo
related DTOInformation about event (e.g. The Lion King, The Phantom of The Opera, ...)
| Property | Data type | Nullable | Description |
|---|---|---|---|
| EventId | Integer | no | event identifier |
| EventType | Integer (type id) | no | see EventType enumeration for further information |
| Name | String | no | event name |
| Description | String | yes | HTML-formatted description |
| VenueId | Integer | 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 Image | 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 |
| SeatingPlanSupported | Boolean | no | if Seating plan is available for this event |
| EventSeriesIds | list of Integers | no | list of event series |
GetEventListResult
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| Events | Collection of EventInfo | no | contains information about an event |
GetEventDetailResult
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| Event | EventInfo | no | contains information about an event |
AvailableEventInfo
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| EventName | String | yes | event name |
| EventId | Integer | no | event identifier |
| AvailablePerformanceInfos | Collection of AvailablePerformanceInfo | no | contains information about an available performance |
GetEventPreliminaryBookingInfoResult
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| Performances | Collection of PreliminaryPerformanceInfo | no | contains preliminary information about a performance |
VenueInfo
related DTOInformation about venue
| Property | Data type | Nullable | Description |
|---|---|---|---|
| VenueId | Integer | no | venue identifier |
| Name | String | yes | venue 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 |
| 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 |
GetVenuesResult
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| Venues | Collection of VenueInfo | no | contains information about a venue |
GetVenueDetailResult
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| Venue | VenueInfo | no | contains information about a venue |
PerformanceInfo
related DTOContains information about a performance
| Property | Data type | Nullable | Description |
|---|---|---|---|
| PerformanceId | Integer | no | performance identifier |
| PerformanceDate | DateTime | no | date and time at which performance occurs |
| TicketCount | Integer | no | maximum count of tickets that can be sold |
| TotalSeatsCount | Integer | yes | total seats count for the performance |
| TotalAvailableTickesCount | Integer | no | total tickets available |
| ContainsDiscountOfferTickets | Boolean | no | flag indicating whether there are any discount offer tickets (i.e. selling price < face price) |
| ContainsNoFeeOfferTickets | Boolean | no | flag indicating whether there are any no fee tickets (i.e. face price = selling price) |
| MinimumTicketPrice | Decimal | no | the lowest ticket price |
| MaximumConsecutiveSeatsCount | Integer | no | maximum count of tickets that are consecutive |
| EventId | Integer | no | event identifier |
EventPerformances
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| EventId | Integer | no | event identifier |
| Performances | Collection of Performance | no | contains information about a performance |
Performance
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| PerformanceId | Integer | no | performance identifier |
| PerformanceDate | DateTime | no | date and time at which performance occurs |
| IsUnreserved | Boolean | no | if reservation for this performance is not required |
GetPerformanceDetailResult
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| Performance | PerformanceInfo | no | contains information about event performances |
GetPerformancesResult
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| Performances | Collection of PerformanceInfo | no | contains information about a performance |
GetEventPerformancesResult
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| EventId | Integer | no | event identifier |
| Performances | Collection of PerformanceInfo | no | contains information about a performance |
GetEventsPerformancesResult
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| Events | Collection of EventPerformances | no | contains information about event performances |
PreliminaryPerformanceInfo
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| PerformanceId | Integer | no | performance identifier |
| PerformanceDate | DateTime | no | date and time at which performance occurs |
| MinimalTicketPrice | Decimal | no | the lowest ticket price |
| MaximalTicketPrice | Decimal | no | the highest ticket price |
AvailablePerformanceInfo
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| PerformanceId | Integer | no | performance indentifier |
| PerformanceDate | DateTime | no | date and time at which performance occurs |
| MinimumTicketPrice | Decimal | no | the lowest ticket price |
| AvailableTicketInfos | Collection of AvailableTicketInfo | yes | contains information about a ticket that is available for sale |
| AvailableTicketsBlockInfos | Collection of AvailableTicketsBlockInfo | no | contains information about available tickets grouped by a ticket area, face and selling price |
GetAvailablePerformanceTicketsResult
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| PerformanceId | Integer | no | performance identifier |
| EventId | Integer | no | event identifier |
| TicketAreas | Collection of TicketAreaInfo | no | contains information about an available ticket in a seating area |
AvailableTicketInfo
related DTOContains information about a ticket that is available for sale
| Property | Data type | Nullable | Description |
|---|---|---|---|
| VenueId | Integer | 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 |
| TicketName1 | String | no | seat row |
| TicketName2 | String | no | seat number |
| AdjacencyIndex | Integer | no | marks seats adjacency |
| FaceValue | Decimal | no | face price |
| SellingPrice | Decimal | no | selling price |
| 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 |
| TicketArea | String | yes | name of a ticket area where ticket resides (e.g. Stalls, Royal Circle) |
| TicketId | Integer | no | ticket identifier |
| IsRestrictedView | Bool | no | indicates, whether related ticket has restricted view |
| RestrictionDescription | String | yes | restricted view description (occurs only, when IsRestrictedView is set to true) |
AvailableTicketsBlockInfo
related DTOServes 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 | contains information about a ticket that is available for sale |
FullTicketInfo
related DTOContains information about a ticket that is available for sale
| Property | Data type | Nullable | Description |
|---|---|---|---|
| TicketId | Integer | no | ticket identifier |
| AreaName | String | yes | ticket area name which this block refers to |
| TicketName1 | String | no | seat row |
| TicketName2 | String | no | seat number |
| SellingPrice | Decimal | no | selling price that is same for all tickets within this block |
| FaceValue | Decimal | no | face price |
| RestrictedView | Bool | no | indicates, whether related ticket has restricted view |
| Description | String | yes | seat description (usually restricted view description) |
GetFullPerformanceAvailabilityResult
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| PerformanceId | Integer | no | performance identifier |
| EventId | Integer | no | event identifier |
| AvailableTickets | Collection of FullTicketInfo | no | contains information about a ticket that is available for sale |
CheckTicketAvailabilityResult
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| TicketId | Integer | no | ticket identifier |
| IsAvailable | bool | no | if this ticket is available |
GetEventAvailableTicketsResult
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| AvailableEvent | AvailableEventInfo | no | contains information about an available event |
GetEventsAvailableTicketsResult
related DTO| Property | Data type | Nullable | Description |
|---|---|---|---|
| AvailableEvents | Collection of AvailableEventInfo | no | contains information about an available event |