FlightDetailsRsp |
element |
|
|
|
|
| CommandHistory |
string simple type |
|
Optional |
|
HTTP link to download command history and debugging information of the request that generated this response. Must be enabled on the system. |
| ResponseTime |
decimal simple type |
|
Optional |
|
The time (in ms) the system spent processing this request, not including transmission times. |
| SponsoredFltTrnxId |
string simple type |
|
Optional |
|
Identifier for Sponsored Flight transaction information. |
| TraceId |
string simple type |
|
Optional |
|
Unique identifier for this atomic transaction traced by the user. Use is optional. |
| TransactionId |
string simple type |
|
Optional |
|
System generated unique identifier for this atomic transaction. |
| ResponseMessage |
element |
|
|
|
A simple textual fare note. Used within several other objects. |
| Code |
decimal simple type |
|
Required |
|
|
| Type |
string simple type |
Warning , Error , Info |
Optional |
|
Indicates the type of message (Warning, Error, Info) |
| ProviderCode |
string simple type |
|
Optional |
|
|
| SupplierCode |
string simple type |
|
Optional |
|
|
| AirSegment |
typeBaseAirSegment complex type |
|
|
|
An Air marketable travel segment. |
| Key |
string simple type |
|
Required |
|
|
| Passive |
boolean simple type |
|
Optional |
|
|
| ProviderSegmentOrder |
integer simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel/Rail segments/reservations in the provider reservation. |
| Status |
string simple type |
|
Optional |
|
Status of this segment. |
| TravelOrder |
decimal simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel segments/reservations based on travel dates. This ordering is applicable across the UR not provider or traveler specific |
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| APISRequirementsRef |
string simple type |
|
Optional |
|
Reference to the APIS Requirements for
this AirSegment. |
| AvailabilitySource |
string simple type |
|
Optional |
|
Indicates Availability source of
AirSegment. |
| BlackListed |
boolean simple type |
|
Optional |
|
Indicates blacklisted carriers which are banned from servicing points to, from and within the European Community. |
| BookingDate |
date simple type |
|
Optional |
|
Used for rapid reprice. The date the booking was made.
Providers: 1G/1V/1P/1S/1A |
| BrandIndicator |
string simple type |
|
Optional |
|
Value “B” specifies that the carrier supports Rich Content and Branding. The Brand Indicator is only returned in the availability search response. Provider: 1G, 1V, 1P, ACH |
| CabinClass |
string simple type |
|
Optional |
|
Specifies Cabin class for a group of
class of services. Cabin class is not identified if it is not
present. |
| Carrier |
string simple type |
|
Optional |
|
The carrier that is marketing this segment |
| ChangeOfPlane |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
planes between flights. |
| ClassOfService |
string simple type |
|
Optional |
|
|
| ETicketability |
string simple type |
Yes , No , Required , Ticketless |
Optional |
|
Identifies if this particular segment
is E-Ticketable |
| Equipment |
string simple type |
|
Optional |
|
Identifies the equipment that this
segment is operating under. |
| FlightNumber |
string simple type |
|
Optional |
|
The flight number under which the marketing
carrier is marketing this flight |
| FlownSegment |
boolean simple type |
|
Optional |
false |
Used for rapid reprice. Tells whether or not the air segment has been flown.
Providers: 1G/1V/1P/1S/1A |
| Group |
long simple type |
|
Required |
|
The Origin Destination Grouping of this
segment. |
| GuaranteedPaymentCarrier |
string simple type |
|
Optional |
|
Identifies that this segment has
Guaranteed Payment Carrier. |
| HostTokenRef |
string simple type |
|
Optional |
|
Identifies that this segment has
Guaranteed Payment Carrier. |
| MarriageGroup |
long simple type |
|
Optional |
|
Identifies this segment as being a
married segment. It is paired with other segments of the same
value. |
| NumberInParty |
positiveInteger simple type |
|
Optional |
|
Number of person traveling in this air segment excluding the number of infants on lap. |
| NumberOfStops |
long simple type |
|
Optional |
|
Identifies the number of stops for
each within the segment. |
| OpenSegment |
boolean simple type |
|
Optional |
|
Indicates OpenSegment when True |
| OperationalStatus |
string simple type |
|
Optional |
|
Refers to the flight operational status for the segment.
This attribute will only be returned in the AvailabilitySearchRsp and not used/returned in any other request/responses.
If this attribute is not returned back in the response, it means the flight is operational and not past scheduled departure. |
| OptionalServicesIndicator |
boolean simple type |
|
Optional |
|
Indicates true if flight provides
optional services. |
| PassiveProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
| ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
| RailCoachNumber |
string simple type |
|
Optional |
|
Coach number for which rail seatmap/coachmap is returned. |
| ScheduleChange |
boolean simple type |
|
Optional |
false |
Used for rapid reprice. Tells whether or not the air segment had a
schedule change by the carrier. This tells rapid reprice that the change in the air
segment was involuntary and because of a schedule change, not because the user is
changing the segment. Providers: 1G/1V/1P/1S/1A |
| Seamless |
boolean simple type |
|
Optional |
|
Identifies that this segment was sold
via a direct access channel to the marketing carrier. |
| ProviderCode |
string simple type |
|
Optional |
|
|
| SupplierCode |
string simple type |
|
Optional |
|
|
| ArrivalTime |
string simple type |
|
Optional |
|
The date and time at which this entity arrives at the destination. Date and time are represented as Airport Local Time at the place of arrival. The correct time zone offset is also included. |
| DepartureTime |
string simple type |
|
Optional |
|
The date and time at which this entity departs. Date and time are represented as Airport Local Time at the place of departure. The correct time zone offset is also included. |
| Destination |
string simple type |
|
Required |
|
The IATA location code for this destination of this entity. |
| Origin |
string simple type |
|
Required |
|
The IATA location code for this origination of this entity. |
| Distance |
decimal simple type |
|
Optional |
|
The distance traveled. Units are specified in the parent response element. |
| FlightTime |
decimal simple type |
|
Optional |
|
Time spent (minutes) traveling in flight, including airport taxi time. |
| TravelTime |
decimal simple type |
|
Optional |
|
Total time spent (minutes) traveling including flight time and ground time. |
| AvailabilityDisplayType |
string simple type |
|
Optional |
|
The type of availability from which the segment is sold.Possible Values (List):
G - General
S - Flight Specific
L - Carrier Specific/Direct Access
M - Manual Sell
F - Fare Shop/Optimal Shop
Q - Fare Specific Fare Quote unbooked
R - Redemption Availability used to complete the sell. Supported Providers: 1G,1V. |
| LinkAvailability |
boolean simple type |
|
Optional |
|
Indicates if carrier has link (carrier
specific) display option. |
| ParticipantLevel |
string simple type |
|
Optional |
|
Type of sell agreement between host and link
carrier. |
| PolledAvailabilityOption |
string simple type |
|
Optional |
|
Indicates if carrier has Inside
(polled)Availability option. |
| SegmentRemark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
| Key |
string simple type |
|
Required |
|
|
| SponsoredFltInfo |
element |
|
|
|
This describes whether the segment is determined to be a sponsored flight. The SponsoredFltInfo node will only come back for Travelport UIs and not for other customers. |
| FltKey |
string simple type |
|
Required |
|
The unique identifying key for the sponsored flight. |
| NeutralLNB |
integer simple type |
|
Required |
|
The neutral line number for the flight item. |
| SponsoredLNB |
integer simple type |
|
Required |
|
The line number of the sponsored flight item |
| CodeshareInfo |
element |
|
|
|
Describes the codeshare disclosure (simple
text string) or the specific operating flight information (as
attributes). |
| OperatingCarrier |
string simple type |
|
Optional |
|
The actual carrier that is operating the
flight. |
| OperatingFlightNumber |
string simple type |
|
Optional |
|
The actual flight number of the carrier that
is operating the flight. |
| AirAvailInfo |
element |
|
|
|
Matches class of service information with
availability counts. Only provided on search results. |
| HostTokenRef |
string simple type |
|
Optional |
|
|
| ProviderCode |
string simple type |
|
Optional |
|
|
| BookingCodeInfo |
element |
|
|
|
Details Cabin class info and class of
service information with availability counts. Only provided on
search results and grouped by Cabin class |
| BookingCounts |
string simple type |
|
Optional |
|
Lists class of service and their counts for
specific cabin class |
| CabinClass |
string simple type |
|
Optional |
|
Specifies Cabin class for a group of
class of services. Cabin class is not identified if it is not
present. |
| FareTokenInfo |
element |
|
|
|
Associates Fare with HostToken |
| FareInfoRef |
string simple type |
|
Required |
|
|
| HostTokenRef |
string simple type |
|
Required |
|
|
| FlightDetails |
element |
|
|
|
Specific details within a flight segment. |
| AutomatedCheckin |
boolean simple type |
|
Optional |
false |
“True” indicates that the flight allows automated check-in. The default is “False”. |
| DestinationTerminal |
string simple type |
|
Optional |
|
|
| Equipment |
string simple type |
|
Optional |
|
|
| GroundTime |
decimal simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Required |
|
|
| OnTimePerformance |
decimal simple type |
|
Optional |
|
Represents flight on time performance
as a percentage from 0 to 100 |
| OriginTerminal |
string simple type |
|
Optional |
|
|
| Distance |
decimal simple type |
|
Optional |
|
The distance traveled. Units are specified in the parent response element. |
| FlightTime |
decimal simple type |
|
Optional |
|
Time spent (minutes) traveling in flight, including airport taxi time. |
| TravelTime |
decimal simple type |
|
Optional |
|
Total time spent (minutes) traveling including flight time and ground time. |
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| ArrivalTime |
string simple type |
|
Optional |
|
The date and time at which this entity arrives at the destination. Date and time are represented as Airport Local Time at the place of arrival. The correct time zone offset is also included. |
| DepartureTime |
string simple type |
|
Optional |
|
The date and time at which this entity departs. Date and time are represented as Airport Local Time at the place of departure. The correct time zone offset is also included. |
| Destination |
string simple type |
|
Required |
|
The IATA location code for this destination of this entity. |
| Origin |
string simple type |
|
Required |
|
The IATA location code for this origination of this entity. |
| Connection |
element |
|
|
|
Flight Connection Information |
| ChangeOfAirport |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
airports between flights. |
| ChangeOfPlane |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
planes between flights. |
| ChangeOfTerminal |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
terminals between flights. |
| Duration |
long simple type |
|
Optional |
|
The actual duration (in minutes) between
flights. |
| FlightDetailsIndex |
long simple type |
|
Optional |
|
The sequential FlightDetails number that this
connection information applies to. |
| IncludeStopOverToFareQuote |
string simple type |
NoStopOver , StopOver , IgnoreSegment |
Optional |
|
The field determines to quote fares with or
without stop overs,the values can be NoStopOver,StopOver and
IgnoreSegment. |
| MinConnectionTime |
long simple type |
|
Optional |
|
The minimum time needed to connect between the
two different destinations. |
| SegmentIndex |
long simple type |
|
Optional |
|
The sequential AirSegment number that this
connection information applies to. |
| StopOver |
boolean simple type |
|
Optional |
false |
Indicates that there is a significant
delay between flights (usually 12 hours or more) |
| FareNote |
element |
|
|
|
A simple textual fare note. Used within several
other objects. |
| FareInfoMessageRef |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Required |
|
|
| NoteName |
string simple type |
|
Optional |
|
|
| Precedence |
decimal simple type |
|
Optional |
|
|
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| Meals |
typeMealService simple type |
|
|
|
Available Meal Service. |
| InFlightServices |
string simple type |
|
|
|
Available InFlight Services. They are: 'Movie', 'Telephone', 'Telex', 'AudioProgramming', 'Television' ,'ResvBookingService' ,'DutyFreeSales' ,'Smoking' ,'NonSmoking' ,'ShortFeatureVideo' ,'NoDutyFree' ,'InSeatPowerSource' ,'InternetAccess' ,'Email' ,'Library' ,'LieFlatSeat' ,'Additional service(s) exists' ,'WiFi' ,'Lie-Flat seat first' ,'Lie-Flat seat business' ,'Lie-Flat seat premium economy' ,'Amenities subject to change' etc.. These follow the IATA standard. Please see the IATA standards for a more complete list. |
| FlightDetailsRef |
element |
|
|
|
Reference to a complete FlightDetails from
a shared list |
| Key |
string simple type |
|
Required |
|
|
| AlternateLocationDistanceRef |
element |
|
|
|
Reference to a AlternateLocationDistance |
| Key |
string simple type |
|
Required |
|
|
| Connection |
element |
|
|
|
Flight Connection Information |
| ChangeOfAirport |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
airports between flights. |
| ChangeOfPlane |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
planes between flights. |
| ChangeOfTerminal |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
terminals between flights. |
| Duration |
long simple type |
|
Optional |
|
The actual duration (in minutes) between
flights. |
| FlightDetailsIndex |
long simple type |
|
Optional |
|
The sequential FlightDetails number that this
connection information applies to. |
| IncludeStopOverToFareQuote |
string simple type |
NoStopOver , StopOver , IgnoreSegment |
Optional |
|
The field determines to quote fares with or
without stop overs,the values can be NoStopOver,StopOver and
IgnoreSegment. |
| MinConnectionTime |
long simple type |
|
Optional |
|
The minimum time needed to connect between the
two different destinations. |
| SegmentIndex |
long simple type |
|
Optional |
|
The sequential AirSegment number that this
connection information applies to. |
| StopOver |
boolean simple type |
|
Optional |
false |
Indicates that there is a significant
delay between flights (usually 12 hours or more) |
| FareNote |
element |
|
|
|
A simple textual fare note. Used within several
other objects. |
| FareInfoMessageRef |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Required |
|
|
| NoteName |
string simple type |
|
Optional |
|
|
| Precedence |
decimal simple type |
|
Optional |
|
|
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| SellMessage |
string simple type |
|
|
|
Sell Message from Vendor. This is applicable in response messages only, any input in request message will be ignored. |
| RailCoachDetails |
element |
|
|
|
Sell Message from Vendor. This is applicable in response messages only, any input in request message will be ignored. |
| AvailableRailSeats |
string simple type |
|
Optional |
|
Number of available seats present in this rail coach. |
| RailCoachNumber |
string simple type |
|
Optional |
|
Rail coach number for the returned coach details. |
| RailSeatMapAvailability |
boolean simple type |
|
Optional |
|
Indicates if seats are available in this rail coach which can be mapped. |
| CO2Emissions |
element |
|
|
|
The carbon emissions produced by the journey |
| Category |
string simple type |
|
Optional |
|
The category name of the type of cabin, either Economy or Premium. Premium is any cabin that is not considered Economy |
| Source |
string simple type |
|
Optional |
|
The source responsible for the values |
| TotalValue |
float simple type |
|
Optional |
|
The total CO2 emission value for the journey |
| Unit |
string simple type |
|
Optional |
|
The unit used in the TotalValue attribute |
| CO2Emission |
element |
|
|
|
Carbon emission values |
| AirSegmentRef |
string simple type |
|
Optional |
|
The segment reference |
| Value |
float simple type |
|
Optional |
|
The CO2 emission value for the air segment |