TicketUserServices

<back to all web services

TicketOrder

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequires the permission:ReadData
The following routes are available for this service:
GET POST/ticketOrder
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Ticket:
    id: Optional[int] = None
    user_id: Optional[int] = None
    user_auth_id: Optional[int] = None
    event_id: Optional[int] = None
    timestamp_bought: Optional[datetime.datetime] = None
    timestamp_activated: Optional[datetime.datetime] = None
    time_stamp_ordered: Optional[datetime.datetime] = None
    device_id: Optional[str] = None
    phone_verification_id: Optional[int] = None
    payment_method_id: Optional[str] = None
    payment_reference: Optional[str] = None
    ticket_status: Optional[str] = None
    phone_verification_number: Optional[str] = None
    ticket_token_id: Optional[str] = None
    payment_phone_number: Optional[str] = None
    ticket_transferred_from: Optional[int] = None
    original_phone_verification_number: Optional[str] = None
    team_pass_id: Optional[int] = None
    payment_id: Optional[str] = None
    is_free: Optional[bool] = None
    free_ticket_from_id: Optional[str] = None
    free_ticket_from_type_id: Optional[str] = None
    free_ticket_card_type_id: Optional[str] = None
    free_ticket_card_id: Optional[int] = None
    total_paid_for_ticket: Optional[Decimal] = None
    seats_reservation_id: Optional[str] = None
    time_stamp_last_status_change: Optional[datetime.datetime] = None
    last_ticket_status: Optional[str] = None
    scan_code: Optional[str] = None
    scan_code_type: Optional[str] = None
    scan_code_not_active: Optional[bool] = None
    multiple_scan_codes: Optional[bool] = None
    currency: Optional[str] = None
    ticket_has_expired: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TicketDetails:
    id: Optional[int] = None
    ticket_id: Optional[int] = None
    event_series_ticket_type: Optional[int] = None
    event_series_owner_ticket_type: Optional[int] = None
    ticket_price: Optional[Decimal] = None
    total_price: Optional[Decimal] = None
    count: Optional[int] = None
    ticket_color: Optional[str] = None
    show_used_tickets: Optional[bool] = None
    ticket_name: Optional[str] = None
    ticket_display_string: Optional[str] = None
    ticket_details_transferred_from: Optional[int] = None
    team_pass_id: Optional[int] = None
    is_special_ticket: Optional[bool] = None
    special_ticket_id: Optional[str] = None
    just_changed_by_s_q_l: Optional[bool] = None
    sql_just_changed_time_stamp: Optional[datetime.datetime] = None
    currency: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TicketHolderInfo:
    name: Optional[str] = None
    full_phone_number: Optional[str] = None
    holder_id: Optional[str] = None
    seat_id: Optional[int] = None
    seat_display_string: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExternalGateAccessCodeInfo:
    code: Optional[str] = None
    code_type: Optional[str] = None
    code_url: Optional[str] = None
    valid_from: Optional[datetime.datetime] = None
    valid_to: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TicketDetailsInfo(TicketDetails):
    holder_info_required: Optional[bool] = None
    block_transfer: Optional[bool] = None
    ticket_type_image_url: Optional[str] = None
    ticket_holders: Optional[List[TicketHolderInfo]] = None
    gate_access_codes: Optional[List[ExternalGateAccessCodeInfo]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EventDetails:
    id: Optional[int] = None
    name: Optional[str] = None
    description: Optional[str] = None
    external_reference: Optional[str] = None
    time_of_event: Optional[datetime.datetime] = None
    event_location_id: Optional[int] = None
    event_series_id: Optional[int] = None
    event_owner_id: Optional[int] = None
    event_active: Optional[bool] = None
    event_owner_name: Optional[str] = None
    external_owner_id: Optional[str] = None
    team_away_id: Optional[str] = None
    team_away_name: Optional[str] = None
    event_series_name: Optional[str] = None
    event_location_name: Optional[str] = None
    latitude: Optional[Decimal] = None
    longitude: Optional[Decimal] = None
    default_values: Optional[str] = None
    external_reference_type: Optional[str] = None
    event_series_active: Optional[bool] = None
    allowed_ksi_card: Optional[str] = None
    series_id: Optional[str] = None
    series_show_by_default: Optional[bool] = None
    postponed_no_date: Optional[bool] = None
    away_team_external_id: Optional[str] = None
    sport_gender_id: Optional[str] = None
    external_id_type: Optional[str] = None
    series_event_sale_suspended: Optional[bool] = None
    series_sale_suspension_event_start_date: Optional[datetime.datetime] = None
    series_sale_suspension_event_end_date: Optional[datetime.datetime] = None
    sale_is_active: Optional[bool] = None
    hide_event: Optional[bool] = None
    image_url2: Optional[str] = None
    direct_access_code: Optional[str] = None
    image_url: Optional[str] = None
    detailed_description: Optional[str] = None
    owner_image_url: Optional[str] = None
    owner_image_url2: Optional[str] = None
    owner_cards_not_allowed: Optional[bool] = None
    seating_image_url: Optional[str] = None
    end_of_event: Optional[datetime.datetime] = None
    end_of_event_u_t_c: Optional[datetime.datetime] = None
    time_zone: Optional[str] = None
    time_of_event_u_t_c: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EventTicketWithDetails:
    event_ticket: Optional[Ticket] = None
    event_ticket_details: Optional[List[TicketDetailsInfo]] = None
    event_info: Optional[EventDetails] = None
    event_is_today: Optional[bool] = None
    eventis_live: Optional[bool] = None
    minutes_to_event: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TicketOrderResult:
    ticket_and_details: Optional[EventTicketWithDetails] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TeamPassType:
    id: Optional[int] = None
    name: Optional[str] = None
    price: Optional[Decimal] = None
    series_id: Optional[int] = None
    owner_id: Optional[int] = None
    series_ticket_type: Optional[int] = None
    series_owner_ticket_type: Optional[int] = None
    is_active: Optional[bool] = None
    only_for_team_use: Optional[bool] = None
    timestamp_created: Optional[datetime.datetime] = None
    timestamp_last_changed: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TicketHoldersList:
    ticket_holders: Optional[List[TicketHolderInfo]] = None
    holder_info_required: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaymentMethodCreditCardInfo:
    payment_type: Optional[str] = None
    token: Optional[str] = None
    pan: Optional[str] = None
    exp_year: Optional[str] = None
    exp_month: Optional[str] = None
    cvc: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaymentRequestCreditCard:
    payment_method: Optional[PaymentMethodCreditCardInfo] = None
    amount: Optional[Decimal] = None
    currency: Optional[str] = None
    order_id: Optional[str] = None
    trans_action_date: Optional[datetime.datetime] = None
    save_card_to_token: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RequestSignature:
    system_id: Optional[str] = None
    system_secret: Optional[str] = None
    signature: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BorgunApplePayThreeDSecureInfo:
    data_type: Optional[str] = None
    security_level_ind: Optional[str] = None
    cavv: Optional[str] = None
    ucaf: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BorgunApplePayFinalInfo:
    order_id: Optional[str] = None
    three_d_secure: Optional[BorgunApplePayThreeDSecureInfo] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Borgun3DFinalPaymentMethodInfo:
    payment_type: Optional[str] = None
    token: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Borgun3DFinal3DSecureInfo:
    data_type: Optional[str] = None
    mpi_token: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Borgun3DFinalRequest:
    transaction_type: Optional[str] = None
    amount: Optional[int] = None
    currency: Optional[str] = None
    transaction_date: Optional[datetime.datetime] = None
    order_id: Optional[str] = None
    payment_method: Optional[Borgun3DFinalPaymentMethodInfo] = None
    three_d_secure: Optional[Borgun3DFinal3DSecureInfo] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TicketOrder:
    team_pass: Optional[TeamPassType] = None
    order: Optional[Ticket] = None
    order_details: Optional[List[TicketDetails]] = None
    ticket_holders: Optional[TicketHoldersList] = None
    seat_reservation_token_id: Optional[str] = None
    card_info: Optional[PaymentRequestCreditCard] = None
    payment_phone_number: Optional[str] = None
    payment_card_id: Optional[int] = None
    request_unix_u_t_c_time_stamp: Optional[int] = None
    signature: Optional[RequestSignature] = None
    phone_verification_number: Optional[str] = None
    device_id: Optional[str] = None
    dont_return_tickets: Optional[bool] = None
    app_meta_data: Optional[str] = None
    apple_pay_info: Optional[BorgunApplePayFinalInfo] = None
    borgun3_d_final_info: Optional[Borgun3DFinalRequest] = None

Python TicketOrder DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /ticketOrder HTTP/1.1 
Host: stubbur-autoupdates-live.smartnewapis.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	teamPass: 
	{
		id: 0,
		name: String,
		price: 0,
		seriesId: 0,
		ownerId: 0,
		seriesTicketType: 0,
		seriesOwnerTicketType: 0,
		isActive: False,
		onlyForTeamUse: False,
		timestampCreated: 0001-01-01,
		timestampLastChanged: 0001-01-01
	},
	order: 
	{
		id: 0,
		userId: 0,
		userAuthId: 0,
		eventId: 0,
		timestampBought: 0001-01-01,
		timestampActivated: 0001-01-01,
		timeStampOrdered: 0001-01-01,
		deviceId: String,
		phoneVerificationId: 0,
		paymentMethodId: String,
		paymentReference: String,
		ticketStatus: String,
		phoneVerificationNumber: String,
		ticketTokenId: String,
		paymentPhoneNumber: String,
		ticketTransferredFrom: 0,
		originalPhoneVerificationNumber: String,
		teamPassId: 0,
		paymentId: String,
		isFree: False,
		freeTicketFromId: String,
		freeTicketFromTypeId: String,
		freeTicketCardTypeId: String,
		freeTicketCardId: 0,
		totalPaidForTicket: 0,
		seatsReservationId: String,
		timeStampLastStatusChange: 0001-01-01,
		lastTicketStatus: String,
		scanCode: String,
		scanCodeType: String,
		scanCodeNotActive: False,
		multipleScanCodes: False,
		currency: String,
		ticketHasExpired: False
	},
	orderDetails: 
	[
		{
			id: 0,
			ticketId: 0,
			eventSeriesTicketType: 0,
			eventSeriesOwnerTicketType: 0,
			ticketPrice: 0,
			totalPrice: 0,
			count: 0,
			ticketColor: String,
			showUsedTickets: False,
			ticketName: String,
			ticketDisplayString: String,
			ticketDetailsTransferredFrom: 0,
			teamPassId: 0,
			isSpecialTicket: False,
			specialTicketId: String,
			justChangedBySQL: False,
			sqlJustChangedTimeStamp: 0001-01-01,
			currency: String
		}
	],
	ticketHolders: 
	{
		ticketHolders: 
		[
			{
				name: String,
				fullPhoneNumber: String,
				holderId: String,
				seatId: 0,
				seatDisplayString: String
			}
		],
		holderInfoRequired: False
	},
	seatReservationTokenId: String,
	cardInfo: 
	{
		paymentMethod: 
		{
			paymentType: String,
			token: String,
			pan: String,
			expYear: String,
			expMonth: String,
			cvc: String
		},
		amount: 0,
		currency: String,
		orderId: String,
		transActionDate: 0001-01-01,
		saveCardToToken: False
	},
	paymentPhoneNumber: String,
	paymentCardId: 0,
	requestUnixUTCTimeStamp: 0,
	signature: 
	{
		systemId: String,
		systemSecret: String,
		signature: String
	},
	phoneVerificationNumber: String,
	deviceId: String,
	dontReturnTickets: False,
	appMetaData: String,
	applePayInfo: 
	{
		orderId: String,
		threeDSecure: 
		{
			dataType: String,
			securityLevelInd: String,
			cavv: String,
			ucaf: String
		}
	},
	borgun3DFinalInfo: 
	{
		transactionType: String,
		amount: 0,
		currency: String,
		transactionDate: 0001-01-01,
		orderId: String,
		paymentMethod: 
		{
			paymentType: String,
			token: String
		},
		threeDSecure: 
		{
			dataType: String,
			mpiToken: String
		}
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ticketAndDetails: 
	{
		eventTicket: 
		{
			id: 0,
			userId: 0,
			userAuthId: 0,
			eventId: 0,
			timestampBought: 0001-01-01,
			timestampActivated: 0001-01-01,
			timeStampOrdered: 0001-01-01,
			deviceId: String,
			phoneVerificationId: 0,
			paymentMethodId: String,
			paymentReference: String,
			ticketStatus: String,
			phoneVerificationNumber: String,
			ticketTokenId: String,
			paymentPhoneNumber: String,
			ticketTransferredFrom: 0,
			originalPhoneVerificationNumber: String,
			teamPassId: 0,
			paymentId: String,
			isFree: False,
			freeTicketFromId: String,
			freeTicketFromTypeId: String,
			freeTicketCardTypeId: String,
			freeTicketCardId: 0,
			totalPaidForTicket: 0,
			seatsReservationId: String,
			timeStampLastStatusChange: 0001-01-01,
			lastTicketStatus: String,
			scanCode: String,
			scanCodeType: String,
			scanCodeNotActive: False,
			multipleScanCodes: False,
			currency: String,
			ticketHasExpired: False
		},
		eventTicketDetails: 
		[
			{
				
			}
		],
		eventInfo: 
		{
			id: 0,
			name: String,
			description: String,
			externalReference: String,
			timeOfEvent: 0001-01-01,
			eventLocationId: 0,
			eventSeriesId: 0,
			eventOwnerId: 0,
			eventActive: False,
			eventOwnerName: String,
			externalOwnerId: String,
			teamAwayId: String,
			teamAwayName: String,
			eventSeriesName: String,
			eventLocationName: String,
			latitude: 0,
			longitude: 0,
			defaultValues: String,
			externalReferenceType: String,
			eventSeriesActive: False,
			allowedKsiCard: String,
			seriesId: String,
			seriesShowByDefault: False,
			postponedNoDate: False,
			awayTeamExternalId: String,
			sportGenderId: String,
			externalIdType: String,
			seriesEventSaleSuspended: False,
			seriesSaleSuspensionEventStartDate: 0001-01-01,
			seriesSaleSuspensionEventEndDate: 0001-01-01,
			saleIsActive: False,
			hideEvent: False,
			imageUrl2: String,
			directAccessCode: String,
			imageUrl: String,
			detailedDescription: String,
			ownerImageUrl: String,
			ownerImageUrl2: String,
			ownerCardsNotAllowed: False,
			seatingImageUrl: String,
			endOfEvent: 0001-01-01,
			endOfEventUTC: 0001-01-01,
			timeZone: String,
			timeOfEventUTC: 0001-01-01
		},
		eventIsToday: False,
		eventisLive: False,
		minutesToEvent: 0
	},
	statusCode: 0,
	message: String
}