Data Definition

Name Description
AdditionalField A definition of a question to be asked of the ticket buyer, in the form:
  • name (String): the key for the field
  • adminName (String): the server-side key for the field (don't use this one)
  • fieldType (String): a standard field type, or CUSTOM
  • label (String): the description of the field to be displayed to the ticket buyer
  • inputType (String): AUTOCOMPLETE, TEXT, TEXTAREA, DATE, SELECT - a hint as to how to display the input
  • index (Number): sort order for the field
  • child (Boolean): whether the input appears conditionally
  • values (List[String]): possible values for a SELECT
  • metadata (Map): other metadata about the input
AdditionalFieldWithTickets All the fields on AdditionalField, and also:
  • ticketTypes (List[Ref]): the ticket types this field is used for
Address A postal address in the form:
  • streetAddress1 (String): the first line of the street address
  • streetAddress2 (String): the second line of the street address
  • postcode (String): the postcode of the street address
  • state (String): the state
  • country (String): the country
Admission Details of an Admission (a ticket in a sale) in the form:
  • saleDate (Date): the time the sale was created
  • orderId (Number): the ID of the sale
  • orderRef (String): the key for the sale
  • eventDate (Date): the time the event date starts
  • eventName (String): the name of the event
  • ticketId (Number): the ID of the Admission
  • ticketName (String): the name of the Ticket Type
  • scans (List[Scan]): scans of the Admission
  • reservationStatus (String): the status of the Admission: NOT_RESERVED, RESERVED, PENDING_GUEST_DETAILS, CONFIRMED, REFUNDED, RETURNED
  • ticketPrice (Currency): the face value of the ticket
  • discountCode (String): the booking code used for the sale
  • customer (Map): the payee details
AdmissionResult One of:
  • SUCCESSFUL
  • ALREADY_ADMITTED
AllocationType One of:
  • GENERAL_ADMISSION
  • BEST_AVAILABLE
  • RESERVED_ALLOCATION
CartItem An item in a cart (reserved tickets or other items such as surcharges) in the form:
  • ticketType optional (Ref): the type of ticket
  • description (String): text describing the item
  • quantity (Number): how many of the item are reserved
  • sortIndex (Number): ordering for display
  • lineTotal (Currency): the total cost for this item
  • fees (Currency): fees for a single item
  • price (Currency): face value for a single item
CartSale A reserved sale in the form:
  • saleKey (String): the unique key for the sale
  • event (Ref): the event the sale is for
  • total (Currency): the total amount to be paid
  • tax (Currency): the tax component of the total
  • discount (Currency): the total discounts applying to this sale
  • items (List[CartItem]): the items in this sale
CartSalePaymentResponse A response to the attempted payment of one sale in the form:
  • saleKey (String): the unique key for the sale
  • status (String): the status of the sale before payment was attempted
    • RESERVED
    • LOCKED
    • PROCESSING
    • CONFIRMED
    • UNFULFILLED
  • successful (Boolean): whether payment succeeded
  • amount (Currency): the amount that was charged
Currency A currency in the form:
  • code (String): ISO 4217
  • value (Numeric): a represented value of currency.
Customer A customer in the form:
  • firstName (String): the first name of the customer
  • lastName (String): the last name of the customer
  • emailAddress (Email): the email address of the customer
  • mobilePhone (Phone): the phone number of the customer
Date A date in ISO8601 format (yyyy-MM-ddTHH:mm:ss:SSSZZ).
Email A valid email address.
Invoice An Invoice in the form:
  • subTotal (Currency)
  • taxTotal (Currency)
  • totalPaid (Currency)
  • lineItems (List[Map])
    • description (String)
    • quantity (Number)
    • unitPrice (Currency)
    • lineTotal (Currency)
    • taxTotal (Currency)
List An array.
Number A numeric value.
PaddingStrategy The padding strategy of a venue section:
  • CENTRE
  • XY_PLOT
PaymentTransaction A payment transaction in the form:
  • type (String) REFUND or PAYMENT
  • created (String)
  • total (Currency)
  • eftpos (Currency)
  • cash (Currency)
  • credit (Currency)
  • cardNumber (String)
  • txRef (String)
  • successful (Boolean)
  • refund (Boolean)
  • return (Boolean)
Phone A valid phone number.
Ref A reference to another entity. Is of the form:
  • id (Number): the id of the referenced entity.
  • link (URL): the URL of the referenced entity.
  • name (String): some value that describes this entity.
ReservationStatus (String) one of:
  • NOT_RESERVED
  • RESERVED
  • PENDING_GUEST_DETAILS
  • CONFIRMED
  • REFUNDED
SaleStatus (String) one of:
  • NOT_AVAILABLE_FOR_SALE_PUBLIC_OR_PRIVATE
  • NOT_AVAILABLE_FOR_SALE
  • AVAILABLE_FOR_SALE
  • AVAILABLE_FOR_SALE_FROM
  • SOLD_OUT
  • WITHDRAWN
Scan A scan of an Admission, in the form:
  • scannedDate (Date): when the scan happened.
  • scannedBy (String): the user who did the scanning.
String A textual value.