OrderRetrieve Request NDC 2017.2

OrderRetrieveRQ

XPath: /OrderRetrieveRQ

Data Type Value: restriction of xs:anyType [0..1]

Description: The OrderRetrieve/OrderView transaction set retrieves a specified order that matches one or more search criteria. Search criteria may include any supported Order Reference information, which may be the Order ID, a PNR reference, a ticket or coupon/ document number, or other Airline supported order reference and a Traveler Surname and Given Name. Note that if the order retrieval request is initiated from the party that originally requested the order creation, then an Order Reference is sufficient with the identity of the requesting party. If the order retrieval request is initiated from a party that did not originally request the order creation, then an extended security mechanism may be used to extend order view access to the party (e.g., using a CustomerInputRQ/RS for an additional security challenge (e.g., custom security question and answers.).The requestor may additionally specify filters to constrain the response information sets, including: Trip itinerary, Flight segment, Passenger, Payment and Accountable document information. If no filters are specified, all order information is returned. If a matching order is found, the OrderView response will contain all order information or filtered information (if filters were requested in the order retrieval request). If no matching Order is located, the OrderView response will include processing condition information and no order information.

EchoToken

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

Data Type Value: Target

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

Version

XPath: /OrderRetrieveRQ/@Version

Data Type Value: string

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

TransactionIdentifier

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

PrimaryLangID

XPath: /OrderRetrieveRQ/@PrimaryLangID

Data Type Value: language

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

PointOfSale

CountryCode

XPath: /OrderRetrieveRQ/PointOfSale/Location/CountryCode

Data Type Value: CountryCode

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

Code

XPath: /OrderRetrieveRQ/PointOfSale/TouchPoint/Device/Code

Data Type Value: CodesetValueSimpleType

Description: Code value. Example: 003

TableName

XPath: /OrderRetrieveRQ/PointOfSale/TouchPoint/Device/TableName

Data Type Value: ProperNameSimpleType

Description: Code set table name.

Definition

XPath: /OrderRetrieveRQ/PointOfSale/TouchPoint/Device/Definition

Data Type Value: ProperNameSimpleType

Description: Code Definition. Example: Travel Agency

Party

IATA_Number

XPath: /OrderRetrieveRQ/Party/Sender/TravelAgencySender/IATA_Number

Data Type Value: IATA_NbrSimpleType

Description: Agency Seller IATA number. Example: 98417900

PseudoCity

XPath: /OrderRetrieveRQ/Party/Sender/TravelAgencySender/PseudoCity

Data Type Value: PseudoCity

Description: Pseudo City code. Example: AAA2

Type

XPath: /OrderRetrieveRQ/Party/Sender/TravelAgencySender/Type

Data Type Value: AgencyCategorySimpleType

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

Owner

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

Query

OrderID

XPath: /OrderRetrieveRQ/Query/Filters/OrderID

Data Type Value: OrderID_Type

Description: A data type for an Order ID. The airline-assigned unique Order ID. Example: ORDER-c98c-4759-a20b.

OwnerType

XPath: /OrderRetrieveRQ/Query/Filters/OrderID/@OwnerType

Data Type Value: OwnerType

Description: The POA OrderID should only go to the ORA, not back to the seller.

Owner

XPath: /OrderRetrieveRQ/Query/Filters/OrderID/@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.

GivenName

XPath: /OrderRetrieveRQ/Query/Filters/Passengers/Individual/GivenName

Data Type Value: ProperNameType[]

Description: Individual's first or given name. Example: JOHN.

Surname

XPath: /OrderRetrieveRQ/Query/Filters/Passengers/Individual/Surname

Data Type Value: ProperNameType

Description: Individual's family name, last name. Example: SMITH.

Type

XPath: /OrderRetrieveRQ/Query/Filters/BookingReferences/BookingReference/Type

Data Type Value: IATA_CodeType

Description: Booking Reference Type. Example: 6 (Passenger confirmation number). Encoding Scheme: IATA Padis Codeset - List for data element [1153] Reference Qualifier.

ID

XPath: /OrderRetrieveRQ/Query/Filters/BookingReferences/BookingReference/ID

Data Type Value: ID

Description: Existing Booking Reference ID. Example: R1A3SK.

AirlineID

XPath: /OrderRetrieveRQ/Query/Filters/BookingReferences/BookingReference/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