User Guidance - Service Input Parameters | ||
Input Parameters | Type | Optional/Mandatory |
Request Object | IATA_ServiceListRS | M |
<Response>
<PayloadAttributes>
<Response> | ||
|---|---|---|
Elements | Details | Mandatory/Optional |
Response | Service List RS response information. | M |
<ALaCarteOffer> | ||
Elements | Details | Mandatory/Optional |
XML Example for the following elements<ns2:ALaCarteOffer> | ||
Elements | Details | Mandatory/Optional |
ALaCarteOffer | 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 across several messages. | M |
OfferItem | A priced grouping of one or more services within an Offer. The A La Carte Offer Item assigns a total price for all included services for all passengers and all segments referenced. | M |
Eligibility | Refers to the Passengers, Price class or segments for which this offer item is eligible. | M |
OfferFlightAssociations | Offer Flight Associations. | O |
PaxSegmentReferences | Reference to a PaxSegmentID's - 1 or more pax segments references. | M |
PaxSegmentRefID | Reference to a PaxSegmentID. | M |
PaxRefID | Reference to the passengers who are eligible for this Offer Item. | O |
OfferItemID | Carrier assigned ID which exists uniquely within an Offer. | M |
Service | The instance of a specific flight or Service Definition as it has been offered (and eventually ordered and consumed) in the context of a specific Offer and/or Order. At the time of shopping, a service can be sold to multiple passengers on a given journey. | M |
ServiceDefinitionRefID | Reference to a service definition. | M |
ServiceID | Uniquely Identifies a Service within the context of one message. | M |
UnitPrice | The amount of money expected, required, or given in payment for something. | M |
Fee | Amount added on to a charge for a specific product, purpose, or service. | O |
Amount | Fee Amount. | M |
DescText | Fee/ surcharge Description. | O |
DesigText | Fee designator code. | O |
TaxSummary | Tax summary information. | O |
Tax | A compulsory contribution to state revenue, levied by the government on workers' income and business profits. | O |
Amount | Tax amount. | M |
Country | A nation with its own government, occupying a particular territory. | O |
CountryCode | ISO Country Code. | O |
DescText | Tax short description. | O |
FiledTaxCode | Internal tax filed type code as determined by the airline. | O |
TaxCode | IATA TTBS Tax Code. | O |
TaxName | The name given to describe the tax. For example, this name can be taken from the IATA TTBS. | O |
TotalTaxAmount | Total of all applicable tax amounts including the price. | O |
TotalAmount | Total monetary price amount, including all tax, surcharge, and fee amounts. | O |
OwnerCode | Airline code assigned to a carrier. | M |
<DataLists> | ||
Elements | Details | Mandatory/Optional |
DataLists | Data List definition. | O |
<BaggageAllowanceList> | ||
BaggageAllowanceList | Baggage allowance data list definition | O |
<BaggageAllowance> | ||
XML Example for the following elements<ns2:BaggageAllowance> | ||
Elements | Details | Mandatory/Optional |
BaggageAllowance | The amount of checked or carry-on luggage the airline will allow per passenger. | M |
AirlineTaxonomy | Used in the context of the Airline Taxonomy to define a product or service to the seller or to request a collection of products and services from an airline. | O |
TaxonomyCode | Used for defining a product or service within the Shared Industry Taxonomy or bilaterally. | O |
BaggageAllowanceID | Unique identifier of this Baggage Allowance. | M |
PieceAllowance | Defines the maximum number of each allowable baggage type. | O |
TotalQty | Maximum pieces of baggage allowed. | M |
TypeCode | Type of Baggage Allowance. E.g. Checked or CarryOn. | M |
WeightAllowance | Baggage weight allowance with application information. | O |
MaximumWeightMeasure | Maximum weight value and unit of measure. | O |
WeightUnitOfMeasurement | The unit of measurement of weight defined as imperial or metric. | M |
<DatedMarketingSegmentList> | ||
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, either under the operating carrier's designator or that of another carrier. | M |
Arrival | This is a transport point location. | M |
AircraftScheduledDateTime | The Scheduled Date and Time of Arrival of the aircraft 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 used in a message. | M |
DatedOperatingSegmentRefId | Reference to a unique identifier of a dated operating segment used in a message. | 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> </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 |
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 |
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 |
CarrierAircraftTypeName | Internal name given by the carrier to this aircraft type. | O |
DatedOperatingLegID | Uniquely identifies a leg | M |
Dep | Departure transport point location | M |
<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 |
CarrierDesigCode | Airline code assigned to a carrier. | 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 |
OperatingCarrierFlightNumberText | The numerical designation of a flight as it is operated by a carrier. | 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> | ||
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. | M |
DatedMarketingSegmentRefId | A reference to a unique identifier of a dated marketing segment used in a message. | M |
PaxSegmentID | Uniquely identifies a Passenger Segment | M |
<ServiceDefinitionList> | ||
Elements | Details | Mandatory/Optional |
ServiceDefinitionList | Service Definition data list definition. | O |
<ServiceDefinition> | ||
XML Example for the following elements<ns2:ServiceDefinition> <ns2:ServiceDefinitionAssociation> <!-- This element is to be populated for Baggage SSR --> <!--This element is to be populated for Bundle SSR --> <ns2:ServiceDefinitionID>V1_SSR.1697326329407</ns2:ServiceDefinitionID> | ||
Elements | Details | Mandatory/Optional |
ServiceDefinition | Description and characteristics of a non-flight product or service that can be separately sold and delivered. | M |
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 |
Name | Service name. | M |
OwnerCode | Airline code assigned to a carrier. | M |
RFIC | Reason For Issuance Code | O |
RFISC | Reason For Issuance Sub Code. | O |
ServiceCode | Airline specific service code which can be associated with the Reason for Issuance Sub Code. | O |
ServiceDefinitionAssociation | Service Definition Association Choice to determine if the information of this ServiceDefinition needs to be extended with specific Bag or Seat characteristics or whether the ServiceDefinition is used as a bundle of further ServiceDefinitions. | O |
BaggageAllowanceRef | Reference to a Baggage Allowance. | M |
BaggageAllowanceRefID | Reference to a Bag Allowance ID. | M |
ServiceBundle | A set of services offered for sale as a single service. | M |
ServiceDefinitionRefID | Airline specific definition of a product or service (excluding flights) that can be separately sold and delivered. | M |
ServiceDefinitionID | Uniquely Identifies a Service Definition. | M |
<Processing> | ||
Elements | Details | Mandatory/Optional |
Processing | A set of Information related to how response results should be returned. | O |
XML Example for the following elements<ns2:CurParameter> </ns2:CurParameter> | ||
<CurParameter> | ||
CurParameter | Currency related parameters intended to influence which currency the shopping results are displayed in. | O |
CurCode | Currency Code as per ISO | M |
DecimalsAllowedNumber | Specifies how many numbers to be specified after the decimal in case of currency amounts. | O |
<PayloadAttributes> | ||
XML Example for the following elements<ns3:PayloadAttributes> </ns3:PayloadAttributes> | ||
Elements | Details | Mandatory/Optional |
PayloadAttributes | IATA payload standard attributes. | O |
Timestamp | Indicates the creation date and time of the message in UTC. | O |
VersionNumber | The version of the message | O |