ServiceListRS NDC 2017.2

ServiceListRS

XPath: /ServiceListRS

Data Type Value: restriction of xs:anyType [0..1]

Description: The ServiceList transaction set returns a list of all applicable ancillary services that meet request qualifiers and flights. The message supports shopping for additional a la carte services to compliment any selected offer, as well as shopping for specialty service items not generally included in an initial offer but rather based on service search filters, e.g., sports equipment specialty baggage and unaccompanied minor fees.

The message also returns multi-media content at the message level and media references at the individual service level.

EchoToken

XPath: /ServiceListRS/@EchoToken

Data Type Value: StringLength1to128

Description: A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.

TimeStamp

XPath: ServiceListRS/@TimeStamp

Data Type Value: dateTime

Description: Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g., 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).

Target

XPath: /ServiceListRS/@Target

Data Type Value: Target

Description: Used to indicate whether the request is for the Test or Production system.

Version

XPath: /ServiceListRS/@Version

Data Type Value: string

Description: For all IATA versioned messages, the version of the message is indicated by a decimal value.

TransactionIdentifier

XPath: /ServiceListRS/@TransactionIdentifier

Data Type Value: StringLength1to32

Description: A unique identifier to relate all messages within a transaction (e.g., this would be sent in all request and response messages that are part of an on-going transaction).

SequenceNmbr

XPath: /ServiceListRS/@SequenceNmbr

Data Type Value: nonNegativeInteger

Description: Used to identify the sequence number of the transaction as assigned by the sending system; allows for an application to process messages in a certain order or to request a resynchronization of messages in the event that a system has been off-line and needs to retrieve messages that were missed.

TransactionStatusCode

XPath: /ServiceListRS/@TransactionStatusCode

Data Type Value: TransactionStatusCode

Description: This indicates where this message falls within a sequence of messages.

PrimaryLangID

XPath: /ServiceListRS/@PrimaryLangID

Data Type Value: language

Description: Identifes the primary language preference for the message. The human language is identified by ISO 639 codes.

AltLangID

XPath: /ServiceListRS/@AltLangID

Data Type Value: language

Description: Identifies the alternate language for a customer or message. The human language is identified by ISO 639 codes.

RetransmissionIndicator

XPath: /ServiceListRS/@RetransmissionIndicator

Data Type Value: boolean

Description: When true, indicates the message is being re-sent after a failure. It is recommended that this attribute is used (i.e., set to TRUE) only when a message is retransmitted.

CorrelationID

XPath: /ServiceListRS/@CorrelationID

Data Type Value: StringLength1to64

Description: Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.

Document

id

XPath: /ServiceListRS/Document/@id

Data Type Value: ID

Description: A globally unique identifier for this object instance.

Name

XPath: /ServiceListRS/Document/Name

Data Type Value: ProperNameSimpleType

Description: NDC Implementation Name. Example: ThisAirline Gateway

ReferenceVersion

XPath: /ServiceListRS/Document/ReferenceVersion

Data Type Value: ContextSimpleType

Description: NDC Framework Version. Example: SOAP 2015.1

Success

XPath: /ServiceListRS/Success

Data Type Value: SuccessType

Description: The presence of the empty Success element explicitly indicates that the message succeeded.

Warnings

XPath: /ServiceListRS/Warnings

Data Type Value: WarningsType

Description: Used in conjunction with the Success element to define one or more business errors.

Warning

XPath: /ServiceListRS/Warnings/Warning

Data Type Value: WarningType [1..99]

Description: Used in conjunction with the Success element to define a business error.

Language

XPath: /ServiceListRS/Warnings/Warning/@Language

Data Type Value: language

Description: Language identification.

Type

XPath: /ServiceListRS/Warnings/Warning/@Type

Data Type Value: IATA_CodeType

Description: The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown".

ShortText

XPath: /ServiceListRS/Warnings/Warning/@ShortText

Data Type Value: StringLength1to255

Description: An error in textual format.

Code

XPath: /ServiceListRS/Warnings/Warning/@Code

Data Type Value: IATA_CodeType

Description: If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to IATA PADIS Code List data element 9321.

DocURL

XPath: /ServiceListRS/Warnings/Warning/@DocURL

Data Type Value: anyURI

Description: If present, this URL refers to an online description of the error that occurred.

Status

XPath: /ServiceListRS/Warnings/Warning/@Status

Data Type Value: StringLength1to64

Description: If present, recommended values are those enumerated in the IATA_ErrorRS, (NotProcessed | Incomplete | Complete | Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.

Tag

XPath: /ServiceListRS/Warnings/Warning/@Tag

Data Type Value: string

Description: If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].

