<xsd:complexType name="MessageHeader">
<xsd:annotation>
<xsd:documentation xml:lang="en">Message Header definition: The standard element that appears on the root all OpenTravel 2 messages.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="Identification">
<xsd:annotation>
<xsd:documentation xml:lang="en">Attributes that uniquely identify the message.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="timeStamp" type="xsd:dateTime" use="required">
<xsd:annotation>
<xsd:documentation xml:lang="en">The creation date and time of the message in UTC in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). Source: http://bit.ly/OTA2_ISO8601</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="messageID" type="String_Short" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">A reference for additional message identification, assigned by the requesting system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="correlationID" type="String_Medium" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">A unique identifier that may be specified 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).</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="sequenceNbr" type="xsd:nonNegativeInteger" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">A sequence number for the transaction assigned by the sending system that 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.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element name="TargetSystem" minOccurs="0">
<xsd:annotation>
<xsd:documentation xml:lang="en">Attributes that identify the target message processing system.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="type" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">The type of the target system to process this message that may be specified, e.g. a production or test system.</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:NMTOKEN">
<xsd:enumeration value="Production" />
<xsd:enumeration value="Test" />
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="name" type="String_Short" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">The name of the target system that may be specified if there are more than one system for a specified system type, e.g. "Test System 23." </xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element name="Language" minOccurs="0">
<xsd:annotation>
<xsd:documentation xml:lang="en">Attributes used to identify the language preference for the message.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="primary" type="xsd:language" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">The primary human language preference to use for message processing in ISO 639 code format. Source: http://bit.ly/OTA2_ISO639</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="secondary" type="xsd:language" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">The secondary human language preference to use for message processing in ISO 639 code format. Source: http://bit.ly/OTA2_ISO639</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element name="Correlation" minOccurs="0">
<xsd:annotation>
<xsd:documentation xml:lang="en">Attributes used to correlate and sequence transactions.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="sequenceLocation" use="prohibited">
<xsd:annotation>
<xsd:documentation xml:lang="en">An indication of where this message falls within a sequence of messages.</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:NMTOKEN">
<xsd:enumeration value="First">
<xsd:annotation>
<xsd:documentation xml:lang="en">This is the first message within the sequence.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Last">
<xsd:annotation>
<xsd:documentation xml:lang="en">This is the last message within the sequence.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="InSeries">
<xsd:annotation>
<xsd:documentation xml:lang="en">This is any message that is not the first or last message within the sequence.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="SubsequentRequest">
<xsd:annotation>
<xsd:documentation xml:lang="en">This request message is a subsequent request based on the previous message sent in the sequence.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Rollback">
<xsd:annotation>
<xsd:documentation xml:lang="en">An indication that all messages within the current sequence should be ignored.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="followupRequestInd" type="xsd:boolean" use="prohibited">
<xsd:annotation>
<xsd:documentation xml:lang="en">An indication that this is a followup request asking for more of what was requested in the previous request.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="rollbackInd" type="xsd:boolean" use="prohibited">
<xsd:annotation>
<xsd:documentation xml:lang="en">An indication that all messages within the current sequence should be ignored.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="logID" type="String_Medium" use="prohibited">
<xsd:annotation>
<xsd:documentation xml:lang="en">Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element name="PointOfSale" maxOccurs="99">
<xsd:annotation>
<xsd:documentation xml:lang="en">Contains point of sale metadata that identifies the party or connection channel making a request or responding to a request, including requestor ID and type, company information and other authentication information such as a message password.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Type">
<xsd:annotation>
<xsd:documentation xml:lang="en">The type of entity making the request, e.g., aggregator, wholesaler, supplier and travel agent.
NOTE: Select a predefined value from the list or use the "Other_" value to create an enumerated value agreed upon between trading partners. </xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="extension" type="ota:String_EnumExtension" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">A string value that represents an "Other_", or extended, enumerated value agreed upon between trading partners.
NOTE: It is recommended that you submit an OpenTravel comment to formally add any extended enumerations to the OpenTravel Specification to maximize trading partner interoperability.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element name="Company" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation xml:lang="en">Requestor company code and short name.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="BookingChannelInfo" minOccurs="0">
<xsd:annotation>
<xsd:documentation xml:lang="en">Booking channel metadata, cincluding type, ID and name.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence minOccurs="0">
<xsd:element name="Type">
<xsd:annotation>
<xsd:documentation xml:lang="en">The type of booking channel, e.g. Global Distribution System (GDS), Alternative Distribution System (ADS), etc.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:simpleContent>
<xsd:extension base="Enum_BookingChannel">
<xsd:attribute name="extension" type="ota:String_EnumExtension" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">A string value that represents an "Other_", or extended, enumerated value agreed upon between trading partners.
NOTE: It is recommended that you submit an OpenTravel comment to formally add any extended enumerations to the OpenTravel Specification to maximize trading partner interoperability.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:element>
<xsd:element name="Name" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation xml:lang="en">The code and short nameof the booking channel.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="primaryInd" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation xml:lang="en">Indicates whether the enumerated booking channel type is the primary means of connectivity used by the source.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="id" type="String_Short" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">A unique booking channel ID.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element name="Agent" minOccurs="0">
<xsd:annotation>
<xsd:documentation xml:lang="en">Travel agent identification and authentication information.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="sine" type="String_Short" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">A unique identification of an agent location that typically includes a four digit personal identification number, a two character agent identifier and a duty code.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="pseudoCityCode" type="Code_PseudoCity" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">A three to five character code (alpha, numeric, or combination) that specifies a GDS code used to identify a travel agency location. Typically required when using negotiated rates to associate the rates to an agency.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="dutyCode" type="Code_AgentDuty" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">Typically a two to five character code (alpha, numeric, or combination) code that specifies a travel agents duty code that is used for agency authentication.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="terminalID" type="String_Short" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">The electronic address of the device from which information is entered.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element name="AirInfo" minOccurs="0">
<xsd:annotation>
<xsd:documentation xml:lang="en">Identification and authentication information related to airline travel requests.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="ERSP" type="Code_IATA_ERSP" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">A unique IATA (in cooperation with ATA and ARC) code used as a means of identification when performing online bookings with airlines. Source: http://bit.ly/OTA2_ERSP</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="airlineVendorID" type="Code_IATA_AirlineID" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">A two character IATA assigned airline code. Source: http://bit.ly/OTA2_IATA_AirlineCode</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="airportCode">
<xsd:annotation>
<xsd:documentation xml:lang="en">A three character IATA assigned airport code. Source: http://bit.ly/OTA2_IATA_AirportCodes</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="firstDeparturePoint" type="Code_IATA_Airport" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">An IATA airline or city code for the point of first departure in a trip. Source: http://bit.ly/OTA2_IATA_AirportOrLocationCode</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element name="Location" minOccurs="0">
<xsd:annotation>
<xsd:documentation xml:lang="en">Localization information, including requestor country and local currency.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="TimeZone" type="TimeZone" minOccurs="0">
<xsd:annotation>
<xsd:documentation xml:lang="en">The time zone of the requestor.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="ISOCountry">
<xsd:annotation>
<xsd:documentation xml:lang="en">The country code of the requesting party in ISO 3166 format. Source: http://bit.ly/OTA2_ISO3166</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="ISOCurrency" type="Code_ISO_Currency" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">Specifies a three character currency code in ISO 4217 format. Source: http://bit.ly/OTA2_ISO4217</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element name="Position" type="String_Short" minOccurs="0">
<xsd:annotation>
<xsd:documentation xml:lang="en">Specifies the geographical position of a requestor.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="requestorID" type="String_Short" use="required">
<xsd:annotation>
<xsd:documentation xml:lang="en">A unique identification for the requestor that is known between trading partners and other basic identifying information for the entity making the request.
NOTE: This ID is typically a unique ID agreed upon between trading partners, or the some other entity assigned ID, including ATA/IATA number, Electronic Reservation Service Provider ID and/or Association of British Travel Agents ID.
NOTE: The type specified is associated with this ID.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="idContext" type="String_Short" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">May be used to specifiy the source of the requestor ID, such as IATA, ARC, and ERSP.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="url" type="URL" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">A URL that identifies the location associated with the ID in a W3C recommended format. Source: http://bit.ly/W3C_Specification</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="travelSegment" type="Enum_TravelSector">
<xsd:annotation>
<xsd:documentation xml:lang="en">The travel segment associated with the requestor type, e.g. hotel, cruise, day tour, rental car and airline.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="messagePassword" type="String_Short" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">A message password that provides an additional level of security that the recipient can use to validate the sending party's authority to use the message.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="domain" type="String_Short" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">The domain associated with the message password and/or requestor ID.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="instance" type="String_Short" use="prohibited">
<xsd:annotation>
<xsd:documentation xml:lang="en">The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element name="Results" minOccurs="0">
<xsd:annotation>
<xsd:documentation xml:lang="en">This element contains the transaction processing status and conditions.
NOTE: If any processing conditions have ocurred, there will be a compensation (human intervention) or resend indicator.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="failureInd" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">When TRUE, a transport, validation, application and/or business logic condition has ocurred.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="status" use="required">
<xsd:annotation>
<xsd:documentation xml:lang="en">The status of the transaction processing.
1. If Complete, the transaction was processed with no business warnings or errors generated.
2. If NotProcessed, a condition ocurred and the failureInd will be TRUE.
3. If Incomplete, a condition ocurred that prevented the completion of the requested action.
4. If Unknown, a condition has ocurred and either the retryInd or compensationInd may be set to TRUE.</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="Enum_ProcessingStatus" />
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="retryInd" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation xml:lang="en">When the failureInd is TRUE and the retryInd is TRUE, a condition has ocurred that does not require human intervention and the transaction may be resent.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="compensationInd" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation xml:lang="en">When the failureInd is TRUE and this compensationInd is TRUE, a condition has ocurred that may require human intervention.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="moreDataToken" type="String_Medium" use="prohibited">
<xsd:annotation>
<xsd:documentation xml:lang="en">The response returns this attribute if there was additional data. The text value should be echoed in this request to indicate where to begin the next block of data.TIED to biz warnings and errors.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="retransmissionInd" type="xsd:boolean" use="prohibited">
<xsd:annotation>
<xsd:documentation xml:lang="en">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.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="maxResponses" type="xsd:positiveInteger" use="prohibited">
<xsd:annotation>
<xsd:documentation xml:lang="en">The maximum number of responses to receive from a request message.
NOTE: Check with your trading partners that they support this functionality or this attribute may be ignored.
BJL- Add this only to search, avail, etc. messages that would use it.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
|
XSD Schema Diagram:
