Skip to content

Latest commit

 

History

History
556 lines (271 loc) · 8.93 KB

experienceevent-flight-reservation.schema.md

File metadata and controls

556 lines (271 loc) · 8.93 KB
Raw

Flight Reservation Schema

https://ns.adobe.com/xdm/mixins/industry-verticals/experienceevent-flight-reservation

Collects all details specific to a flight reservation.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental No Forbidden Permitted mixins/experience-event/industry-verticals/experienceevent-flight-reservation.schema.json

Schema Hierarchy

  • Flight Reservation https://ns.adobe.com/xdm/mixins/industry-verticals/experienceevent-flight-reservation
    • Reservation Details https://ns.adobe.com/xdm/mixins/industry-verticals/experienceevent-reservation-details

Flight Reservation Example

{
  "xdm:flightReservation": {
    "xdm:arrivalLocation": "SYD",
    "xdm:departureLocation": "LAX",
    "xdm:fareClass": "business class",
    "xdm:flightDate": "2004-09-22T15:52:25+00:00",
    "xdm:flightNumber": "815",
    "xdm:loyaltyID": "H1102199221",
    "xdm:passenger": {
      "xdm:name": {
        "xdm:firstName": "Jane",
        "xdm:middleName": "F",
        "xdm:lastName": "Doe",
        "xdm:fullName": "Jane F. Doe"
      },
      "xdm:birthDate": "1996-01-19",
      "xdm:gender": "female"
    }
  },
  "xdm:reservationID": "RM8I9FG7HR",
  "xdm:seatMapProcess": {
    "xdm:tool-usage": {
      "xdm:toolUsageCancelled": 1,
      "xdm:toolUsageComplete": 1,
      "xdm:toolUsageFailure": 1,
      "xdm:toolUsageID": "T421",
      "xdm:toolUsageName": "seat map selection",
      "xdm:toolUsageSaved": 1,
      "xdm:toolUsageStart": 1,
      "xdm:toolUsageStep": 1,
      "xdm:toolUsageStepName": "select seat",
      "xdm:toolUsageSubmitted": 1,
      "xdm:toolUsageType": "generic"
    }
  },
  "xdm:securityScreening": "PreCheck"
}

Flight Reservation Properties

Property Type Required Defined by
xdm:reservations object Optional Reservation Details
* any Additional this schema allows additional properties

xdm:reservations

xdm:reservations

xdm:reservations Type

object with following properties:

Property Type Required
xdm:ID string Optional
xdm:ancillaryRevenue Optional
xdm:cancellation integer Optional
xdm:confirmationNumber string Optional
xdm:created integer Optional
xdm:currencyCode string Optional
xdm:endDate string Optional
xdm:itemComparison Optional
xdm:length integer Optional
xdm:modification integer Optional
xdm:modificationDate string Optional
xdm:nonRefundableAmount Optional
xdm:numberOfAdults integer Optional
xdm:numberOfChildren integer Optional
xdm:processSteps Optional
xdm:purpose string Optional
xdm:rackrate Optional
xdm:startDate string Optional
xdm:transaction Optional
xdm:triptype string Optional
xdm:type string Optional

xdm:ID

ID

Tracks the reservation number/identifier.

xdm:ID

  • is optional
  • type: string
xdm:ID Type

string

xdm:ancillaryRevenue

Ancillary Revenue

Protection and equipment revenue associated with a reservation.

xdm:ancillaryRevenue

  • is optional
  • type: reference
xdm:ancillaryRevenue Type
  • – https://ns.adobe.com/xdm/datatypes/currency

xdm:cancellation

Cancellation

Tracked when a reservation has been cancelled.

xdm:cancellation

  • is optional
  • type: integer
xdm:cancellation Type

integer

xdm:confirmationNumber

Confirmation Number

Tracks the reservation confirmation number/identifier.

xdm:confirmationNumber

  • is optional
  • type: string
xdm:confirmationNumber Type

string

xdm:created

Created

Tracked when a reservation has been created.

xdm:created

  • is optional
  • type: integer
xdm:created Type

integer

xdm:currencyCode

Currency Code

Currency code used to make the purchase. ISO 4217 currency code.

xdm:currencyCode

  • is optional
  • type: string
xdm:currencyCode Type

string

All instances must conform to this regular expression (test examples here):

^[A-Z]{3}$

xdm:endDate

End Date

The end drop-off/return/check-out date of the reservation.

xdm:endDate

  • is optional
  • type: string
xdm:endDate Type

string

xdm:itemComparison

Item Comparison

Used to track room, flight, vehicle, or restaurant comparisons on a site or an app.

xdm:itemComparison

  • is optional
  • type: reference
xdm:itemComparison Type
  • – https://ns.adobe.com/xdm/datatypes/comparisons

xdm:length

Length

Tracks the total number of days for a reservation.

xdm:length

  • is optional
  • type: integer
xdm:length Type

integer

xdm:modification

Modification

Captured when a reservation has been modified.

xdm:modification

  • is optional
  • type: integer
xdm:modification Type

integer

xdm:modificationDate

Modification Date

Tracks when a reservation has been modified.

xdm:modificationDate

  • is optional
  • type: string
xdm:modificationDate Type

string

xdm:nonRefundableAmount

Non-Refundable Amount

Amount of the reservation price that is marked as non-refundable.

xdm:nonRefundableAmount

  • is optional
  • type: reference
xdm:nonRefundableAmount Type
  • – https://ns.adobe.com/xdm/datatypes/currency

xdm:numberOfAdults

Number of Adults

Captures the number of adults associated with the reservation.

xdm:numberOfAdults

  • is optional
  • type: integer
xdm:numberOfAdults Type

integer

xdm:numberOfChildren

Number of Children

Captures the number of children associated with the reservation.

xdm:numberOfChildren

  • is optional
  • type: integer
xdm:numberOfChildren Type

integer

xdm:processSteps

Process Steps

Extension of toolUsage data type.

xdm:processSteps

  • is optional
  • type: reference
xdm:processSteps Type
  • – https://ns.adobe.com/xdm/datatypes/tool-usage

xdm:purpose

Purpose

Tracks the purpose of the reservation, typically either business or personal.

xdm:purpose

  • is optional
  • type: enum

The value of this property must be equal to one of the known values below.

xdm:purpose Known Values
Value Description
business
personal

xdm:rackrate

Rack Rate

Cost for the same day reservation without prior booking arrangements.

xdm:rackrate

  • is optional
  • type: reference
xdm:rackrate Type
  • – https://ns.adobe.com/xdm/datatypes/currency

xdm:startDate

Start Date

The start pick-up/outbound/check-in date of the reservation.

xdm:startDate

  • is optional
  • type: string
xdm:startDate Type

string

xdm:transaction

Transaction

Extension of transaction data type.

xdm:transaction

  • is optional
  • type: reference
xdm:transaction Type
  • – https://ns.adobe.com/xdm/datatypes/transaction

xdm:triptype

Trip Type

Indicates if the reservation is for a one way, round trip, or multi-city.

xdm:triptype

  • is optional
  • type: enum

The value of this property must be equal to one of the known values below.

xdm:triptype Known Values
Value Description
roundtrip
one-way
multi-city

xdm:type

Type

Records the type of reservation being placed.

xdm:type

  • is optional
  • type: string
xdm:type Type

string