Developer portal

Data Types

Complex data types

TicketInfoBooking

related DTO
Property Data type Nullable Description
TicketId Integer no ticket identifier
TicketName1 String no seat row which this ticket refers to
TicketName2 String no seat number which this ticket refers to
FaceValue Decimal no face price
SellingPrice Decimal no selling price
IsRestrictedView Boolean no indicates, whether related ticket has restricted view
RestrictionDescription String yes restricted view description (occurs only, when IsRestrictedView is set to true)

TicketInfo

related DTO
Property Data type Nullable Description
TicketId Integer no ticket identifier
TicketName1 String no seat row which this ticket refers to
TicketName2 String no seat number which this ticket refers to
IsRestrictedView Boolean no indicates, whether related ticket has restricted view
RestrictionDescription String yes restricted view description (occurs only, when IsRestrictedView is set to true)

PrintAtHomeTicketInfo

related DTO
Property Data type Nullable Description
TicketId Integer yes ticket identifier
TicketName1 String no seat row which this ticket refers to
TicketName2 String no seat number which this ticket refers to

GetTicketPlanPriceResult

related DTO
Property Data type Nullable Description
Price Decimal no plan price

TicketAreaInfo

related DTO
Property Data type Nullable Description
AreaName String yes ticket area name which this block refers to
SellingPrice Decimal no selling price that is same for all tickets within this block
FaceValue Decimal no face price that is same for all tickets within this block
TicketName1 String no seat row
Tickets Collection of TicketInfo no contains information about a ticket
SingleItemBookLink String yes link for single item booking

GeneratedPrintAtHomeTicket

related DTO
Property Data type Nullable Description
Ticket PrintAtHomeTicketInfo no Print-At-Home ticket info
FileSize Integer no Print-At-Home ticket file size
DownloadUrl String no download URL to a Print-At-Home ticket

Review

related DTO

Contains information about a review

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

GetReviewsResult

related DTO
Property Data type Nullable Description
Reviews Collection of Review no contains information about a review
ReviewsCount Integer no reviews count
AverageRating Double no average rating
HighestPossibleRating Integer no highest possible rating
CurrentReviewsCount Integer no selected reviews count
CurrentReviewsFrom Integer no selected reviews skipped

CreateBasketResult

related DTO
Property Data type Nullable Description
Success Boolean no if basket was successfully created
BasketId Guid no basket identifier

BasketItem

related DTO
Property Data type Nullable Description
BasketItemId Integer no basket item identifier
EventId Integer no event identifier
EventName String yes event name
ImageUrl String yes URL to an illustration image
PerformanceDate DateTime no date and time at which performance occurs
AreaName String yes ticket area name which these tickets refers to
Seats Collection of string no seats which these tickets refers to
Tickets Collection of TicketInfoBooking no contains information about a ticket
VenueId Integer no venue identifier which this basket item refers to
VenueName String yes venue name which this basket item refers to
VenueAddress String yes venue address which this basket item refers to
VenueCity String yes venue city which this basket item refers to
VenuePostCode String yes venue postal code which this basket item refers to
PriceSubTotal Decimal no total price of basket item
ReservationValidity Integer no number of minutes till reservation expires (also negative value)
ExpirationDate DateTime no expiration date of reservation

GetPerformanceSeatingPlan

related DTO
Property Data type Nullable Description
SeatingPlanUrl String no URL of the embedded seating plan that can be displayed inside an iframe

AddItemToBasketResult

related DTO
Property Data type Nullable Description
Success Boolean no if item was successfully added to basket
FailureReason Integer no see AddItemToBasketFailureReason enumeration for further information
GetBasketContentResult GetBasketContentResult no contains information about basket content

GetBasketContentResult

related DTO
Property Data type Nullable Description
BasketId Guid no basket identifier
MinExpirationDate DateTime no expiration date of reservation
DeliveryInformation DeliveryInformation yes contains delivery information
Items Collection of BasketItem no contains information about a basket item
DiscountInformation String yes discount information

GetPrintAtHomeTicketsResult

