Ancillary Servicing - RS




 OrderChange - OrderViewRS - Ancillary Servicing

Data Model


Schemas

The service adheres to the IATA NDC OrderView schema version 17.2, with some modifications.

User Guidance - Response Definitions - Service Input Parameters

Input ParametersType

Mandatory/Optional

Request objectOrderViewRSM

<Document>

ElementsDetails

Mandatory/Optional

<Document>

M
<Name>
Will be returned as “BA”M

<Success>

Elements
Details

Mandatory/Optional

<Success/>
The presence of the empty Success element explicitly indicates that the message succeededM

<Errors>

ElementsDetails

Mandatory/Optional

<Errors>

A warning will be returned when the agent who did not create the booking requests for booking to be retrieved.

O
<Error>

BA warning message
Example: Agent Id in the request does not match the one in the booking

O
ShortText (Attribute)

PADIS Code - IATA definition from codeset 9845
Example: Requestor not authorized for this function for this PNR

O
Code (Attribute)

PADIS message - IATA definition from codeset 9845
Example: 375

O

<Warning>

ElementsDetailsMandatory/Optional
<Warnings>

O

<Warning>

BA warning message
Example:

An error occurred while retrieving Amadeus Mini Rules Response

O

Type (Attribute)

PADIS Code - IATA definition from codeset 9845
Example: 78

O

ShortText (Attribute)

PADIS message - IATA definition from codeset 9845
Example:

Invalid or missing fare data

O

<Order>

ElementsDetails

Mandatory/Optional

<Order>

This section contains details on all the elements in the booking-flight, seat, bag, meal, etc.

M

OrderID (Attribute)

Booking reference or PNR reference

Example: PPWZDF

M

Owner (Attribute)

Owner of the booking

Example: BA

M

<BookingReferences>

This section contains the PNR reference for the booking

M

<BookingReference>


M

<ID>

PNR reference

Example: PPWZDF

M

<AirlineID>

Airline Code

Example: BA

M

<TotalOrderPrice>

Returns the total price for the booking including flight, seats, bags, etc. for all passengers

M

<SimpleCurrencyPrice>

Total price for the booking including flight, seats, bags, etc. for all passengers

M

Code (Attribute)

Currency Code

Example: GBP

M

<OrderItems>

This section returns all the order items in the booking–Flight, Seat, Bag, Meal, etc along with the price passenger-wise.

M

<OrderItem>

This section returns individual order item per passenger and has to be repeated for each order item and for each passenger.

M

OrderItemID (Attribute)

A unique ID for the order item

Example: PPWZDF-T2-FS1-FS2

M

<PriceDetail>

This section returns total, fare and tax information along with the break down for the order item

M

<TotalAmount>


M

<SimpleCurrencyPrice>

Total amount (fare and tax) for the order item

Example: 420.41

M

Code (Attribute)

Currency Code

Example: GBP

M

<BaseAmount>

Fare amount for the order item

Example: 196

M

Code (Attribute)

Currency Code

Example: GBP

M

<Taxes>

This section contains total and breakdown of tax for the order item

O

<Total>

Tax amount for the order item

Example: 224.41

M

Code (Attribute)

Currency Code

Example: GBP

M

<Breakdown>

This section contains a breakdown of various tax elements

M

<Tax>

This section contains information on individual tax element

M

<Amount>

Value of this particular tax element

Example: 104.5

M

Code (Attribute)

Currency Code

Example: GBP

M

<TaxCode>

Code for the tax element

Example: YQ

M

<CollectionPoint>

Tax data break down by collection point for XF (Extra fee) and ZP (Federal tax segment) taxes

O

<CurrCode>

Airport’s local currency code

Example: USD

O

<AirportAmount>

Amount filed by the airport in the currency applicable to the geographical location of the airport

Example: 4.50

M

<AirportCode>

Segment departure or arrival airport code

Example: JFK

M

<Description>

Description of the tax element

Example: Carrier imposed charge

O

<Service>

This section contains the passenger reference, flight segment reference and seat details for flight/seat items.

For Meal and Disability Order items, this section contains passenger reference, Service Definition Reference and Flight segment reference (as an attribute)

For Bag Order item, this section contains passenger reference and Service Definition Reference

For flight item, this needs to be repeated for each flight segment for the passenger.

M

ServiceID (attribute)

A unique ID for the service
Example: Svc001

M

<PassengerRef>

Passenger reference associated with the order item
Example: T2

M

<SegmentRef>

Flight segment reference associated with the order item

Example: FS1.


This will be returned only for Flight and Seat items.

O

<SelectedSeat>

This is returned only for seat order items

O

<Seat>

Seat row and column details

M

<Row>

Seat row number

Example:31

M

<Column>

