OrderCancel Request NDC 2017.2

OrderCancelRQ

XPath: /OrderCancelRQ

Data Type Value: OrderCancelRQ

Description: The OrderCancel transaction set requests the cancellation of a specified order and returns confirmation of cancellation.

EchoToken

XPath: /OrderCancelRQ/@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: /OrderCancelRQ/@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: /OrderCancelRQ/@Target

Data Type Value: Target

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

Version

XPath: /OrderCancelRQ/@Version

Data Type Value: string

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

TransactionIdentifier

XPath: /OrderCancelRQ/@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: /OrderCancelRQ/@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 if a system has been off-line and needs to retrieve messages that were missed.

TransactionStatusCode

XPath: /OrderCancelRQ/@TransactionStatusCode

Data Type Value: TransactionStatusCode

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

PrimaryLangID

XPath: /OrderCancelRQ/@PrimaryLangID

Data Type Value: language

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

AltLangID

XPath: /OrderCancelRQ/@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: /OrderCancelRQ/@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: /OrderCancelRQ/@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.

PointOfSale

CountryCode

XPath: /OrderCancelRQ/PointOfSale/Location/CountryCode

Data Type Value: CountryCode

Description: Country Code. Examples: US, FR. Encoding Scheme: ISO 3166-1 (two character) Country Code.

Code

XPath: /OrderCancelRQ/PointOfSale/TouchPoint/Device/Code

Data Type Value: CodesetValueSimpleType

Description: Code value. Example: 003.

Definition

XPath: /OrderCancelRQ/PointOfSale/TouchPoint/Device/Definition

Data Type Value: ProperNameSimpleType

Description: Code Definition. Example: Travel Agency.

TableName

XPath: /OrderCancelRQ/PointOfSale/TouchPoint/Device/TableName

Data Type Value: ProperNameSimpleType

Description: Code set table name.

Document

Name

XPath: /OrderCancelRQ/Document/Name

Data Type Value: ProperNameSimpleType

Description: NDC Implementation Name. Example: ThisAirline Gateway.

ReferenceVersion

XPath: /OrderCancelRQ/Document/ReferenceVersion

Data Type Value: ContextSimpleType

Description: NDC Framework Version. Example: SOAP 2015.1.

Party

Address

XPath: /OrderCancelRQ/Party/Sender/TravelAgencySender/Contacts/Contact/EmailContact/Address

Data Type Value: Address

Description: The traveler email address for contact.

Type

XPath: /OrderCancelRQ/Party/Sender/TravelAgencySender/Type

Data Type Value: AgencyCategorySimpleType

Description: Agency Seller Type. Examples: TravelAgency, OnlineTravelAgency, TravelManagementCompany.

IATA_Number

XPath: /OrderCancelRQ/Party/Sender/TravelAgencySender/IATA_Number

Data Type Value: IATA_NbrSimpleType

Description: Agency Seller IATA number. Example: 98417900.

PseudoCity

XPath: /OrderCancelRQ/Party/Sender/TravelAgencySender/AgentUser/PseudoCity

Data Type Value: PseudoCity

Description: Pseudo City code. Example: AAA2.

Surname

XPath: /OrderCancelRQ/Party/Sender/TravelAgencySender/AgentUser/Contacts/Contact/Name/Surname

Data Type Value: Surname

Description: Family name, last name. Example: SMITH.

Given

XPath: /OrderCancelRQ/Party/Sender/TravelAgencySender/AgentUser/Contacts/Contact/Name/Given

Data Type Value: Given[]

Description: Given name, first name or names.

AgencyID

XPath: /OrderCancelRQ/Party/Sender/TravelAgencySender/AgencyID

Data Type Value: AgencyID_Type

Description: A data type for Agency (Seller) ID.

AgentUserID

XPath: /OrderCancelRQ/Party/Sender/TravelAgencySender/AgentUser/AgentUserID

Data Type Value: AgentUserID

Description: Agent User ID. Example: ksmith212.

UserRole

XPath: /OrderCancelRQ/Party/Sender/TravelAgencySender/AgentUser/UserRole

Data Type Value: ProperNameSimpleType

Description: Agent role. Example: Authorized User.

Name

XPath: /OrderCancelRQ/Party/Participants/Participant/EnabledSystemParticipant/Name

Data Type Value: ProperNameSimpleType

Description: Intermediary Name. Example: Farelogix.

SystemID

XPath: /OrderCancelRQ/Party/Participants/Participant/EnabledSystemParticipant/SystemID

Data Type Value: SystemID_Type

Description: A data type for Unique NDC-Enabled System ID.

Owner

XPath: /OrderCancelRQ/Party/Participants/Participant/EnabledSystemParticipant/SystemID/@Owner

Data Type Value: ContextSimpleType

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.

ExpectedRefundAmount

RefundAllInd

XPath: /OrderCancelRQ/ExpectedRefundAmount/@RefundAllInd

Data Type Value: boolean

Description: When true, all price amounts are refundable.

Query

OrderID

XPath: /OrderCancelRQ/Query/Order/@OrderID

Data Type Value: UniqueID_SimpleType

Description: The airline-assigned unique Order ID. Example: ORDER-c98c-4759-a20b.

Owner

XPath: /OrderCancelRQ/Query/Order/@Owner

Data Type Value: AirlineDesigSimpleType

Description: Airline Designator of airline that owns/assigned this ID. Example: BA. Encoding Scheme: IATA/A4A (two or three character) Airline Designator Codes.

Reason

XPath: /OrderCancelRQ/OrderCancelParameters/Reason

Data Type Value: IATA_CodeType

Description: Reason for cancellation. Encoding Scheme: IATA Padis Codeset REA.