Attachments:
Introduction
This service is used to cancel PNR.
OrderCancel Webservice
Limitations:
- Ticket refund is not supported.
This web service is called with the following inputs:
- Party data;
- OrderID;
The output data this service returns include:
- Success or error reply
- OrderReference
Flow
- Order RetrieveRQ: Retrieve the PNR by record locator;
- OrderViewRS: Receive a reply with OrderId;
- OrderCancelRQ: Pass OrderID received in OrderViewRS;
- OrderCancelRS: OrderID and success status.
Access
In order to access API, you will need to pass the following two headers for each call.
Authentication and authorization stand on the protocol layer using basic HTTP authentication. Given username and password with separator “:” MUST be base64-encoded and passed as HTTP header “Authorization”. This header is mandatory for all requests. For example, if "TestLogin" set as the username and "TestPass" set as the password, then the field's value is base64-encoding of TestLogin: TestPass, or QWxhZGRpbjpPcGVuU2VzYW1l. Then the Authorization header will appear as Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l
OrderCancelRQ structure
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/EDIST/2017.1 OrderCancelRQ.xsd">
<Header/>
<Body>
<OrderCancelRQ xmlns="http://www.iata.org/IATA/EDIST/2017.1" Version="17.1">
<Document>
<Name>PS</Name>
</Document>
<Party>
<Sender>
<TravelAgencySender>
<Name>TravelAgent</Name>
<PseudoCity>IEVPS28ND</PseudoCity>
<AgencyID>TA123</AgencyID>
</TravelAgencySender>
</Sender>
</Party>
<Query>
<OrderID Owner="PS">9b772db4-5ade-4871-b837-92dca43bdc31</OrderID>
</Query>
</OrderCancelRQ>
</Body>
</Envelope>
OrderCancelRQ fields description
Click here to expand...
M = Mandatory; O = Optional; C = Conditional
OrderCancelRQ | Attributes: Version - Specify NDC schema message version. Always pass 17.1 PrimaryLangID - Specifies the agent’s preferred language. Service response will be returned in this language. IF not specified default language = EN | M | |
↳ Document | NDC Message Document information. | M |
|
↳ Name | Document name will be always "PS" | M | <Document>
<Name>PS</Name>
</Document>
|
↳ Party | NDC Message/ Transaction Party(s) information. Note that information about parties is intended for business use, it is not intended for transaction authentication and routing of the message. | M |
|
↳ Sender | Message Sender information. | M |
|
↳ TravelAgencySender | SELLER: Travel Agency | M |
|
↳ Name | Name of the travel agency | M | Smith Travel |
↳ PseudoCity | Pseudo City code./ Office ID | M | IEVPS00ZZ |
↳ AgencyID | Unique Agency Seller ID. | O | SASELLER1 |
↳ Query | Order Cancel Query. | M |
|
| ↳ OrderID | The airline-assigned unique Order ID Attributes: Owner - Airline Designator of the airline that owns/ assigned this ID. | M | <OrderID Owner="PS">9b772db4-5ade-4871-b837-92dca43bdc31</OrderID> |
<OrderCancelRS xmlns="http://www.iata.org/IATA/EDIST/2017.1" Version="17.1">
<Document>
<Name>PS</Name>
</Document>
<Success/>
<Response>
<OrderReference>9b772db4-5ade-4871-b837-92dca43bdc31</OrderReference>
</Response>
</OrderCancelRS>
OrderCancelRS fields description
Click here to expand...
M = Mandatory; O = Optional; C = Conditional
OrderCancel Error/Validation Checks
Click here to expand...
| PADIS Error Code | PADIS Error Text | Use Cases |
|---|
| System errors |
| 911 | Unable to process - system error / Invalid query | Invalid query |
| 486 | Unknown | The equivalent of -1 error |
| 304 | System Temporarily unavailable | The system is not available/HOST problem |
| 916 | EDIFACT version not supported | Not supported NDC service version. |
| Agent authorization errors |
| 368 | Not authorized | Wrong agent authentication key. Agent is inactive |
| 79A | Invalid office identification | OID is missing or incorrect |
| Query errors |
129 | No PNR Match Found | Invalid OrderID in the request |
| 912 | Incomplete message - data missing in query | Mandatory parameters are missing in the query |
| 486 | PNR cancelled | PNR is cancelled or does not have flight segments |