displayItinerary Data Type

A display itinerary has all of the details in an itinerary that a traveler would want to see. This should contain specifics like notes from our system (but not from the GDS) and should have all of the parts a traveler would not care about removed.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs description
afterHoursNumber string element 0/1 The phone number that the passenger should call after normal business hours for travel support.
string element 0/1 The URL to the Travel Agency's logo.
agencyLogoLink string element 0/1 The URL of the travel agency's webpage.
approval displayApproval element 0/1  
bannerAdImageUrl string element 0/1 A URL to a banner ad that should be shown on the trip's travel document.
bannerAdLink string element 0/1  
bookingAgent string element 0/1 The name of the agent that booked this trip.
bookingAgentEmail string element 0/1 The email of the agent that booked this trip.
citySummary string element 0/1 Get the summary of the start and end locations for the PNR.
client string element 0/1 The name of the account.
clientId long element 0/1 The internal ID of the account this trip is booked under.
string element 0/1 The logo of the client that bought this trip.
clientLogoLink string element 0/1 The URL of the client's home webpage.
contactNumber string element 0/1 A phone number that the traveler can use to contact their agent.
customLinks list of displayLink element 0/unbounded Custom links that should be displayed on the trip document.
departureCity string element 0/1 The name of the departure city of the trip.
destinationCity string element 0/1 The name of the destination city of the trip.
endDate string element 0/1  
endDateUTC string element 0/1 The end date of this trip, in UTC.
endTimeZone string element 0/1 The time zone of the last stop of this trip.
estimatedBaseAmount string element 0/1 An estimate of the base cost of the given trip (without taxes).
estimatedTaxes string element 0/1 An estimate of the total taxes accumulated for this trip.
estimatedTotalAmount string element 0/1 An estimated total amount that it will cost for this trip.
hidden boolean element 1/1 Whether or not this trip is ready for traveler viewing.
hotelAttachment displayHotelAttachment element 0/1  
id long element 0/1 This itinerary's internal airportal id.
importDate dateTime element 0/1 The import date of this trip.
invoiceFirst boolean element 1/1 Whether or not to show the invoice at the top of a trip document or the bottom.
invoices list of displayInvoice element 0/unbounded The invoices for this itinerary.
notes list of displayNotes element 0/unbounded Any notes added to this itinerary.
onlineSupportNumber string element 0/1 The online support number a traveler can get help with online bookings from
passengers list of displayPassenger element 0/unbounded  
promotionalLinks list of displayLink element 0/unbounded A list of promotional links to display on this trip's travel document.
quotes list of displayQuote element 0/unbounded A list of quotes that the agent gave to the traveler as options to book.
recordLocator string element 0/1 The agency locator for this itinerary.
segments list of displaySegment element 0/unbounded The segments, in chronological order.
showCalendar boolean element 1/1 Whether or not to allow the traveler to download a calendar version of this trip.
showPdf boolean element 1/1 Whether or not to allow the traveler to download a PDF version of this trip.
showText boolean element 1/1  
showTravelPolicy boolean element 1/1 Whether or not to show the travel policy on this trip's travel document.
startDate string element 0/1 The start date of the trip, in local time.
startDateUTC string element 0/1 The start date of this trip, in UTC.
startTimeZone string element 0/1 The time zone of the first departure of this trip.
tmcAddress string element 0/1 Get the Travel Management Company's first line of their address.
tmcCityStateZip string element 0/1 Get the Travel Management Company's second line of their address.
tmcName string element 0/1 Get the name of the Travel Management Company.
tollFreeNumber string element 0/1 The toll free number the traveler can contact the agent by.
topNotes list of displayNotes element 0/unbounded Notes to display at the top of the trip document.
totalCharged string element 0/1 The total amount that this trip will cost.
udids list of displayOption element 0/unbounded Get all UDIDs that should be displayed.
Properties inherited from baseEntity
violations list of simpleViolation element 0/unbounded A list of constraint violations, if any, that this object has.

Example