Seat column number

Example: B

M

<ServiceDefinitionRef>

This should be returned only for non-flight order items.

A unique reference for the service

Example: SEAT-T2-FS1

O

SegmentRef (attribute)

Flight segment reference associated with the order item

Example: FS1

This will be returned only for Meal and Disability order items

O

<Penalty>

This section returns the rule references for fare rules for flight items

M

refs (attribute)

Reference for each fare rule which will be defined in the Penaltylist.
Example: Rule 1 Rule 2 Rule3

M

<TicketDocInfos>

ElementsDetails

Mandatory/Optional

<TicketDocInfos>

M

<TicketDocInfo>

Ticket document information. This is a list and will be repeated for each eTicket/EMD number

M

<TicketDocument>

Ticket document details

M

<TicketDocNbr>

Ticket/EMD number.
This number is comprised of airline code and serial number
Example: 125-8512563144

Where 125 = Airline code and 8512563144 = Serial number

M

<Type>

Document type.

IATA PADIS Code from codeset 1001

Possible values are T, J and Y

Where T = Ticket, J =  EMD-A (Associated) and Y = EMD-S (Standalone)

M

<NumberofBooklets>

Will always be returned as “1”

M

<DateOfIssue>

Example: 2015-09-21

M

<CouponInfo>

For etickets, for each flight segment, CouponInfo will be returned.

For EMDs, CouponInfo will be returned per ancillary per passenger

O

<CouponNumber>

ETicket or EMD coupon number

Example: 1

M

<FareBasisCode>

O

<Code>

FareBasisCode will be returned only for etickets
Example: MLXNCGB

M

<Status>

ETicket or EMD coupon status
The status will be returned as defined in IATA Codeset 4405

Code       

Description

AL          

Airport control

B            

Flown/used

BD          

Boarded

CK          

Checked in

E

Exchanged/reissued

OPE       

Open

RF          

Refunded

V

Void

M

<SoldAirlineInfo>

This section will be returned only for etickets

O

<DepartureDateTime>

O

DateTime (Attribute)

Example:

2016-09-08T13:10:00.000Z

O

<Departure>

Departure information

O

<AirportCode>

Departure airport IATA code

Example: LHR

M

<Date>

Local Departure date i.e. local to the departure location

Example: 2015-08-13

M

<Time>

Local Departure time i.e. local to the departure location

O

<AirportName>

Example: Heathrow (London)

O

<Arrival>

Arrival information

O

<AirportCode>

Arrival airport IATA code

Example: AMS

M

<MarketingCarrier>

Marketing carrier information

O

<AirlineID>

Marketing carrier code

Example: BA

M

<FlightNumber>

Marketing flight number

Example: 1403

M

<AddlBaggageInfo>

O

<AllowableBag>

O

Number (Attribute)

Ticketed and Additional Baggage allowance (except prepaid additional bags)

Example: 4

O

<Price>

Total price paid for this ancillary

O

<Total>

EMD Price

Example: 15.00

O

<Code>

Currency Code

Example: GBP

O

<InConnectionWithInfo>

This section will be returned only for EMDs

O

<InConnectionDocNbr>

The ETicket number to which this EMD is associated

Example: 1258540669475

O

<InConnectonCpnNbr>

The ETicket coupon number to which this EMD is associated

Example: 1

O

<ReasonForIssuance>

Reason for Issuance Information
This section will be returned only for EMDs

O

<RFIC>

The RFIC will be returned as defined in IATA Codeset 4183

O

<Code>

EMD code returned by BA
Example: 0B5 for seats

O

<Description>

Free format text associated with the EMD
Example:
PREPAID SEAT CHARGE NON-INTERLINEABLE

O

<ReportingType>

For billing and settlement purposes, each time a travel agent requests an airline to perform an action on a document (Issuance, Refund, Exchange), he needs to know how to reconcile this action: via BSP, via ARC, directly done by the ORA, etc.
Example: Airline

M

<PassengerReference>

Reference to a passenger for whom the ETicket/EMD is associated

Example: T1

M

<DataLists>

ElementsDetails

Mandatory/Optional

<PassengerList>
List of all passengers to whom the OrderView is returnedO
<ContactList>
List of contacts for passengersO
<BaggageAllowanceList>
Baggage Allowance ListO
<DisclosureList>
Seating policy link, Terms and conditions link and general seating rules are returned hereO
<FlightSegmentList>
Flight segment details to whom the seat map is returnedO
<FlightList>
List of flights in the JourneyO
<OriginDestinationList>
List of O&D's in the journeyO
<MediaList>
List of URLs to manage the booking onlineO
<PenaltyList>
Fare rules listO
<ServiceDefinitionList>
Service definition list which has been offered.O