OrderViewRS for OrderCreate NDC 2017.2
OrderViewRS
OrderViewRS
XPath: /OrderViewRS
Data Type Value: OrderViewRS
Description: The OrderCreate/ OrderView transaction is a multi-function message that may:
- Request specified inventory to be held (and returns a reference to the held inventory)
- Request that an order to be created (returning the complete view of the Order)
- Request additions to order data elements (e.g., add frequent flyer data)
EchoToken
XPath: /OrderViewRS/@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: /OrderViewRS/@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: /OrderViewRS/@Target
Data Type Value: Target
Description: Used to indicate whether the request is for the Test or Production system.
Version
XPath: /OrderViewRS/@Version
Data Type Value: string
Description: For all IATA versioned messages, the version of the message is indicated by a decimal value.
TransactionIdentifier
XPath: /OrderViewRS/@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: /OrderViewRS/@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.
TransactionStatusCode
XPath: /OrderViewRS/@TransactionStatusCode
Data Type Value: TransactionStatusCode
Description: This indicates where this message falls within a sequence of messages.
PrimaryLangID
XPath: /OrderViewRS/@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: /OrderViewRS/@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: /OrderViewRS/@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: /OrderViewRS/@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
Name
XPath: /OrderViewRS/Document/Name
Data Type Value: ProperNameSimpleType
Description: NDC Implementation Name. Example: ThisAirline Gateway.
ReferenceVersion
XPath: /OrderViewRS/Document/ReferenceVersion
Data Type Value: ContextSimpleType
Description: NDC Framework Version. Example: SOAP 2015.1.
Success
Success
XPath: /OrderViewRS/Success
Data Type Value: SuccessType
Description: The presence of the empty Success element explicitly indicates that the message succeeded.
DataLists
PassengerList
XPath: /OrderViewRS/Response/DataLists/PassengerList
Data Type Value: PassengerList
Description: Passenger data list definition.
Passenger
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger
Data Type Value: PassengerType[]
Description: Any person except members of the crew carried or to be carried with the consent of the carrier, on board of any transport vehicle such as aircraft, train, bus, or ship.
PassengerID
XPath: OrderViewRS/Response/DataLists/PassengerList/Passenger/@PassengerID
Data Type Value: xsd:ID [1..1]
Description: Uniquely identifies a Passenger within the context of one message.
PTC
XPath: OrderViewRS/Response/DataLists/PassengerList/Passenger/PTC
Data Type Value: PassengerTypeCodeType [0..1] xsd:string
Description: Type code applying to the Passenger which typically drives pricing (e.g., ADT, CHD, etc.).
InfantRef
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/InfantRef
Data Type Value: xsd:IDREF [0..1]
Description: Reference to Passenger instance within the context of one message, associating an infant on lap to this adult passenger.
Birthdate
XPath: OrderViewRS/Response/DataLists/PassengerList/Passenger/Individual/Birthdate
Data Type Value: DateType [0..1]
Description: Individual's birth location (e.g., city and/or country).
Gender
XPath: OrderViewRS/Response/DataLists/PassengerList/Passenger/Individual/Gender
Data Type Value: GenderCodeType [0..1]
Description: Gender of the individual (M, F, or X for unspecified). Additional BDT to specify Gender code list.
NameTitle
XPath: OrderViewRS/Response/DataLists/PassengerList/Passenger/Individual/NameTitle
Data Type Value: ShortNameType [0..1]
Description: Name Title. Examples: MR, MRS, DR.
GivenName
XPath: OrderViewRS/Response/DataLists/PassengerList/Passenger/Individual/GivenName
Data Type Value: extension of ProperNameSimpleType [0..5]
Description: Individual's first or given name. Example: JOHN.
MiddleName
XPath: OrderViewRS/Response/DataLists/PassengerList/Passenger/Individual/MiddleName
Data Type Value: extension of xs:string [0..3]
Description: Individual's middle name or initial. Examples: G, GEORGE.
Surname
XPath: OrderViewRS/Response/DataLists/PassengerList/Passenger/Individual/Surname
Data Type Value: extension of ProperNameSimpleType [1..1]
Description: Family name, last name Example: SMITH.
ProfileID
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/ProfileID
Data Type Value: SimpleTextType
Description: Passenger Profile ID
ProfileID
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/ProfileID
Data Type Value: SimpleTextType
Description: Passenger Profile ID
LoyaltyProgramAccount
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/LoyaltyProgramAccount
Data Type Value: LoyaltyProgramAccountType[]
Description: An account set up for a customer within a rewards program which holds funds on behalf of that customer.
TierPriority
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/TierPriority
Data Type Value: SimpleTextType
Description: Loyalty Program account priority within the tier (e.g., Platinum, executive, etc.)
AccountNumber
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/AccountNumber
Data Type Value: SimpleCodeType
Description: Loyalty Program account number. Example: ABC123456.
ProgramCode
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/ProgramCode
Data Type Value: SimpleCodeType
Description: Loyalty Program ID: Example: MAM.
AirlineName
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/Airline/AirlineName
Data Type Value: ProperNameType
Description: Issuing Airline Name. Example: British Airways.
AirlineDesignator
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/LoyaltyProgramAccount/Airline/AirlineDesignator
Data Type Value: AirlineDesignatorCodeType
Description: Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. Refer to IATA Airline Coding Directory, Section 3.
IdentityDocument
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument
Data Type Value: IdentityDocumentType[]
Description: Any document which may be used to identify a person or verify aspects of a person's personal identity.
IdentityDocumentNumber
XPath: OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/IdentityDocumentNumber
Data Type Value: SimpleCodeType [1..1]
Description: Uniquely identifies the document from all other identity documents issued by the state or organization. For example, passport number, drive license number.
IdentityDocumentType
XPath: OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/IdentityDocumentType
Data Type Value: IdentityDocumentTypeCodeType [1..1]
Description: The type of passenger document. Examples: PT (Passport)
Birthdate
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/Birthdate
Data Type Value: DateType
Description: Holder’s date of birth as written on the document.
Gender
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/Gender
Data Type Value: GenderCodeContentType
Description: Holder’s gender as specified on the document (M, F, or X for unspecified).
IssueDate
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/IssueDate
Data Type Value: DateType
Description: The date the identity document was issued.
ExpiryDate
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/ExpiryDate
Data Type Value: DateType
Description: The date the identity document expires.
IssuingCountryCode
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/IssuingCountryCode
Data Type Value: ISO_3166CountryCodeContentType
Description: Issuing country code of the identity document.
CitizenshipCountryCode
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/CitizenshipCountryCode
Data Type Value: ISO_3166CountryCodeContentType
Description: Citizenship Country Code. Examples: US, FR.
NameTitle
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/NameTitle
Data Type Value: ProperNameType
Description: Holder's name title as written on the document. Examples: MR, MRS, DRn.
GivenName
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/GivenName
Data Type Value: ProperNameType[]
Description: Holder's first or given name, as written on the document. Example: JOHN.
MiddleName
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/MiddleName
Data Type Value: ProperNameType[]
Description: Holder's middle name or initial, as written on the document. Examples: G, GEORGE.
Surname
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/Surname
Data Type Value: ProperNameType
Description: Holder's family name, last name as written on the document. Example: SMITH.
SurnameSuffix
XPath: /OrderViewRS/Response/DataLists/PassengerList/Passenger/IdentityDocument/SurnameSuffix
Data Type Value: ShortNameType
Description: Holder's surname suffixes and letters as written on the document. Examples: Jr., Sr., III, Ret., Esq.
ContactInfoRef
XPath: OrderViewRS/Response/DataLists/PassengerList/Passenger/ContactInfoRef
Data Type Value: xsd:IDREF [0..1]
Description: Reference to Contact Information, within the context of one message.
ContactInformation
XPath: /OrderViewRS/Response/DataLists/ContactList/ContactInformation
Data Type Value: ContactInformationType[]
Description: The electronic or geographic address which a party has provided as the contact channel. For example, contact email, contact postal address, contact phone number.
ContactID
XPath: OrderViewRS/Response/DataLists/ContactList/ContactInformation/@ContactID
Data Type Value: xsd:ID[0..1]
Description: Uniquely Identifies a set of Contact Information, within the context of one message.
EmailAddressValue
XPath: OrderViewRS/Response/DataLists/ContactList/ContactInformation/ContactProvided/EmailAddress/EmailAddressValue
Data Type Value: SimpleTextType [1..1]
Description: The email address which should be used for contact purposes.
Phone
XPath: OrderViewRS/Response/DataLists/ContactList/ContactInformation/ContactProvided/Phone
Data Type Value: PhoneTypeAIDM [1..'Unbounded] Choice Based
Description: A telephone number is a sequence of digits assigned to a fixed-line telephone subscriber station connected to a telephone line or to a wireless electronic telephony device, such as a radio telephone or a mobile telephone, or to other devices for data transmission via the public switched telephone network (PSTN) or other private networks.
Label
XPath: /OrderViewRS/Response/DataLists/ContactList/ContactInformation/ContactProvided/Phone/Label
Data Type Value: SimpleTextType
Description: Used to differentiate multiple Phone numbers of one contact. Examples: Work, Home, Mobile.
CountryDialingCode
XPath: /OrderViewRS/Response/DataLists/ContactList/ContactInformation/ContactProvided/Phone/CountryDialingCode
Data Type Value: CountryDialiingCodeType
Description: Numeric telephone dialing prefixes for the member countries of the International Telecommunication Union (ITU).
AreaCode
XPath: /OrderViewRS/Response/DataLists/ContactList/ContactInformation/ContactProvided/Phone/AreaCode
Data Type Value: NumberType
Description: Phone number area code. Example: 813
PhoneNumber
XPath: OrderViewRS/Response/DataLists/ContactList/ContactInformation/ContactProvided/Phone/PhoneNumber
Data Type Value: NumberType [0..1]
Description: Phone number text. For example: +1 999-999-9999 ext 1234, 617-9976. 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.
FlightSegment
XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment
Data Type Value: ListOfFlightSegmentType[]
Description: Flight origin/destination information.
SegmentKey
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/@SegmentKey
Data Type Value: KeyIdentifier [1..1]
Description: A globally unique identifier for this Flight Segment instance. Example: segment1.
FlightSegmentType
XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/FlightSegmentType
Data Type Value: IATA_CodeType
Description: Used for codes in the IATA code tables. Possible values of this pattern are 1, 101, EQP.
Departure
XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Departure
Data Type Value: Departure
Description: Departure (origin) Airport, Date and Time information.
AirportCode
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Departure/AirportCode
Data Type Value: extension of AirportCitySimpleType [1..1]
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: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Departure/Date
Data Type Value: xs:date [1..1]
Description: Departure date. Example: 2017-01-13 Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD).
Time
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Departure/Time
Data Type Value: TimeSimpleType [0..1]
Description: Departure time. Example: 09:15 Encoding Scheme: ISO 8601 Military/24 Hour Format (HH:MM).
Name
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Departure/Terminal/Name
Data Type Value: ProperNameSimpleType [0..1]
Description: Terminal name or ID. Example: Terminal C.
Gate
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Departure/Terminal/Gate
Data Type Value: ContextSimpleType [0..1]
Description: Terminal Gate Number. Example: C39.
Arrival
XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Arrival
Data Type Value: FlightArrivalType
Description: FLIGHT ARRIVAL definition.
AirportCode
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Arrival/AirportCode
Data Type Value: extension of AirportCitySimpleType [1..1]
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: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Arrival/Date
Data Type Value: xs:date [0..1]
Description: Arrival date. Example: 2017-01-14 Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD).
Time
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Arrival/Time
Data Type Value: TimeSimpleType [0..1]
Description: Arrival time. Example: 09:15.
Name
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Arrival/Terminal/Name
Data Type Value: ProperNameSimpleType [0..1]
Description: Terminal name or ID. Example: Terminal C.
Gate
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Arrival/Terminal/Gate
Data Type Value: ContextSimpleType [0..1]
Description: Terminal Gate Number. Example: C39
MarketingCarrier
XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier
Data Type Value: MarketingCarrierFlightType
Description: Marketing Carrier information.
AirlineID
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/AirlineID
Data Type Value: extension of AirlineID_Type [1..1]
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.
Name
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/Name
Data Type Value: CarrierNameType [0..1]
Description: Airline Name. Example: British Airways.
FlightNumber
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/FlightNumber
Data Type Value: extension of FlightNumberType [1..1]
Description: Flight Number. Example: 1234, or OPEN, or ARNK.
ResBookDesigCode
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/MarketingCarrier/ResBookDesigCode
Data Type Value: xs:anyType [0..1]
Description: The Reservation Booking Designator (booking class) of the Marketing Carrier. Example: Y, W, S, etc.
OperatingCarrier
XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier
Data Type Value: OperatingCarrier
Description: Operating Carrier Information. Operating Carrier is the carrier that operates a flight with a reference to its own prime flight number.
Note: Operating Carrier may be different from a Marketing Carrier(s), if the flight is actually marketed by another carrier(s) within a codeshare agreement. Operating Carrier may not be the AOC holder, in which case, and wherever required, this will need to be disclosed to the customer.
AirlineID
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/AirlineID
Data Type Value: extension of AirlineID_Type [0..1]
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.
Name
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/Name
Data Type Value: CarrierNameType [0..1]
Description: Airline Name. Example: British Airways.
FlightNumber
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/FlightNumber
Data Type Value: extension of FlightNumberType [0..1]
Description: Flight Number. Example: 1234, or OPEN, or ARNK.
ResBookDesigCode
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/OperatingCarrier/ResBookDesigCode
Data Type Value: CodesetValueSimpleType [0..1]
Description: The Reservation Booking Designator (booking class) of the Operating Carrier if different from the Marketing Carrier. Example: Y.
AircraftCode
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/Equipment/AircraftCode
Data Type Value: extension of AircraftCodeType
Description: The IATA aircraft type 3 character code; use SSIM Appendix A. Example:318.
Code
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/ClassOfService/Code
Data Type Value: Flight_COS_SimpleType [1..1]
Description: Class of Service Code. Example: B.
SecureFlight
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/@SecureFlight
Data Type Value: xsd:boolean[0..1]
Description: When true, the flight is secure flight. An indicator to disclose when a flight is a "secure flight".
Value
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/FlightDuration/Value
Data Type Value: xsd:duration [1..1]
Description: Flight Segment Duration. Example: PT6H45M (six hours and forty-five minutes)
Note: This is the in-flight time duration associated with this segment. Stop duration is specified in the Stops node.
StopQuantity
XPath: OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopQuantity
Data Type Value: [0..1] xsd:integer"
Description: Stop Quantity. Example: 1.
StopLocation
XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation
Data Type Value: StopLocation[]
Description: Stop Location detail.
AirportCode
XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation/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.
ArrivalDate
XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation/ArrivalDate
Data Type Value: date
Description: Stop Arrival date. Example: 2017-01-14. Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD).
ArrivalTime
XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation/ArrivalTime
Data Type Value: TimeSimpleType
Description: Arrival time. Example: 09:15. Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM).
DepartureDate
XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation/DepartureDate
Data Type Value: date
Description: Scheduled Departure Date. Example: 2017-01-13.
Note: This is the date and time of departure in GMT from the unticketed point.
DepartureTime
XPath: /OrderViewRS/Response/DataLists/FlightSegmentList/FlightSegment/FlightDetail/Stops/StopLocations/StopLocation/DepartureTime
Data Type Value: TimeSimpleType
Description: Departure time. Example: 09:15. Encoding Scheme: ISO 8601 Military/24 Hour Format (HH:MM).
ListKey
XPath: /OrderViewRS/Response/DataLists/InstructionsList/Instruction/@ListKey
Data Type Value: ID
Description: Globally unique id for this Data List instance.
Remark
XPath: /OrderViewRS/Response/DataLists/InstructionsList/Instruction/FreeFormTextInstruction/Remark
Data Type Value: Remark[]
Description: Remark Text.
Name
XPath: OrderViewRS/Response/DataLists/PriceClassList/PriceClass/Name
Data Type Value: ProperNameSimpleType [1..1]
Description: Price class name. Example: SUPERSAVER.
Text
XPath: /OrderViewRS/Response/DataLists/PriceClassList/PriceClass/Descriptions/Description/Text
Data Type Value:
Description: Text Description value.
ServiceDefinition
XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition
Data Type Value: ServiceDefinitionType[]
Description: OPTIONAL SERVICE CORE definition.
Owner
XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/@Owner
Data Type Value: AirlineDesigSimpleType
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.
ServiceDefinitionID
XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/@ServiceDefinitionID
Data Type Value: ID
Description: "A unique Service ID that has been returned in the Shopping results and identifies an airline service item (i.e., a product or a service) that can be separately delivered and uniquely described by an airline. Example: SRVC-2B88-4C33-9787-9461114BC9BE".
Name
XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/Name
Data Type Value: Name
Description: Service name. Example: Lounge Pass.
Code
XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/Encoding/Code
Data Type Value: Code
Description: Service code. Examples: XLEG (Extra Leg Room Seat, implementer encoding); XBAG (Extra Bag, implementer encoding). Used in conjunction with SubCode (Associated Reason for Issuance SubCode).
Text
XPath: /OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/Descriptions/Description/Text
Data Type Value: Text
Description: Description value.
Order
OrderID
XPath: /OrderViewRS/Response/Order/@OrderID
Data Type Value: UniqueID_SimpleType [1..1]
Description: The airline-assigned unique Order ID. Example: ORDER-c98c-4759-a20b.
Owner
XPath: /OrderViewRS/Response/Order/@Owner
Data Type Value: AirlineDesigSimpleType [1..1]
Description: Airline Designator of airline that owns/ assigned this ID. Example: BA
Encoding Scheme: IATA/ A4A (two or three character) Airline Designator Codes
OwnerType
XPath: /OrderViewRS/Response/Order/@OwnerType
Data Type Value: OwnerType
Description: The POA OrderID should only go to the ORA, not back to the seller.
- ORA
- POA
BookingReference
XPath: /OrderViewRS/Response/Order/BookingReferences/BookingReference
Data Type Value: BookingReferenceType[]
Description: Booking Reference detail.
Type
XPath: /OrderViewRS/Response/Order/BookingReferences/BookingReference/Type
Data Type Value: IATA_CodeType [0..1]
Description: Booking Reference Type. Example: 6 (Passenger confirmation number) Encoding Scheme: IATA Padis Codeset - List for data element [1153] Reference Qualifier.
ID
XPath: /OrderViewRS/Response/Order/BookingReferences/BookingReference/ID
Data Type Value: [1..1] xsd:string
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.
AirlineID
XPath: /OrderViewRS/Response/Order/BookingReferences/BookingReference/AirlineID
Data Type Value: [1..1]
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.
Name
XPath: /OrderViewRS/Response/Order/BookingReferences/BookingReference/AirlineID/@Name
Data Type Value: ProperNameSimpleType [0..1]
Description: Name. Example: British Airways.
TotalOrderPrice
XPath: /OrderViewRS/Response/Order/TotalOrderPrice
Data Type Value: TotalOrderPrice
Description: Total Order Price. Example: 3400 USD.
Note: This is a sub-total of all associated Order Item prices.
DetailCurrencyPrice
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice
Data Type Value: DetailCurrencyPriceType
Description: DETAIL CURRENCY PRICE BASIS UNIT: Price with tax and/ or fee break-down or totals.
Total
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Total
Data Type Value: CurrencyAmountOptType [1..1]
Description: Total price in currency. Example: 16000 USD.
Note: This is the total price INCLUDING base price, taxes and fees/ surcharges.
Code
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Total/@Code
Data Type Value: CurrencySimpleType [0..1]
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
SubTotal
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Details/Detail/SubTotal
Data Type Value: CurrencyAmountOptType [0..1]
Description: Price breakdown sub-total. This is the total of all price breakdown items, excluding tax and/ or surcharge.
Code
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Details/Detail/SubTotal/@Code
Data Type Value: CurrencySimpleType [0..1]
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Application
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Details/Detail/Application
Data Type Value: ProperNameSimpleType
Description: Price application. Example: Base Fare.
Total
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Taxes/Total
Data Type Value: Total
Description: Sub-total of all applicable taxes. Monetary value and currency code.
Amount
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/Amount
Data Type Value: CurrencyAmountOptType
Description: Amount. Example: 15000 USD.
Code
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/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: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/TaxCode
Data Type Value: string
Description: Tax Code. Example: AY, GB.
Description
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Taxes/Breakdown/Tax/Description
Data Type Value: ShortDescSimpleType
Description: Tax short description. Example: $4 per flight segment, per passenger (U.S. domestic segment tax).
Total
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Fees/Total
Data Type Value: Total
Description: Sub-total of all fees and charges. Monetary value and currency code.
Code
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Fees/Total/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Amount
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Fees/Breakdown/Fee/Amount
Data Type Value: CurrencyAmountOptType
Description: Fee Amount. Example: 500 USD
Code
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Fees/Breakdown/Fee/Amount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Designator
XPath: /OrderViewRS/Response/Order/TotalOrderPrice/DetailCurrencyPrice/Fees/Breakdown/Fee/Designator
Data Type Value: CodesetValueSimpleType
Description: Fee designator. Example: USC.
OrderItemID
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/@OrderItemID
Data Type Value: xsd:ID [1..1]
Description: The airline-assigned unique Order Item ID. Example: ORD769-A850-4EC4-8F46-02293F72D7E6.
SimpleCurrencyPrice
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/TotalAmount/SimpleCurrencyPrice
Data Type Value: SimpleCurrencyPriceType [1..1]
Description: A (simple) CURRENCY-based Price with NO taxes and/ or fees. Examples: 100.00, 100, 100 (USD).
Code
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/TotalAmount/SimpleCurrencyPrice/@Code
Data Type Value: CurrencySimpleType [0..1]
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
BaseAmount
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/BaseAmount
Data Type Value: CurrencyAmountOptType [1..1]
Description: Total Base Fare Amount. Example: 200000. This includes surcharges (if applicable).
Code
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/BaseAmount/@Code
Data Type Value: CurrencySimpleType [0..1]
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Serivce
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/Service
Data Type Value: Service[]
Description: The individual instance of a specific Service (as described in DataLists' ServiceDefinitions) or service bundle as it has been offered, and eventually ordered by a specific Passenger.
ServiceID
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/Service/@ServiceID
Data Type Value: xsd:ID [1..1]
Description: ID for the Service contained this OrderItem. While the OrderItem would be a direct transference of the originating OfferItem, the Services within are broken down to a more granular level (i.e., a single deliverable unit of a specific service per passenger per flight segment). Therefore, the ServiceIDs in an Order do not reflect a 1-to-1 mapping to the originating Offer’s ServiceIDs.
PassengerRef
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/Service/PassengerRef
Data Type Value: xsd:IDREF [1..1]
Description:
ServiceRef
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/Service/ServiceRef
Data Type Value: IDREF
Description: Create dependencies with parent services to which this particular ServiceItem is linked to (e.g., a meal to a flight). Can reference ServiceItems across different OfferItems within the same Offer.
SegmentRef
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/Service/SegmentRef
Data Type Value: xsd:IDREF [1..1] Choice
Description: Reference a segment being sold as part of this OrderItem/Service.
Total
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Taxes/Total
Data Type Value: CurrencyAmountOptType [1..1]
Description: Sub-total of all applicable taxes. Monetary value and currency code.
Code
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Taxes/Total/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Amount
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Taxes/Breakdown/Tax/Amount
Data Type Value: CurrencyAmountOptType [1..1]
Description: Total Base Fare Amount. Example: 200000. This includes surcharges (if applicable).
Code
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Taxes/Breakdown/Tax/Amount/@Code
Data Type Value: CurrencySimpleType [0..1]
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
TaxCode
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Taxes/Breakdown/Tax/TaxCode
Data Type Value: xsd:string [0..1]
Description: Tax Code. Example: AY, GB.
Description
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Taxes/Breakdown/Tax/Description
Data Type Value: ShortDescSimpleType [0..1]
Description: Tax short description. Example: $4 per flight segment, per passenger (U.S. domestic segment tax).
Nation
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Taxes/Breakdown/Tax/Nation
Data Type Value: xsd:string [0..1]
Description: Tax Nation or Designator. Example: US, GB
Total
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Fees/Total
Data Type Value: CurrencyAmountOptType [1..1]
Description: Sub-total of all fees and charges. Monetary value and currency code.
Code
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Fees/Total/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Amount
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Fees/Breakdown/Fee/Amount
Data Type Value: CurrencyAmountOptType
Description: Fee Amount. Example: 500 USD
Code
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Fees/Breakdown/Fee/Amount/@Code
Data Type Value: CurrencySimpleType
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Designator
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/PriceDetail/Fees/Breakdown/Fee/Designator
Data Type Value: CodesetValueSimpleType [0..1]
Description: Fee designator. Example: USC.
BaseAmount
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/Price/BaseAmount
Data Type Value: CurrencyAmountOptType [1..1]
Description: Total Base Fare Amount. Example: 200000. This includes surcharges (if applicable).
Code
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/Price/BaseAmount/@Code
Data Type Value: CurrencySimpleType [0..1]
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Code
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareBasis/FareBasisCode/Code
Data Type Value: FareBasisAppSimpleType
Description: Fare basis code. Example: Y26.
refs
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareBasis/FareBasisCode/@refs
Data Type Value: InstanceClassRefSimpleType
Description: Object association(s) between this object and any other object or metadata instance(s).
RBD
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareBasis/RBD
Data Type Value: string
Description: Reservation Booking Designator or Booking Class. Example: T.
FareBasisCityPair
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareBasis/FareBasisCityPair
Data Type Value: ContextSimpleType
Description: A data type for Context Value size constraint.
Application
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareBasis/FareBasisCode/Application
Data Type Value: FareBasisAppSimpleType [0..1]
Description: Fare basis application. Examples: Requested, Ticketed, Other.
CabinType
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareBasis/CabinType
Data Type Value: [1..1]
Description: Type of Cabin
CabinTypeCode
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareBasis/CabinType/CabinTypeCode
Data Type Value: CabinTypeCode [1..1]
Description: Cabin type code
CabinTypeName
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareBasis/CabinType/CabinTypeName
Data Type Value: CabinTypeName [1..1]
Description: Cabin type Name
PriceClassRef
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/PriceClassRef
Data Type Value: PriceClassRef [0..1]
Description:
Remark
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareRules/Remarks/Remark
Data Type Value: Remark[]
Description: Remark Text.
Timestamp
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/FareRules/Remarks/Remark/@Timestamp
Data Type Value: dateTime
Description: Remark creation timestamp. Example: 2017-01-13T13:59:38Z.
SegmentRefs
XPath: OrderViewRS/Response/Order/OrderItems/OrderItem/FareDetail/FareComponent/SegmentRefs
Data Type Value: xsd:IDREFS [0..1]
Description:
Payments
XPath: /OrderViewRS/Response/Order/Payments
Data Type Value: Payments
Description: Payment Processing information.
Note: This payment information applies to the entire Order. Note that it may also be specified at the Order Item level.
Payments
XPath: /OrderViewRS/Response/Order/Payments/Payment
Data Type Value: PaymentProcessType[]
Description: Payment Processing detail.
Type
XPath: /OrderViewRS/Response/Order/Payments/Payment/Type
Data Type Value: IATA_CodeType [1..1]
Description: The form of payment type. Examples: Credit Card, Cash. Encoding Scheme: IATA PADIS code list data element [9888] Form of Payment Identification.
ObjectKey
XPath: /OrderViewRS/Response/Order/Payments/Payment/Description/@ObjectKey
Data Type Value: ID
Description: Object globally unique Instance ID. Example: obj1.
StatusCode
XPath: /OrderViewRS/Response/Order/Payments/Payment/Status/StatusCode
Data Type Value: StatusCode
Description: Overall Order payment Status Code.
PaymentCardMethod
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod
Data Type Value: PaymentCardMethodType
Description: PAYMENT CARD Payment Method definition.
CardType
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/CardType
Data Type Value: PayCardTypeSimpleType [0..1]
Description: Magnetic striped card type.
CardCode
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/CardCode
Data Type Value: PayCardCodeSimpleType [0..1]
Description: Credit card issuer code. Example: MC. This is the two-character code of the credit card issuer.
MaskedCardNumber
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/MaskedCardNumber
Data Type Value: MaskedCardNmbrSimpleType [0..1]
Description: Concealed credit card number, Example: xxxxxxxxxxxx9922.
AddressContact
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/AddressContact
Data Type Value: AddressContactType
Description: ADDRESS CONTACT definition.
Street
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/AddressContact/Street
Data Type Value: string[]
Description: Street. Examples: Main Street, 100 Main Street.
CityName
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/AddressContact/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: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/AddressContact/StateProv
Data Type Value: string
Description: State or province code. Examples: NY, QUE.
PostalCode
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/AddressContact/PostalCode
Data Type Value: PostalCode
Description: Postal code. Examples: 11001, 11001-2345
CountryCode
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/AddressContact/CountryCode
Data Type Value: CountryCode
Description: Country Code. Examples: US, FR. Encoding Scheme: ISO 3166-1 (two character) Country Code.
Application
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/EmailContact/Application
Data Type Value: EmailAppSimpleType
Description: Email address application. Examples: Personal, Business, SMS
Address
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/Contacts/Contact/EmailContact/Address
Data Type Value: Address
Description: The traveler email address for contact.
CardHolderName
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/CardHolderName
Data Type Value: CardHolderName
Description: Name of credit card holder. Example: JOHN SMITH.
CardIssuerName
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/CardIssuerName
Data Type Value: CardIssuerName
Description: Credit card issuing company.
BankID
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/CardIssuerName/BankID
Data Type Value: ProperNameSimpleType
Description: Issuer Name. Example: Bank of America.
Note: This is the name of bank or organization issuing the card (e.g., alumni association, bank, fraternal organization, etc.).
Expiration
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/PaymentCardMethod/EffectiveExpireDate/Expiration
Data Type Value: [0..1] PayCardDateSimpleType
Description: Payment Card Expiration Date. Example: 0119.
TicketNumber
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/MiscChargeMethod/TicketNumber
Data Type Value: ContextSimpleType
Description: The ticket number of the miscellaneous charge order (MCO).
SimpleCurrencyPrice
XPath: /OrderViewRS/Response/Order/Payments/Payment/Amount/SimpleCurrencyPrice
Data Type Value: SimpleCurrencyPriceType [1..1]
Description: A (simple) CURRENCY-based Price with NO taxes and/ or fees.-Examples: 100.00, 100, 100 (USD).
Code
XPath: /OrderViewRS/Response/Order/Payments/Payment/Amount/SimpleCurrencyPrice/@Code
Data Type Value: CurrencySimpleType [0..1]
Description: Currency code. Example: USD. Encoding Scheme: ISO 4217 (three alpha character) Currency Code.
Number
XPath: /OrderViewRS/Response/Order/Payments/Payment/Method/VoucherMethod/Number
Data Type Value: ShortDescSimpleType
Description: Voucher ID or Number. Example: XX12345
Timestamp
XPath: /OrderViewRS/Response/Order/OrderItems/OrderItem/TimeLimits/PaymentTimeLimit/@Timestamp
Data Type Value: dateTime
Description: Timestamp. Example: 2017-01-13T13:59:38Z.
TicketDocInfos
TIcketDocInfo
XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo
Data Type Value: TicketDocInfo[]
Description: Ticket/document information.
TicketDocNbr
XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/TicketDocNbr
Data Type Value: IATA_CodeType [1..1]
Description: Coupon Document Number.This is the document number comprised of the airline code, form code, and serial number.
Type
XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/Type
Data Type Value: xsd:integer [1..1]
Description: Coupon Type. Example: Y (EMD-S Standalone). Encoding Scheme: IATA Padis Codeset - List for data element 1001 (Document/ Message Name, coded)
NumberofBooklets
XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/NumberofBooklets
Data Type Value: xsd:string [1..1]
Description: The number of booklets issued.
DateOfIssue
XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/DateOfIssue
Data Type Value: xsd:date [0..1]
Description: Date of Issue. Example: 2018-06-13.
Remark
XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/Remark
Data Type Value: string
Description: Free text to provide further information related to the document and/or the coupon.
ReportingType
XPath: /OrderViewRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/ReportingType
Data Type Value: xsd:string [1..1]
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.
PassengerReference
XPath: OrderViewRS/Response/TicketDocInfos/TicketDocInfo/PassengerReference
Data Type Value: xsd:IDREFS [1..1]
Description: Association to one or multiple Passenger instances. Example: pax1 pax2.
Errors
Errors
XPath: /OrderViewRS/Errors
Data Type Value: ErrorsType
Description: A collection of errors that occurred during the processing of a message.
Error
XPath: /OrderViewRS/Errors/Error
Data Type Value: ErrorType[]
Description: Standard way to indicate that an error occurred during the processing of an IATA message.
Language
XPath: /OrderViewRS/Errors/Error/@Language
Data Type Value: language
Description: Language identification.
Type
XPath: /OrderViewRS/Errors/Error/@Type
Data Type Value: IATA_CodeType
Description: The Error element MUST contain the Type attribute that uses a recommended set of values to indicate the error type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown".
ShortText
XPath: /OrderViewRS/Errors/Error/@ShortText
Data Type Value: StringLength1to255
Description: An error in textual format.
Code
XPath: /OrderViewRS/Errors/Error/@Code
Data Type Value: IATA_CodeType
Description: If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to IATA PADIS Code List data element 9321.
DocURL
XPath: /OrderViewRS/Errors/Error/@DocURL
Data Type Value: anyURI
Description: If present, this URL refers to an online description of the error that occurred.
Status
XPath: /OrderViewRS/Errors/Error/@Status
Data Type Value: StringLength1to64
Description: If present, recommended values are those enumerated in the IATA_ErrorRS (NotProcessed | Incomplete | Complete | Unknown); however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.
Tag
XPath: /OrderViewRS/Errors/Error/@Tag
Data Type Value: string
Description: If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].
RecordID
XPath: /OrderViewRS/Errors/Error/@RecordID
Data Type Value: StringLength1to32
Description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records.
Owner
XPath: /OrderViewRS/Errors/Error/@Owner
Data Type Value: StringLength1to32
Description: Used to specify the owner of the error/warning codelist.
NodeList
XPath: /OrderViewRS/Errors/Error/@NodeList
Data Type Value: string
Description: An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional constraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message.
Warnings
Warnings
XPath: /OrderViewRS/Warnings
Data Type Value: WarningsType
Description: Used in conjunction with the Success element to define one or more business errors.
Warning
XPath: /OrderViewRS/Warnings/Warning
Data Type Value: WarningType[]
Description: Used in conjunction with the Success element to define a business error.
Language
XPath: /OrderViewRS/Warnings/Warning/@Language
Data Type Value: language
Description: Language identification.
Type
XPath: /OrderViewRS/Warnings/Warning/@Type
Data Type Value: IATA_CodeType
Description: The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown".
ShortText
XPath: /OrderViewRS/Warnings/Warning/@ShortText
Data Type Value: StringLength1to255
Description: An error in textual format.
Code
XPath: /OrderViewRS/Warnings/Warning/@Code
Data Type Value: IATA_CodeType
Description: If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to IATA PADIS Code List data element 9321.
DocURL
XPath: /OrderViewRS/Warnings/Warning/@DocURL
Data Type Value: anyURI
Description: If present, this URL refers to an online description of the error that occurred.
Status
XPath: /OrderViewRS/Warnings/Warning/@Status
Data Type Value: StringLength1to64
Description: If present, recommended values are those enumerated in the IATA_ErrorRS, (NotProcessed | Incomplete | Complete | Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.
Tag
XPath: /OrderViewRS/Warnings/Warning/@Tag
Data Type Value: string
Description: If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].
RecordID
XPath: /OrderViewRS/Warnings/Warning/@RecordID
Data Type Value: StringLength1to32
Description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records.
Owner
XPath: /OrderViewRS/Warnings/Warning/@Owner
Data Type Value: StringLength1to32
Description: Used to specify the owner of the error/warning codelist.
Metadata
refs
XPath: /OrderViewRS/Response/Metadata/Other/OtherMetadata/CurrencyMetadatas/CurrencyMetadata/@refs
Data Type Value: InstanceClassRefSimpleType
Description: Object association(s) between this object and any object instance(s).
MetadataKey
XPath: OrderViewRS/Response/Metadata/Other/OtherMetadata/CurrencyMetadatas/CurrencyMetadata/@MetadataKey
Data Type Value: xs:ID
Description: A globally unique identifier for this Metadata instance.
Decimals
XPath: OrderViewRS/Response/Metadata/Other/OtherMetadata/CurrencyMetadatas/CurrencyMetadata/Decimals
Data Type Value: xs:integer [0..1]
Description: Number of decimal places. Example: 2.