CBT Web Services: displaySegment

Namespace: (Default)
Schema: ns0.xsd

Properties
name	data type	type	min/max occurs	constraints	description
accomodationCode	string	element	0/1		The accomodation code that the traveler reserved. This is similar to a class of service.
additionalRoomTax	string	element	0/1		Additional tax that is applied to a hotel room stay.
baggageLink	string	element	0/1		A link to any baggage information from an airline. The DoT requires this to be displayed on all electronic confirmations.
cancellationNumber	string	element	0/1		The cancellation number for this reservation.
cancellationPolicy	string	element	0/1		The cancellation policy for this reservation.
carAirConditioning	boolean	element	0/1		The type of air conditioning the rented equipment has.
carClass	string	element	0/1		The class of vehicle the rented equipment is.
carNumber	string	element	0/1		The car number the seats are located in.
carTransmission	string	element	0/1		The type of transmission the rented equipment has.
carType	string	element	0/1		The type of car the rented equipment has.
checkOutPenalty	string	element	0/1
checkinLink	string	element	0/1		A link to the airline's early checkin webpage.
classOfService	string	element	0/1		The class of service that the traveler will receive during the segment.
codeShareInformation	string	element	0/1		The name of the operating airline when a codeshare is applied. This is required by the DoT to be on all electronic confirmation documents.
codeShareNumber	string	element	0/1		The confirmation code for the operating airline when a codeshare is applied.
confirmationNumber	string	element	0/1		The confirmation number for this reservation.
corpDiscountNumber	string	element	0/1		The corporate discount number used for this reservation.
customerId	string	element	0/1		The customer or membership ID used for this reservation.
deliveryNotes	string	element	0/1		Any delivery notes about the delivery of the rented equipment.
dropOffCharges	string	element	0/1		Any additional charges that will occur when the equipment is dropped off.
endCityCode	string	element	0/1		The IATA city code of the ending location.
endLatitude	double	element	0/1		The latitude of the ending location.
endLocationAddress1	string	element	0/1		The end location address for this segment.
endLocationAddress2	string	element	0/1		The second line of the ending address of this segment.
endLocationCity	string	element	0/1		The city that this segment ends in.
endLocationCountryCode	string	element	0/1		The country code the reservation ends in.
endLocationFaxNumber	string	element	0/1		The fax number for the ending location.
endLocationHours	string	element	0/1		The daily hours of the end location of this segment.
endLocationName	string	element	0/1		The name of the ending location
endLocationPhoneNumber	string	element	0/1		The phone number to contact the ending location for this segment.
endLocationStateCountry	string	element	0/1		The country that this segment ends in.
endLocationStateOrRegionCode	string	element	0/1		The state or region code the reservation ends in.
endLocationZip	string	element	0/1		The zip code that this segment ends in.
endLongitude	double	element	0/1		The longitude of the ending location.
endTerminal	string	element	0/1		The arrival (or ending) terminal for this segment.
endTime	string	element	0/1		The time that the segment will end.
endTimeUTC	string	element	0/1		The end time of the segment, in UTC.
endTimeZone	string	element	0/1		The time zone that the segment ends in.
flightNumber	string	element	0/1		The flight number for the segment.
flightTime	string	element	0/1		The expected time that will pass according to the perspective of the traveler.
frequentTravelerNumber	string	element	0/1		The frequent traveler / guest number for this reservation.
grandTotal	string	element	0/1		A number representation of the expected total amount of the reservation.
groundTime	string	element	0/1		The amount of time that will pass per the perspective of an observer on the ground.
guaranteeRequirements	string	element	0/1		The requirements to meet to qualify for a guarantee for the reservation.
hplRequeueUrl	string	element	0/1		A shortcut URL to activate HotelPrePayLogic services.
legMileage	int	element	0/1		The mileage that is counted for this leg/segment of the trip.
notes	list of displayNotes	element	0/unbounded		Custom notes for this segment.
number	int	element	0/1		The number to order this segment by.
numberOfChildren	int	element	0/1		The number of children included in the reservation.
numberOfGuests	int	element	0/1		The number of guests expected to reside in the reserved equipment.
numberOfRooms	int	element	0/1		The number of rooms reserved.
numberOfStops	int	element	0/1		Get the number of stops that will happen during the segment.
officialStatus	boolean	element	1/1	required boolean	Whether or not this status is officially recognized by the travel vendor.
percentageOnTime	int	element	0/1		The percentage that this flight is considered on time for arrival.
rateDetails	list of displayRate	element	0/unbounded		A breakdown of the rates, organized by cost types.
rateInfo	string	element	0/1		A plain english representation of the total approximate rate.
renterName	string	element	0/1		The name of the renter for this reservation.
roomDescription	string	element	0/1		A plain english description of the room reserved.
roomNumber	string	element	0/1		The room number that the beds / seats are located in.
seats	list of displaySeat	element	0/unbounded		A list of seats reserved during the segment.
startCityCode	string	element	0/1		The IATA city code of the starting location.
startLatitude	double	element	0/1		The latitude of the starting location.
startLocationAddress1	string	element	0/1		The start location address of this segment.
startLocationAddress2	string	element	0/1		The second line of the start location address of this segment.
startLocationCity	string	element	0/1		The city that the start location resides in.
startLocationCountryCode	string	element	0/1		The country code the reservation starts in.
startLocationFaxNumber	string	element	0/1		The fax number for the starting location.
startLocationHours	string	element	0/1		The daily hours of the start location of this segment.
startLocationName	string	element	0/1		The name of the starting location.
startLocationPhoneNumber	string	element	0/1		The phone number for the start location.
startLocationStateCountry	string	element	0/1		The country the reservation starts in.
startLocationStateOrRegionCode	string	element	0/1		The state or region code the reservation starts in.
startLocationZip	string	element	0/1		The zip code for the start location.
startLongitude	double	element	0/1		The longitude of the starting location.
startTerminal	string	element	0/1		The departure (or starting) terminal for this segment.
startTime	string	element	0/1		The time that the segment will begin.
startTimeUTC	string	element	0/1		The start time of the segment, in UTC.
startTimeZone	string	element	0/1		The time zone that the start location is in.
status	string	element	0/1		The status of this reservation.
stopOvers	list of displayStopOver	element	0/unbounded		A list of cities that a segment will be stopping at during the voyage.
totalMiles	int	element	0/1		The total amount of miles that will be traveled during this segment.
totalTime	string	element	0/1		The total amount of time that will pass during this segment.
trainNumber	string	element	0/1		The number of the train the seat is reserved on.
travelOptions	list of displayOption	element	0/unbounded		An array of name value pairs that convey other information about the segment.
type	string	element	0/1		The type of segment.
vehicleInfo	string	element	0/1		Information about the vehicle used for the segment.
vendorName	string	element	0/1		The name of the vendor supplying the segment
vendorNotes	string	element	0/1		Notes from the vendor about the reservation.
voucher	string	element	0/1		A voucher number used to reduce the price.

Example

<displaySegment>
  <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>
  <startLocationCountryCode>...</startLocationCountryCode>
  <startLocationStateOrRegionCode>...</startLocationStateOrRegionCode>
  <endLocationCountryCode>...</endLocationCountryCode>
  <endLocationStateOrRegionCode>...</endLocationStateOrRegionCode>
  <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>
</displaySegment>

displaySegment Data Type