RecordID

XPath: /ServiceListRS/Warnings/Warning/@RecordID

Data Type Value: StringLength1to32

Description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records.

DataLists

PTC

XPath: /ServiceListR/DataLists/PassengerList/Passenger/PTC

Data Type Value: extension of PaxSimpleType [0..1]

Description: Passenger type code and travelers quantity. ADT

PassengerID

XPath: /ServiceListR/DataLists/PassengerList/Passenger/@PassengerID

Data Type Value: ID

Description: Uniquely identifies a Passenger within the context of one message.

FlightSegmentList

XPath: /ServiceListRS/DataLists/FlightSegmentList

Data Type Value: FlightSegmentList

Description: List of flight segments.

FlightSegment

XPath: /ServiceListR/DataLists/FlightSegmentList/FlightSegment

Data Type Value: ListOfFlightSegmentType []

Description: FlighSegment information. Contains details flight segment information.

SegmentKey

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/@SegmentKey

Data Type Value: KeyIdentifier

Description: A globally unique identifier for this Flight Segment instance. Example: segment1

Date

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/Departure/Date

Data Type Value: date

Description: Departure date. Example: 2017-01-13

Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)

Time

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/Departure/Time

Data Type Value: TimeSimpleType

Description: Departure time. Example: 09:15

Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)

Date

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/Arrival/Date

Data Type Value: date

Description: Arrival date. Example: 2017-01-14

Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)

Time

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/Arrival/Time

Data Type Value: TimeSimpleType

Description: Arrival time. Example: 09:15

Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)

StopQuantity

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopQuantity

Data Type Value: integer

Description: Stop Quantity. Example: 1

FlightNumber

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/FlightNumber

Data Type Value: FlightNumber

Description: Flight Number. Example: 1234, or OPEN, or ARNK

Code

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/ClassOfService/Code

Data Type Value: Code

Description: Class of Service Code. Example: B

Departure

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/Departure

Data Type Value: Departure

Description: Departure (origin) Airport, Date and Time information.

AirportCode

XPath: /ServiceListRS/DataLists/FlightSegment/Departure/AirportCode

Data Type Value: AirportCode

Description: Airport or a city code. Use a three-letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory. Example: TPA

AirportCode

XPath: /ServiceListRS/DataLists/FlightSegment/Arrival/AirportCode

Data Type Value: AirportCode

Description: Airport or a city code. Use a three-letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory. Example: TPA

OperatingCarrier

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier

Data Type Value: OperatingCarrier

Description: Operating Carrier Information.

Name

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Name

Data Type Value: CarrierNameType

Description: Airline Name. Example: British Airways

AirlineID

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/AirlineID

Data Type Value: AirlineID

Description: A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory.

Equipment

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegmentList/FlightSegment/Equipment

Data Type Value: AircraftSummaryType

Description: Aircraft Equipment.

AircraftCode

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/Equipment/AircraftCode

Data Type Value: AircraftCode

Description: The IATA aircraft type three-character code; use SSIM Appendix A. Example:318.

MarketingCarrier

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegmentList/FlightSegment/MarketingCarrier

Data Type Value: MarketingCarrierFlightType

Description: Marketing Carrier information.

Name

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/Name

Data Type Value: CarrierNameType

Description: Airline Name. Example: British Airways

AirlineID

XPath: /ServiceListRS/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/AirlineID

Data Type Value: AirlineID

Description: A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory.

ServiceDefinition

XPath: /ServiceListRS/DataLists/ServiceDefinitionList/ServiceDefinition

Data Type Value: ServiceDefinitionType[]

Description: Note: ServiceDefinition can be one to many, but ServiceDefinitionList is single.

ServiceDefinitionID

XPath: /ServiceListRS/DataLists/ServiceDefinitionList/ServiceDefinition/@ServiceDefinitionID

Data Type Value: ID

Description: A unique Service ID that has been returned in the Shopping results and identifies an airline service item (i.e., a product or a service) that can be separately delivered and uniquely described by an airline.

Example: SRVC-2B88-4C33-9787-9461114BC9BE.

Owner

XPath: /ServiceListRS/DataLists/ServiceDefinitionList/ServiceDefinition/@Owner

Data Type Value: AirlineDesigSimpleType

Description: Airline designator or CRS code of the owner/ assigner of the Offer ID, typically used for offer ordering purposes. Example: UA, BA. Encoding Scheme: IATA/ A4A (two or three character) Airline or CRS Designator Code.

Name