related DTO
Property Data type Nullable Description
AllTicketsGenerated Boolean no if all Print-At-Home tickets of provided basket were generated successfully
RequestedTicketsCount Integer no requested Print-At-Home tickets count
GeneratedTicketsCount Integer no generated Print-At-Home tickets count
GeneratedTickets collection of GeneratedPrintAtHomeTicket no generated Print-At-Home tickets information

SubmitOrderResult

related DTO
Property Data type Nullable Description
Success Boolean no if order was successfully submitted
PaymentRedirectUrl String no URL to a payment redirect result

SubmitOrderOnAccountResult

related DTO
Property Data type Nullable Description
Success Boolean no if order was successfully submitted
BookingReference String no public unique booking reference

GetSubmittedBasketSummaryResult

related DTO
Property Data type Nullable Description
TransactionReference Integer no transaction reference
BasketId Guid no basket identifier
DeliveryInformation DeliveryInformation yes contains delivery information
BasketItems Collection of BasketItem no contains information about a basket item
BookingReference Integer no booking reference
DiscountInformation String yes discount information

ReleaseTicketFromBasketResult

related DTO
Property Data type Nullable Description
Success Boolean no if tickets were successfully deleted from basket
GetBasketContentResult GetBasketContentResult no contains information about basket content

DeliveryInformation

related DTO
Property Data type Nullable Description
DeliveryType DeliveryType no delivery type
DeliveryPrice Decimal no delivery price
CustomerEmail String yes customer e-mail address
BillingFirstName String yes billing customer first name
BillingSurname String yes billing customer surname
BillingAddressLine1 String yes billing street, house number
BillingAddressLine2 String yes billing additional address information (e.g. floor)
BillingPostCode String yes billing post code
BillingPhoneNumber String yes billing phone number
BillingCity String yes billing city
BillingStateCode String yes billing state code, applied only for United States
BillingCountry String yes billing country identifier
BillingCountryName String yes billing country name
DeliveryFirstName String yes delivery customer first name
DeliverySurname String yes delivery customer surname
DeliveryAddressLine1 String yes delivery street, house number
DeliveryAddressLine2 String yes delivery additional address information (e.g. floor)
DeliveryPostCode String yes delivery post code
DeliveryPhoneNumber String yes delivery phone number
DeliveryCity String yes delivery city
DeliveryStateCode String yes delivery state code, applied only for United States
DeliveryCountry String yes delivery country identifier
DeliveryCountryName String yes delivery country name
DeliveryAddressSame Boolean no if delivery address is same as billing

ProtectionInformation

related DTO
Property Data type Nullable Description
ProtectedTicketsCount Integer no protected tickets count
TotalProtectionPrice Decimal no total protection price
Property Data type Nullable Description
Width Integer no image width
Height Integer no image height
Url String no image url

EventMultimediaContent

related DTO
Property Data type Nullable Description
Type EventMultimediaContentType no see EventMultimediaContentType enumeration for further information
Url String no content url

Country

related DTO
Property Data type Nullable Description
CountryId Integer no country identifier
CountryName String no country name
Ordering Integer no country order
ISO3166 String no worldwide country identifier

GetCountriesResult

related DTO
Property Data type Nullable Description
Countries Collection of Country no contains information about a country

USState

related DTO
Property Data type Nullable Description
StateId Integer no country identifier
StateName String no state name
StateCode String no state code

GetUSStatesResult

related DTO
Property Data type Nullable Description
USStates Collection of USState no contains information about an US state

DeliveryType

related DTO
Property Data type Nullable Description
DeliveryTypeId Integer no delivery type identifier
DeliveryTypeName String yes delivery type name
DeliveryTypePrice Decimal no delivery type price

GetDeliveryTypesResult

related DTO
Property Data type Nullable Description
DeliveryTypes Collection of DeliveryType no contains information about a delivery type

EventType

related DTO
Property Data type Nullable Description
EventTypeId Integer no event type identifier
EventTypeName String yes event type name

GetEventTypesResult

related DTO
Property Data type Nullable Description
EventTypes Collection of EventType no contains information about an event type