OrderChangeNotification 17.2
This page in divided in the following sections:
Introduction
Iberia is happy to be able to offer the OCN (OrderChangeNotification) functionality.
This allows users of Iberia’s NDC API to receive notifications when a Service in an Order undergoes an involuntary change.
The following are the disruptions we will be notifying:
Order cancellation due to PaymentTimeLimit expiry.
Flight Time Change
Change of Flight
Cancelation of Flight
Change of Seat Assignment
To learn more about which elements are sent to us in the OrderCreate, please visit the Involuntary Changes section in our Order Contacts & Communications page.
Registration
To receive the OCN messages you need to open a support ticket through our Support Portal providing us with certain information. To use this service you must also undergo a certification process with a series of tests, which will be advised when registering for the service.
For Iberia to send you the OCN messages, you must publish an endpoint, with the necessary security, to which we can send the messages. Presently Iberia has implemented the “Basic AUTH” and “OAUTH” security methods to connect to third parties.
In order to initiate the certification process a support ticket needs to be opened in our Support Portal, and the following information must be included in the request:
An HTTPS URL for a SOAP or REST endpoint, to which we can send the OCN messages.
Please ensure you tell us which protocol the endpoint uses.
For Basic authentication we need to be able to send the credentials in the “Authorization” header, with the values separated with “:” in Base64 format.
For OAUTH authentication we require the following:
The client_id, client_secret and grant_type. (Today we only use the OAUTH implementation where the parameters are sent in the body of the message.)
The HTTPS URL from where to obtain the token
Whether you require the “scope” in the call to this URL, and if so then the value you require in the “scope”
An example using CURL of your authentication service, and OCN reception service.
Example OAUTH request to send the OCN:
curl --location --request POST 'https://miurl.com/v1/booking/travel-orders/ib-order-change-events' \
--header 'Content-Type: application/xml' \
--header 'Authorization: Bearer xxxxxxxxxxxxxxxxxx' \Types of Change
The type of change impacting the Order is indicated in the ActionType Context and also reflected in the Remarks. The following are the values returned:
Remark | ActionType | ActionType Context* | Explanation |
|---|---|---|---|
PaymentTimeLimit Expired | Delete | 104 | The Order has been cancelled as the PaymentTimeLimit has expired and the Order has not been paid for. |
Flight number change | Update | 1 | The Flight Number has been changed. This means the passenger has been reallocated onto a different flight, and may also mean that the time of departure has changed. |
Flight retimed | Update | 2 | The departure and/or arrival time of the flight has changed. |
Flight cancelled | Cancel | 3 | The flight they had booked has been cancelled and an alternative could not been provided. |
Seat change | Update | 101 | The pre-assigned seat has been changed. This could be due to a change of flight, change of equipment or a change of cabin configuration. |
*The context code is as per the IATA Padis Code-set REA, except in the case of PaymentTimeLimit expiration.
Example
The following is an example of an OCN message* generated by Iberia:
<OrderChangeNotif Version="5.000" xmlns="http://www.iata.org/IATA/EDIST/2017.2">
<Document>
<ReferenceVersion>5.000</ReferenceVersion>
</Document>
<Party>
<Sender>
<!--Offer Responsible Airline-->
<ORA_Sender>
<AirlineID>IB</AirlineID>
<Name>Iberia</Name>
</ORA_Sender>
</Sender>
<Participants>
<Participant>
<AggregatorParticipant SequenceNumber="1">
<Name>AggregatorName</Name>
<AggregatorID>00000000</AggregatorID>
</AggregatorParticipant>
</Participant>
</Participants>
<Recipient>
<TravelAgencyRecipient>
<Name>TravelAgencyName</Name>
<IATA_Number>XXXXXXXX</IATA_Number>
<AgencyID>77777777</AgencyID>
</TravelAgencyRecipient>
</Recipient>
</Party>
<Query>
<Order OrderID="IB6dff0c0b748b48b29fe00d3d4711debdOP" Owner="IB">
<BookingReferences>
<BookingReference>
<ID>A1B2C</ID>
<AirlineID>IB</AirlineID>
</BookingReference>
</BookingReferences>
</Order>
<Amendments>
<Amendment>
<ActionType Context="1">Update</ActionType>
<Remarks>
<Remark>Flight Number Change</Remark>
</Remarks>
</Amendment>
</Amendments>
</Query>
</OrderChangeNotif>*The IATA 17.2 schema makes the OrderItems obligatory, however we do not include them.
Acknowledgement
The Seller or Aggregator receiving the OCN message responds with an Acknowledgment message.
<Acknowledgement xmlns="http://www.iata.org/IATA/EDIST/2017.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="5.000" xsi:schemaLocation="http://www.iata.org/IATA/EDIST/2017.2 Acknowledgement.xsd">
<Document/>
<StatusCode>OK</StatusCode>
</Acknowledgement>