XPath: /ServiceListRS/DataLists/ServiceDefinitionList/ServiceDefinition/Name

Data Type Value: Name

Description: Service name. Example: Lounge Pass.

Text

XPath: /ServiceListRS/DataLists/ServiceDefinitionList/ServiceDefinition/Descriptions/Description/Text

Data Type Value: Text

Description: Description value.

Note: Description can be one to many, but Descriptions is single.

Text

XPath: /ServiceListRS/DataLists/ServiceDefinitionList/ServiceDefinition/BookingInstructions/Text

Data Type Value: string

Description:

Code

XPath: /ServiceListRS/DataLists/ServiceDefinitionList/ServiceDefinition/Encoding/Code

Data Type Value: Code

Description: Service code.

SeatDefinitionRefs

XPath: /ServiceListRS/DataLists/ServiceDefinitionList/ServiceDefinition/SeatDefinitionRefs

Data Type Value: IDREFS

Description: Reference to Seats within SeatList to further define the characteristics of the seat product. In a shopping scenario, reference one instance of a seat, for further description. May be used in SeatAvailability messages to reference multiple seats to reflect availability of physical seats of this product type.

OriginDestinationKey

XPath: /ServiceListRS/DataLists/OriginDestinationList/OriginDestination/@OriginDestinationKey

Data Type Value: KeyIdentifier

Description: A globally unique identifier for this OriginDestination instance. Example: origDest1

DepartureCode

XPath: /ServiceListRS/DataLists/OriginDestinationList/OriginDestination/DepartureCode

Data Type Value: DepartureCode

Description: Departure (origin) Airport Code.

ArrivalCode

XPath: /ServiceListRS/DataLists/OriginDestinationList/OriginDestination/ArrivalCode

Data Type Value: ArrivalCode

Description: Airport or a city code. Use a three-letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory. Example: TPA

FlightReferences

XPath: /ServiceListRS/DataLists/OriginDestinationList/OriginDestination/FlightReferences

Data Type Value: FlightReferences

Description: Association to multiple Flight instance(s). Example: flight1 flight2.

Note: Flight Slice On and Off Board Points may also be specified.

SeatDefinition

XPath: /ServiceListRS/DataLists/SeatDefinitionList/SeatDefinition

Data Type Value: ServiceDefinitionType

Description: Seat information by aircraft section.

SeatDefinitionID

XPath: /ServiceListRS/DataLists/SeatDefinitionList/SeatDefinition/@SeatDefinitionID

Data Type Value: ID

Description: A unique Seat ID that identifies an airline seat item that can be separately delivered and uniquely described by an airline.

refs

XPath: /ServiceListRS/DataLists/SeatDefinitionList/SeatDefinition/Description/Text/@refs

Data Type Value: InstanceClassRefSimpleType

Description: Object association(s) between this object and any other object or metadata instance(s).

Text

XPath: /ServiceListRS/DataLists/SeatDefinitionList/SeatDefinition/Description/Text

Data Type Value: Text

Description: Description value

SeatCharacteristicCode

XPath: /ServiceListRS/DataLists/SeatDefinitionList/SeatDefinition/SeatCharacteristicCode

Data Type Value: CodesetValueSimpleType[]

Description: Refers to aircraft seat characteristics; seat option codes. Examples: E (EXIT ROW), M (Middle Seat), A (Aisle seat), L (Left side of aircraft), Q (Bulkhead). Refer to PADIS code list 9825.

BaggageAllowance

XPath: /ServiceListRS/DataLists/BaggageAllowanceList/BaggageAllowance

Data Type Value: BaggageAllowance[]

Description: Checked or Carry-On Baggage Allowance detail. Use BaggageCategory to specify which of the two.

BaggageAllowanceID

XPath: /ServiceListRS/DataLists/BaggageAllowanceList/BaggageAllowance/@BaggageAllowanceID

Data Type Value: ID

Description:

BaggageCategory

XPath: /ServiceListRS/DataLists/BaggageAllowanceList/BaggageAllowance/BaggageCategory

Data Type Value: BaggageCategoryListType

Description: Enumeration:

CarryOn

Checked

refs

XPath: /ServiceListRS/DataLists/BaggageAllowanceList/BaggageAllowance/WeightAllowance/@refs

Data Type Value: InstanceClassRefSimpleType

Description: Object association(s) between this object and any other object or metadata instance(s).

Value

XPath: /ServiceListRS/DataLists/BaggageAllowanceList/BaggageAllowance/WeightAllowance/MaximumWeight/Value

Data Type Value: decimal

Description: Maximum weight value. Example: 50

