OrderCancelRS
OrderCancelRS
XPath: /OrderCancelRS
Data Type Value: OrderCancelRS
Description: The OrderCancel transaction set requests the cancellation of a specified order and returns confirmation of cancellation.
EchoToken
XPath: /OrderCancelRS/@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: /OrderCancelRS/@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: /OrderCancelRS/@Target
Data Type Value: Target
Description: Used to indicate whether the request is for the Test or Production system.
Version
XPath: /OrderCancelRS/@Version
Data Type Value: string
Description: For all IATA versioned messages, the version of the message is indicated by a decimal value.
TransactionIdentifier
XPath: /OrderCancelRS/@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: /OrderCancelRS/@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: /OrderCancelRS/@TransactionStatusCode
Data Type Value: TransactionStatusCode
Description: This indicates where this message falls within a sequence of messages.
PrimaryLangID
XPath: /OrderCancelRS/@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: /OrderCancelRS/@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: /OrderCancelRS/@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: /OrderCancelRS/@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
Document
XPath: /OrderCancelRS/Document
Data Type Value: MsgDocumentType
Description: A data type for Common NDC Message Document Structures.
Name
XPath: /OrderCancelRS/Document/Name
Data Type Value: ProperNameSimpleType
Description: NDC Implementation Name. Example: ThisAirline Gateway.
ReferenceVersion
XPath: /OrderCancelRS/Document/ReferenceVersion
Data Type Value: ContextSimpleType
Description: NDC Framework Version. Example: SOAP 2015.1.
Success
Success
XPath: /OrderCancelRS/Success
Data Type Value: SuccessType
Description: The presence of the empty Success element explicitly indicates that the message succeeded.
Warnings
Warnings
XPath: /OrderCancelRS/Warnings
Data Type Value: WarningsType
Description: Used in conjunction with the Success element to define one or more business errors.
Warning
XPath: /OrderCancelRS/Warnings/Warning
Data Type Value: WarningType []
Description: Used in conjunction with the Success element to define a business error.
Language
XPath: /OrderCancelRS/Warnings/Warning/@Language
Data Type Value:
Description:
Type
XPath: /OrderCancelRS/Warnings/Warning/@Type
Data Type Value:
Description:
ShortText
XPath: /OrderCancelRS/Warnings/Warning/@ShortText
Data Type Value:
Description:
Code
XPath: /OrderCancelRS/Warnings/Warning/@Code
Data Type Value:
Description:
DocURL
XPath: /OrderCancelRS/Warnings/Warning/@DocURL
Data Type Value:
Description:
Status
XPath: /OrderCancelRS/Warnings/Warning/@Status
Data Type Value:
Description:
Tag
XPath: /OrderCancelRS/Warnings/Warning/@Tag
Data Type Value:
Description:
RecordID
XPath: /OrderCancelRS/Warnings/Warning/@RecordID
Data Type Value:
Description:
Response
Remark
XPath: /OrderCancelRS/Response/OrderCancelProcessing/Remarks/Remark
Data Type Value: Remark[]
Description: Remark Text.
OrderReference
XPath: /OrderCancelRS/Response/OrderReference
Data Type Value: UniqueStringID_SimpleType
Description: Cancelled order reference. Example: REF12345.
Remark
XPath: /OrderCancelRS/Response/ChangeFees/ApplicableFeeRemarks/Remark
Data Type Value: Remark[]
Description: Remark Text.
Type
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Type
Data Type Value: PenaltySimpleType
Description: Penalty Type. Examples: Cancellation, Change, NoShow, Upgrade, Other.
CurrencyAmountValue
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/CurrencyAmountValue
Data Type Value: CurrencyAmountOptType
Description: Penalty monetary value amount and currency code.
Code
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/CurrencyAmountValue/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
AmountApplication
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/AmountApplication
Data Type Value: PenaltyAppSimpleType
Description: Penalty Amount Application. Examples: MinimumPenaltyAmount, MaximumPenaltyAmount, Other.
Remark
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/ApplicableFeeRemarks/Remark
Data Type Value: Remark[]
Description: Remark Text.
TicketDocInfo
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo
Data Type Value: TicketDocInfo[]
Description: Ticket/document detail.
TicketDocNbr
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/TicketDocNbr
Data Type Value: TicketDocNbr
Description: Coupon Document Number.
📝 This is the document number comprised of the airline code, form code, and serial number.
Type
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/Type
Data Type Value: IATA_CodeType
Description: Coupon Type. Example: Y (EMD-S Standalone). Encoding Scheme: IATA Padis Codeset - List for data element 1001 (Document/ Message Name, coded).
NumberofBooklets
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/NumberofBooklets
Data Type Value: integer
Description: The number of booklets issued.
ReportingType
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/ReportingType
Data Type Value: ReportingType
Description: 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 reconciliate this action: via BSP, via ARC, directly done by the ORA, etc.
ObjectKey
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/@ObjectKey
Data Type Value: ID
Description: Object globally unique Instance ID. Example: obj1.
AirportCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/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.
Date
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/Departure/Date
Data Type Value: date
Description: Departure date. Example: 2017-01-13. Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD).
Time
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/Departure/Time
Data Type Value: TimeSimpleType
Description: Departure time. Example: 09:15. Encoding Scheme: ISO 8601 Military/24 Hour Format (HH:MM).
AirlineID
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/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.
FlightNumber
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/MarketingCarrier/FlightNumber
Data Type Value: FlightNumber
Description: Flight Number. Example: 1234, or OPEN, or ARNK.
Status
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/Status
Data Type Value: IATA_CodeType
Description: Reservation Status Code. Encoding Scheme: IATA Padis Codeset - List for data element 4405 (Status, coded).
CouponNumber
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CouponNumber
Data Type Value: integer
Description: Applicable coupon number. Example: 1234.
Status
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/Status
Data Type Value: IATA_CodeType
Description: Current status of the flight/value coupon. Example: E (Exchanged/reissued). Encoding Scheme: IATA Padis Codeset - List for data element 4405 (Status, coded).
Amount
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Total/Amount
Data Type Value: Amount
Description: Used to specify the total or total net amount. Example 160 USD.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Total/Amount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Amount
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/BaseFare/Amount
Data Type Value: Amount
Description: Base Fare Amount. Example 160 USD.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/BaseFare/Amount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Total
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Total
Data Type Value: Total
Description: Sub-total of all applicable taxes. Monetary value and currency code.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Total/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Amount
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Breakdown/Tax/Amount
Data Type Value: CurrencyAmountOptType
Description: Amount. Example: 15000 USD.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Breakdown/Tax/Amount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
TaxCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Breakdown/Tax/TaxCode
Data Type Value: string
Description: Tax Code. Example: AY, GB.
Description
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Breakdown/Tax/Description
Data Type Value: ShortDescSimpleType
Description: Tax short description. Example: $4 per flight segment, per passenger (U.S. domestic segment tax).
Method
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method
Data Type Value: Method[]
Description: Payment Method detail.
VoucherMethod
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod
Data Type Value: VoucherMethodType
Description: VOUCHER Payment Form definition.
Number
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/Number
Data Type Value: ShortDescSimpleType
Description: Voucher ID or Number. Example: XX12345.
Expiration
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/EffectiveExpireDate/Expiration
Data Type Value: date
Description: Voucher Expiration date. Example: 2017-06-13.
RemainingValue
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/RemainingValue
Data Type Value: CurrencyAmountOptType
Description: Remaining Amount on Voucher.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/RemainingValue/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
PaymentCardMethod
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod
Data Type Value: PaymentCardMethodType
Description: PAYMENT CARD Payment Method definition.
CardType
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardType
Data Type Value: PayCardTypeSimpleType
Description: Magnetic striped card type.
CardCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardCode
Data Type Value: PayCardCodeSimpleType
Description: Credit card issuer code. Example: MC.
OrderCancelRS NDC 2017.2
OrderCancelRS
OrderCancelRS
XPath: /OrderCancelRS
Data Type Value: OrderCancelRS
Description: The OrderCancel transaction set requests the cancellation of a specified order and returns confirmation of cancellation.
EchoToken
XPath: /OrderCancelRS/@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: /OrderCancelRS/@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: /OrderCancelRS/@Target
Data Type Value: Target
Description: Used to indicate whether the request is for the Test or Production system.
Version
XPath: /OrderCancelRS/@Version
Data Type Value: string
Description: For all IATA versioned messages, the version of the message is indicated by a decimal value.
TransactionIdentifier
XPath: /OrderCancelRS/@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: /OrderCancelRS/@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: /OrderCancelRS/@TransactionStatusCode
Data Type Value: TransactionStatusCode
Description: This indicates where this message falls within a sequence of messages.
PrimaryLangID
XPath: /OrderCancelRS/@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: /OrderCancelRS/@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: /OrderCancelRS/@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: /OrderCancelRS/@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
Document
XPath: /OrderCancelRS/Document
Data Type Value: MsgDocumentType
Description: A data type for Common NDC Message Document Structures.
Name
XPath: /OrderCancelRS/Document/Name
Data Type Value: ProperNameSimpleType
Description: NDC Implementation Name. Example: ThisAirline Gateway.
ReferenceVersion
XPath: /OrderCancelRS/Document/ReferenceVersion
Data Type Value: ContextSimpleType
Description: NDC Framework Version. Example: SOAP 2015.1.
Success
Success
XPath: /OrderCancelRS/Success
Data Type Value: SuccessType
Description: The presence of the empty Success element explicitly indicates that the message succeeded.
Warnings
Warnings
XPath: /OrderCancelRS/Warnings
Data Type Value: WarningsType
Description: Used in conjunction with the Success element to define one or more business errors.
Warning
XPath: /OrderCancelRS/Warnings/Warning
Data Type Value: WarningType []
Description: Used in conjunction with the Success element to define a business error.
Language
XPath: /OrderCancelRS/Warnings/Warning/@Language
Data Type Value:
Description:
Type
XPath: /OrderCancelRS/Warnings/Warning/@Type
Data Type Value:
Description:
ShortText
XPath: /OrderCancelRS/Warnings/Warning/@ShortText
Data Type Value:
Description:
Code
XPath: /OrderCancelRS/Warnings/Warning/@Code
Data Type Value:
Description:
DocURL
XPath: /OrderCancelRS/Warnings/Warning/@DocURL
Data Type Value:
Description:
Status
XPath: /OrderCancelRS/Warnings/Warning/@Status
Data Type Value:
Description:
Tag
XPath: /OrderCancelRS/Warnings/Warning/@Tag
Data Type Value:
Description:
RecordID
XPath: /OrderCancelRS/Warnings/Warning/@RecordID
Data Type Value:
Description:
Response
Remark
XPath: /OrderCancelRS/Response/OrderCancelProcessing/Remarks/Remark
Data Type Value: Remark[]
Description: Remark Text.
OrderReference
XPath: /OrderCancelRS/Response/OrderReference
Data Type Value: UniqueStringID_SimpleType
Description: Cancelled order reference. Example: REF12345.
Remark
XPath: /OrderCancelRS/Response/ChangeFees/ApplicableFeeRemarks/Remark
Data Type Value: Remark[]
Description: Remark Text.
Type
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Type
Data Type Value: PenaltySimpleType
Description: Penalty Type. Examples: Cancellation, Change, NoShow, Upgrade, Other.
CurrencyAmountValue
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/CurrencyAmountValue
Data Type Value: CurrencyAmountOptType
Description: Penalty monetary value amount and currency code.
Code
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/CurrencyAmountValue/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
AmountApplication
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/AmountApplication
Data Type Value: PenaltyAppSimpleType
Description: Penalty Amount Application. Examples: MinimumPenaltyAmount, MaximumPenaltyAmount, Other.
Remark
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/ApplicableFeeRemarks/Remark
Data Type Value: Remark[]
Description: Remark Text.
TicketDocInfo
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo
Data Type Value: TicketDocInfo[]
Description: Ticket/document detail.
TicketDocNbr
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/TicketDocNbr
Data Type Value: TicketDocNbr
Description: Coupon Document Number.
Note: This is the document number comprised of the airline code, form code, and serial number.
Type
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/Type
Data Type Value: IATA_CodeType
Description: Coupon Type. Example: Y (EMD-S Standalone). Encoding Scheme: IATA Padis Codeset - List for data element 1001 (Document/ Message Name, coded).
NumberofBooklets
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/NumberofBooklets
Data Type Value: integer
Description: The number of booklets issued.
ReportingType
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/ReportingType
Data Type Value: ReportingType
Description: 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 reconciliate this action: via BSP, via ARC, directly done by the ORA, etc.
ObjectKey
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/@ObjectKey
Data Type Value: ID
Description: Object globally unique Instance ID. Example: obj1.
AirportCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/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.
Date
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/Departure/Date
Data Type Value: date
Description: Departure date. Example: 2017-01-13. Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD).
Time
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/Departure/Time
Data Type Value: TimeSimpleType
Description: Departure time. Example: 09:15. Encoding Scheme: ISO 8601 Military/24 Hour Format (HH:MM).
AirlineID
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/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.
FlightNumber
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/MarketingCarrier/FlightNumber
Data Type Value: FlightNumber
Description: Flight Number. Example: 1234, or OPEN, or ARNK.
Status
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/Status
Data Type Value: IATA_CodeType
Description: Reservation Status Code. Encoding Scheme: IATA Padis Codeset - List for data element 4405 (Status, coded).
CouponNumber
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CouponNumber
Data Type Value: integer
Description: Applicable coupon number. Example: 1234.
Status
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/Status
Data Type Value: IATA_CodeType
Description: Current status of the flight/value coupon. Example: E (Exchanged/reissued). Encoding Scheme: IATA Padis Codeset - List for data element 4405 (Status, coded).
Amount
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Total/Amount
Data Type Value: Amount
Description: Used to specify the total or total net amount. Example 160 USD.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Total/Amount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Amount
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/BaseFare/Amount
Data Type Value: Amount
Description: Base Fare Amount. Example 160 USD.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/BaseFare/Amount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Total
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Total
Data Type Value: Total
Description: Sub-total of all applicable taxes. Monetary value and currency code.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Total/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Amount
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Breakdown/Tax/Amount
Data Type Value: CurrencyAmountOptType
Description: Amount. Example: 15000 USD.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Breakdown/Tax/Amount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
TaxCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Breakdown/Tax/TaxCode
Data Type Value: string
Description: Tax Code. Example: AY, GB.
Description
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Breakdown/Tax/Description
Data Type Value: ShortDescSimpleType
Description: Tax short description. Example: $4 per flight segment, per passenger (U.S. domestic segment tax).
Method
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method
Data Type Value: Method[]
Description: Payment Method detail.
VoucherMethod
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod
Data Type Value: VoucherMethodType
Description: VOUCHER Payment Form definition.
Number
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/Number
Data Type Value: ShortDescSimpleType
Description: Voucher ID or Number. Example: XX12345.
Expiration
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/EffectiveExpireDate/Expiration
Data Type Value: date
Description: Voucher Expiration date. Example: 2017-06-13.
RemainingValue
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/RemainingValue
Data Type Value: CurrencyAmountOptType
Description: Remaining Amount on Voucher.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/RemainingValue/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
PaymentCardMethod
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod
Data Type Value: PaymentCardMethodType
Description: PAYMENT CARD Payment Method definition.
CardType
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardType
Data Type Value: PayCardTypeSimpleType
Description: Magnetic striped card type.
CardCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardCode
Data Type Value: PayCardCodeSimpleType
Description: Credit card issuer code. Example: MC.
Note: This is the 2-character code of the credit card issuer.
MaskedCardNumber
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/MaskedCardNumber
Data Type Value: MaskedCardNumber
Description: Concealed credit card number, Example: xxxxxxxxxxxx9922.
Street
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/Street
Data Type Value:
Description:
CityName
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/CityName
Data Type Value: string
Description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
StateProv
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/StateProv
Data Type Value: string
Description: State or province code. Examples: NY, QUE.
PostalCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/PostalCode
Data Type Value: PostalCode
Description: Postal code. Examples: 11001, 11001-2345.
CountryCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/CountryCode
Data Type Value: CountryCode
Description: Country Code. Examples: US, FR. Encoding Scheme: ISO 3166-1 (two character) Country Code.
Errors
Errors
XPath: /OrderCancelRS/Errors
Data Type Value: ErrorsType
Description: A collection of errors that occurred during the processing of a message.
Error
XPath: /OrderCancelRS/Errors/Error
Data Type Value: ErrorType[]
Description: Standard way to indicate that an error occurred during the processing of an IATA message.
Language
XPath: /OrderCancelRS/Errors/Error/@Language
Data Type Value:
Description:
Type
XPath: /OrderCancelRS/Errors/Error/@Type
Data Type Value:
Description:
ShortText
XPath: /OrderCancelRS/Errors/Error/@ShortText
Data Type Value:
Description:
Code
XPath: /OrderCancelRS/Errors/Error/@Code
Data Type Value:
Description:
DocURL
XPath: /OrderCancelRS/Errors/Error/@DocURL
Data Type Value:
Description:
Status
XPath: /OrderCancelRS/Errors/Error/@Status
Data Type Value:
Description:
Tag
XPath: /OrderCancelRS/Errors/Error/@Tag
Data Type Value:
Description:
RecordID
XPath: /OrderCancelRS/Errors/Error/@RecordID
Data Type Value:
Description:
NodeList
XPath: /OrderCancelRS/Errors/Error/@NodeList
Data Type Value:
Description:
DataLists
GivenName
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/Individual/GivenName
Data Type Value: ProperNameType[]
Description: Individual's first or given name. Example: JOHN.
Surname
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/Individual/Surname
Data Type Value: ProperNameType
Description: Individual's family name, last name. Example: SMITH.
ContactID
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/@ContactID
Data Type Value: ID
Description: Uniquely Identifies a set of Contact Information, within the context of one message.
ContactInfoRef
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/ContactInfoRef
Data Type Value: IDREF
Description: Reference to Contact Information, within the context of one message.
EmailAddressValue
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/ContactProvided/EmailAddress/EmailAddressValue
Data Type Value: SimpleTextType
Description: The email address which should be used for contact purposes.
PhoneNumber
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/ContactProvided/Phone/PhoneNumber
Data Type Value: NumberType
Description: Phone number text. Example: +1 999-999-9999 ext. 1234, 617-9976.
Note: This may be a simple, un-structured phone number, such as +01 999-999-9999 ext. 1234 or combined with the additional attributes to create a structured phone number.
Label
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/ContactProvided/Phone/Label
Data Type Value: SimpleTextType
Description: Used to differentiate multiple Phone numbers of one contact. Examples: Work, Home, Mobile.
Street
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/Street
Data Type Value: SimpleTextType[]
Description: Street name and number corresponding to the postal address. Examples: Main Street, 100 Main Street.
CityName
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/CityName
Data Type Value: SimpleNameType
Description: The name, expressed as text, of the city, town, or village.
PostalCode
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/PostalCode
Data Type Value: SimpleCodeType
Description: Postal code. Examples: 11001, 11001-2345.
CountrySubdivisionName
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/CountrySubdivisionName
Data Type Value: ProperNameType
Description: The name, expressed as text, of the subdivision of a country.
CountryCode
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/CountryCode
Data Type Value: ISO_3166CountryCodeContentType
Description: ISO Country Code. Examples: US, FR.
Label
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/Label
Data Type Value: SimpleTextType
Description: Used to differentiate multiple Postal Addresses of one contact. Examples: AddressAtOrigin or AddressAtDestination.
PassengerID
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/@PassengerID
Data Type Value: ID
Description: Uniquely identifies a Passenger within the context of one message.
PassengerTypeCodeType
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/PTC
Data Type Value: PassengerTypeCodeType
Description: Type code applying to the Passenger which typically drives pricing (e.g., ADT, CHD, etc.).
Birthdate
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/Individual/Birthdate
Data Type Value: DateType
Description: Individual's birth location (e.g., city and/or country).
InfantRef
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/InfantRef
Data Type Value: IDREF
Description: Reference to Passenger instance within the context of one message, associating an infant on lap to this adult passenger.
IdentityDocumentNumber
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/IdentityDocumentNumber
Data Type Value: SimpleCodeType
Description: Uniquely identifies the document from all other identity documents issued by the state or organization. Example: passport number, drive license number.
IdentityDocumentType
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/IdentityDocumentType
Data Type Value: IdentityDocumentTypeCodeType
Description: The type of passenger document. Examples: PT (Passport).
Birthdate
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/Birthdate
Data Type Value: DateType
Description: Holder’s date of birth as written on the document.
Gender
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/Gender
Data Type Value: GenderCodeContentType
Description: Holder’s gender as specified on the document (M, F, or X for unspecified).
Surname
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/Surname
Data Type Value: ProperNameType
Description: Holder's family name, last name as written on the document. Example: SMITH.
GivenName
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/GivenName
Data Type Value: ProperNameType[]
Description: Holder's first or given name, as written on the document. Example: JOHN. This is the 2-character code of the credit card issuer.
MaskedCardNumber
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/MaskedCardNumber
Data Type Value: MaskedCardNumber
Description: Concealed credit card number, Example: xxxxxxxxxxxx9922.
Street
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/Street
Data Type Value:
Description:
CityName
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/CityName
Data Type Value: string
Description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
StateProv
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/StateProv
Data Type Value: string
Description: State or province code. Examples: NY, QUE.
PostalCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/PostalCode
Data Type Value: PostalCode
Description: Postal code. Examples: 11001, 11001-2345.
CountryCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/CountryCode
Data Type Value: CountryCode
Description: Country Code. Examples: US, FR. Encoding Scheme: ISO 3166-1 (two character) Country Code.
Errors
Errors
XPath: /OrderCancelRS/Errors
Data Type Value: ErrorsType
Description: A collection of errors that occurred during the processing of a message.
Error
XPath: /OrderCancelRS/Errors/Error
Data Type Value: ErrorType[]
Description: Standard way to indicate that an error occurred during the processing of an IATA message.
Language
XPath: /OrderCancelRS/Errors/Error/@Language
Data Type Value:
Description:
Type
XPath: /OrderCancelRS/Errors/Error/@Type
Data Type Value:
Description:
ShortText
XPath: /OrderCancelRS/Errors/Error/@ShortText
Data Type Value:
Description:
Code
XPath: /OrderCancelRS/Errors/Error/@Code
Data Type Value:
Description:
DocURL
XPath: /OrderCancelRS/Errors/Error/@DocURL
Data Type Value:
Description:
Status
XPath: /OrderCancelRS/Errors/Error/@Status
Data Type Value:
Description:
Tag
XPath: /OrderCancelRS/Errors/Error/@Tag
Data Type Value:
Description:
RecordID
XPath: /OrderCancelRS/Errors/Error/@RecordID
Data Type Value:
Description:
NodeList
XPath: /OrderCancelRS/Errors/Error/@NodeList
Data Type Value:
Description:
DataLists
GivenName
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/Individual/GivenName
Data Type Value: ProperNameType[]
Description: Individual's first or given name. Example: JOHN.
Surname
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/Individual/Surname
Data Type Value: ProperNameType
Description: Individual's family name, last name. Example: SMITH.
ContactID
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/@ContactID
Data Type Value: ID
Description: Uniquely Identifies a set of Contact Information, within the context of one message.
ContactInfoRef
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/ContactInfoRef
Data Type Value: IDREF
Description: Reference to Contact Information, within the context of one message.
EmailAddressValue
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/ContactProvided/EmailAddress/EmailAddressValue
Data Type Value: SimpleTextType
Description: The email address which should be used for contact purposes.
PhoneNumber
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/ContactProvided/Phone/PhoneNumber
Data Type Value: NumberType
Description: Phone number text. Example: +1 999-999-9999 ext. 1234, 617-9976.
OrderCancelRS NDC 2017.2
OrderCancelRS
OrderCancelRS
XPath: /OrderCancelRS
Data Type Value: OrderCancelRS
Description: The OrderCancel transaction set requests the cancellation of a specified order and returns confirmation of cancellation.
EchoToken
XPath: /OrderCancelRS/@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: /OrderCancelRS/@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: /OrderCancelRS/@Target
Data Type Value: Target
Description: Used to indicate whether the request is for the Test or Production system.
Version
XPath: /OrderCancelRS/@Version
Data Type Value: string
Description: For all IATA versioned messages, the version of the message is indicated by a decimal value.
TransactionIdentifier
XPath: /OrderCancelRS/@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: /OrderCancelRS/@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: /OrderCancelRS/@TransactionStatusCode
Data Type Value: TransactionStatusCode
Description: This indicates where this message falls within a sequence of messages.
PrimaryLangID
XPath: /OrderCancelRS/@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: /OrderCancelRS/@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: /OrderCancelRS/@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: /OrderCancelRS/@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
Document
XPath: /OrderCancelRS/Document
Data Type Value: MsgDocumentType
Description: A data type for Common NDC Message Document Structures.
Name
XPath: /OrderCancelRS/Document/Name
Data Type Value: ProperNameSimpleType
Description: NDC Implementation Name. Example: ThisAirline Gateway.
ReferenceVersion
XPath: /OrderCancelRS/Document/ReferenceVersion
Data Type Value: ContextSimpleType
Description: NDC Framework Version. Example: SOAP 2015.1.
Success
Success
XPath: /OrderCancelRS/Success
Data Type Value: SuccessType
Description: The presence of the empty Success element explicitly indicates that the message succeeded.
Warnings
Warnings
XPath: /OrderCancelRS/Warnings
Data Type Value: WarningsType
Description: Used in conjunction with the Success element to define one or more business errors.
Warning
XPath: /OrderCancelRS/Warnings/Warning
Data Type Value: WarningType []
Description: Used in conjunction with the Success element to define a business error.
Language
XPath: /OrderCancelRS/Warnings/Warning/@Language
Data Type Value:
Description:
Type
XPath: /OrderCancelRS/Warnings/Warning/@Type
Data Type Value:
Description:
ShortText
XPath: /OrderCancelRS/Warnings/Warning/@ShortText
Data Type Value:
Description:
Code
XPath: /OrderCancelRS/Warnings/Warning/@Code
Data Type Value:
Description:
DocURL
XPath: /OrderCancelRS/Warnings/Warning/@DocURL
Data Type Value:
Description:
Status
XPath: /OrderCancelRS/Warnings/Warning/@Status
Data Type Value:
Description:
Tag
XPath: /OrderCancelRS/Warnings/Warning/@Tag
Data Type Value:
Description:
RecordID
XPath: /OrderCancelRS/Warnings/Warning/@RecordID
Data Type Value:
Description:
Response
Remark
XPath: /OrderCancelRS/Response/OrderCancelProcessing/Remarks/Remark
Data Type Value: Remark[]
Description: Remark Text.
OrderReference
XPath: /OrderCancelRS/Response/OrderReference
Data Type Value: UniqueStringID_SimpleType
Description: Cancelled order reference. Example: REF12345.
Remark
XPath: /OrderCancelRS/Response/ChangeFees/ApplicableFeeRemarks/Remark
Data Type Value: Remark[]
Description: Remark Text.
Type
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Type
Data Type Value: PenaltySimpleType
Description: Penalty Type. Examples: Cancellation, Change, NoShow, Upgrade, Other.
CurrencyAmountValue
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/CurrencyAmountValue
Data Type Value: CurrencyAmountOptType
Description: Penalty monetary value amount and currency code.
Code
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/CurrencyAmountValue/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
AmountApplication
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/AmountApplication
Data Type Value: PenaltyAppSimpleType
Description: Penalty Amount Application. Examples: MinimumPenaltyAmount, MaximumPenaltyAmount, Other.
Remark
XPath: /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/ApplicableFeeRemarks/Remark
Data Type Value: Remark[]
Description: Remark Text.
TicketDocInfo
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo
Data Type Value: TicketDocInfo[]
Description: Ticket/document detail.
TicketDocNbr
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/TicketDocNbr
Data Type Value: TicketDocNbr
Description: Coupon Document Number.
Note: This is the document number comprised of the airline code, form code, and serial number.
Type
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/Type
Data Type Value: IATA_CodeType
Description: Coupon Type. Example: Y (EMD-S Standalone). Encoding Scheme: IATA Padis Codeset - List for data element 1001 (Document/ Message Name, coded).
NumberofBooklets
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/NumberofBooklets
Data Type Value: integer
Description: The number of booklets issued.
ReportingType
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/ReportingType
Data Type Value: ReportingType
Description: 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 reconciliate this action: via BSP, via ARC, directly done by the ORA, etc.
ObjectKey
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/@ObjectKey
Data Type Value: ID
Description: Object globally unique Instance ID. Example: obj1.
AirportCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/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.
Date
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/Departure/Date
Data Type Value: date
Description: Departure date. Example: 2017-01-13. Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD).
Time
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/Departure/Time
Data Type Value: TimeSimpleType
Description: Departure time. Example: 09:15. Encoding Scheme: ISO 8601 Military/24 Hour Format (HH:MM).
AirlineID
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/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.
FlightNumber
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/MarketingCarrier/FlightNumber
Data Type Value: FlightNumber
Description: Flight Number. Example: 1234, or OPEN, or ARNK.
Status
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CurrentAirlineInfo/Status
Data Type Value: IATA_CodeType
Description: Reservation Status Code. Encoding Scheme: IATA Padis Codeset - List for data element 4405 (Status, coded).
CouponNumber
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/CouponNumber
Data Type Value: integer
Description: Applicable coupon number. Example: 1234.
Status
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/CouponInfo/Status
Data Type Value: IATA_CodeType
Description: Current status of the flight/value coupon. Example: E (Exchanged/reissued). Encoding Scheme: IATA Padis Codeset - List for data element 4405 (Status, coded).
Amount
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Total/Amount
Data Type Value: Amount
Description: Used to specify the total or total net amount. Example 160 USD.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Total/Amount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Amount
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/BaseFare/Amount
Data Type Value: Amount
Description: Base Fare Amount. Example 160 USD.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/BaseFare/Amount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Total
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Total
Data Type Value: Total
Description: Sub-total of all applicable taxes. Monetary value and currency code.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Total/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Amount
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Breakdown/Tax/Amount
Data Type Value: CurrencyAmountOptType
Description: Amount. Example: 15000 USD.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Breakdown/Tax/Amount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
TaxCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Breakdown/Tax/TaxCode
Data Type Value: string
Description: Tax Code. Example: AY, GB.
Description
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/FareInfo/Taxes/Breakdown/Tax/Description
Data Type Value: ShortDescSimpleType
Description: Tax short description. Example: $4 per flight segment, per passenger (U.S. domestic segment tax).
Method
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method
Data Type Value: Method[]
Description: Payment Method detail.
VoucherMethod
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod
Data Type Value: VoucherMethodType
Description: VOUCHER Payment Form definition.
Number
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/Number
Data Type Value: ShortDescSimpleType
Description: Voucher ID or Number. Example: XX12345.
Expiration
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/EffectiveExpireDate/Expiration
Data Type Value: date
Description: Voucher Expiration date. Example: 2017-06-13.
RemainingValue
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/RemainingValue
Data Type Value: CurrencyAmountOptType
Description: Remaining Amount on Voucher.
Code
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/RemainingValue/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
PaymentCardMethod
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod
Data Type Value: PaymentCardMethodType
Description: PAYMENT CARD Payment Method definition.
CardType
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardType
Data Type Value: PayCardTypeSimpleType
Description: Magnetic striped card type.
CardCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardCode
Data Type Value: PayCardCodeSimpleType
Description: Credit card issuer code. Example: MC.
Note: This is the 2-character code of the credit card issuer.
MaskedCardNumber
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/MaskedCardNumber
Data Type Value: MaskedCardNumber
Description: Concealed credit card number, Example: xxxxxxxxxxxx9922.
Street
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/Street
Data Type Value:
Description:
CityName
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/CityName
Data Type Value: string
Description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
StateProv
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/StateProv
Data Type Value: string
Description: State or province code. Examples: NY, QUE.
PostalCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/PostalCode
Data Type Value: PostalCode
Description: Postal code. Examples: 11001, 11001-2345.
CountryCode
XPath: /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod/CardholderAddress/StructuredAddress/CountryCode
Data Type Value: CountryCode
Description: Country Code. Examples: US, FR. Encoding Scheme: ISO 3166-1 (two character) Country Code.
Errors
Errors
XPath: /OrderCancelRS/Errors
Data Type Value: ErrorsType
Description: A collection of errors that occurred during the processing of a message.
Error
XPath: /OrderCancelRS/Errors/Error
Data Type Value: ErrorType[]
Description: Standard way to indicate that an error occurred during the processing of an IATA message.
Language
XPath: /OrderCancelRS/Errors/Error/@Language
Data Type Value:
Description:
Type
XPath: /OrderCancelRS/Errors/Error/@Type
Data Type Value:
Description:
ShortText
XPath: /OrderCancelRS/Errors/Error/@ShortText
Data Type Value:
Description:
Code
XPath: /OrderCancelRS/Errors/Error/@Code
Data Type Value:
Description:
DocURL
XPath: /OrderCancelRS/Errors/Error/@DocURL
Data Type Value:
Description:
Status
XPath: /OrderCancelRS/Errors/Error/@Status
Data Type Value:
Description:
Tag
XPath: /OrderCancelRS/Errors/Error/@Tag
Data Type Value:
Description:
RecordID
XPath: /OrderCancelRS/Errors/Error/@RecordID
Data Type Value:
Description:
NodeList
XPath: /OrderCancelRS/Errors/Error/@NodeList
Data Type Value:
Description:
DataLists
GivenName
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/Individual/GivenName
Data Type Value: ProperNameType[]
Description: Individual's first or given name. Example: JOHN.
Surname
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/Individual/Surname
Data Type Value: ProperNameType
Description: Individual's family name, last name. Example: SMITH.
ContactID
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/@ContactID
Data Type Value: ID
Description: Uniquely Identifies a set of Contact Information, within the context of one message.
ContactInfoRef
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/ContactInfoRef
Data Type Value: IDREF
Description: Reference to Contact Information, within the context of one message.
EmailAddressValue
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/ContactProvided/EmailAddress/EmailAddressValue
Data Type Value: SimpleTextType
Description: The email address which should be used for contact purposes.
PhoneNumber
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/ContactProvided/Phone/PhoneNumber
Data Type Value: NumberType
Description: Phone number text. Example: +1 999-999-9999 ext. 1234, 617-9976.
Note: This may be a simple, un-structured phone number, such as +01 999-999-9999 ext. 1234 or combined with the additional attributes to create a structured phone number.
Label
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/ContactProvided/Phone/Label
Data Type Value: SimpleTextType
Description: Used to differentiate multiple Phone numbers of one contact. Examples: Work, Home, Mobile.
Street
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/Street
Data Type Value: SimpleTextType[]
Description: Street name and number corresponding to the postal address. Examples: Main Street, 100 Main Street.
CityName
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/CityName
Data Type Value: SimpleNameType
Description: The name, expressed as text, of the city, town, or village.
PostalCode
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/PostalCode
Data Type Value: SimpleCodeType
Description: Postal code. Examples: 11001, 11001-2345.
CountrySubdivisionName
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/CountrySubdivisionName
Data Type Value: ProperNameType
Description: The name, expressed as text, of the subdivision of a country.
CountryCode
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/CountryCode
Data Type Value: ISO_3166CountryCodeContentType
Description: ISO Country Code. Examples: US, FR.
Label
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/Label
Data Type Value: SimpleTextType
Description: Used to differentiate multiple Postal Addresses of one contact. Examples: AddressAtOrigin or AddressAtDestination.
PassengerID
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/@PassengerID
Data Type Value: ID
Description: Uniquely identifies a Passenger within the context of one message.
PassengerTypeCodeType
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/PTC
Data Type Value: PassengerTypeCodeType
Description: Type code applying to the Passenger which typically drives pricing (e.g., ADT, CHD, etc.).
Birthdate
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/Individual/Birthdate
Data Type Value: DateType
Description: Individual's birth location (e.g., city and/or country).
InfantRef
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/InfantRef
Data Type Value: IDREF
Description: Reference to Passenger instance within the context of one message, associating an infant on lap to this adult passenger.
IdentityDocumentNumber
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/IdentityDocumentNumber
Data Type Value: SimpleCodeType
Description: Uniquely identifies the document from all other identity documents issued by the state or organization. Example: passport number, drive license number.
IdentityDocumentType
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/IdentityDocumentType
Data Type Value: IdentityDocumentTypeCodeType
Description: The type of passenger document. Examples: PT (Passport).
Birthdate
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/Birthdate
Data Type Value: DateType
Description: Holder’s date of birth as written on the document.
Gender
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/Gender
Data Type Value: GenderCodeContentType
Description: Holder’s gender as specified on the document (M, F, or X for unspecified).
Surname
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/Surname
Data Type Value: ProperNameType
Description: Holder's family name, last name as written on the document. Example: SMITH.
GivenName
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/GivenName
Data Type Value: ProperNameType[]
Description: Holder's first or given name, as written on the document. Example: JOHN. This may be a simple, un-structured phone number, such as +01 999-999-9999 ext. 1234 or combined with the additional attributes to create a structured phone number.
Label
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/ContactProvided/Phone/Label
Data Type Value: SimpleTextType
Description: Used to differentiate multiple Phone numbers of one contact. Examples: Work, Home, Mobile.
Street
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/Street
Data Type Value: SimpleTextType[]
Description: Street name and number corresponding to the postal address. Examples: Main Street, 100 Main Street.
CityName
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/CityName
Data Type Value: SimpleNameType
Description: The name, expressed as text, of the city, town, or village.
PostalCode
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/PostalCode
Data Type Value: SimpleCodeType
Description: Postal code. Examples: 11001, 11001-2345.
CountrySubdivisionName
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/CountrySubdivisionName
Data Type Value: ProperNameType
Description: The name, expressed as text, of the subdivision of a country.
CountryCode
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/CountryCode
Data Type Value: ISO_3166CountryCodeContentType
Description: ISO Country Code. Examples: US, FR.
Label
XPath: /OrderCancelRS/DataLists/ContactList/ContactInformation/PostalAddress/Label
Data Type Value: SimpleTextType
Description: Used to differentiate multiple Postal Addresses of one contact. Examples: AddressAtOrigin or AddressAtDestination.
PassengerID
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/@PassengerID
Data Type Value: ID
Description: Uniquely identifies a Passenger within the context of one message.
PassengerTypeCodeType
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/PTC
Data Type Value: PassengerTypeCodeType
Description: Type code applying to the Passenger which typically drives pricing (e.g., ADT, CHD, etc.).
Birthdate
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/Individual/Birthdate
Data Type Value: DateType
Description: Individual's birth location (e.g., city and/or country).
InfantRef
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/InfantRef
Data Type Value: IDREF
Description: Reference to Passenger instance within the context of one message, associating an infant on lap to this adult passenger.
IdentityDocumentNumber
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/IdentityDocumentNumber
Data Type Value: SimpleCodeType
Description: Uniquely identifies the document from all other identity documents issued by the state or organization. Example: passport number, drive license number.
IdentityDocumentType
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/IdentityDocumentType
Data Type Value: IdentityDocumentTypeCodeType
Description: The type of passenger document. Examples: PT (Passport).
Birthdate
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/Birthdate
Data Type Value: DateType
Description: Holder’s date of birth as written on the document.
Gender
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/Gender
Data Type Value: GenderCodeContentType
Description: Holder’s gender as specified on the document (M, F, or X for unspecified).
Surname
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/Surname
Data Type Value: ProperNameType
Description: Holder's family name, last name as written on the document. Example: SMITH.
GivenName
XPath: /OrderCancelRS/DataLists/PassengerList/Passenger/IdentityDocument/GivenName
Data Type Value: ProperNameType[]
Description: Holder's first or given name, as written on the document. Example: JOHN.