AvailabilitySearchReq |
element |
|
|
|
Availability Search request. |
| RetrieveProviderReservationDetails |
boolean simple type |
|
Optional |
false |
|
| AuthorizedBy |
string simple type |
|
Optional |
|
Used in showing who authorized the request. Use is optional. |
| LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
| OverrideLogging |
string simple type |
TRACE , DEBUG , INFO , WARN , ERROR , FATAL |
Optional |
|
Use to override the default logging level |
| ReturnAmenities |
boolean simple type |
|
Optional |
false |
When set to true, Amenities information will be returned in the response. |
| ReturnSponsoredFlight |
boolean simple type |
|
Optional |
|
When set to true, Sponsored flight information will be returned in the response. |
| SponsoredFltTrnxId |
string simple type |
|
Optional |
|
Identifier for Sponsored Flight transaction information. |
| TargetBranch |
string simple type |
|
Optional |
|
Used for Emulation - If authorised will execute the request as if the agent's parent branch is the TargetBranch specified. |
| TokenId |
string simple type |
|
Optional |
|
Authentication Token ID used when running in statefull operation. Obtained from the LoginRsp. Use is optional. |
| TraceId |
string simple type |
|
Optional |
|
Unique identifier for this atomic transaction traced by the user. Use is optional. |
| ChannelId |
string simple type |
|
Optional |
|
A Channel ID is 4 alpha-numeric characters used to activate the Search Control Console filter for a specific group of travelers being served by the agency credential. |
| NSCC |
string simple type |
|
Optional |
|
Allows the agency to bypass/override the Search Control Console rule. |
| ReturnBrandIndicator |
boolean simple type |
|
Optional |
false |
When set to “true”, the Brand Indicator can be returned in the availability search response. Provider: 1G, 1V, 1P, ACH |
| BillingPointOfSaleInfo |
element |
|
|
|
Point of Sale information for Billing |
| CIDBNumber |
integer simple type |
|
Optional |
|
A 10 Digit customer number generated by CIDB system. |
| OriginApplication |
string simple type |
|
Required |
|
Name of the Point of Sale application which initiated the Request.This information will be provided as part of the provisioning of the user. |
| AgentIDOverride |
element |
|
|
|
Vendor specific agent identifier overrides to be used to access vendor systems. |
| AgentID |
string simple type |
|
Required |
|
The Agent ID for the applicable supplier/vendor |
| ProviderCode |
string simple type |
|
Required |
|
Provider code to route the AgentId to proper provider. |
| SupplierCode |
string simple type |
|
Optional |
|
Supplier code to determine which vendor this AgentId belongs to. |
| TerminalSessionInfo |
string simple type |
|
|
|
Travelport use only. This element contains CDATA information representing existing GDS session data or ACH credentials information of the terminal user |
| OverridePCC |
element |
|
|
|
Used to emulate to another PCC or SID. Providers: 1G, 1V, 1P. |
| ProviderCode |
string simple type |
|
Required |
|
The code of the provider (e.g. 1G, 1S) |
| PseudoCityCode |
string simple type |
|
Required |
|
The PCC in the host system. |
| NextResultReference |
element |
|
|
|
Container to return/send additional retrieve/request additional search results |
| ProviderCode |
string simple type |
|
Optional |
|
The code of the Provider (e.g 1G,1S) |
| PointOfCommencement |
element |
|
|
|
Point of Commencement is optional. CityOrAirportCode and date portion of the Time attribute is mandatory. |
| CityOrAirportCode |
string simple type |
|
Required |
|
Three digit Airport or City code that would be the Point of Commencement location for the trips/legs mentioned. |
| Time |
string simple type |
|
Required |
|
Specify a date or date and time |
| SearchAirLeg |
element |
|
|
|
Search version of AirLeg used to specify
search criteria |
| SearchOrigin |
typeSearchLocation complex type |
|
|
|
Search version of AirLeg used to specify
search criteria |
| Airport |
element |
|
|
|
Airport identifier |
| Code |
string simple type |
|
Required |
|
|
| City |
element |
|
|
|
City identifier |
| Code |
string simple type |
|
Required |
|
|
| CityOrAirport |
element |
|
|
|
This element can be used when it is not known whether the value is an airport or a city code. |
| Code |
string simple type |
|
Required |
|
The airport or city IATA code. |
| PreferCity |
boolean simple type |
|
Optional |
false |
Indicates that the search should prefer city results over airport results. |
| CoordinateLocation |
element |
|
|
|
Specific lat/long location, usually associated with a Distance |
| latitude |
double simple type |
|
Required |
|
|
| longitude |
double simple type |
|
Required |
|
|
| RailLocation |
element |
|
|
|
RCH specific location code (a.k.a UCodes) which uniquely identifies a train station. |
| Code |
string simple type |
|
Required |
|
|
| Distance |
element |
|
|
|
Container to encapsulate the a distance value with its unit of measure. |
| Direction |
string simple type |
|
Optional |
|
Directions: S, N, E, W, SE, NW, ... |
| Units |
string simple type |
MI , KM |
Optional |
MI |
|
| Value |
decimal simple type |
|
Required |
|
|
| SearchDestination |
typeSearchLocation complex type |
|
|
|
|
| Airport |
element |
|
|
|
Airport identifier |
| Code |
string simple type |
|
Required |
|
|
| City |
element |
|
|
|
City identifier |
| Code |
string simple type |
|
Required |
|
|
| CityOrAirport |
element |
|
|
|
This element can be used when it is not known whether the value is an airport or a city code. |
| Code |
string simple type |
|
Required |
|
The airport or city IATA code. |
| PreferCity |
boolean simple type |
|
Optional |
false |
Indicates that the search should prefer city results over airport results. |
| CoordinateLocation |
element |
|
|
|
Specific lat/long location, usually associated with a Distance |
| latitude |
double simple type |
|
Required |
|
|
| longitude |
double simple type |
|
Required |
|
|
| RailLocation |
element |
|
|
|
RCH specific location code (a.k.a UCodes) which uniquely identifies a train station. |
| Code |
string simple type |
|
Required |
|
|
| Distance |
element |
|
|
|
Container to encapsulate the a distance value with its unit of measure. |
| Direction |
string simple type |
|
Optional |
|
Directions: S, N, E, W, SE, NW, ... |
| Units |
string simple type |
MI , KM |
Optional |
MI |
|
| Value |
decimal simple type |
|
Required |
|
|
| SearchDepTime |
typeFlexibleTimeSpec complex type |
|
|
|
|
| PreferredTime |
string simple type |
|
Optional |
|
Specifies a time that would be preferred within the time range specified. |
| TimeRange |
typeTimeRange complex type |
|
|
|
Specifies a time that would be preferred within the time range specified. |
| EarliestTime |
string simple type |
|
Required |
|
|
| LatestTime |
string simple type |
|
Required |
|
|
| SpecificTime |
typeSpecificTime complex type |
|
|
|
|
| Time |
string simple type |
|
Required |
|
|
| SearchExtraDays |
element |
|
|
|
Options to search for extra days on top of the specified date |
| DaysAfter |
long simple type |
|
Optional |
|
Number of days to search after the specified date |
| DaysBefore |
long simple type |
|
Optional |
|
Number of days to search before the specified date |
| SearchArvTime |
typeTimeSpec complex type |
|
|
|
Specifies the preferred time within the time range. For 1G, 1V, 1P, it is supported for AvailabilitySearchReq (TimeRange must also be specified) and not supported for LowFareSearchReq. ACH does not support search by arrival time. |
| PreferredTime |
string simple type |
|
Optional |
|
Specifies a time that would be preferred within the time range specified. |
| TimeRange |
typeTimeRange complex type |
|
|
|
Specifies a time that would be preferred within the time range specified. |
| EarliestTime |
string simple type |
|
Required |
|
|
| LatestTime |
string simple type |
|
Required |
|
|
| SpecificTime |
typeSpecificTime complex type |
|
|
|
|
| Time |
string simple type |
|
Required |
|
|
| AirLegModifiers |
element |
|
|
|
|
| AllowDirectAccess |
boolean simple type |
|
Optional |
false |
If it is true request will be sent directly to the carrier. |
| MaxConnectionTime |
decimal simple type |
|
Optional |
|
|
| MaxJourneyTime |
nonNegativeInteger simple type |
|
Optional |
|
Maximum Journey Time for this leg (in hours) 0-99. Supported Providers 1G,1V. |
| OrderBy |
string simple type |
JourneyTime , DepartureTime , ArrivalTime |
Optional |
|
Indicates whether to sort by Journey Time, Deparature Time or Arrival Time |
| PreferNonStop |
boolean simple type |
|
Optional |
false |
When non-stops are preferred, the distribution of search results should skew heavily toward non-stop flights while still returning
some one stop flights for comparison and price competitiveness. The search request will ‘boost' the preference towards non-stops. If true then Non Stop
flights will be preferred. |
| ProhibitMultiAirportConnection |
boolean simple type |
|
Optional |
|
Indicates whether to restrict multi-airport connections |
| ProhibitOvernightLayovers |
boolean simple type |
|
Optional |
false |
If true, excludes connections if arrival time of first flight and departure time of second flight
is on 2 different calendar days. When used in conjunction with MaxConnectionTime, it would exclude all connections if the
connecting flights wait time exceeds the time specified in MaxConnectionTime. |
| ReturnFirstAvailableOnly |
boolean simple type |
|
Optional |
|
If it is true then it will search for first
available for the booking code designated or any booking code in
same cabin. |
| PermittedCabins |
element |
|
|
|
If it is true then it will search for first
available for the booking code designated or any booking code in
same cabin. |
| CabinClass |
element |
|
|
|
Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier. |
| Type |
string simple type |
|
Required |
|
|
| PreferredCabins |
element |
|
|
|
|
| CabinClass |
element |
|
|
|
Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier. |
| Type |
string simple type |
|
Required |
|
|
| PermittedCarriers |
element |
|
|
|
|
| Carrier |
element |
|
|
|
Carrier identifier |
| Code |
string simple type |
|
Required |
|
|
| ProhibitedCarriers |
element |
|
|
|
|
| Carrier |
element |
|
|
|
Carrier identifier |
| Code |
string simple type |
|
Required |
|
|
| PreferredCarriers |
element |
|
|
|
|
| Carrier |
element |
|
|
|
Carrier identifier |
| Code |
string simple type |
|
Required |
|
|
| PermittedConnectionPoints |
element |
|
|
|
This is the container to specify all permitted connection points. Applicable for 1G/1V/1P. |
| ConnectionPoint |
typeLocation complex type |
|
|
|
A connection point can be eith an IATA airport or cir city code. |
| Airport |
element |
|
|
|
Airport identifier |
| Code |
string simple type |
|
Required |
|
|
| City |
element |
|
|
|
City identifier |
| Code |
string simple type |
|
Required |
|
|
| CityOrAirport |
element |
|
|
|
This element can be used when it is not known whether the value is an airport or a city code. |
| Code |
string simple type |
|
Required |
|
The airport or city IATA code. |
| PreferCity |
boolean simple type |
|
Optional |
false |
Indicates that the search should prefer city results over airport results. |
| ProhibitedConnectionPoints |
element |
|
|
|
This is the container to specify all prohibited connection points. Applicable for 1G/1V/1P. |
| ConnectionPoint |
typeLocation complex type |
|
|
|
A connection point can be eith an IATA airport or cir city code. |
| Airport |
element |
|
|
|
Airport identifier |
| Code |
string simple type |
|
Required |
|
|
| City |
element |
|
|
|
City identifier |
| Code |
string simple type |
|
Required |
|
|
| CityOrAirport |
element |
|
|
|
This element can be used when it is not known whether the value is an airport or a city code. |
| Code |
string simple type |
|
Required |
|
The airport or city IATA code. |
| PreferCity |
boolean simple type |
|
Optional |
false |
Indicates that the search should prefer city results over airport results. |
| PreferredConnectionPoints |
element |
|
|
|
This is the container to specify all preferred connection points. Applicable for 1G/1V only. |
| ConnectionPoint |
typeLocation complex type |
|
|
|
A connection point can be eith an IATA airport or cir city code. |
| Airport |
element |
|
|
|
Airport identifier |
| Code |
string simple type |
|
Required |
|
|
| City |
element |
|
|
|
City identifier |
| Code |
string simple type |
|
Required |
|
|
| CityOrAirport |
element |
|
|
|
This element can be used when it is not known whether the value is an airport or a city code. |
| Code |
string simple type |
|
Required |
|
The airport or city IATA code. |
| PreferCity |
boolean simple type |
|
Optional |
false |
Indicates that the search should prefer city results over airport results. |
| PermittedBookingCodes |
element |
|
|
|
This is the container to specify all permitted booking codes |
| BookingCode |
element |
|
|
|
The Booking Code (Class of Service) for a
segment |
| Code |
string simple type |
|
Required |
|
|
| PreferredBookingCodes |
element |
|
|
|
This is the container to specify all preferred booking codes |
| BookingCode |
element |
|
|
|
The Booking Code (Class of Service) for a
segment |
| Code |
string simple type |
|
Required |
|
|
| PreferredAlliances |
element |
|
|
|
|
| Alliance |
element |
|
|
|
Alliance Code |
| Code |
string simple type |
|
Required |
|
The possible values are *A for Star Alliance,*O for One world,*S for Sky team etc. |
| ProhibitedBookingCodes |
element |
|
|
|
This is the container to specify all prohibited booking codes |
| BookingCode |
element |
|
|
|
The Booking Code (Class of Service) for a
segment |
| Code |
string simple type |
|
Required |
|
|
| DisfavoredAlliances |
element |
|
|
|
|
| Alliance |
element |
|
|
|
Alliance Code |
| Code |
string simple type |
|
Required |
|
The possible values are *A for Star Alliance,*O for One world,*S for Sky team etc. |
| FlightType |
element |
|
|
|
Modifier to request flight type options example non-stop only, non-stop and direct only,
include single online connection etc. |
| DoubleInterlineCon |
boolean simple type |
|
Optional |
|
|
| DoubleOnlineCon |
boolean simple type |
|
Optional |
|
|
| MaxConnections |
integer simple type |
|
Optional |
-1 |
The maximum number of connections within a
segment group. |
| MaxStops |
integer simple type |
|
Optional |
-1 |
The maximum number of stops within a
connection. |
| NonStopDirects |
boolean simple type |
|
Optional |
|
|
| RequireSingleCarrier |
boolean simple type |
|
Optional |
false |
|
| SingleInterlineCon |
boolean simple type |
|
Optional |
|
|
| SingleOnlineCon |
boolean simple type |
|
Optional |
|
|
| StopDirects |
boolean simple type |
|
Optional |
|
|
| TripleInterlineCon |
boolean simple type |
|
Optional |
|
|
| TripleOnlineCon |
boolean simple type |
|
Optional |
|
|
| AnchorFlightData |
typeAnchorFlightData complex type |
|
|
|
|
| AirlineCode |
string simple type |
|
Required |
|
Indicates Anchor flight carrier code |
| ConnectionIndicator |
boolean simple type |
|
Optional |
|
Indicates that the Anchor flight has any connecting flight or not |
| FlightNumber |
string simple type |
|
Required |
|
Indicates Anchor flight number |
| SearchSpecificAirSegment |
element |
|
|
|
Indicates Anchor flight number |
| Carrier |
string simple type |
|
Required |
|
The carrier that is marketing this segment |
| DepartureTime |
string simple type |
|
Required |
|
The date and time at which this entity departs.
This does not include time zone information since it can be derived
from the origin location. |
| Destination |
string simple type |
|
Required |
|
The IATA location code for this destination of
this entity. |
| FlightNumber |
string simple type |
|
Required |
|
The flight number under which the marketing
carrier is marketing this flight |
| Origin |
string simple type |
|
Required |
|
The IATA location code for this origination of
this entity. |
| SegmentIndex |
long simple type |
|
Optional |
|
The sequential AirSegment number that this segment
connected to. |
| AirSearchModifiers |
element |
|
|
|
Controls and switches for the Air Search
request |
| AllowChangeOfAirport |
boolean simple type |
|
Optional |
true |
|
| DistanceType |
string simple type |
MI , KM |
Optional |
MI |
|
| ExcludeGroundTransportation |
boolean simple type |
|
Optional |
false |
Indicates whether to allow the user to exclude ground transportation or not. Default value is 'false'. If value is true then ground transportations are excluded. If false then ground transportations are included. The supported providers: 1P |
| ExcludeOpenJawAirport |
boolean simple type |
|
Optional |
false |
This option ensures that travel into/out of each location will be into/out of the same airport of that location. Values are true or false. Default value is 'false'. If value is true then open jaws are exclude. If false the open jaws are included. The supported providers: 1P |
| IncludeExtraSolutions |
boolean simple type |
|
Optional |
|
If true, indicates that search should be made
for returning more solutions, if available. For example, for
certain providers, premium members may have the facility to get
more solutions. This attribute may have to be combined with other
applicable modifiers (like SearchWeekends) to return more results. |
| IncludeFlightDetails |
boolean simple type |
|
Optional |
true |
|
| JetServiceOnly |
boolean simple type |
|
Optional |
|
Restricts results to Jet service flights only. |
| MaxConnectionTime |
decimal simple type |
|
Optional |
|
The maximum anount of time (in minutes) that a
solution can contain for connections between flights. |
| MaxJourneyTime |
nonNegativeInteger simple type |
|
Optional |
|
Maximum Journey Time for all legs (in hours) 0-99. For LFS Supported Providers are 1G,1V,1P. For AirAvail Supported Providers are 1G,1V. |
| MaxSolutions |
decimal simple type |
|
Optional |
|
The maximum number of solutions to return.
Decreasing this number |
| OrderBy |
string simple type |
JourneyTime , DepartureTime , ArrivalTime |
Optional |
|
Indicates whether to sort by Journey Time, Deparature Time or Arrival Time. Applicable to air availability only. |
| PreferNonStop |
boolean simple type |
|
Optional |
false |
When non-stops are preferred, the distribution of search results should skew heavily toward non-stop flights while still returning
some one stop flights for comparison and price competitiveness. The search request will ‘boost' the preference towards non-stops. If true then Non Stop
flights will be preferred. |
| ProhibitMultiAirportConnection |
boolean simple type |
|
Optional |
|
Indicates whether to restrict multi-airport connections |
| ProhibitOvernightLayovers |
boolean simple type |
|
Optional |
false |
If true, excludes connections if arrival time of first flight and departure time of second flight
is on 2 different calendar days. When used in conjunction with MaxConnectionTime, it would exclude all connections if the
connecting flights wait time exceeds the time specified in MaxConnectionTime. |
| SearchWeekends |
boolean simple type |
|
Optional |
|
A value of true indicates that search should be
expanded to include weekend combinations, if applicable. |
| DisfavoredProviders |
element |
|
|
|
A value of true indicates that search should be
expanded to include weekend combinations, if applicable. |
| Provider |
element |
|
|
|
Provider identifier |
| Code |
string simple type |
|
Required |
|
|
| PreferredProviders |
element |
|
|
|
|
| Provider |
element |
|
|
|
Provider identifier |
| Code |
string simple type |
|
Required |
|
|
| DisfavoredCarriers |
element |
|
|
|
|
| Carrier |
element |
|
|
|
Carrier identifier |
| Code |
string simple type |
|
Required |
|
|
| PermittedCarriers |
element |
|
|
|
|
| Carrier |
element |
|
|
|
Carrier identifier |
| Code |
string simple type |
|
Required |
|
|
| ProhibitedCarriers |
element |
|
|
|
|
| Carrier |
element |
|
|
|
Carrier identifier |
| Code |
string simple type |
|
Required |
|
|
| PreferredCarriers |
element |
|
|
|
|
| Carrier |
element |
|
|
|
Carrier identifier |
| Code |
string simple type |
|
Required |
|
|
| ProhibitedValidatingCarriers |
element |
|
|
|
|
| Carrier |
element |
|
|
|
Carrier identifier |
| Code |
string simple type |
|
Required |
|
|
| PermittedCabins |
element |
|
|
|
|
| CabinClass |
element |
|
|
|
Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier. |
| Type |
string simple type |
|
Required |
|
|
| PreferredCabins |
element |
|
|
|
|
| CabinClass |
element |
|
|
|
Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier. |
| Type |
string simple type |
|
Required |
|
|
| PreferredAlliances |
element |
|
|
|
|
| Alliance |
element |
|
|
|
Alliance Code |
| Code |
string simple type |
|
Required |
|
The possible values are *A for Star Alliance,*O for One world,*S for Sky team etc. |
| DisfavoredAlliances |
element |
|
|
|
The possible values are *A for Star Alliance,*O for One world,*S for Sky team etc. |
| Alliance |
element |
|
|
|
Alliance Code |
| Code |
string simple type |
|
Required |
|
The possible values are *A for Star Alliance,*O for One world,*S for Sky team etc. |
| PermittedBookingCodes |
element |
|
|
|
This is the container to specify all permitted booking codes |
| BookingCode |
element |
|
|
|
The Booking Code (Class of Service) for a
segment |
| Code |
string simple type |
|
Required |
|
|
| PreferredBookingCodes |
element |
|
|
|
This is the container to specify all preferred booking codes |
| BookingCode |
element |
|
|
|
The Booking Code (Class of Service) for a
segment |
| Code |
string simple type |
|
Required |
|
|
| ProhibitedBookingCodes |
element |
|
|
|
This is the container to specify all prohibited booking codes |
| BookingCode |
element |
|
|
|
The Booking Code (Class of Service) for a
segment |
| Code |
string simple type |
|
Required |
|
|
| FlightType |
element |
|
|
|
Modifier to request flight type options example non-stop only, non-stop and direct only,
include single online connection etc. |
| DoubleInterlineCon |
boolean simple type |
|
Optional |
|
|
| DoubleOnlineCon |
boolean simple type |
|
Optional |
|
|
| MaxConnections |
integer simple type |
|
Optional |
-1 |
The maximum number of connections within a
segment group. |
| MaxStops |
integer simple type |
|
Optional |
-1 |
The maximum number of stops within a
connection. |
| NonStopDirects |
boolean simple type |
|
Optional |
|
|
| RequireSingleCarrier |
boolean simple type |
|
Optional |
false |
|
| SingleInterlineCon |
boolean simple type |
|
Optional |
|
|
| SingleOnlineCon |
boolean simple type |
|
Optional |
|
|
| StopDirects |
boolean simple type |
|
Optional |
|
|
| TripleInterlineCon |
boolean simple type |
|
Optional |
|
|
| TripleOnlineCon |
boolean simple type |
|
Optional |
|
|
| MaxLayoverDuration |
MaxLayoverDurationType complex type |
|
|
|
This is the maximum duration the layover may have for each trip in the request. Supported providers 1P. |
| Domestic |
integer simple type |
|
Optional |
|
It will be applied for all Domestic-to-Domestic connections. |
| Gateway |
integer simple type |
|
Optional |
|
It will be applied for all Domestic to International and International to Domestic connections. |
| International |
integer simple type |
|
Optional |
|
It will be applied for all International-to-International connections. |
| NativeSearchModifier |
typeNativeSearchModifier complex type |
|
|
|
Container for Native command modifiers. Providers supported : 1P |
| ProviderCode |
string simple type |
|
Required |
|
The host for which the NativeModfier being added to |
| JourneyData |
element |
|
|
|
Performs journey aware air availability |
| 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. |
| 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. |
| ProviderCode |
string simple type |
|
Optional |
|
|
| SupplierCode |
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. |
| 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. |
| 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 |
|
|
| 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. |
| 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. |
| 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. |
| SearchPassenger |
element |
|
|
|
Passenger type with code and optional age information |
| AccompaniedPassenger |
boolean simple type |
|
Optional |
false |
Container to identify accompanied passenger. Set true means this passenger is accompanied |
| Age |
decimal simple type |
|
Optional |
|
|
| BookingTravelerRef |
string simple type |
|
Optional |
|
This value should be set for Multiple Passengers in the request. |
| Code |
string simple type |
|
Required |
|
The 3-char IATA passenger type code |
| DOB |
date simple type |
|
Optional |
|
Passenger Date of Birth |
| Gender |
string simple type |
|
Optional |
|
The passenger gender type |
| PricePTCOnly |
boolean simple type |
|
Optional |
|
|
| ResidencyType |
string simple type |
Employee , National , Resident |
Optional |
|
The passenger residence type. |
| Key |
string simple type |
|
Optional |
|
|
| Name |
element |
|
|
|
Complete name fields |
| First |
string simple type |
|
Required |
|
First Name. Size can be up to 256 characters |
| Last |
string simple type |
|
Required |
|
Last Name. Size can be up to 256 characters |
| Middle |
string simple type |
|
Optional |
|
Midle name. Size can be up to 256 characters |
| Prefix |
string simple type |
|
Optional |
|
Name prefix. Size can be up to 20 characters |
| Suffix |
string simple type |
|
Optional |
|
Name suffix. Size can be up to 256 characters |
| TravelerProfileId |
integer simple type |
|
Optional |
|
Traveler Applied Profile ID. |
| LoyaltyCard |
element |
|
|
|
Provider loyalty card information |
| CardNumber |
string simple type |
|
Required |
|
|
| FreeText |
string simple type |
|
Optional |
|
|
| Level |
string simple type |
|
Optional |
|
|
| MembershipStatus |
string simple type |
|
Optional |
|
|
| PriorityCode |
string simple type |
|
Optional |
|
|
| Status |
string simple type |
|
Optional |
|
|
| SupplierType |
string simple type |
Air , Vehicle , Hotel , Rail , Cruise , Other |
Optional |
|
|
| VendorLocationRef |
string simple type |
|
Optional |
|
|
| AllianceLevel |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Optional |
|
|
| MembershipProgram |
string simple type |
|
Optional |
|
Loyalty Program membership Id of the traveler specific to Amtrak(2V) Guest Rewards |
| SupplierCode |
string simple type |
|
Required |
|
The code used to identify the Loyalty supplier, e.g. AA, ZE, MC |
| 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. |
| ProviderReservationSpecificInfo |
typeProviderReservationSpecificInfo complex type |
|
|
|
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. |
| ProviderReservationLevel |
boolean simple type |
|
Optional |
|
If true means Loyalty card is applied at ProviderReservation level. |
| ReservationLevel |
boolean simple type |
|
Optional |
|
If true means Loyalty card is applied at Universal Record Reservation level e.g. Hotel Reservation, Vehicle Reservation etc. |
| OperatedBy |
element |
|
|
|
This is the carrier code to support Cross Accrual |
| ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
| Key |
string simple type |
|
Required |
|
|
| DiscountCard |
element |
|
|
|
Rail Discount Card Information |
| Code |
string simple type |
|
Required |
|
|
| Description |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Optional |
|
|
| Number |
string 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. |
| PersonalGeography |
element |
|
|
|
Personal geography details of the associated passenger. |
| CountryCode |
typeCountry simple type |
|
|
|
Passenger country code. |
| StateProvinceCode |
typeState simple type |
|
|
|
Passenger state/province code. |
| CityCode |
typeCity simple type |
|
|
|
Passenger city code. |
| PointOfSale |
element |
|
|
|
User can use this node to send a specific PCC to access fares allowed only for that PCC. This node gives the capability for fare redistribution at UR level. For fare redistribution at the stored fare level see AirPricingSolution/AirPricingInfo/AirPricingModifiers/PointOfSale. |
| IATA |
string simple type |
|
Optional |
|
Used for rapid reprice. This field is the IATA associated to this Point of Sale PCC. Providers: 1G/1V |
| Key |
string simple type |
|
Optional |
|
|
| ProviderCode |
string simple type |
|
Required |
|
The provider in which the PCC is defined. |
| PseudoCityCode |
string simple type |
|
Required |
|
The PCC in the host system. |