UOM

XPath: /ServiceListRS/DataLists/BaggageAllowanceList/BaggageAllowance/WeightAllowance/MaximumWeight/UOM

Data Type Value: IATA_CodeType

Description: Baggage weight unit of measure.

Encoding Scheme: IATA Padis Codeset - List for data element 6411

ALaCarteOffer

OfferID

XPath: /ServiceListRS/ALaCarteOffer/@OfferID

Data Type Value: xsd:ID required

Description: Airline-assigned unique Offer identifier.

Owner

XPath: /ServiceListRS/ALaCarteOffer/@Owner

Data Type Value: xsd:string

Description: Airline designator of the owner/ assigner of the Offer ID, typically used for offer ordering purposes. Example: UA, BA

Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Code.

OfferItemID

XPath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/@OfferItemID

Data Type Value: ID

Description: Unique identifier for this OfferItem instance. Must be unique within XML message. Exceeding 64 characters or use of dashes is not recommended.

Eligibility

XPath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/Eligibility

Data Type Value: Eligibility

Description: Refers to the Passengers, Price class or Segments for which this offer item is eligible.

PassengerRefs

XPath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/Eligibility/PassengerRefs

Data Type Value: PassengerRefs

Description: Reference to the passengers who are eligible for this Offer Item.

SegmentRefs

XPath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/Eligibility/SegmentRefs

Data Type Value: SegmentRefs

Description: Reference to the flight segments on which this Offer Item can be provided.

Total

XPath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/TotalAmount/DetailCurrencyPrice/Total

Data Type Value: CurrencyAmountOptType

Description: Total price in currency. Example: 16000 USD.

Code

XPath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/TotalAmount/DetailCurrencyPrice/Total/@Code

Data Type Value: CurrencySimpleType

Description: Currency code. Example: USD.

BaseAmount

XPath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/BaseAmount

Data Type Value: CurrencyAmountOptType

Description: Total Base Fare Amount. Example: 200000

Note: This includes surcharges (if applicable).

Taxes

XPath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/Taxes

Data Type Value: TaxDetailType

Description: Ticket Tax/fee/charge details to indicate taxes that apply to country of commencement of travel and routing.

Total

XPath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/Taxes/Total

Data Type Value: Total

Description: Sub-total of all applicable taxes. Monetary value and currency code.

Amount

XPath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/Taxes/Breakdown/Tax/Amount

Data Type Value: CurrencyAmountOptType

Description: Amount

TaxCode

XPath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/Taxes/Breakdown/Tax/TaxCode

Data Type Value: string

Description: Tax Code. Example: AY, GB

Nation

XPath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/UnitPriceDetail/Taxes/Breakdown/Tax/Nation

Data Type Value: string

Description: Tax Nation or Designator. Example: US, GB

ServiceID

XPath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/Service/@ServiceID

Data Type Value: ID

Description: Unique identifier for this Service instance.

ServiceDefinitionRef

XPath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/Service/ServiceDefinitionRef

Data Type Value: IDREF

Description:

Errors

XPath: /ServiceListRS/Errors

Data Type Value: ErrorsType

Description: Error(s) that prevented message processing.

Error

XPath: /ServiceListRS/Errors/Error

Data Type Value: ErrorType[]

Description: Standard way to indicate that an error occurred during the processing of an IATA message

Language

XPath: /ServiceListRS/Errors/Error/@Language

Data Type Value: language

Description: Language identification.

Type

XPath: /ServiceListRS/Errors/Error/@Type

Data Type Value: IATA_CodeType

Description: The Error element MUST contain the Type attribute that uses a recommended set of values to indicate the error type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown".

ShortText

XPath: /ServiceListRS/Errors/Error/@ShortText

Data Type Value: StringLength1to255

Description: An error in textual format.

Code

XPath: /ServiceListRS/Errors/Error/@Code

Data Type Value: IATA_CodeType

Description: If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to IATA PADIS Code List data element 9321.

DocURL

XPath: /ServiceListRS/Errors/Error/@DocURL

Data Type Value: anyURI

Description: If present, this URL refers to an online description of the error that occurred.

Status

XPath: /ServiceListRS/Errors/Error/@Status

Data Type Value: StringLength1to64

Tag

XPath: /ServiceListRS/Errors/Error/@Tag

Data Type Value: string

RecordID

XPath: /ServiceListRS/Errors/Error/@RecordID

Data Type Value: StringLength1to32

Description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records.

NodeList

XPath: /ServiceListRS/Errors/Error/@NodeList

Data Type Value: string

Description: An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional constraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message.