<displayItinerary>
  <passengers>
    <name>...</name>
    <customName>...</customName>
    <id>...</id>
    <userId>...</userId>
    <userName>...</userName>
    <email>...</email>
    <passportNumber>...</passportNumber>
    <knownTravelerNumber>...</knownTravelerNumber>
  </passengers>
  <segments>
    <checkOutPenalty>...</checkOutPenalty>
    <number>...</number>
    <notes>
      <number>...</number>
      <text>...</text>
    </notes>
    <type>...</type>
    <startLocationName>...</startLocationName>
    <endLocationName>...</endLocationName>
    <vendorName>...</vendorName>
    <startTime>...</startTime>
    <endTime>...</endTime>
    <startLocationHours>...</startLocationHours>
    <endLocationHours>...</endLocationHours>
    <startLocationAddress1>...</startLocationAddress1>
    <startLocationAddress2>...</startLocationAddress2>
    <startLocationPhoneNumber>...</startLocationPhoneNumber>
    <startLocationCity>...</startLocationCity>
    <guaranteeRequirements>...</guaranteeRequirements>
    <startLocationZip>...</startLocationZip>
    <dropOffCharges>...</dropOffCharges>
    <numberOfStops>...</numberOfStops>
    <cancellationNumber>...</cancellationNumber>
    <cancellationPolicy>...</cancellationPolicy>
    <numberOfChildren>...</numberOfChildren>
    <startLocationStateCountry>...</startLocationStateCountry>
    <endLocationAddress1>...</endLocationAddress1>
    <startTerminal>...</startTerminal>
    <endTerminal>...</endTerminal>
    <endLocationAddress2>...</endLocationAddress2>
    <endLocationPhoneNumber>...</endLocationPhoneNumber>
    <endLocationCity>...</endLocationCity>
    <endLocationZip>...</endLocationZip>
    <endLocationStateCountry>...</endLocationStateCountry>
    <status>...</status>
    <confirmationNumber>...</confirmationNumber>
    <renterName>...</renterName>
    <frequentTravelerNumber>...</frequentTravelerNumber>
    <corpDiscountNumber>...</corpDiscountNumber>
    <customerId>...</customerId>
    <carTransmission>...</carTransmission>
    <carType>...</carType>
    <carAirConditioning>...</carAirConditioning>
    <carClass>...</carClass>
    <deliveryNotes>...</deliveryNotes>
    <totalTime>...</totalTime>
    <totalMiles>...</totalMiles>
    <baggageLink>...</baggageLink>
    <checkinLink>...</checkinLink>
    <startLocationFaxNumber>...</startLocationFaxNumber>
    <endLocationFaxNumber>...</endLocationFaxNumber>
    <vendorNotes>...</vendorNotes>
    <rateInfo>...</rateInfo>
    <grandTotal>...</grandTotal>
    <roomDescription>...</roomDescription>
    <stopOvers>
      <code>...</code>
      <arrivalDate>...</arrivalDate>
      <departureDate>...</departureDate>
      <locationName>...</locationName>
      <cityName>...</cityName>
      <stateCountry>...</stateCountry>
    </stopOvers>
    <flightNumber>...</flightNumber>
    <classOfService>...</classOfService>
    <seats>
      <name>...</name>
      <status>...</status>
      <seat>...</seat>
      <seatClass>...</seatClass>
      <meal>...</meal>
      <frequentFlyerNumber>...</frequentFlyerNumber>
      <position>...</position>
    </seats>
    <carNumber>...</carNumber>
    <roomNumber>...</roomNumber>
    <accomodationCode>...</accomodationCode>
    <numberOfRooms>...</numberOfRooms>
    <numberOfGuests>...</numberOfGuests>
    <additionalRoomTax>...</additionalRoomTax>
    <hplRequeueUrl>...</hplRequeueUrl>
    <travelOptions>
      <name>...</name>
      <value>...</value>
      <position>...</position>
    </travelOptions>
    <startCityCode>...</startCityCode>
    <endCityCode>...</endCityCode>
    <startLatitude>...</startLatitude>
    <startLongitude>...</startLongitude>
    <endLatitude>...</endLatitude>
    <endLongitude>...</endLongitude>
    <flightTime>...</flightTime>
    <codeShareNumber>...</codeShareNumber>
    <codeShareInformation>...</codeShareInformation>
    <vehicleInfo>...</vehicleInfo>
    <legMileage>...</legMileage>
    <groundTime>...</groundTime>
    <percentageOnTime>...</percentageOnTime>
    <rateDetails>
      <type>...</type>
      <amount>...</amount>
      <limit>...</limit>
      <extra>...</extra>
      <effectiveDate>...</effectiveDate>
      <endDate>...</endDate>
    </rateDetails>
    <trainNumber>...</trainNumber>
    <startTimeUTC>...</startTimeUTC>
    <endTimeUTC>...</endTimeUTC>
    <startTimeZone>...</startTimeZone>
    <endTimeZone>...</endTimeZone>
    <voucher>...</voucher>
    <officialStatus>...</officialStatus>
  </segments>
  <invoices>
    <number>...</number>
    <tickets>
      <ticketNumber>...</ticketNumber>
      <issueDate>...</issueDate>
      <type>...</type>
      <passengerName>...</passengerName>
      <baseAmount>...</baseAmount>
      <totalAmount>...</totalAmount>
      <totalTax>...</totalTax>
      <payment>...</payment>
      <vendor>...</vendor>
      <invoiceNumber>...</invoiceNumber>
    </tickets>
    <totalCharged>...</totalCharged>
    <totalTax>...</totalTax>
    <taxes>
      <code>...</code>
      <value>...</value>
    </taxes>
    <totalAirfare>...</totalAirfare>
    <totalServicefee>...</totalServicefee>
    <totalCredit>...</totalCredit>
    <name>...</name>
    <totalRefunded>...</totalRefunded>
  </invoices>
  <notes>
    <number>...</number>
    <text>...</text>
  </notes>
  <recordLocator>...</recordLocator>
  <id>...</id>
  <citySummary>...</citySummary>
  <bookingAgent>...</bookingAgent>
  <bookingAgentEmail>...</bookingAgentEmail>
  <afterHoursNumber>...</afterHoursNumber>
  <endDate>...</endDate>
  <startDate>...</startDate>
  <client>...</client>
  <topNotes>
    <number>...</number>
    <text>...</text>
  </topNotes>
  <customLinks>
    <text>...</text>
    <url>...</url>
  </customLinks>
  <agencyLogoLink>...</agencyLogoLink>
  <clientLogoLink>...</clientLogoLink>
  <clientLogo>...</clientLogo>
  <promotionalLinks>
    <text>...</text>
    <url>...</url>
  </promotionalLinks>
  <showPdf>...</showPdf>
  <showCalendar>...</showCalendar>
  <agencyLogo>...</agencyLogo>
  <clientId>...</clientId>
  <totalCharged>...</totalCharged>
  <hidden>...</hidden>
  <tmcName>...</tmcName>
  <tmcAddress>...</tmcAddress>
  <tmcCityStateZip>...</tmcCityStateZip>
  <estimatedTotalAmount>...</estimatedTotalAmount>
  <estimatedTaxes>...</estimatedTaxes>
  <estimatedBaseAmount>...</estimatedBaseAmount>
  <contactNumber>...</contactNumber>
  <bannerAdImageUrl>...</bannerAdImageUrl>
  <bannerAdLink>...</bannerAdLink>
  <showTravelPolicy>...</showTravelPolicy>
  <tollFreeNumber>...</tollFreeNumber>
  <onlineSupportNumber>...</onlineSupportNumber>
  <invoiceFirst>...</invoiceFirst>
  <quotes>
    <baseAmount>...</baseAmount>
    <taxAmount>...</taxAmount>
    <totalAmount>...</totalAmount>
    <segments>...</segments>
  </quotes>
  <showText>...</showText>
  <importDate>...</importDate>
  <startDateUTC>...</startDateUTC>
  <endDateUTC>...</endDateUTC>
  <startTimeZone>...</startTimeZone>
  <endTimeZone>...</endTimeZone>
  <approval>
    <approvalUrl>...</approvalUrl>
    <rejectionUrl>...</rejectionUrl>
    <modificationUrl>...</modificationUrl>
    <messages>
      <name>...</name>
      <value>...</value>
      <position>...</position>
    </messages>
    <showButtons>...</showButtons>
    <history>
      <name>...</name>
      <value>...</value>
      <position>...</position>
    </history>
    <header>...</header>
    <title>...</title>
    <actionRequired>...</actionRequired>
    <subjectPrefix>...</subjectPrefix>
    <approved>...</approved>
    <approvalUdids>
      <id>...</id>
      <name>...</name>
    </approvalUdids>
    <udidUrl>...</udidUrl>
    <agentName>...</agentName>
    <showTimeLine>...</showTimeLine>
    <reminder>...</reminder>
  </approval>
  <hotelAttachment>
    <itineraryToken>...</itineraryToken>
    <online>...</online>
    <overnightSegments>...</overnightSegments>
    <agentAssistance>...</agentAssistance>
    <obe>...</obe>
    <requested>...</requested>
    <obeName>...</obeName>
    <confirmation>...</confirmation>
  </hotelAttachment>
  <destinationCity>...</destinationCity>
  <departureCity>...</departureCity>
  <udids>
    <name>...</name>
    <value>...</value>
    <position>...</position>
  </udids>
  <violations>
    <propertyName>...</propertyName>
    <failureMessage>...</failureMessage>
    <stackTrace>...</stackTrace>
  </violations>
</displayItinerary>