AirMerchandisingDetailsRsp |
element |
|
|
|
Response for retrieved brand details and optional services included in them |
| 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 |
|
|
| OptionalServices |
element |
|
|
|
A wrapper for all the information regarding each
of the Optional services |
| OptionalServicesTotal |
element |
|
|
|
The total fares, fees and taxes associated
with the Optional Services |
| ApproximateBasePrice |
string simple type |
|
Optional |
|
The Converted base price in Default Currency for this entity. This does not include any taxes or surcharges. |
| ApproximateFees |
string simple type |
|
Optional |
|
The Converted fee amount in Default Currency. |
| ApproximateTaxes |
string simple type |
|
Optional |
|
The Converted tax amount in Default Currency. |
| ApproximateTotalPrice |
string simple type |
|
Optional |
|
The Converted total price in Default Currency for this entity including base price and all taxes. |
| BasePrice |
string simple type |
|
Optional |
|
Represents the base price for this entity. This does not include any taxes or surcharges. |
| EquivalentBasePrice |
string simple type |
|
Optional |
|
Represents the base price in the related currency for this entity. This does not include any taxes or surcharges. |
| Fees |
string simple type |
|
Optional |
|
The aggregated amount of all the fees that are associated with this entity. See the associated FeeInfo array for a breakdown of the individual fees. |
| Services |
string simple type |
|
Optional |
|
The total cost for all optional services. |
| Taxes |
string simple type |
|
Optional |
|
The aggregated amount of all the taxes that are associated with this entity. See the associated TaxInfo array for a breakdown of the individual taxes. |
| TotalPrice |
string simple type |
|
Optional |
|
The total price for this entity including base price and all taxes. |
| TaxInfo |
typeTaxInfo complex type |
|
|
|
The tax information for a |
| CarrierDefinedCategory |
string simple type |
|
Optional |
|
Optional category, where a carrier has
used a non-standard IATA tax category. The tax category will be
set to "DU" |
| Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax
code. |
| CouponRef |
string simple type |
|
Optional |
|
The coupon to which that tax is relative (if
applicable) |
| FlightDetailsRef |
string simple type |
|
Optional |
|
The flight details that this tax is relative
to (if applicable) |
| Key |
string simple type |
|
Optional |
|
The tax key represents a valid key of tax |
| ProviderCode |
string simple type |
|
Optional |
|
Code of the provider returning this TaxInfo. |
| SegmentRef |
string simple type |
|
Optional |
|
The segment to which that tax is relative (if
applicable) |
| SupplierCode |
string simple type |
|
Optional |
|
Code of the supplier returning this TaxInfo. |
| TaxExempted |
boolean simple type |
|
Optional |
|
This indicates whether the tax specified by
tax category is exempted. |
| Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
| Amount |
string simple type |
|
Required |
|
|
| CountryCode |
string simple type |
|
Optional |
|
|
| Description |
string simple type |
|
Optional |
|
|
| DestinationAirport |
string simple type |
|
Optional |
|
|
| FareInfoRef |
string simple type |
|
Optional |
|
|
| OriginAirport |
string simple type |
|
Optional |
|
|
| TaxDetail |
element |
|
|
|
The tax idetail nformation for a fare quote tax. |
| Amount |
string simple type |
|
Required |
|
|
| CountryCode |
string simple type |
|
Optional |
|
|
| Description |
string simple type |
|
Optional |
|
|
| DestinationAirport |
string simple type |
|
Optional |
|
|
| FareInfoRef |
string simple type |
|
Optional |
|
|
| OriginAirport |
string simple type |
|
Optional |
|
|
| IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
| Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
| FeeInfo |
typeFeeInfo complex type |
|
|
|
A generic type of fee for those charges which are incurred by the passenger, but not necessarily shown on tickets |
| Amount |
string simple type |
|
Required |
|
|
| BaseAmount |
string simple type |
|
Optional |
|
|
| BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to booking traveler |
| Code |
string simple type |
|
Required |
|
|
| Description |
string simple type |
|
Optional |
|
|
| FeeToken |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Required |
|
|
| PassengerTypeCode |
string simple type |
|
Optional |
|
|
| PaymentRef |
string simple type |
|
Optional |
|
The reference to the one of the air
reservation payments if fee included in charge |
| SubCode |
string simple type |
|
Optional |
|
|
| Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
| ProviderCode |
string simple type |
|
Optional |
|
|
| SupplierCode |
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. |
| TaxInfoRef |
element |
|
|
|
This reference elements will associate relevant taxes to this fee |
| Key |
string simple type |
|
Required |
|
|
| IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
| Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
| OptionalService |
element |
|
|
|
this attribute shows the amount included in the base fare for the specific fee or tax |
| ApplicableFFLevel |
integer simple type |
|
Optional |
|
Numerical value of the loyalty card level for which this service is available. |
| AssessIndicator |
string simple type |
MileageAndCurrency , MileageOrCurrency |
Optional |
|
Indicates whether price is assessed by mileage or currency or both |
| Available |
boolean simple type |
|
Optional |
|
Boolean to describe whether the Service is
available for sale or not |
| BaggageUnitPrice |
string simple type |
|
Optional |
|
The per unit price of baggage. Providers: 1G, 1V, 1P |
| BookedQuantity |
string simple type |
|
Optional |
|
Indicates the Optional Service quantity already booked. Provider: 1G, 1V, 1P |
| Chargeable |
string simple type |
|
Optional |
|
Indicates if the optional service is not offered, is available for a charge, or is included in the brand |
| Confirmation |
string simple type |
|
Optional |
|
Confirmation number provided by the
supplier |
| CreateDate |
dateTime simple type |
|
Optional |
|
Timestamp when this service/offer got
created. |
| DisplayOrder |
integer simple type |
|
Optional |
|
Optional service group display order. |
| DisplayText |
string simple type |
|
Optional |
|
Title of the Optional Service. Provider: ACH |
| Entitled |
boolean simple type |
|
Optional |
|
Boolean to describe whether the passenger
is entitled for the service without charge or not |
| ExcessWeightRate |
string simple type |
|
Optional |
|
The cost of the bag per unit weight. |
| FirstPiece |
long simple type |
|
Optional |
|
Indicates the minimum occurrence of excess baggage.Provider: 1G, 1V, 1P. |
| GeographySpecification |
string simple type |
|
Optional |
|
Sector, Portion, Journey. |
| Group |
string simple type |
|
Optional |
|
Associates Optional Services with the same ServiceSub Code, Air Segment, Passenger, and EMD Associated Item. Provider:1G, 1V, 1P |
| InclusiveOfTax |
boolean simple type |
|
Optional |
|
Identifies if the service was filed with a fee that is inclusive of tax. |
| InterlineSettlementAllowed |
boolean simple type |
|
Optional |
|
Identifies if the interline settlement is allowed in service . |
| IsPricingApproximate |
boolean simple type |
|
Optional |
|
When set to True indicates that the pricing returned is approximate. Supported providers are MCH/ACH |
| IsRepriceRequired |
boolean simple type |
|
Optional |
false |
When set to “true”, the Optional Service must be re-priced. Provider: 1G, 1V, 1P |
| IssuanceReason |
string simple type |
|
Optional |
|
A one-letter code specifying the reason for
issuance of the OptionalService |
| Key |
string simple type |
|
Optional |
|
|
| LastPiece |
long simple type |
|
Optional |
|
Indicates the maximum occurrence of excess baggage. Provider: 1G, 1V, 1P. |
| Mileage |
decimal simple type |
|
Optional |
|
Indicates mileage fee/amount |
| OptionalServicesRuleRef |
string simple type |
|
Optional |
|
UniqueID to associate a rule to the
Optional Service |
| PaymentRef |
string simple type |
|
Optional |
|
Reference to a payment for merchandising
services. |
| PerTraveler |
boolean simple type |
|
Optional |
true |
Boolean to describe whether the Amount on
the Service is charged per traveler. |
| Priority |
decimal simple type |
|
Optional |
|
Numeric value that represents the priority
order of the Service |
| Private |
boolean simple type |
|
Optional |
|
Describes if service is private or not. |
| ProviderDefinedType |
string simple type |
|
Optional |
|
Original Type as sent by the provider |
| PseudoCityCode |
string simple type |
|
Optional |
|
The PCC or SID that booked the Optional Service. |
| PurchaseWindow |
string simple type |
BookingOnly , TicketingOnly , CheckInOnly , Anytime , PostTicketing |
Optional |
|
Describes when the Service is available
for confirmation or purchase (e.g. Booking Only, Check-in Only,
Anytime, etc.) |
| Quantity |
decimal simple type |
|
Optional |
|
The number of units availed for each optional
service (e.g. 2 baggage availed will be specified as 2 in quantity
for optional service BAGGAGE) |
| Restricted |
boolean simple type |
|
Optional |
false |
When set to “true”, the Optional Service is restricted by an embargo. Provider: 1G, 1V, 1P |
| SSRCode |
string simple type |
|
Optional |
|
The SSR Code associated with the
OptionalService |
| SSRFreeText |
string simple type |
|
Optional |
|
Certain SSR types sent in OptionalService SSRCode require a free text message. For example, PETC Pet in Cabin. |
| SecondaryType |
string simple type |
|
Optional |
|
The secondary option code type required for
certain options |
| SequenceNumber |
decimal simple type |
|
Optional |
|
The sequence number associated with the
OptionalService |
| ServiceStatus |
string simple type |
|
Optional |
|
Specify the service status (e.g. active,
canceled, etc.) |
| ServiceSubCode |
string simple type |
|
Optional |
|
The service subcode associated with the
OptionalService |
| Source |
string simple type |
|
Optional |
|
The Source of the optional service. The source can be ACH, MCE, or MCH. |
| Tag |
string simple type |
|
Optional |
|
Optional service group name. |
| TotalWeight |
string simple type |
|
Optional |
|
The total weight of a bag. Providers: 1G, 1V, 1P |
| Type |
string simple type |
|
Required |
|
Specify the type of service offered (e.g.
seats, baggage, etc.) |
| ViewableOnly |
boolean simple type |
|
Optional |
|
Describes if the OptionalService is viewable only or not.
If viewable only then the service cannot be sold. |
| WeightInExcess |
string simple type |
|
Optional |
|
The excess weight of a bag. Providers: 1G, 1V, 1P |
| 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. |
| ApproximateBasePrice |
string simple type |
|
Optional |
|
The Converted base price in Default Currency for this entity. This does not include any taxes or surcharges. |
| ApproximateFees |
string simple type |
|
Optional |
|
The Converted fee amount in Default Currency. |
| ApproximateTaxes |
string simple type |
|
Optional |
|
The Converted tax amount in Default Currency. |
| ApproximateTotalPrice |
string simple type |
|
Optional |
|
The Converted total price in Default Currency for this entity including base price and all taxes. |
| BasePrice |
string simple type |
|
Optional |
|
Represents the base price for this entity. This does not include any taxes or surcharges. |
| EquivalentBasePrice |
string simple type |
|
Optional |
|
Represents the base price in the related currency for this entity. This does not include any taxes or surcharges. |
| Fees |
string simple type |
|
Optional |
|
The aggregated amount of all the fees that are associated with this entity. See the associated FeeInfo array for a breakdown of the individual fees. |
| Services |
string simple type |
|
Optional |
|
The total cost for all optional services. |
| Taxes |
string simple type |
|
Optional |
|
The aggregated amount of all the taxes that are associated with this entity. See the associated TaxInfo array for a breakdown of the individual taxes. |
| TotalPrice |
string simple type |
|
Optional |
|
The total price for this entity including base price and all taxes. |
| ProviderCode |
string simple type |
|
Optional |
|
|
| SupplierCode |
string simple type |
|
Optional |
|
|
| ServiceData |
element |
|
|
|
|
| AirSegmentRef |
string simple type |
|
Optional |
|
Reference to a segment if the merchandising offering only pertains to that segment. If no segment reference is present this means this offering is for the whole itinerary. |
| BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to a passenger if the merchandising offering only pertains to that passenger. If no passenger reference is present this means this offering is for all passengers. |
| Data |
string simple type |
|
Optional |
|
Data that specifies the details of the merchandising offering (e.g. seat number for seat service) |
| EMDCouponRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD coupon issued. Supported providers are 1G/1V/1P |
| EMDSummaryRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD issued. Supported providers are 1G/1V/1P |
| StopOver |
boolean simple type |
|
Optional |
false |
Indicates that there is a significant
delay between flights (usually 12 hours or more) |
| TravelerType |
string simple type |
|
Optional |
|
Passenger Type Code. |
| SeatAttributes |
element |
|
|
|
Identifies the seat attribute of the service. |
| SeatAttribute |
element |
|
|
|
Identifies the seat attribute of the service. |
| Value |
string simple type |
|
Required |
|
|
| CabinClass |
element |
|
|
|
Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier. |
| Type |
string simple type |
|
Required |
|
|
| SSRRef |
typeKeyBasedReference complex type |
|
|
|
References to the related SSRs. At present, only reference to ASVC SSR is supported. Supported providers are 1G/1V/1P |
| Key |
string simple type |
|
Required |
|
|
| ServiceInfo |
element |
|
|
|
|
| Description |
string simple type |
|
|
|
Description of the Service. Usually used in tandem with one or more media items. |
| MediaItem |
element |
|
|
|
Photos and other media urls for the property referenced above. |
| caption |
string simple type |
|
Optional |
|
|
| height |
integer simple type |
|
Optional |
|
|
| icon |
anyURI simple type |
|
Optional |
|
|
| sizeCode |
string simple type |
|
Optional |
|
|
| type |
string simple type |
|
Optional |
|
|
| url |
anyURI simple type |
|
Optional |
|
|
| width |
integer simple type |
|
Optional |
|
|
| Remark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
| Key |
string simple type |
|
Optional |
|
|
| TaxInfo |
typeTaxInfo complex type |
|
|
|
The tax information for a |
| CarrierDefinedCategory |
string simple type |
|
Optional |
|
Optional category, where a carrier has
used a non-standard IATA tax category. The tax category will be
set to "DU" |
| Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax
code. |
| CouponRef |
string simple type |
|
Optional |
|
The coupon to which that tax is relative (if
applicable) |
| FlightDetailsRef |
string simple type |
|
Optional |
|
The flight details that this tax is relative
to (if applicable) |
| Key |
string simple type |
|
Optional |
|
The tax key represents a valid key of tax |
| ProviderCode |
string simple type |
|
Optional |
|
Code of the provider returning this TaxInfo. |
| SegmentRef |
string simple type |
|
Optional |
|
The segment to which that tax is relative (if
applicable) |
| SupplierCode |
string simple type |
|
Optional |
|
Code of the supplier returning this TaxInfo. |
| TaxExempted |
boolean simple type |
|
Optional |
|
This indicates whether the tax specified by
tax category is exempted. |
| Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
| Amount |
string simple type |
|
Required |
|
|
| CountryCode |
string simple type |
|
Optional |
|
|
| Description |
string simple type |
|
Optional |
|
|
| DestinationAirport |
string simple type |
|
Optional |
|
|
| FareInfoRef |
string simple type |
|
Optional |
|
|
| OriginAirport |
string simple type |
|
Optional |
|
|
| TaxDetail |
element |
|
|
|
The tax idetail nformation for a fare quote tax. |
| Amount |
string simple type |
|
Required |
|
|
| CountryCode |
string simple type |
|
Optional |
|
|
| Description |
string simple type |
|
Optional |
|
|
| DestinationAirport |
string simple type |
|
Optional |
|
|
| FareInfoRef |
string simple type |
|
Optional |
|
|
| OriginAirport |
string simple type |
|
Optional |
|
|
| IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
| Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
| FeeInfo |
typeFeeInfo complex type |
|
|
|
A generic type of fee for those charges which are incurred by the passenger, but not necessarily shown on tickets |
| Amount |
string simple type |
|
Required |
|
|
| BaseAmount |
string simple type |
|
Optional |
|
|
| BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to booking traveler |
| Code |
string simple type |
|
Required |
|
|
| Description |
string simple type |
|
Optional |
|
|
| FeeToken |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Required |
|
|
| PassengerTypeCode |
string simple type |
|
Optional |
|
|
| PaymentRef |
string simple type |
|
Optional |
|
The reference to the one of the air
reservation payments if fee included in charge |
| SubCode |
string simple type |
|
Optional |
|
|
| Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
| ProviderCode |
string simple type |
|
Optional |
|
|
| SupplierCode |
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. |
| TaxInfoRef |
element |
|
|
|
This reference elements will associate relevant taxes to this fee |
| Key |
string simple type |
|
Required |
|
|
| IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
| Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
| EMD |
element |
|
|
|
this attribute shows the amount included in the base fare for the specific fee or tax |
| AssociatedItem |
string simple type |
|
Optional |
|
The type of Optional Service. The choices are Flight, Ticket, Merchandising, Rule Buster, Allowance, Chargeable Baggage, Carry On Baggage Allowance, Prepaid Baggage. Provider: 1G, 1V, 1P |
| AvailabilityChargeIndicator |
string simple type |
X , E , F , G , H |
Optional |
|
A one-letter code specifying whether the service
is available or if there is a charge associated with it.
X = Service not available
F = No charge for service (free) and an EMD is not issued to
reflect free service
E = No charge for service (free) and an EMD is issued to reflect
the free service.
G = No charge for service (free), booking is not required and an
EMD is not issued to reflect free service
H = No charge for service (free), booking is not required, and an
EMD is issued to reflect the free service.
Blank = No application. Charges apply according to the data in the
Service Fee fields. |
| Booking |
typeBooking simple type |
|
Optional |
|
Holds the booking description for the service, e.g., SSR. |
| Commissionable |
boolean simple type |
|
Optional |
|
True/False value to whether or not the
service is comissionable. |
| Date |
dateTime simple type |
|
Optional |
|
The date at which the service will be used. |
| DisplayCategory |
typeDisplayCategory simple type |
|
Optional |
|
Describes when the service should be displayed. |
| FulfillmentType |
integer simple type |
|
Optional |
|
A one digit code specifying how the service must be fulfilled.
See FulfillmentTypeDescription for the description of this value. |
| FulfillmentTypeDescription |
string simple type |
|
Optional |
|
EMD description. |
| Location |
typeIATACode simple type |
|
Optional |
|
3 letter location code where the service will be availed. |
| MileageIndicator |
boolean simple type |
|
Optional |
|
True/False value to whether or not the
service has miles. |
| RefundReissueIndicator |
string simple type |
Refundable , NonRefundable , Reuse |
Optional |
|
An attribute specifying whether the service is
refundable or reissuable. |
| Reusable |
boolean simple type |
|
Optional |
|
Identifies if the service can be re-used towards a future purchase. |
| BundledServices |
element |
|
|
|
Identifies if the service can be re-used towards a future purchase. |
| BundledService |
element |
|
|
|
Displays the services bundled together |
| Booking |
typeBooking simple type |
|
Optional |
|
Booking method for the bundled service, e..g SSR. |
| Carrier |
string simple type |
|
Optional |
|
Carrier the service is applicable. |
| CarrierSubCode |
boolean simple type |
|
Optional |
|
Carrier sub code. True means the carrier used their own sub code. False means the carrier used an ATPCO sub code |
| Name |
string simple type |
|
Optional |
|
Name of the bundled service. |
| Occurrence |
nonNegativeInteger simple type |
|
Optional |
|
How many of the service are included in the bundled service. |
| ServiceSubCode |
string simple type |
|
Optional |
|
The sub code of the service, e.g. OAA for Pre paid baggage |
| ServiceType |
string simple type |
|
Optional |
|
The type of service or what the service is used for, e.g. F type is flight type, meaning the service is used on a flight |
| AdditionalInfo |
element |
|
|
|
The type of service or what the service is used for, e.g. F type is flight type, meaning the service is used on a flight |
| Category |
string simple type |
|
Required |
|
The category code is the code the AdditionalInfo text came from, e.g. S5 or S7. |
| FeeApplication |
element |
|
|
|
The category code is the code the AdditionalInfo text came from, e.g. S5 or S7. |
| Code |
string simple type |
|
Optional |
|
The code associated to the fee application. The choices are: 1, 2, 3, 4, 5, K, F |
| Text |
typeTextElement complex type |
|
|
|
Type of Text, Eg-'Upsell','Marketing Agent','Marketing Consumer','Strapline','Rule'. |
| 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. |
| Type |
string simple type |
|
Required |
|
|
| PriceRange |
element |
|
|
|
|
| DefaultCurrency |
boolean simple type |
|
Optional |
|
Indicates if the currency code of StartPrice / EndPrice is the default currency code |
| EndPrice |
string simple type |
|
Optional |
|
Price range end value |
| StartPrice |
string simple type |
|
Optional |
|
Price range start value |
| TourCode |
element |
|
|
|
Tour Code Fare Basis |
| Value |
string simple type |
|
Required |
|
|
| BrandingInfo |
element |
|
|
|
Branding information for the Ancillary Service. Returned in Seat Map only. Providers: 1G, 1V, 1P, ACH |
| Chargeable |
string simple type |
|
Optional |
|
Indicates if the optional service is not offered, is available for a charge, or is included in the brand. Providers: 1G, 1V, 1P, ACH |
| CommercialName |
string simple type |
|
Required |
|
The commercial name of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| ExternalServiceName |
string simple type |
|
Optional |
|
The external name of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| Key |
string simple type |
|
Optional |
|
|
| ServiceSubCode |
string simple type |
|
Optional |
|
The Service Sub Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| ServiceType |
string simple type |
|
Optional |
|
The type of Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| PriceRange |
element |
|
|
|
The type of Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| DefaultCurrency |
boolean simple type |
|
Optional |
|
Indicates if the currency code of StartPrice / EndPrice is the default currency code |
| EndPrice |
string simple type |
|
Optional |
|
Price range end value |
| StartPrice |
string simple type |
|
Optional |
|
Price range start value |
| Text |
typeTextElement complex type |
|
|
|
Type of Text, Eg-'Upsell','Marketing Agent','Marketing Consumer','Strapline','Rule'. |
| 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. |
| Type |
string simple type |
|
Required |
|
|
| Title |
typeTextElement complex type |
|
|
|
The additional titles associated to the brand or optional service. Providers: ACH, RCH, 1G, 1V, 1P. |
| 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. |
| Type |
string simple type |
|
Required |
|
|
| ImageLocation |
element |
|
|
|
|
| ImageHeight |
integer simple type |
|
Required |
|
The height of the image |
| ImageWidth |
integer simple type |
|
Required |
|
The width of the image |
| Type |
string simple type |
|
Required |
|
Type of Image Location. E.g., "Agent", "Consumer". |
| ServiceGroup |
element |
|
|
|
The Service Group of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| Code |
string simple type |
|
Required |
|
The Service Group Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| ServiceSubGroup |
element |
|
|
|
The Service Sub Group of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| Code |
string simple type |
|
Optional |
|
The Service Sub Group Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| AirSegmentRef |
typeSegmentRef complex type |
|
|
|
Specifies the AirSegment the branding information is for. Providers: ACH, 1G, 1V, 1P |
| Key |
string simple type |
|
Required |
|
|
| Title |
typeTextElement complex type |
|
|
|
The additional titles associated to the brand or optional service. Providers: ACH, RCH, 1G, 1V, 1P. |
| 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. |
| Type |
string simple type |
|
Required |
|
|
| GroupedOptionInfo |
element |
|
|
|
|
| GroupedOption |
element |
|
|
|
|
| OptionalServiceRef |
string simple type |
|
Required |
|
Reference to a optionalService which is paired with other optional services in the parent PairedOptions element. |
| OptionalServiceRules |
ServiceRuleType complex type |
|
|
|
Holds the rules for selecting the optional
service in the itinerary |
| Key |
string simple type |
|
Required |
|
Unique ID to identify an optional service rule |
| ApplicationRules |
element |
|
|
|
The rules to apply the rule to the itinerary |
| RequiredForAllSegments |
boolean simple type |
|
Optional |
|
Indicates if the option needs to be applied to all segments in the itinerary if selected |
| RequiredForAllSegmentsInOD |
boolean simple type |
|
Optional |
|
Indicates if the option needs to be applied to all segments in a origin / destination (connection flights) if selected for one segment in the OD |
| RequiredForAllTravelers |
boolean simple type |
|
Optional |
|
Indicates if the option needs to be applied to all travelers in the itinerary if selected |
| SecondaryOptionCodeRequired |
boolean simple type |
|
Optional |
|
If set to true, the secondary option code is required for this option |
| UnselectedOptionRequired |
boolean simple type |
|
Optional |
|
If an UnselectedOption is present in the option, then the Unselected option needs to be selected even if the option is not selected when this flag is set to true |
| ApplicationLevel |
element |
|
|
|
Lists the levels where the option is applied in the itinerary. Some options are applied for the entire itinerary, some for entire segments, etc. |
| ApplicableLevels |
anonymous simple type |
|
Optional |
|
Indicates the level in the itinerary when the option is applied. |
| ProviderDefinedApplicableLevels |
string simple type |
|
Optional |
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
| ApplicationLimits |
element |
|
|
|
Adds the limits on the number of options that can be selected for a particular type |
| ApplicationLimit |
OptionalServiceApplicationLimitType complex type |
|
|
|
The application limits for a particular level |
| ApplicableLevel |
string simple type |
Itinerary , Passenger , Segment , PassengerSegment , PassengerOD , Other |
Required |
|
Indicates the applicable level for the option |
| MaximumQuantity |
nonNegativeInteger simple type |
|
Required |
|
The maximum quantity allowed for the type |
| MinimumQuantity |
nonNegativeInteger simple type |
|
Optional |
|
Indicates the minimum number of the option that can be selected. |
| ProviderDefinedApplicableLevels |
string simple type |
|
Optional |
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
| ServiceData |
element |
|
|
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
| AirSegmentRef |
string simple type |
|
Optional |
|
Reference to a segment if the merchandising offering only pertains to that segment. If no segment reference is present this means this offering is for the whole itinerary. |
| BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to a passenger if the merchandising offering only pertains to that passenger. If no passenger reference is present this means this offering is for all passengers. |
| Data |
string simple type |
|
Optional |
|
Data that specifies the details of the merchandising offering (e.g. seat number for seat service) |
| EMDCouponRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD coupon issued. Supported providers are 1G/1V/1P |
| EMDSummaryRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD issued. Supported providers are 1G/1V/1P |
| StopOver |
boolean simple type |
|
Optional |
false |
Indicates that there is a significant
delay between flights (usually 12 hours or more) |
| TravelerType |
string simple type |
|
Optional |
|
Passenger Type Code. |
| SeatAttributes |
element |
|
|
|
Identifies the seat attribute of the service. |
| SeatAttribute |
element |
|
|
|
Identifies the seat attribute of the service. |
| Value |
string simple type |
|
Required |
|
|
| CabinClass |
element |
|
|
|
Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier. |
| Type |
string simple type |
|
Required |
|
|
| SSRRef |
typeKeyBasedReference complex type |
|
|
|
References to the related SSRs. At present, only reference to ASVC SSR is supported. Supported providers are 1G/1V/1P |
| Key |
string simple type |
|
Required |
|
|
| ModifyRules |
element |
|
|
|
Groups the modification rules for the Option |
| ProviderDefinedModificationType |
string simple type |
|
Optional |
|
Indicates the actual provider defined modification type which is mapped to Other |
| SupportedModifications |
anonymous simple type |
|
Optional |
|
Lists the supported modifications for the itinerary. |
| ModifyRule |
element |
|
|
|
Indicates modification rules for the particular modification type. |
| AutomaticallyAppliedOnAdd |
boolean simple type |
|
Optional |
false |
Indicates if the option will be automatically added to new segments / passengers in the itinerary. |
| CanAdd |
boolean simple type |
|
Optional |
|
Indicates if the option can be added to the itinerary without segment or passenger modification |
| CanDelete |
boolean simple type |
|
Optional |
|
Indicates if the option can be deleted from the itinerary without segment or passenger modifications |
| Modification |
NMTOKEN simple type |
AddSegment , RemoveSegment , ReplaceSegment , AddPassenger , RemovePassenger , OptionsOnly , Other |
Required |
|
The modificaiton for which this rule group applies. |
| ProviderDefinedModificationType |
string simple type |
|
Optional |
|
Indicates the actual provider defined modification type which is mapped to Other |
| Refundable |
boolean simple type |
|
Optional |
|
Indicates if the price of the option is refundable. |
| SecondaryTypeRules |
element |
|
|
|
Lists the supported Secondary Codes for the optional / additional service. |
| SecondaryTypeRule |
element |
|
|
|
Lists a single secondary code for the optional / additional service. |
| SecondaryType |
string simple type |
|
Required |
|
The unique type to associate a secondary type in an optional service |
| ApplicationLimit |
OptionalServiceApplicationLimitType complex type |
|
|
|
The unique type to associate a secondary type in an optional service |
| ApplicableLevel |
string simple type |
Itinerary , Passenger , Segment , PassengerSegment , PassengerOD , Other |
Required |
|
Indicates the applicable level for the option |
| MaximumQuantity |
nonNegativeInteger simple type |
|
Required |
|
The maximum quantity allowed for the type |
| MinimumQuantity |
nonNegativeInteger simple type |
|
Optional |
|
Indicates the minimum number of the option that can be selected. |
| ProviderDefinedApplicableLevels |
string simple type |
|
Optional |
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
| Remarks |
FormattedTextTextType complex type |
|
|
|
Adds text remarks / rules for the optional / additional service |
| Formatted |
boolean simple type |
|
Optional |
|
Textual information, which may be formatted as a line of information, or unformatted, as a paragraph of text. |
| TextFormat |
NMTOKEN simple type |
PlainText , HTML |
Optional |
|
Indicates the format of text used in the description e.g. unformatted or html. |
| Language |
token simple type |
|
Optional |
|
Language identification. |
| Brand |
element |
|
|
|
Commercially recognized product offered by an airline |
| AirItineraryDetailsRef |
string simple type |
|
Optional |
|
AirItinerary associated with this brand |
| BrandFound |
boolean simple type |
|
Optional |
|
Indicates whether brand for the fare was found for carrier or not |
| BrandID |
string simple type |
|
Optional |
|
The unique identifier of the brand |
| BrandMaintained |
string simple type |
|
Optional |
|
Indicates whether the brand was maintained from the original ticket. |
| BrandTier |
string simple type |
|
Optional |
|
Modifier to price by specific brand tier number. |
| BrandedDetailsAvailable |
boolean simple type |
|
Optional |
|
Indicates if full details of the brand is available |
| Carrier |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Optional |
|
Brand Key |
| Name |
string simple type |
|
Optional |
|
The Title of the brand |
| UpSellBrandFound |
boolean simple type |
|
Optional |
|
Indicates whether upsell brand for the fare was found for carrier or not |
| UpSellBrandID |
string simple type |
|
Optional |
|
|
| Title |
typeTextElement complex type |
|
|
|
The additional titles associated to the brand or optional service. Providers: ACH, RCH, 1G, 1V, 1P. |
| 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. |
| Type |
string simple type |
|
Required |
|
|
| Text |
typeTextElement complex type |
|
|
|
Type of Text, Eg-'Upsell','Marketing Agent','Marketing Consumer','Strapline','Rule'. |
| 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. |
| Type |
string simple type |
|
Required |
|
|
| ImageLocation |
element |
|
|
|
|
| ImageHeight |
integer simple type |
|
Required |
|
The height of the image |
| ImageWidth |
integer simple type |
|
Required |
|
The width of the image |
| Type |
string simple type |
|
Required |
|
Type of Image Location. E.g., "Agent", "Consumer". |
| OptionalServices |
element |
|
|
|
A wrapper for all the information regarding each
of the Optional services |
| OptionalServicesTotal |
element |
|
|
|
The total fares, fees and taxes associated
with the Optional Services |
| ApproximateBasePrice |
string simple type |
|
Optional |
|
The Converted base price in Default Currency for this entity. This does not include any taxes or surcharges. |
| ApproximateFees |
string simple type |
|
Optional |
|
The Converted fee amount in Default Currency. |
| ApproximateTaxes |
string simple type |
|
Optional |
|
The Converted tax amount in Default Currency. |
| ApproximateTotalPrice |
string simple type |
|
Optional |
|
The Converted total price in Default Currency for this entity including base price and all taxes. |
| BasePrice |
string simple type |
|
Optional |
|
Represents the base price for this entity. This does not include any taxes or surcharges. |
| EquivalentBasePrice |
string simple type |
|
Optional |
|
Represents the base price in the related currency for this entity. This does not include any taxes or surcharges. |
| Fees |
string simple type |
|
Optional |
|
The aggregated amount of all the fees that are associated with this entity. See the associated FeeInfo array for a breakdown of the individual fees. |
| Services |
string simple type |
|
Optional |
|
The total cost for all optional services. |
| Taxes |
string simple type |
|
Optional |
|
The aggregated amount of all the taxes that are associated with this entity. See the associated TaxInfo array for a breakdown of the individual taxes. |
| TotalPrice |
string simple type |
|
Optional |
|
The total price for this entity including base price and all taxes. |
| TaxInfo |
typeTaxInfo complex type |
|
|
|
The tax information for a |
| CarrierDefinedCategory |
string simple type |
|
Optional |
|
Optional category, where a carrier has
used a non-standard IATA tax category. The tax category will be
set to "DU" |
| Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax
code. |
| CouponRef |
string simple type |
|
Optional |
|
The coupon to which that tax is relative (if
applicable) |
| FlightDetailsRef |
string simple type |
|
Optional |
|
The flight details that this tax is relative
to (if applicable) |
| Key |
string simple type |
|
Optional |
|
The tax key represents a valid key of tax |
| ProviderCode |
string simple type |
|
Optional |
|
Code of the provider returning this TaxInfo. |
| SegmentRef |
string simple type |
|
Optional |
|
The segment to which that tax is relative (if
applicable) |
| SupplierCode |
string simple type |
|
Optional |
|
Code of the supplier returning this TaxInfo. |
| TaxExempted |
boolean simple type |
|
Optional |
|
This indicates whether the tax specified by
tax category is exempted. |
| Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
| Amount |
string simple type |
|
Required |
|
|
| CountryCode |
string simple type |
|
Optional |
|
|
| Description |
string simple type |
|
Optional |
|
|
| DestinationAirport |
string simple type |
|
Optional |
|
|
| FareInfoRef |
string simple type |
|
Optional |
|
|
| OriginAirport |
string simple type |
|
Optional |
|
|
| TaxDetail |
element |
|
|
|
The tax idetail nformation for a fare quote tax. |
| Amount |
string simple type |
|
Required |
|
|
| CountryCode |
string simple type |
|
Optional |
|
|
| Description |
string simple type |
|
Optional |
|
|
| DestinationAirport |
string simple type |
|
Optional |
|
|
| FareInfoRef |
string simple type |
|
Optional |
|
|
| OriginAirport |
string simple type |
|
Optional |
|
|
| IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
| Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
| FeeInfo |
typeFeeInfo complex type |
|
|
|
A generic type of fee for those charges which are incurred by the passenger, but not necessarily shown on tickets |
| Amount |
string simple type |
|
Required |
|
|
| BaseAmount |
string simple type |
|
Optional |
|
|
| BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to booking traveler |
| Code |
string simple type |
|
Required |
|
|
| Description |
string simple type |
|
Optional |
|
|
| FeeToken |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Required |
|
|
| PassengerTypeCode |
string simple type |
|
Optional |
|
|
| PaymentRef |
string simple type |
|
Optional |
|
The reference to the one of the air
reservation payments if fee included in charge |
| SubCode |
string simple type |
|
Optional |
|
|
| Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
| ProviderCode |
string simple type |
|
Optional |
|
|
| SupplierCode |
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. |
| TaxInfoRef |
element |
|
|
|
This reference elements will associate relevant taxes to this fee |
| Key |
string simple type |
|
Required |
|
|
| IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
| Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
| OptionalService |
element |
|
|
|
this attribute shows the amount included in the base fare for the specific fee or tax |
| ApplicableFFLevel |
integer simple type |
|
Optional |
|
Numerical value of the loyalty card level for which this service is available. |
| AssessIndicator |
string simple type |
MileageAndCurrency , MileageOrCurrency |
Optional |
|
Indicates whether price is assessed by mileage or currency or both |
| Available |
boolean simple type |
|
Optional |
|
Boolean to describe whether the Service is
available for sale or not |
| BaggageUnitPrice |
string simple type |
|
Optional |
|
The per unit price of baggage. Providers: 1G, 1V, 1P |
| BookedQuantity |
string simple type |
|
Optional |
|
Indicates the Optional Service quantity already booked. Provider: 1G, 1V, 1P |
| Chargeable |
string simple type |
|
Optional |
|
Indicates if the optional service is not offered, is available for a charge, or is included in the brand |
| Confirmation |
string simple type |
|
Optional |
|
Confirmation number provided by the
supplier |
| CreateDate |
dateTime simple type |
|
Optional |
|
Timestamp when this service/offer got
created. |
| DisplayOrder |
integer simple type |
|
Optional |
|
Optional service group display order. |
| DisplayText |
string simple type |
|
Optional |
|
Title of the Optional Service. Provider: ACH |
| Entitled |
boolean simple type |
|
Optional |
|
Boolean to describe whether the passenger
is entitled for the service without charge or not |
| ExcessWeightRate |
string simple type |
|
Optional |
|
The cost of the bag per unit weight. |
| FirstPiece |
long simple type |
|
Optional |
|
Indicates the minimum occurrence of excess baggage.Provider: 1G, 1V, 1P. |
| GeographySpecification |
string simple type |
|
Optional |
|
Sector, Portion, Journey. |
| Group |
string simple type |
|
Optional |
|
Associates Optional Services with the same ServiceSub Code, Air Segment, Passenger, and EMD Associated Item. Provider:1G, 1V, 1P |
| InclusiveOfTax |
boolean simple type |
|
Optional |
|
Identifies if the service was filed with a fee that is inclusive of tax. |
| InterlineSettlementAllowed |
boolean simple type |
|
Optional |
|
Identifies if the interline settlement is allowed in service . |
| IsPricingApproximate |
boolean simple type |
|
Optional |
|
When set to True indicates that the pricing returned is approximate. Supported providers are MCH/ACH |
| IsRepriceRequired |
boolean simple type |
|
Optional |
false |
When set to “true”, the Optional Service must be re-priced. Provider: 1G, 1V, 1P |
| IssuanceReason |
string simple type |
|
Optional |
|
A one-letter code specifying the reason for
issuance of the OptionalService |
| Key |
string simple type |
|
Optional |
|
|
| LastPiece |
long simple type |
|
Optional |
|
Indicates the maximum occurrence of excess baggage. Provider: 1G, 1V, 1P. |
| Mileage |
decimal simple type |
|
Optional |
|
Indicates mileage fee/amount |
| OptionalServicesRuleRef |
string simple type |
|
Optional |
|
UniqueID to associate a rule to the
Optional Service |
| PaymentRef |
string simple type |
|
Optional |
|
Reference to a payment for merchandising
services. |
| PerTraveler |
boolean simple type |
|
Optional |
true |
Boolean to describe whether the Amount on
the Service is charged per traveler. |
| Priority |
decimal simple type |
|
Optional |
|
Numeric value that represents the priority
order of the Service |
| Private |
boolean simple type |
|
Optional |
|
Describes if service is private or not. |
| ProviderDefinedType |
string simple type |
|
Optional |
|
Original Type as sent by the provider |
| PseudoCityCode |
string simple type |
|
Optional |
|
The PCC or SID that booked the Optional Service. |
| PurchaseWindow |
string simple type |
BookingOnly , TicketingOnly , CheckInOnly , Anytime , PostTicketing |
Optional |
|
Describes when the Service is available
for confirmation or purchase (e.g. Booking Only, Check-in Only,
Anytime, etc.) |
| Quantity |
decimal simple type |
|
Optional |
|
The number of units availed for each optional
service (e.g. 2 baggage availed will be specified as 2 in quantity
for optional service BAGGAGE) |
| Restricted |
boolean simple type |
|
Optional |
false |
When set to “true”, the Optional Service is restricted by an embargo. Provider: 1G, 1V, 1P |
| SSRCode |
string simple type |
|
Optional |
|
The SSR Code associated with the
OptionalService |
| SSRFreeText |
string simple type |
|
Optional |
|
Certain SSR types sent in OptionalService SSRCode require a free text message. For example, PETC Pet in Cabin. |
| SecondaryType |
string simple type |
|
Optional |
|
The secondary option code type required for
certain options |
| SequenceNumber |
decimal simple type |
|
Optional |
|
The sequence number associated with the
OptionalService |
| ServiceStatus |
string simple type |
|
Optional |
|
Specify the service status (e.g. active,
canceled, etc.) |
| ServiceSubCode |
string simple type |
|
Optional |
|
The service subcode associated with the
OptionalService |
| Source |
string simple type |
|
Optional |
|
The Source of the optional service. The source can be ACH, MCE, or MCH. |
| Tag |
string simple type |
|
Optional |
|
Optional service group name. |
| TotalWeight |
string simple type |
|
Optional |
|
The total weight of a bag. Providers: 1G, 1V, 1P |
| Type |
string simple type |
|
Required |
|
Specify the type of service offered (e.g.
seats, baggage, etc.) |
| ViewableOnly |
boolean simple type |
|
Optional |
|
Describes if the OptionalService is viewable only or not.
If viewable only then the service cannot be sold. |
| WeightInExcess |
string simple type |
|
Optional |
|
The excess weight of a bag. Providers: 1G, 1V, 1P |
| 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. |
| ApproximateBasePrice |
string simple type |
|
Optional |
|
The Converted base price in Default Currency for this entity. This does not include any taxes or surcharges. |
| ApproximateFees |
string simple type |
|
Optional |
|
The Converted fee amount in Default Currency. |
| ApproximateTaxes |
string simple type |
|
Optional |
|
The Converted tax amount in Default Currency. |
| ApproximateTotalPrice |
string simple type |
|
Optional |
|
The Converted total price in Default Currency for this entity including base price and all taxes. |
| BasePrice |
string simple type |
|
Optional |
|
Represents the base price for this entity. This does not include any taxes or surcharges. |
| EquivalentBasePrice |
string simple type |
|
Optional |
|
Represents the base price in the related currency for this entity. This does not include any taxes or surcharges. |
| Fees |
string simple type |
|
Optional |
|
The aggregated amount of all the fees that are associated with this entity. See the associated FeeInfo array for a breakdown of the individual fees. |
| Services |
string simple type |
|
Optional |
|
The total cost for all optional services. |
| Taxes |
string simple type |
|
Optional |
|
The aggregated amount of all the taxes that are associated with this entity. See the associated TaxInfo array for a breakdown of the individual taxes. |
| TotalPrice |
string simple type |
|
Optional |
|
The total price for this entity including base price and all taxes. |
| ProviderCode |
string simple type |
|
Optional |
|
|
| SupplierCode |
string simple type |
|
Optional |
|
|
| ServiceData |
element |
|
|
|
|
| AirSegmentRef |
string simple type |
|
Optional |
|
Reference to a segment if the merchandising offering only pertains to that segment. If no segment reference is present this means this offering is for the whole itinerary. |
| BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to a passenger if the merchandising offering only pertains to that passenger. If no passenger reference is present this means this offering is for all passengers. |
| Data |
string simple type |
|
Optional |
|
Data that specifies the details of the merchandising offering (e.g. seat number for seat service) |
| EMDCouponRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD coupon issued. Supported providers are 1G/1V/1P |
| EMDSummaryRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD issued. Supported providers are 1G/1V/1P |
| StopOver |
boolean simple type |
|
Optional |
false |
Indicates that there is a significant
delay between flights (usually 12 hours or more) |
| TravelerType |
string simple type |
|
Optional |
|
Passenger Type Code. |
| SeatAttributes |
element |
|
|
|
Identifies the seat attribute of the service. |
| SeatAttribute |
element |
|
|
|
Identifies the seat attribute of the service. |
| Value |
string simple type |
|
Required |
|
|
| CabinClass |
element |
|
|
|
Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier. |
| Type |
string simple type |
|
Required |
|
|
| SSRRef |
typeKeyBasedReference complex type |
|
|
|
References to the related SSRs. At present, only reference to ASVC SSR is supported. Supported providers are 1G/1V/1P |
| Key |
string simple type |
|
Required |
|
|
| ServiceInfo |
element |
|
|
|
|
| Description |
string simple type |
|
|
|
Description of the Service. Usually used in tandem with one or more media items. |
| MediaItem |
element |
|
|
|
Photos and other media urls for the property referenced above. |
| caption |
string simple type |
|
Optional |
|
|
| height |
integer simple type |
|
Optional |
|
|
| icon |
anyURI simple type |
|
Optional |
|
|
| sizeCode |
string simple type |
|
Optional |
|
|
| type |
string simple type |
|
Optional |
|
|
| url |
anyURI simple type |
|
Optional |
|
|
| width |
integer simple type |
|
Optional |
|
|
| Remark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
| Key |
string simple type |
|
Optional |
|
|
| TaxInfo |
typeTaxInfo complex type |
|
|
|
The tax information for a |
| CarrierDefinedCategory |
string simple type |
|
Optional |
|
Optional category, where a carrier has
used a non-standard IATA tax category. The tax category will be
set to "DU" |
| Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax
code. |
| CouponRef |
string simple type |
|
Optional |
|
The coupon to which that tax is relative (if
applicable) |
| FlightDetailsRef |
string simple type |
|
Optional |
|
The flight details that this tax is relative
to (if applicable) |
| Key |
string simple type |
|
Optional |
|
The tax key represents a valid key of tax |
| ProviderCode |
string simple type |
|
Optional |
|
Code of the provider returning this TaxInfo. |
| SegmentRef |
string simple type |
|
Optional |
|
The segment to which that tax is relative (if
applicable) |
| SupplierCode |
string simple type |
|
Optional |
|
Code of the supplier returning this TaxInfo. |
| TaxExempted |
boolean simple type |
|
Optional |
|
This indicates whether the tax specified by
tax category is exempted. |
| Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
| Amount |
string simple type |
|
Required |
|
|
| CountryCode |
string simple type |
|
Optional |
|
|
| Description |
string simple type |
|
Optional |
|
|
| DestinationAirport |
string simple type |
|
Optional |
|
|
| FareInfoRef |
string simple type |
|
Optional |
|
|
| OriginAirport |
string simple type |
|
Optional |
|
|
| TaxDetail |
element |
|
|
|
The tax idetail nformation for a fare quote tax. |
| Amount |
string simple type |
|
Required |
|
|
| CountryCode |
string simple type |
|
Optional |
|
|
| Description |
string simple type |
|
Optional |
|
|
| DestinationAirport |
string simple type |
|
Optional |
|
|
| FareInfoRef |
string simple type |
|
Optional |
|
|
| OriginAirport |
string simple type |
|
Optional |
|
|
| IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
| Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
| FeeInfo |
typeFeeInfo complex type |
|
|
|
A generic type of fee for those charges which are incurred by the passenger, but not necessarily shown on tickets |
| Amount |
string simple type |
|
Required |
|
|
| BaseAmount |
string simple type |
|
Optional |
|
|
| BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to booking traveler |
| Code |
string simple type |
|
Required |
|
|
| Description |
string simple type |
|
Optional |
|
|
| FeeToken |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Required |
|
|
| PassengerTypeCode |
string simple type |
|
Optional |
|
|
| PaymentRef |
string simple type |
|
Optional |
|
The reference to the one of the air
reservation payments if fee included in charge |
| SubCode |
string simple type |
|
Optional |
|
|
| Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
| ProviderCode |
string simple type |
|
Optional |
|
|
| SupplierCode |
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. |
| TaxInfoRef |
element |
|
|
|
This reference elements will associate relevant taxes to this fee |
| Key |
string simple type |
|
Required |
|
|
| IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
| Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
| EMD |
element |
|
|
|
this attribute shows the amount included in the base fare for the specific fee or tax |
| AssociatedItem |
string simple type |
|
Optional |
|
The type of Optional Service. The choices are Flight, Ticket, Merchandising, Rule Buster, Allowance, Chargeable Baggage, Carry On Baggage Allowance, Prepaid Baggage. Provider: 1G, 1V, 1P |
| AvailabilityChargeIndicator |
string simple type |
X , E , F , G , H |
Optional |
|
A one-letter code specifying whether the service
is available or if there is a charge associated with it.
X = Service not available
F = No charge for service (free) and an EMD is not issued to
reflect free service
E = No charge for service (free) and an EMD is issued to reflect
the free service.
G = No charge for service (free), booking is not required and an
EMD is not issued to reflect free service
H = No charge for service (free), booking is not required, and an
EMD is issued to reflect the free service.
Blank = No application. Charges apply according to the data in the
Service Fee fields. |
| Booking |
typeBooking simple type |
|
Optional |
|
Holds the booking description for the service, e.g., SSR. |
| Commissionable |
boolean simple type |
|
Optional |
|
True/False value to whether or not the
service is comissionable. |
| Date |
dateTime simple type |
|
Optional |
|
The date at which the service will be used. |
| DisplayCategory |
typeDisplayCategory simple type |
|
Optional |
|
Describes when the service should be displayed. |
| FulfillmentType |
integer simple type |
|
Optional |
|
A one digit code specifying how the service must be fulfilled.
See FulfillmentTypeDescription for the description of this value. |
| FulfillmentTypeDescription |
string simple type |
|
Optional |
|
EMD description. |
| Location |
typeIATACode simple type |
|
Optional |
|
3 letter location code where the service will be availed. |
| MileageIndicator |
boolean simple type |
|
Optional |
|
True/False value to whether or not the
service has miles. |
| RefundReissueIndicator |
string simple type |
Refundable , NonRefundable , Reuse |
Optional |
|
An attribute specifying whether the service is
refundable or reissuable. |
| Reusable |
boolean simple type |
|
Optional |
|
Identifies if the service can be re-used towards a future purchase. |
| BundledServices |
element |
|
|
|
Identifies if the service can be re-used towards a future purchase. |
| BundledService |
element |
|
|
|
Displays the services bundled together |
| Booking |
typeBooking simple type |
|
Optional |
|
Booking method for the bundled service, e..g SSR. |
| Carrier |
string simple type |
|
Optional |
|
Carrier the service is applicable. |
| CarrierSubCode |
boolean simple type |
|
Optional |
|
Carrier sub code. True means the carrier used their own sub code. False means the carrier used an ATPCO sub code |
| Name |
string simple type |
|
Optional |
|
Name of the bundled service. |
| Occurrence |
nonNegativeInteger simple type |
|
Optional |
|
How many of the service are included in the bundled service. |
| ServiceSubCode |
string simple type |
|
Optional |
|
The sub code of the service, e.g. OAA for Pre paid baggage |
| ServiceType |
string simple type |
|
Optional |
|
The type of service or what the service is used for, e.g. F type is flight type, meaning the service is used on a flight |
| AdditionalInfo |
element |
|
|
|
The type of service or what the service is used for, e.g. F type is flight type, meaning the service is used on a flight |
| Category |
string simple type |
|
Required |
|
The category code is the code the AdditionalInfo text came from, e.g. S5 or S7. |
| FeeApplication |
element |
|
|
|
The category code is the code the AdditionalInfo text came from, e.g. S5 or S7. |
| Code |
string simple type |
|
Optional |
|
The code associated to the fee application. The choices are: 1, 2, 3, 4, 5, K, F |
| Text |
typeTextElement complex type |
|
|
|
Type of Text, Eg-'Upsell','Marketing Agent','Marketing Consumer','Strapline','Rule'. |
| 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. |
| Type |
string simple type |
|
Required |
|
|
| PriceRange |
element |
|
|
|
|
| DefaultCurrency |
boolean simple type |
|
Optional |
|
Indicates if the currency code of StartPrice / EndPrice is the default currency code |
| EndPrice |
string simple type |
|
Optional |
|
Price range end value |
| StartPrice |
string simple type |
|
Optional |
|
Price range start value |
| TourCode |
element |
|
|
|
Tour Code Fare Basis |
| Value |
string simple type |
|
Required |
|
|
| BrandingInfo |
element |
|
|
|
Branding information for the Ancillary Service. Returned in Seat Map only. Providers: 1G, 1V, 1P, ACH |
| Chargeable |
string simple type |
|
Optional |
|
Indicates if the optional service is not offered, is available for a charge, or is included in the brand. Providers: 1G, 1V, 1P, ACH |
| CommercialName |
string simple type |
|
Required |
|
The commercial name of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| ExternalServiceName |
string simple type |
|
Optional |
|
The external name of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| Key |
string simple type |
|
Optional |
|
|
| ServiceSubCode |
string simple type |
|
Optional |
|
The Service Sub Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| ServiceType |
string simple type |
|
Optional |
|
The type of Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| PriceRange |
element |
|
|
|
The type of Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| DefaultCurrency |
boolean simple type |
|
Optional |
|
Indicates if the currency code of StartPrice / EndPrice is the default currency code |
| EndPrice |
string simple type |
|
Optional |
|
Price range end value |
| StartPrice |
string simple type |
|
Optional |
|
Price range start value |
| Text |
typeTextElement complex type |
|
|
|
Type of Text, Eg-'Upsell','Marketing Agent','Marketing Consumer','Strapline','Rule'. |
| 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. |
| Type |
string simple type |
|
Required |
|
|
| Title |
typeTextElement complex type |
|
|
|
The additional titles associated to the brand or optional service. Providers: ACH, RCH, 1G, 1V, 1P. |
| 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. |
| Type |
string simple type |
|
Required |
|
|
| ImageLocation |
element |
|
|
|
|
| ImageHeight |
integer simple type |
|
Required |
|
The height of the image |
| ImageWidth |
integer simple type |
|
Required |
|
The width of the image |
| Type |
string simple type |
|
Required |
|
Type of Image Location. E.g., "Agent", "Consumer". |
| ServiceGroup |
element |
|
|
|
The Service Group of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| Code |
string simple type |
|
Required |
|
The Service Group Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| ServiceSubGroup |
element |
|
|
|
The Service Sub Group of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| Code |
string simple type |
|
Optional |
|
The Service Sub Group Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
| AirSegmentRef |
typeSegmentRef complex type |
|
|
|
Specifies the AirSegment the branding information is for. Providers: ACH, 1G, 1V, 1P |
| Key |
string simple type |
|
Required |
|
|
| Title |
typeTextElement complex type |
|
|
|
The additional titles associated to the brand or optional service. Providers: ACH, RCH, 1G, 1V, 1P. |
| 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. |
| Type |
string simple type |
|
Required |
|
|
| GroupedOptionInfo |
element |
|
|
|
|
| GroupedOption |
element |
|
|
|
|
| OptionalServiceRef |
string simple type |
|
Required |
|
Reference to a optionalService which is paired with other optional services in the parent PairedOptions element. |
| OptionalServiceRules |
ServiceRuleType complex type |
|
|
|
Holds the rules for selecting the optional
service in the itinerary |
| Key |
string simple type |
|
Required |
|
Unique ID to identify an optional service rule |
| ApplicationRules |
element |
|
|
|
The rules to apply the rule to the itinerary |
| RequiredForAllSegments |
boolean simple type |
|
Optional |
|
Indicates if the option needs to be applied to all segments in the itinerary if selected |
| RequiredForAllSegmentsInOD |
boolean simple type |
|
Optional |
|
Indicates if the option needs to be applied to all segments in a origin / destination (connection flights) if selected for one segment in the OD |
| RequiredForAllTravelers |
boolean simple type |
|
Optional |
|
Indicates if the option needs to be applied to all travelers in the itinerary if selected |
| SecondaryOptionCodeRequired |
boolean simple type |
|
Optional |
|
If set to true, the secondary option code is required for this option |
| UnselectedOptionRequired |
boolean simple type |
|
Optional |
|
If an UnselectedOption is present in the option, then the Unselected option needs to be selected even if the option is not selected when this flag is set to true |
| ApplicationLevel |
element |
|
|
|
Lists the levels where the option is applied in the itinerary. Some options are applied for the entire itinerary, some for entire segments, etc. |
| ApplicableLevels |
anonymous simple type |
|
Optional |
|
Indicates the level in the itinerary when the option is applied. |
| ProviderDefinedApplicableLevels |
string simple type |
|
Optional |
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
| ApplicationLimits |
element |
|
|
|
Adds the limits on the number of options that can be selected for a particular type |
| ApplicationLimit |
OptionalServiceApplicationLimitType complex type |
|
|
|
The application limits for a particular level |
| ApplicableLevel |
string simple type |
Itinerary , Passenger , Segment , PassengerSegment , PassengerOD , Other |
Required |
|
Indicates the applicable level for the option |
| MaximumQuantity |
nonNegativeInteger simple type |
|
Required |
|
The maximum quantity allowed for the type |
| MinimumQuantity |
nonNegativeInteger simple type |
|
Optional |
|
Indicates the minimum number of the option that can be selected. |
| ProviderDefinedApplicableLevels |
string simple type |
|
Optional |
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
| ServiceData |
element |
|
|
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
| AirSegmentRef |
string simple type |
|
Optional |
|
Reference to a segment if the merchandising offering only pertains to that segment. If no segment reference is present this means this offering is for the whole itinerary. |
| BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to a passenger if the merchandising offering only pertains to that passenger. If no passenger reference is present this means this offering is for all passengers. |
| Data |
string simple type |
|
Optional |
|
Data that specifies the details of the merchandising offering (e.g. seat number for seat service) |
| EMDCouponRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD coupon issued. Supported providers are 1G/1V/1P |
| EMDSummaryRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD issued. Supported providers are 1G/1V/1P |
| StopOver |
boolean simple type |
|
Optional |
false |
Indicates that there is a significant
delay between flights (usually 12 hours or more) |
| TravelerType |
string simple type |
|
Optional |
|
Passenger Type Code. |
| SeatAttributes |
element |
|
|
|
Identifies the seat attribute of the service. |
| SeatAttribute |
element |
|
|
|
Identifies the seat attribute of the service. |
| Value |
string simple type |
|
Required |
|
|
| CabinClass |
element |
|
|
|
Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier. |
| Type |
string simple type |
|
Required |
|
|
| SSRRef |
typeKeyBasedReference complex type |
|
|
|
References to the related SSRs. At present, only reference to ASVC SSR is supported. Supported providers are 1G/1V/1P |
| Key |
string simple type |
|
Required |
|
|
| ModifyRules |
element |
|
|
|
Groups the modification rules for the Option |
| ProviderDefinedModificationType |
string simple type |
|
Optional |
|
Indicates the actual provider defined modification type which is mapped to Other |
| SupportedModifications |
anonymous simple type |
|
Optional |
|
Lists the supported modifications for the itinerary. |
| ModifyRule |
element |
|
|
|
Indicates modification rules for the particular modification type. |
| AutomaticallyAppliedOnAdd |
boolean simple type |
|
Optional |
false |
Indicates if the option will be automatically added to new segments / passengers in the itinerary. |
| CanAdd |
boolean simple type |
|
Optional |
|
Indicates if the option can be added to the itinerary without segment or passenger modification |
| CanDelete |
boolean simple type |
|
Optional |
|
Indicates if the option can be deleted from the itinerary without segment or passenger modifications |
| Modification |
NMTOKEN simple type |
AddSegment , RemoveSegment , ReplaceSegment , AddPassenger , RemovePassenger , OptionsOnly , Other |
Required |
|
The modificaiton for which this rule group applies. |
| ProviderDefinedModificationType |
string simple type |
|
Optional |
|
Indicates the actual provider defined modification type which is mapped to Other |
| Refundable |
boolean simple type |
|
Optional |
|
Indicates if the price of the option is refundable. |
| SecondaryTypeRules |
element |
|
|
|
Lists the supported Secondary Codes for the optional / additional service. |
| SecondaryTypeRule |
element |
|
|
|
Lists a single secondary code for the optional / additional service. |
| SecondaryType |
string simple type |
|
Required |
|
The unique type to associate a secondary type in an optional service |
| ApplicationLimit |
OptionalServiceApplicationLimitType complex type |
|
|
|
The unique type to associate a secondary type in an optional service |
| ApplicableLevel |
string simple type |
Itinerary , Passenger , Segment , PassengerSegment , PassengerOD , Other |
Required |
|
Indicates the applicable level for the option |
| MaximumQuantity |
nonNegativeInteger simple type |
|
Required |
|
The maximum quantity allowed for the type |
| MinimumQuantity |
nonNegativeInteger simple type |
|
Optional |
|
Indicates the minimum number of the option that can be selected. |
| ProviderDefinedApplicableLevels |
string simple type |
|
Optional |
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
| Remarks |
FormattedTextTextType complex type |
|
|
|
Adds text remarks / rules for the optional / additional service |
| Formatted |
boolean simple type |
|
Optional |
|
Textual information, which may be formatted as a line of information, or unformatted, as a paragraph of text. |
| TextFormat |
NMTOKEN simple type |
PlainText , HTML |
Optional |
|
Indicates the format of text used in the description e.g. unformatted or html. |
| Language |
token simple type |
|
Optional |
|
Language identification. |
| Rules |
element |
|
|
|
Language identification. |
| RulesText |
string simple type |
|
|
|
Rules text |
| ServiceAssociations |
element |
|
|
|
Rules text |
| ApplicableSegment |
element |
|
|
|
Applicable air segment associated with this brand. |
| Key |
string simple type |
|
Optional |
|
Applicable air segment key |
| 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 |
|
|
| OptionalServiceRef |
typeRef simple type |
|
|
|
Reference to optional service |
| UpsellBrand |
element |
|
|
|
Upsell brand reference |
| FareBasis |
string simple type |
|
Optional |
|
|
| FareInfoRef |
string simple type |
|
Optional |
|
|
| ApplicableSegment |
typeApplicableSegment complex type |
|
|
|
|
| AirItineraryDetailsRef |
string simple type |
|
Optional |
|
|
| BookingCounts |
string simple type |
|
Optional |
|
Classes of service and their counts. |
| Key |
string simple type |
|
Required |
|
|
| DefaultBrandDetail |
typeDefaultBrandDetail complex type |
|
|
|
Applicable air segment. |
| BrandID |
string simple type |
|
Optional |
|
The unique identifier of the brand |
| Text |
typeTextElement complex type |
|
|
|
Type of Text, Eg-'Upsell','Marketing Agent','Marketing Consumer','Strapline','Rule'. |
| 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. |
| Type |
string simple type |
|
Required |
|
|
| ImageLocation |
element |
|
|
|
|
| ImageHeight |
integer simple type |
|
Required |
|
The height of the image |
| ImageWidth |
integer simple type |
|
Required |
|
The width of the image |
| Type |
string simple type |
|
Required |
|
Type of Image Location. E.g., "Agent", "Consumer". |
| ApplicableSegment |
typeApplicableSegment complex type |
|
|
|
Applicable air segment. |
| AirItineraryDetailsRef |
string simple type |
|
Optional |
|
|
| BookingCounts |
string simple type |
|
Optional |
|
Classes of service and their counts. |
| Key |
string simple type |
|
Required |
|
|
| UnassociatedBookingCodeList |
element |
|
|
|
Lists classes of service by segment sent in the request which are not associated to a brand. |
| ApplicableSegment |
typeApplicableSegment complex type |
|
|
|
Lists classes of service by segment sent in the request which are not associated to a brand. |
| AirItineraryDetailsRef |
string simple type |
|
Optional |
|
|
| BookingCounts |
string simple type |
|
Optional |
|
Classes of service and their counts. |
| Key |
string simple type |
|
Required |
|
|