User Guidance - Service Input Parameters | ||
Input Parameters | Type | Optional/Mandatory |
Request Object | IATA_AirShoppingRS | M |
<Response>
<PayloadAttributes>
<PayloadAttributes> | ||
|---|---|---|
XML Example for the following elements<ns4:PayloadAttributes> | ||
Elements | Details | Mandatory/Optional |
PayloadAttributes | IATA payload standard attributes. | O |
VersionNumber | The version of the message | O |
<Response> | ||
|---|---|---|
Elements | Details | Mandatory/Optional |
Response | AirShopping response information. | M |
<DataLists> | ||
Elements | Details | Mandatory/Optional |
DataLists | Data List definition for this message. | O |
<DatedMarketingSegmentList> | ||
Elements | Details | Mandatory/Optional |
DatedMarketingSegmentList | A list of dated marketing segments used in the contained message. | O |
<DatedMarketingSegment> | ||
XML Example for the following elements<ns2:DatedMarketingSegment> | ||
Elements | Details | Mandatory/Optional |
DatedMarketingSegment | The commercial designation under which a Dated Operating Segment can be booked. | M |
Arrival | Arrival transport point location | M |
AircraftScheduledDateTime | The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport. | O |
IATA_LocationCode | IATA 3-letter code defining the city or airport code | M |
CarrierDesigCode | Airline code assigned to a carrier. | M |
DatedMarketingSegmentId | Unique identifier of a dated marketing segment. | M |
DatedOperatingSegmentRefId | Reference to a unique identifier of a dated operating segment. | M |
Dep | Departure transport point location | M |
MarketingCarrierFlightNumberText | The numerical designation of a flight as it is marketed by a carrier. | M |
OperationalSuffixText | Used to distinguish two flights having the same flight number and departing from their respective Origin Stations on the same date. | O |
<DatedOperatingLegList> | ||
Elements | Details | Mandatory/Optional |
DatedOperatingLegList | A list of dated operating legs | O |
<DatedOperatingLeg> | ||
XML Example for the following elements<ns2:DatedOperatingLeg> | ||
Elements | Details | Mandatory/Optional |
DatedOperatingLeg | The nonstop operation of a transport vehicle between the departure station and the arrival station | M |
Arrival | Arrival transport point location | M |
IATA_LocationCode | IATA 3-letter code defining the city or airport code. | M |
CarrierAircraftType | Carrier defined internal grouping of aircrafts with the same form, function and specification. | O |
CarrierAircraftTypeCode | Internal code used by an carrier to identify the type of aircraft. | O |
DatedOperatingLegID | Uniquely identifies a leg | M |
Dep | Departure transport point location | M |
IATA_AircraftType | Grouping of aircrafts with the same form, function and specification, currently flown, or soon to be flown | O |
IATA_AircraftTypeCode | Code assigned to an aircraft type in IATA SSIM. | O |
<DatedOperatingSegmentList> | ||
Elements | Details | Mandatory/Optional |
DatedOperatingSegmentList | A list of dated operating segments | O |
<DatedOperatingSegment> | ||
XML Example for the following elements<ns2:DatedOperatingSegment> | ||
Elements | Details | Mandatory/Optional |
DatedOperatingSegment | An operation between board point and any subsequent off point within the same flight designator. Could be one or more legs | M |
DatedOperatingLegRefID | Uniquely identifies a leg | O |
DatedOperatingSegmentId | Unique identifier of a dated operating segment | M |
Duration | Total segment time including the combined air time and connection times of any legs | O |
<OriginDestList> | ||
Elements | Details | Mandatory/Optional |
OriginDestList | Origin Destination data list definition. | O |
<OriginDest> | ||
XML Example for the following elements<ns2:OriginDest> | ||
Elements | Details | Mandatory/Optional |
OriginDest | The Origin and Destination airport/city pair which confines a passenger journey or an aircraft flight. | M |
DestCode | IATA defined code identifying Destination city or station. | M |
OriginCode | IATA defined code identifying Origin city or station. | M |
OriginDestID | Uniquely identifies an Origin Destination | M |
PaxJourneyRefID | Uniquely identifies a Passenger Journey | O |
<PaxJourneyList> | ||
Elements | Details | Mandatory/Optional |
PaxJourneyList | Journey data list definition | O |
<PaxJourney> | ||
XML Example for the following elements<ns2:PaxJourney> | ||
Elements | Details | Mandatory/Optional |
PaxJourney | A collection of segments which satisfies transportation of a passenger for a given origin and destination. | M |
Duration | Total journey time including the combined air time and connection times. | O |
PaxJourneyID | Uniquely identifies a Passenger Journey. | M |
PaxSegmentRefID | Reference to a Passenger Segment ID | M |
<PaxList> | ||
Elements | Details | Mandatory/Optional |
PaxList | Passenger data list definition. | O |
<Pax> | ||
XML Example for the following elements<ns2:Pax> | ||
Elements | Details | Mandatory/Optional |
Pax | Any person except members of the crew carried or to be carried with the consent of the carrie | M |
PaxID | Uniquely identifies a Passenger | M |
PTC | Type code applying to the Passenger | O |
<PaxSegmentList> | ||
Elements | Details | Mandatory/Optional |
PaxSegmentList | Segment data list definition. | O |
<PaxSegment> | ||
XML Example for the following elements<ns2:PaxSegment> | ||
Elements | Details | Mandatory/Optional |
PaxSegment | Transportation of a passenger on a Dated Operating Segment. - [Dated Marketing Segment] (All identifying fields) - [Order] Order ID - [Individual] | M |
CabinTypeAssociationChoice | A choice of Cabin Type Association to leg(s) or a segment | O |
SegmentCabinType | Type of compartment of an aircraft, offering specific services | M |
CabinTypeCode | Cabin Type Code | O |
CabinTypeName | Name given to a cabin compartment | O |
DatedMarketingSegmentRefId | A reference to a unique identifier of a dated marketing segment | M |
MarketingCarrierRBD_Code | Code used to identify a particular RBD | O |
PaxSegmentID | Uniquely identifies a Passenger Segment | M |
<PriceClassList> | ||
Elements | Details | Mandatory/Optional |
PriceClassList | Price Class data list definition. | O |
<PriceClass> | ||
XML Example for the following elements<ns2:PriceClass> | ||
Elements | Details | Mandatory/Optional |
PriceClass | A price point within a particular Cabin Type | M |
CabinType | Type of compartment of an aircraft, offering specific services | O |
CabinTypeCode | Cabin Type Code | O |
CabinTypeName | Name given to a cabin compartment | O |
Code | Price class code | O |
Desc | An account or representation of the certain or major aspects, characteristics, or features of a person, object, or event | O |
DescText | Description text value | O |
FareBasisCode | Fare basis code | O |
Name | Price class name | M |
PriceClassID | Uniquely Identifies a Price Class | M |
<ns2:OffersGroup> | ||
Elements | Details | Mandatory/Optional |
OffersGroup | Offers grouped by Carrier | M |
<ns2:CarrierOffers> | ||
Elements | Details | Mandatory/Optional |
CarrierOffers | Carrier Offers grouping of Offers returned by a single ORA. | M |
<Offer> | ||
XML Example for the following elements<ns2:Offer> | ||
Elements | Details | Mandatory/Optional |
Offer | A proposal to sell a specific set of products or Services under specific conditions, for a certain price. | O |
OfferID | Carrier assigned ID which uniquely identifies a specific Offer | M |
OwnerCode | Airline code assigned to a carrier. | M |
ValidatingCarrierCode | Airline code assigned to a carrier. | O |
OfferItem | A priced grouping of one or more services within an Offer. | M |
FareDetail | The amount charged by the carrier for the carriage of a passenger and his allowable free baggage. | O |
FareComponent | A portion of an itinerary between two consecutive fare construction points. | O |
FareBasisCode | Fare basis code | O |
FareRule | Special purchasing rules and restrictions used to differentiate fare levels from one another. | O |
TicketlessInd | When TRUE, the Fare can be purchased without issuing a ticket. | O |
FareTypeCode | Fare Amount Type Code | O |
PaxSegmentRefID | Reference to a Pax Segment ID | O |
Price | The amount of money expected, required, or given in payment for something. | O |
BaseAmount | Total Base Fare Amount. | O |
CurConversion | The result of converting one currency into another currency. | O |
Amount | Amount and currency specified in the converted currency. | M |
ConversionRate | Defines the rate used to convert the local currency into the billing currency. | M |
LocalAmount | Amount and currency as specified by the local Country. | M |
Discount | Deduction from the price amount, made in advance of its payment. | O |
DiscountAmount | Discount amount applied to a price. | O |
Surcharge | Amount added on to a usual charge for a specific product, purpose, or service. | O |
Breakdown | Amount added on to a charge for a specific product, purpose, or service. | O |
Amount | Fee Amount | M |
DesigText | Fee designator code. Example: USC | O |
TotalAmount | Summary of all fee amounts. | O |
TaxSummary | Tax summary information. | O |
Tax | A compulsory contribution to state revenue, levied by the government on workers' income and business profits or added to the cost of some goods, services, and transactions. | O |
AddlTaxCode | A qualifier to the Tax Code to distinguish taxes/fees/charges with the same tax code but with different business uses. | O |
Amount | Tax amount. | M |
TaxCode | IATA TTBS Tax Code. | O |
TaxName | The name given to describe the tax. | O |
TotalAmount | Total monetary price amount, including all tax, surcharge, and fee amounts | O |
PriceClassRefID | A price point within a particular Cabin Type | O |
RBD | Reservation Booking Designator. A categorization used to facilitate access to inventory, application of filed fares, and to identify cabin entitlement. Identified using a single alpha character. | O |
RBD_Code | Code used to identify a particular RBD | M |
FarePriceType | An additional specified fare pricing such as 'Net' and 'Filed'. | O |
FarePriceTypeCode | Indicates if the fare price provided is a filed amount, | M |
Price | The amount of money expected, required, or given in payment for something. | M |
BaseAmount | Total Base Fare Amount. | O |
Discount | Deduction from the price amount, | O |
DiscountAmount | Discount amount applied to a price. | O |
Surcharge | Amount added on to a usual charge for a specific product, purpose, or service. | O |
TotalAmount | Summary of all fee amounts. | O |
TaxSummary | Tax summary information. | O |
TotalTaxAmount | Total of all applicable tax amounts included in the price. | O |
TotalAmount | Total monetary price amount, | O |
PaxRefID | Reference to a Passenger ID | O |
OfferItemID | Carrier assigned ID which exists uniquely within an Offer. | M |
Price | The amount of money expected, required, or given in payment for something. | M |
BaseAmount | Total Base Fare Amount. | O |
Discount | Deduction from the price amount, made in advance of its payment. | O |
DiscountAmount | Discount amount applied to a price. | O |
TotalAmount | Total monetary price amount, | O |
Service | Offered Service is the instance of a specific flight or Service Definition as it has been offered | M |
OfferServiceAssociation | Offer Service Association | M |
PaxJourneyRef | A collection of segments which satisfies transportation of a passenger for a given origin and destination. | M |
PaxJourneyRefID | Uniquely identifies a Passenger Journey | M |
PaxRefID | Reference to a Passenger ID | M |
ServiceID | Uniquely Identifies a Service | M |