reservation Data Type

A reservation is a ticket or receipt made for a trip. This also includes service or penalty fees, but not car and hotel reservations because those are not charged at the time of reservation.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs constraints description
addCollect double element 0/1   The amount that must be paid to make the difference after an exchange.
baseAmount double element 0/1   The amount that is owed before taxes.
commissionAmount double element 0/1   The commission amount the agency can expect for this ticket.
electronic boolean element 1/1 required boolean true / false if this ticket was booked electronically
endorsement string element 0/1   Returns the endorsement describing the restrictions of the fare
exchangedTicketNumber string element 0/1   The number for the ticket that was exchanged for this one.
fareCalculation string element 0/1   The fare calculation is a short explanation of the fares and their pricing.
hidden boolean element 1/1 required boolean Whether the reservation should be hidden by the end user or not.
issueDate dateTime element 0/1   The issued date of the reservation.
passengerName string element 0/1   The passenger name that is on the ticket.
payments list of payment element 0/unbounded   The payments for this reservation.
refundable boolean element 1/1 required boolean Whether or not this ticket is refundable.
status reservationStatus element 1/1 required The status of this ticket.
taxes list of reservationTax element 0/unbounded   The taxes included with this fare.
ticketNumber string element 0/1 max size: 16, min size: 0 The ticket number of the reservation.
totalAmount double element 0/1   The total amount that is owed.
type reservationType element 1/1 required The travel type this reservation is for.
vendor string element 0/1   The name of the vendor receiving the funds for this ticket.
Properties inherited from baseHibernateEntity
id long element 0/1   The unique internal ID of the object.
version long element 0/1   For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from baseEntity
violations list of simpleViolation element 0/unbounded   A list of constraint violations, if any, that this object has.

Example

<reservation>
  <ticketNumber>...</ticketNumber>
  <issueDate>...</issueDate>
  <electronic>...</electronic>
  <type>
    <name>...</name>
    <id>...</id>
    <version>...</version>
  </type>
  <status>
    <name>...</name>
    <id>...</id>
    <version>...</version>
  </status>
  <payments>
    <amount>...</amount>
    <currency>...</currency>
    <paymentCode>...</paymentCode>
    <creditCardType>...</creditCardType>
    <notes>...</notes>
    <lastDigits>...</lastDigits>
    <id>...</id>
    <version>...</version>
  </payments>
  <hidden>...</hidden>
  <passengerName>...</passengerName>
  <totalAmount>...</totalAmount>
  <baseAmount>...</baseAmount>
  <taxes>
    <amount>...</amount>
    <code>...</code>
    <id>...</id>
    <version>...</version>
  </taxes>
  <vendor>...</vendor>
  <addCollect>...</addCollect>
  <commissionAmount>...</commissionAmount>
  <refundable>...</refundable>
  <exchangedTicketNumber>...</exchangedTicketNumber>
  <fareCalculation>...</fareCalculation>
  <endorsement>...</endorsement>
  <id>...</id>
  <version>...</version>
  <violations/>
</reservation>