All Schema files in the OTA specification are made available according to the terms defined by the OTA License Agreement at http://www.opentravel.org/ota_downloads_form.cfm
Returns information about hotel properties that meet the requested criteria, indicating whether the requested service, rate, room stay, etc. is available within the date(s) specified. The response message may include Warnings from business processing rules, or Errors if the request did not succeed.
A quick view of the requested hotels' general availability for each day in the requested range.
Details on the hotel stay including the type of availabilty and the date range for which it applies.
Restrictions pertaining to the availability.
Stay restriction that applies to the availability.
minimum length of stay restriction
maximum length of stay restriction
fixed length of stay restriction
Used in conjunction with the RestrictionType and the TimeUnit to define the restriction length.
A time unit used to apply this status message to other inventory, and with more granularity than daily. Values: Year, Month, Week, Day, Hour, Minute, Second.
Used to specify an availability status at the Hotel Stay level for a property.
The time span during which the availability applies.
Property Information for the Hotel Stay.
References one or more room stays associated with this hotel stay.
Details on the Room Stay including Guest Counts, Time Span of this Room Stay, and financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.
Information by which this availability quote can be later cross-referenced.
The date and time at which this availability quote was made available.
A container for the unique references to the services for the room stay.
Indicates the RoomStay is an alternate offer. Default=false.
Used to specify an availability status at the room stay level for a property.
A reference to a requested room stay candidate from the SearchCriteria.
The availability response returns the attribute if there is additional data that could not fit within the availability response. The text value should be echoed in the availability request to indicate where to begin the next block of availability data.
Used to specify the source of the data being exchanged as determined by trading partners.
Identifies the room stay for use in the hotel stay.
May be used as a simple true/false to indicate availability or used in conjunction with @AvailabilityStatus to indicate if restricted rate qualifications have been met e.g. Exclusive and Available (true) vs. Exclusive but not Available (false).
A text field used to indicate that there are additional rates that cannot fit in the availability response. The text returned should be meaningful in identifying where to begin the next block of data and sent in the availability request.
Element to capture creation and last update data.
Describes the action taken on the record.
Name of individual who originated or updated record.
Free text comment added by the person accessing the profile record.
Type of action taken on the profile.
Month, day, year and optionally in hour, minute, second of day in ISO 8601 format of the action taken on the profile.
The identifier of the system that performed the action on the profile record.
Allows for control of the sharing of access data between parties.
Month, day, year and optionally hour, minute, second of day the profile originated, in ISO 8601 format.
Defines an entity that provides travel services or benefits to a customer or company.
Detailed information for a membership organization that has travel benefits, programs or discounts.
Employer information associated to this affiliation.
Information on the organization responsible for arranging travel.
A club that offers special privileges and related services for this affiliation.
Travel insurance associated to this affiliation.
Allows for control of the sharing of affiliation data between parties.
Section of a business profile that contains information about trading partner agreements.
Information about certifications or accreditations.
Information about alliance partnerships and consortiums.
Information about an agreement for a commission arrangement.
Allows for control of the sharing of agreements data between parties.
Provides information about alliance partnerships and consortiums of members grouped together to obtain trading partner agreements for travel service and privileges.
Identification of a company that participates in an alliance or consortium to which the primary business entity identified in this profile belongs.
Identifies the alliance or consortium member by code.
Identification of the alliance or partnership in which the business entity is a member.
Provides the effective and expiry dates for the alliance partnership.
Information about certifications or accreditation held by the company.
The Certification Identification number assigned to a business entity by the certifying body. This number would presumably be the ID in the Unique ID.
Indicates the alliance status of the company.
Provides the effective and expiry date of the certification.
Contains information about agreements for commission arrangements with the business entity.
Allows for control of the sharing of data between parties.
Identifies a commission plan agreement between trading partners by plan code.
Identifies a rate for paying commissions; can be a decimal value based on percentage paid for the commission plan, or a flat rate.
Detailed information about a company.
Detailed name information for the company.
Detailed information on an address for the company.
Information on a telephone number for the company.
Provides details of a telephone number.
Information on an email address for the company.
Information on a URL for the company.
A jurisdiction in which a company is authorized to do business. Uses the Address entity to indicate the location of business using any of the components of the address (e.g., city, state, zip code, country).
Method of providing funds for travel by the company.
Information on a contact person for the company.
Information on the organization responsible for arranging travel for the company.
Company's loyalty program information.
Company or organization that employs the customer.
The name of the company.
The name of a company affiliated with the employer.
Information about the employee.
Accounting code(s) assigned to travel for employer.
Information on the organization responsible for arranging travel for the employer.
Employer's loyalty program information.
Indicates that the receiving system should assume the default value if the user specifies no overriding value or action.
Designates the office category within an organization.
Used to send the effective date and/or expiration date.
Travel insurance carried by the customer or company.
Name of the person insured.
Name of the insurance company.
Underwriting company providing coverage.
Allows for control of the sharing of insurance data between parties.
Type of insurance policy carried by the individual or company.
Identifier assigned by insurance company to the insurance policy.
The effective and expiry dates for this policy.
A unique reference for this insurance policy within this message.
Identifies a membership or loyalty program offered by the company by name of the program.
Identification of the loyalty program by code.
Indicates the alliance status of the loyalty program.
Indicates special privileges in program assigned to individual.
A unique reference for a loyalty program within this message.
Membership organization that has travel benefits, programs, or discounts.
Name of the member of the organization, as listed among the options of customer names.
Provides member information.
Name of the organization.
An organization that is related to this organization.
Information on the company responsible for arranging travel for the organization.
Indicates whether the organization is the default choice among several.
Allows for control of the sharing of organization data between parties.
The effective and expiry dates for this organization membership.
Designates the office category within an organization.
Needs of the traveler related to travel experiences.
Aggregation of customer travel needs.
Supplier-independent preferences.
A set of preferences for vehicle rental.
A set of preferences for air travel.
A set of preferences for hotel stay.
A set of preferences for other services.
Allows for control of the sharing of data between parties.
Refer to OTA Code List Travel Purpose (TVP).
Allows for control of the sharing of data between parties.
Root element for profile content.
A collection of actions taken on a record.
Detailed customer information for this profile.
A collection of preference collections.
Company information related to the profile.
Affiliation information related to the profile.
Agreement information related to the profile.
Comments related to the profile.
Used to indicate whether information can be shared.
Used to specify a profile type.
Creation date time, creator ID, last modification date time and last modifier ID.
This is a reference placeholder, used as an index for this guest in this reservation.
A collection of Profile objects or Unique IDs of Profiles.
Companies or individuals responsible for making travel plans or transactions either for the customer or company.
Indicates that the receiving system should assume the default value if the user specifies no overriding value or action.
Allows for control of the sharing of travel arranger data between parties.
Type of service making travel plans or transactions (e.g., travel agency, etc.).
A unique reference for a travel arranger within this message.
Identifies a travel club that offers special privileges and related services.
Name of the travel club.
Name information for the club member.
Identifier assigned to person registered with travel club.
Allows for control of the sharing of travel club data.
The effective and expiry dates for this travel club membership.
Identifies a collection of preferences for airline travel.
Identifies the preferred loyalty program(s).
Identifies the preferred airline carrier(s) by name.
Preferred form(s) of payment.
Identifies the preferred origination airport for travel (using IATA airport codes).
Indicates the preferred connection airport(s) (using IATA airport codes)..
Indicates preferred fare restrictions to be used in search.
Indicates preferred flight characteristics to be used in a search (e.g., connections, stopovers).
Indicates preferred equipment type(s) to be used in a search.
Indicates preferred cabin(s) to be used in a search.
Indicates preferred seat characteristics. Refer to OTA Code List Seat Preference (STP) for codes.
Indicates preferred ticket distribution method (e.g., fax, eMail, courier, mail, airport pickup)
Indicates preferred meal type (e.g., vegetarian, Kosher, low fat)
Indicates preferred special request(s) to be used with this collection of preferences.
Indicates Special Service Request preference type.
Media and entertainment preferences.
Indicates preferred information for pet accompanying traveler.
Category of airline passenger, using standard ATPCO codes.
Type of airline ticket preferred for this collection.
Departure airport preferences, using IATA airport codes.
Indicates preferences for type of airplane.
Indicates if an airplane with multiple aisles is preferred.
Indicates preferences for choice of airline cabin.
Indicates preferred airline cabin.
Identifies preferences for airfare restrictions acceptable or not acceptable for a given travel situation.
Refer to OTA Code List Fare Restriction (FAR).
A date that is associated to the fare restriction.
Indicates preferences for certain types of flights, such as connections or stopovers, when used for a specific travel situation.
Indicates type of stops preferred (Nonstop, Direct, Connection).
Indicates that if connection is chosen, then this attribute defines the maximum number of connections preferred.
To specify which types of non-scheduled air service should be included.
Only include non scheduled flights that are charter flights.
Do not include non scheduled flights that are charters.
Include both charter non scheduled flights and those that are not charters.
If true, include connections where one of the enroute stops is the same as the initial board point or the final off point of the flight.
If true, include flights that include at least one leg that is ground transportation.
If true, direct and non-stop flights are requested.
If true, only non-stop flights are requested.
If true, only online connection flights are requested (i.e., same marketing airline).
Specifies the travel routing preference.
No special conditions.
Outbound and inbound route of travel must be the same.
When true, exclude connections that include travel by train for one of the legs.
Identifies preferences for special services required for air travel, using standard industry (SSR-OSI) code list.
Code of the special service request to be used for this air travel situation. Refers to standard industry code list.
Indicates preferences for seats or seat types.
Indicates preferences for the size and features of hotel bed types.
Indicates the level of preference for the bed type requested.
Indicates the hotel bed type requested. Refer to OTA Code List Bed Type (BED).
Indicates preferences for type of business services in a hotel.
Identifies the customer's level of preference for the hotel business service identified.
Identifies the types of business services offered by the hotel. Refer to OTA Code ListBusiness Srvc Type (BUS).
Indicates preferences for type of food service facilities in a hotel.
Identifies the customer's level of preference for the hotel food service identified.
Identifies the types of food services offered by the hotel. Refer to OTA Code List Main Cuisine Code (CUI).
These are the hotel preference elements used on an instance of a profile.
Code identifying preferred hotel rate plan for this travel situation
Category of hotel guest. Refer to OTA Code List Hotel Guest Type (GUE).
Indicates preferences for type of personal services in a hotel.
Identifies the customer's level of preference for the hotel personal service identified.
Indicates preferences for type of features required to meet the needs of persons with physical challenges, disabilities, etc.
Identifies the customer's level of preference for the hotel physically challenged feature identified.
Identifies the types of features the hotel offers to service physically challenged guests. Refer to OTA Code List Physically Challenged Feature Code (PHY).
Indicates preferences for hotel property amenities.
Identifies the customer's level of preference for the hotel property amenity identified.
Identifies the amenities offered by the hotel. Refer to OTA Code List Hotel Amenity Code (HAC).
Indicates preferences for class of hotel property.
Identifies the customer's level of preference for the hotel property class identified.
Identifes the classification of the property. Refer to OTA Code List Brand Category Code (BCC).
Indicates preferences for hotel property locations.
Indicates the level of preference for the property location identified.
Identifies the propery location type. Refer to OTA Code List Location Category Codes (LOC).
Name of preferred hotel property associated with this collection.
Identifies the customer's level of preference for the hotel property identified.
The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.
Indicates preference for hotel property types.
Identifies the customer's level of preference for the hotel type identified.
Indicates preferences for type of recreation services in a hotel.
Identifies the customer's level of preference for the hotel recreational service identified.
Identifies the recreational services offered by the hotel. Refer to OTA Code List Recreation Srvc Type (RST).
Indicates preferences for hotel room amenities.
Identifies the customer's level of preference for the hotel room amenity identified.
Identifes the types of room amenities offered by the property. Refer to OTA Code List Room Amenity Type (RMA).
This attribute is used to explicitly define whether an amenity or service is offered. Refer to OTA Code list Option Type Code (OTC). This is used in conjunction with RoomAmenity.
Used to designate the quality level of the RoomAmenity e.g., premium, deluxe, standard, economy.
Indicates preferences for hotel room locations.
Identifies the customer's level of preference for the hotel room location identified.
Identifies the location of the room within the property. Refer to OTA Code List Room Location Type (RLT).
Indicates preferences for type of security features in a hotel.
Identifies the customer's level of preference for the hotel security feature identified. Refer to OTA Code List Security Feature Code (SEC).
A grouping of elements including Guest Counts, Time Span, pointers to Res Guests, guest Memberships, Comments and Special Requests and finally finacial information including Guarantee, Deposit and Payyment and Cancellation Penalties.
A collection of Guest Counts associated to the whole Reservation or a particular Room Stay or Service. A child Guest Count element is required for each distict age group.
The Time Span which covers the Reservation, Room Stay or Service.
A collection of ResGuestRPH objects.
A collection of Membership objects. Memberships provides a list of reward programs which may be credited with points accrued from the guest's activity. Which memberships are to be applied to which part is determined by each object's SelectedMembershipRPHs collection.
A collection of Comment objects. Comments which apply to the whole Reservation or a particular Room Stay or Service.
The SpecialRequest object indicates special requests for the whole Reservation, or a particular Room Stay or Service.
The guarantee information associated to the Reservation or a particular Room Stay or Service.
A collection of deposit and/or payments.
A collection of Cancellation Penalties objects.
A collection of fees that applies to the reservation.
The total amount charged for the accommodation including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.
A collection of unsigned integers serving as reference placeholders, and used as an index identifying which guests occupy this room
This is a reference placeholder, used as an index for this guest in this reservation. In the ResGuest object it is used like all other RPH attributes to send the delta of a reservation. It is used by the RoomStay and Service objects to indicate which guests are associated with that room stay or service.
A unique reference to the guest.
A collection of unsigned integers that reference the RPH (Reference Place holder) attribute in the Service object. The ServiceRPH attribute in the Service object is an indexing attribute that identifies the services attached to a specific guest or to the reservation.
This is a reference placeholder used as an index for a service to be associated with this stay
Provides a unique reference to the service.
Defines whether this is for each room of a RoomStay
A collection of Service objects. This is the collection of all services associated with any part of this reservation (the reservation in its entirety, one or more guests, or one or more room stays). Which services are attributable to which part is determined by each object's ServiceRPHs collection.
A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges.
The selling price of this Service.
Details on the Service including Guest Counts, Time Span of this Service, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Service and finally financial information related to the Service, including Guarantee, Deposit and Payment and Cancellation Penalties.
An enumerated type that defines how a service is priced. Values: Per stay, Per person, Per night, Per person per night, Per use.
An enumerated type that defines the status of the reservation for this service.
The representation of the specific service being reserved.
The representation of the rate plan under which this service was booked.
The representation of the block code under which the inventory for this service is categorized.
Whether the price for this service is guaranteed or quoted and subject to change.
Values: False (Price NOT guaranteed) and True (Price is guaranteed).
Whether the price for this service is included in the room rate.
Values: False (or No), and True (or Yes).
The number of tickets, rounds of golf, etc. Also serves as the number of persons when pricing class is per person or per person per night.
When true, the service has been requested by the guest.
Used to send additional information.
Used to define the type of information being sent (e.g., rate description, property description, room information). Refer to OTA Code List Additional Detail Type (ADT).
Trading partner code associated to AdditionalDetailType
A collection of AdditionalDetail.
Used to send additional information.
Charges related to additional guests.
The amount charged for an additional guest.
Descriptive information regarding amounts charged for additional guests.
Increase the base rate by the additional occupant amount for each additional occupant of the same age group up to this maximum number of occupants of this age group.
A code representing the charges related to additional guests. Refer to OTA Code List Additional Detail Type (ADT). Typically, the 'extra person information' code would be used here.
The percent charged for an additional guest.
An index code to identify an instance in a collection of like items.
Defines the percentage basis for calculating the fee amount or the amount .
Indicates whether taxes are included when figuring the base amount.
Indicates whether fees, such as those imposed by a travel agency or other booking agent, are included when figuring cancel penalties.
The number of nights of the hotel stay that are used to calculate the fee amount.
Provides the basis for how the amount of the guarantee is calculated.
Uses the full stay as the basis.
Uses the nights as the basis.
Uses the first and last night as the basis.
The percentage used to calculate the amount.
Used to specify how the amount needs to be applied with respect to the stay.
Amount to be applied as a deposit for the first night.
Amount to be applied as a deposit for the last night.
Amount to be applied as a deposit for the first and last nights.
Amount to be applied as payment for the first night.
Amount to be applied as payment for the last night.
Amount to be applied as payment for the first and last nights.
Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description.
The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements.
A collection of charges that apply to for additional occupants, guests or service users (over and above the rate's MaxGuest Applicable)
Collection of incremental charges per age qualifying code for additional guests. Amount charged for additional occupant is with respect to age group of the base guests.
A collection of Fees.
A collection of Cancellation Policies
A collection of Payment Policies.
Discount percentage and/or Amount, code and textual reason for discount
Used to identify the monetary amount to which the discount applies.
Indicates the discount applies to the amount identified in the Base element.
Indicates the discount applies to the amount identified in the AdditionalGuestAmount element.
Indicates the discount applies to the amount identified in the Fee element.
Used to identify the specific item referred to by the AppliesTo attribute.
The total amount charged for this rate including additional occupant amounts and fees.
Description of the rate associated with the various monetary amounts and policies.
Collection of additional charges.
Amenities or services to which a charge applies.
The amount charged for an amenity or service.
Identifes the types of room amenities to which a charge applies. Refer to OTA Code List Room Amenity Type (RMA).
Total additional charges before taxes.
Total additional charges after taxes.
Currency code and number of decimal places used.
Candidate for removal in 2007B. Usage is not recommended. Deprecation Warning added in 2007A.
The period during which the booking must be made.
The period of time during which the booking must be made.
The minimum lead time required for the booking.
The maximum lead time required for the booking.
The day(s) of the week either on which the booking may be made or the day(s) of arrival for the booking.
The effective date range for a charge.
Indicates the time unit for the rate.
Indicates the number of rate time units such as "3 Days".
Indicates the minimum number of guests at this rate.
Indicates the maximum number of guests at this rate.
Indicates the minimum length of stay.
Indicates the maximum length of stay.
Day of week guest is required to stay over in order to be eligible for this rate.
When true, indicates the amounts are provided in an alternate currency. When false, indicates the amounts are provided in the primary currency. This may be used to indicate that the currency provided is different from the requested or stored currency .
Defines an area determined by the hotel reservation system.
An area determined by the hotel reservation system.
The IATA city code; for example DCA, ORD.
The standard code or abbreviation for the state, province, or region.
The country in which the area is located.
An abbreviated short summary of hotel descriptive information.
A collection of VenderMessages
An element that identifies the geographic position of the hotel. The Position element uses the representation defined by ISO Standard 6709 to define a geographic point location.
Public address of the hotel property.
Contact numbers of the hotel property. Examples are telephone and fax numbers.
An element that identifies the hotel ratings.
The name of the award or ratings provider.
The actual award or rating received by the hotel facility.
Hotel-level amenities (pool, etc) for searching.
Refer to OTA Code List Hotel Amenity Code (HAC).
Identifies recreation facilities or amenities of interest.
Used to identify a specific recreation activity. Refer to OTA code list Recreation Srvc Type (RST).
Identifies services of interest.
Used to identify a specific business service. Refer to OTA code list Business Srvc Type (BUS).
Policy information for this hotel.
The checkin time required by this hotel for a room stay.
The checkout time required by this hotel for a room stay.
Identifies the segment (e.g., luxury, upscale, extended stay) of the hotel. Refer to OTA Codelist Segment Category Code (SEG).
The level of integration of a property to provide automated transaction information. The lower the number, the higher the integration (e.g., a 1 means the supplier has the highest level of integration automation).
A collection of CancelPenalty.
Defines the cancellation penalty of the hotel facility.
When true, indicates a cancel policy exits. When false, no cancel policy exists. Typically this indicator is used when details are not being sent.
The CancelPenalty class defines the cancellation policy of the hotel facility.
Cancellation deadline, absolute or relative.
Cancellation fee expressed as a fixed amount, or percentage of/or room nights.
Text description of the Penalty in a given language.
Confirm Class.
Policy Class.
Indicates that any prepayment for the reservation is non refundable, therefore a 100% penalty on the prepayment is applied, irrespective of deadline.
A system specific room type to which this cancellation penalty applies.
Days of week on which this room/rate combination is available.
Days of Week on which the guest can arrive.
Days of Week on which the guest can leave.
Days of Week on which the guest has to stay at the hotel.
Identifies and provides details about the discount.
Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent
)
When true, used to indicate the discount should not be displayed. When false, indicates the discount may be displayed.
The guarantee information to hold a reservation
Guarantee Detail
This is to indicate that the information in the model is the default (e.g. if PaymentCard information is completed then this would be considered the default if the boolean is true).
If true, no credit card holder information is required. If false, it is not required.
If true, the credit card holder name is required. If false, it is not required.
If true, credit card holder address is required. If false, it is not required.
If true, credit card holder phone number is required. If false, it is not required.
If true, the credit card interbank number is required. If false, it is not required.
When true, the booking source may be used to guarantee the booking.
When true, the corporate discount number may be used to guarantee the booking.
Used to specify the method of guarantee. Refer to OTA Code List Payment Type (PMT).
Provides the identifier as specified by the GuaranteeTypeCode (e.g., Corporate ID or IATA number).
Guarantee deadline, absolute or relative
Text description of the Guarantee in a given language.
An enumerated type defining the type of action taken when the deadline has been exceeded. Valid values: Res Automatically Cancelled, Res No Longer Guaranteed.
Guarantee Code
GuaranteeType : GuaranteeType An enumerated type defining the guarantee to be applied to this reservation.
A guarantee is required.
No guarantee is required.
Indicates prepayment, typically this means payment is required at booking.
The room will held up until this time without a guarantee.
A collection of GuestCount by age group.
A recurring element that identifies the number of guests and ages of the guests in the request that determines the rates based on business rules for occupancy at each property.
IsPerRoom means that the guests defined in the GuestCounts object apply to each room in the NumberOfRooms for the RoomStay. Value of "false" means that the guests defined in the GuestCounts object apply to all rooms combined in the NumberOfRooms for the RoomStay.
A collection of Profile objects or Unique IDs of Profiles.
Hotel level amenities for searches.
Refer to OTA Code List Hotel Amenity Code (HAC).
When true, there is no charge for the amenity. When false, there is a fee associated with the amenity.
Room level amenities for searches.
An element that identifies the hotel ratings.
The name of the award or ratings provider.
The actual award or rating received by the hotel facility.
Identifies recreation facilities or amenities of interest.
Used to identify a specific recreation activity. Refer to OTA code list Recreation Srvc Type (RST).
Identifies services of interest.
Used to identify a specific business service. Refer to OTA code list Business Srvc Type (BUS).
The representation of the specific service being reserved.
The number of services (e.g., tickets, rounds of golf).
Identifies transportation facilities.
Used to define the mode of available transportation. Refer to OTA Code List Transportation Code (TRP).
Range of dates, or fixed set of dates for Availability Request. Date range can also be specified by using start dates and number of nights (minimum, maximum or fixed).
Requested rate or rate range. Repeats to allow the identification of multiple ranges for multiple room stay candidates.
Used to associate a rate range with a room stay candidate.
This supports returning a type of rate (minimum, maximum, etc.) as an alternative to returning a specific rate. Refer to OTA Code List Rate Mode (RMO).
Collection of requested rate plans.
A collection of profile objects or unique IDs of profiles.
Collection of room stay candidates.
Element used to identify available room products.
Provides the ability to search for hotel(s) based on whether they accept specific form(s) of payment.
A collection of Membership objects. Memberships provides a list of reward programs which may be credited with points accrued from the guest's activity. Which memberships are to be applied to which part is determined by each object's SelectedMembershipRPHs collection.
The SelectedMembership object identifies the frequent customer reward program and (optionally) indicates points awarded for stay activity.
The code or name of the membership program ('Hertz', 'AAdvantage', etc.).
The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)
The account identification number for this particular member in this particular program.
The total number of points earned through the selected membership.
Identifies the travel sector. Refer to OTA Code List Travel Sector (TVS).
Element used to identify available products and rates.
A collection of hotel identifiers to which the rate plan applies.
Information to identify one or more hotels.
Defines which meals are included with this rate plan.
Defines which meals are included with this rate plan.
A unique identifier for this rate plan candidate.
Defines the details of the rate plan as used in the booking process.
Policies and descriptions that apply to a rate plan.
Information significant to defining a rate plan.
Guarantee information that applies to the rate plan. A maximum of 5 occurances are available for use depending on the context.
Collection of cancellation penalties.
Describes the rate plan.
Defines charges that are included in this rate plan.This element allows for future extension should there be a need.
Description of what is included in the rate plan.
Commission associated with the RatePlan. This can be a percentage or a flat amount.
Defines which meals are included with this rate program.
Defines which meals are included with this rate program.
Used to indicate whether the rate is on request or available.
This is used to indicate the item booked and is primarily used to exchange information with GDSs.
The RatePlanCode assigned by the receiving system for the inventory item in response to a new rate plan notification. (Implementation Notes: This would only be returned when the notification is of type New and the sender is translating RatePlanCode values. On subsequent transactions for this rate plan, the sender would populate the RatePlanCode attribute with this value returned by the receiver.)
Information pertaining to the availability of the rate plan.
An enumerated type that allows the query to specify a rate category type, and provides major categories for comparison across brands. Refer to OTA Code List Rate Plan Type (RPT).
A text field used to provide a special ID code that is associated with the rate and is required in the reservation request in order to obtain the rate. Examples are a corporate ID number, a promotion code or a membership number.
Provides the name of the rate plan or group. Typically used with RatePlanType to further describe the rate plan.
The code that relates to the market being sold to (e.g., the corporate market, packages).
Used to specify an availability status for the rate plan.
When true, indicates proof of qualification for this rate is required.
When true, the price for this rate plan can be viewed by the guest. When false, the guest must contact another entity to obtain price information.
Indicates the type of document required by the guest to qualify for this rate plan. Refer to OTA Code List Document Type (DOC).
Individual rate amount. This rate is valid for a range of number of occupants and an occupant type.
The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts as well as payment and cancellation policies. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount The applicable period of the the rate are indicated by the effective dates. Restrictions that may apply to that rate, such as the minimum or maximum length of stay, stay-over dates (such as a Saturday night), min/max guests applicable for the rate, and age group (ex Adult) are attributes of Rate. It indicates the number of units that the quoted rate is based upon, as well as the TimeUnits type used that the rate is based upon, e.g.: 3days at $100.00 per day.
This supports returning a type of rate (minimum, maximum, etc.) as an alternative to returning a specific rate. Refer to OTA Code List Rate Mode (RMO).
When true, this indicates the rate data is not real-time.
The source from which the rate was acquired.
Used to identify the type of rate. Refer to OTA code list Rate Plan Type (RPT).
Specifies how the room is priced (per night, per person, etc.).
A collection of required payments.
Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.
Collection of forms of payment accepted for payment.
Payment expressed as a fixed amount, or a percentage of/or room nights.
Payment deadline, absolute or relative
Text description of the Payment in a given language.
The address to which a deposit may be sent.
The name of the reciever of the payment.
An enumerated type defining the type of action taken when the deadline has been exceeded. Valid values: Res Automatically Cancelled, Res No Longer Guaranteed.
This defines the form of payment. Recommended usage of this is with the Payment Type in OTA Code List, this datatype will be updated in the future.
In order to maintain forward compatability a change is not being made in this publication. This will be corrected in a future version, when a major update is released.
Used to specify the type of information being sent (i.e., RequiredPayment, GuaranteePolicy, AcceptedPaymentForms)
A required payment, such as a deposit due or payment in the event of cancellation.
Used to define policies required to guarantee a reservation at the property (e.g., room(s), function space(s)).
Used to define the acceptable payment forms of the property.
Guarantee Code
GuaranteeType : GuaranteeType An enumerated type defining the guarantee to be applied to this reservation.
Indicates prepayment, typically this means payment is required at booking.
The room will held up until this time without a guarantee.
If true, no credit cardholder information is required for guarantee/deposit.
If true, the credit cardholder name is required for guarantee/deposit.
If true, the credit cardholder address is required for guarantee/deposit.
If true, the credit cardholder phone number is required for guarantee/deposit.
If true, the Interbank Card Association number is required for guarantee/deposit.
A system specific room type to which this guarantee payment information applies.
To specify the source of the rate of exchange for a currency code.
When true, indicates that any prepayment for the reservation is non refundable, therefore a 100% penalty on the prepayment is applied, irrespective of deadline.
Used to specify the type of payment policy.
Individual rate amount. This rate is valid for a range of number of occupants and an occupant type.
Individual rate amount. This rate is valid for a range of number of occupants and an occupant type.
The description or name of a room rate.
A collection of features that are made available as part of this speciific room and this specifiic rate plan.
Allows for the description of any features and/or amenities that are made available as part of this specific room and this specifiic rate plan, for example, large screen television, video/DVD player in room, room service breakfast, and details about that breakfast.
Refer to OTA Code List Room Amenity Type (RMA).
Provides the quantity of the amenity in the room. When zero, the amenity is either unavailable or not allowed.
Specifies the type of view a room has. Refer to OTA Code List Room View Type (RVT).
The total of all rates for this room rate type.
Provides information on the availability of the room rate.
Used to specify an availability status for the room rate.
This is used to indicate the item booked and is primarily used to exchange information with GDSs.
Specfic system room type code, ex: A1K, A1Q etc.
Code that identifies an inventory block.
The number of rooms.
Used to specify an availability status for the room rate.
Used to identify available room products.
This element is used to pass room attributes. Typical attributes are smoking, non-smoking, wheelchair access, room location (low floor, high floor, close to elevator, etc) and view (garden, pool, ocean, etc)
A unique identifier for this room stay candidate.
Used to refer to the Rate Plan Candidate associated with this room stay.
Used to specify the booking code for which availability is requested.
Identifies the dates when the RoomStayCandidate is applicable when there are multiple room stay requirements within a StayDateRange.
Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally finacial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.
A collection of Room Types associated with a particular Room Stay.
The RoomType element is used to contain all the room type information for a single RateType Code (ex A1K) for a given date range.
A collection of Rate Plans associated with a particular Room Stay.
The rate plan element is used to contain all the rate information for a single Rate Plan Code (ex RACK) for a given date range. A given Rate Plan may have variable rates, over the effective period of the Rate Plan, this is represented by the child element Rates.
A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount.
The combination of a given Rate Plan and Room Type. This allows for support for systems where Rate Plans are child of Room Type as well as systems which Room Types are child of Rate Plans.
The period during which the booking must be made.
The period of time during which the booking must be made.
The minimum lead time required for the booking.
The maximum lead time required for the booking.
The day(s) of the week either on which the booking may be made or the day(s) of arrival for the booking.
A collections of restrictions.
Information on the restriction associated with the RoomRate element.
A collection of day of week restrictions.
The effective date range for which the restriction applies.
When true, indicates more rates exist. When false, all rate information is provided.
A collection of Guest Counts associated with Room Stay. A child Guest Count element is required for each distinct age group.
The Time Span which covers the Room Stay.
The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.
A collection of deposit and/or payments for the Room Stay.
A collection of Cancellation Penalties objects for the Room Stay.
Discount percentage and/or Amount, code and textual reason for discount.
The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.
Property Information for the Room Stay.
The code that relates to the market being sold to (e.g., the corporate market, packages).
To specify where the business came from e.g. radio, newspaper ad, etc.
Identifies the status of the room stay.
This references the RPH found in the Warning element. Used to identify the warnings associated with this RoomStay.
Provides details regarding rooms, usually guest rooms.
Textual information regarding the room.
A collection of additional details.
A collection of amenity information.
Used to provide room amenity information.
Indicates the room is a sleeping room when true.
Indicates the room is converted when true.
Indicates the room is an alternate room type to the requested room type when true.
Denotes the form of guarantee for this room.
Provides details of the room type.
Base age group of occupants for which this rate is valid (ex Adult).
Defines an age range or age category of a guest (e.g., under 21, over 65, teen, infant). Refer to OTA Code List Age Qualifying Code (AQC).
MinAge: The minimum age to qualify for AgeQualifyingCode
Max Age: The maximum age to qualify for AgeQualifyingCode
TimeUnit : Qualifier for Age
Defines the number of guests.
A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). This attribute allows for an increase in rate by occupant class. Refer to OTA Code List Age Qualifying Code (AQC).
Defines the age of a guest.
The number of guests in one AgeQualifyingCode or Count.
Used to identify meals that are included.
When true, indicates breakfast is included.
When true, indicates lunch is included.
When true, indicates dinner is included.
When true, a meal plan is included in this rate plan. When false, a meal plan is not included in this rate plan.
Used to identify the types of meals included with a rate plan. Refer to OTA Code List Meal Plan Type (MPT).
The RatePlanCode assigned by the receiving system for the inventory item in response to a new rate plan notification. (Implementation Notes: This would only be returned when the notification is of type New and the sender is translating RatePlanCode values.
On subsequent transactions for this rate plan, the sender would populate the RatePlanCode attribute with this value returned by the receiver.)
An enumerated type that allows the query to specify a rate category type, and provides major categories for comparison across brands. Refer to OTA Code List Rate Plan Type (RPT).
A string value may be used to request a particular code or an ID if the guest qualifies for a specific rate, such as AARP, AAA, a corporate rate, etc., or to specify a negotiated code as a result of a negotiated rate.
A text field used to indicate a special ID code that is associated with the rate and is essential in the reservation request in order to obtain the rate. Examples are Corporate ID.
The Rate Plan Qualifier is used to control the sort order of RatePlans. Those Rate Plans that are not qualified will appear first, those that are qualified will appear last.
Hotel systems often group multiple rate plans into a single category. This refers to that category that is specific to the hotel CRS/PMS and should not be confused with a GDS rate category.
Indicates the type of data to be returned, either a list of hotel records or a list of area (city/reference) codes.
Defines whether the response is a propety list or an area list.
Provides the ability to control if rate information is to be returned within the response.
Provides the ability to request full complete rate details for a specific rate plan(s).
Indicates that the reply content reflects active profile preferences.
Describes the status of a restriction on a room and/or rate.
When true, this indicates sell through is open and when false, this indicates sell through is closed. Typically this would be used in conjunction with the Status attribute to indicate that bookings may be allowed based on a trading partner agreement even though one or more days are closed.
Used to define a room (eg. its location, configuration, view).
(formerly, RoomInventoryCode) A code value that indicates the type of room for which this request is made, e.g.: double, king, etc. Values may use the Hotel Descriptive Content table or a codes specific to the property or hotel brand.
Specific system room type code, ex: A1K, A1Q etc.
Indicates the category of the room. Typical values would be Moderate, Standard, or Deluxe. Refer to OTA Code List Segment Category Code (SEG).
A string value representing the unique identification of a room if the request is looking for a specific room.
Floor on which the room is located.
A code or identification number that identifies the room stay as part of a group, package tour, or block of rooms designated in the inventory.
Indicates the location of the room within the hotel structure. Typical values would be "Near Exit","Close to elevator", "Low Floor" or "High Floor". Refer to OTA Code List Room Location Type (RLT).
Indicates the view of the room. Typical values would be "Ocean view", "Pool view" or "Garden View". Refer to OTA Code List Room View Type (RVT).
Indicates the type of bed(s) found in the room. Typical values would be Double, Twin, Queen, or King. Refer to OTA Code List Bed Type Code (BED).
Non-smoking indicator.
Textual description of room configuration.
Textual description of room dimensions.
Defines the number of the item in question.
Indicates that the room (suite) is a composite of smaller units.
Specifies the room classification (e.g., cabin, apartment). Refer to OTA Code List Guest Room Info (GRI).
Specifies the architectural style of a room. Refer to OTA Code List Architectural Style Code (ARC).
Identifies the availability status of an item.
Inventory is available for sale.
Inventory is not available for sale.
Inventory is not available for sale to arriving guests.
Inventory may not be available for sale to arriving guests.
Inventory may be available.
Identifies an address preference.
Defines a physical address.
Allows for control of the sharing of address preferences between parties.
Identifies preferences for common travel needs not associated with a specific travel service.
Enables a preference to be indicated for name information.
Enables a preference to be indicated for telephone information.
Enables a preference to be indicated for address information.
Enables a preference to be indicated for form of payment.
Enables a preference to be indicated for a traveler's interests.
Enables a preference to be indicated for insurance.
Enables a preference to be indicated for seating.
Enables a preference to be indicated for a method of ticket distribution.
Enables a preference to be indicated for media and entertainment.
Enables a preference to be indicated for pet information.
Enables a preference to be indicated for food and beverage.
Enables a preference to be indicated for a loyalty program.
Enables a preference to be indicated for a special request.
Enables a preference to be indicated for a related traveler.
Allows for control of the sharing of common preferences between parties.
Used to indicate if smoking is preferred.
Used to specify the preferred language.
Used to specify the preferred alternate language.
Identifies a preferred company by name.
Used to specify the preference level for this company.
Identifies a preference for a travel insurance policy.
Used to specify the preference level for this insurance policy.
Index number to be used for reference the insurance policy to be used in this travel collection.
Identifies a preference for a traveler's interest.
Used to specify the preference level for a traveler's interest.
Identifies a preference for a loyalty program.
Used to specify the preference level for this loyalty program.
Identification of loyalty program by reference number or index.
Identifies a food and beverage preference.
Used to specify the preference level for a meal type.
Type of meal required (e.g.,vegetarian, Kosher, low fat, etc.)
Dining preferences used with this collection.
Type of drink(s) preferred.
Media and entertainment information preferences.
Used to indicate a level of preference for media or entertainment.
Enables a preference to be indicated for name information.
Unique identifier for a person or profile.
Name information.
Used to indicate a level of preference for name information.
Identifies other service preferences.
The name identfiying the service.
Enables a preference to be indicated for a vendor.
Enables a preference to be indicated for a loyalty program.
Enables a preference to be indicated for a form of payment.
Enables a preference to be indicated for a special request.
Used to indicate a level of preference for a service perference.
Allows for control of the sharing of data between parties.
Refer to OTA Code List Travel Purpose (TVP).
Identifies a form of payment preference.
Used to indicate a level of preference for a form of payment.
The unique reference for a payment form within this message.
Indentifies preferences regarding a pet.
Used to indicate a level of preference for pet information.
Identifies a telephone number preference.
Identifies a telephone number.
Information about a telephone number, including the actual number and its usage.
Identifies a preference for a name of a related traveler.
Unique identifier for a related traveler.
Used to indicate a level of preference for a related traveler.
Identifies a seating preference.
Used to indicate a level of preference for seat information.
Direction seat faces during travel, when conveyance allows.
Location of seat in cabin of conveyance. Suggested values include: Forward, Middle, Aft, ExitRow, Bulkhead, Right or Left Side, etc.
Preferred position of seat in a row, such as Aisle, Middle, Center, Window, etc.
Preferred row for seating, indicates specific row number and/or seat identifier.
Identifies special request preference.
Used to indicate a level of preference for a special request.
Identifies a preference for a type of ticket distribution.
Used to indicate a level of preference for a method of ticket distribution.
Ticket distribution method such as Fax, Email, Courier, Mail, Airport_Pickup, City_Office, Hotel_Desk,
WillCall, etc. Refer to OTA Code List Distribution Type (DTB).
Ticket turnaround time desired, amount of time requested to deliver tickets.
Identifes an action to take place.
Typically used to add an item where it does not exist or to update an item where it does exist.
Typically used to cancel an existing item.
Typically used to remove specified data.
Typically used to add data whether data already exists or not.
Typically used to overlay existing data.
Used for Alphabetic Strings, length exactly 3
Used for an Alpha String, length 4
Used forAlpha-Numeric Strings, length 1 to 19
Used for Alpha-Numeric Strings, length 1 to 8
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).
A cabin is either First, Business or Economy
First class compartment.
Business class compartment.
Economy (or sometimes referred to as Coach) class compartment.
A construct to validate either a date or a dateTime value.
A construct to validate either a date or a month and day value.
A construct to validate either a date or a time or a dateTime value.
A three letter abbreviation for the days of the week (e.g. may be the starting date for the availability requested, days of operation, rate effective day, etc.).
This simple type defines a set of valid values for the units in which distance is measured (i.e. mile or kilometer).
Allows for the specification of a night duration.
Identifies a particular type of flight - Direct, Stopover etc.
Indicates the flight does not make any scheduled stops between 2 points.
Indicates the flight makes a scheduled stop(s) between 2 points.
Indicates the flight will require a change of aircraft at a connecting point(s).
A trip with only one connection.
A trip with only two connections.
Indicates that the flight makes only one stop.
A union between TransactionActionType and PMS_ResStatusType. Used in messages that communicate between reservation systems as well as between a reservation and property management system. In addition to the TransactionActionType and PMS_ResStatusType, the UpperCaseAlphaLength1to2 may be used for company specifc codes.
2 character country code as defined in ISO3166.
Used to specify the source of the data being exchanged.
List of OTA codes.
List of Reference Place Holders.
List of StringLength1to8.
Month and year information.
Airline meal types.
AVML - Asian Veg
BBML - Baby/Infant Food
BLML - Bland Meal
CHML - Child Meal
DBML - Diabetic
FPML - Fruit Meal
GFML - Gluten Free
HFML - High Fiber
HNML - Hindu Meal
KSML - Kosher
LCML - Low Calorie
LFML - Low Cholesterol
LPML - Low Protein
LSML - Low Sodium/No Salt
MOML - Moslem
NLML - Non-Lactose
ORML - Oriental
PRML - Low Purin
RVML - Raw Vegetarian
SFML - Seafood
SPML - Special/Specify
VGML - Vegetarian/Non Dairy
VLML - Vegetarian/Milk/Eggs
Designates a regular meal.
Used for amounts, max 3 decimals
Provides the ability to define a duration in terms of nights rather than days.
Used for Numeric values, from 0 to 999 inclusive
Used for Numeric values, from 1 to 999 inclusive.
Used for Numeric Strings, length 1 to 16.
Used for Numeric Strings, length 1 to 19.
Used for Numeric Strings, minimum length 1, maximum length 3.
Used for Numeric Strings, length 1 to 5
Used for Numeric Strings, length 1 to 8.
Used for codes in the OTA code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
Indicates main office, field office, or division of the organization.
Statuses that exist in a property management system (PMS).
The reservation has been reserved.
The reservation has been requested but has not yet been reserved.
The request for the reservation has been denied.
This reservation is in "no show" status. Typically this means the person for whom this reservation belonged did not check in and the reservation was moved to "no show" status.
This reservation has been cancelled.
This reservation has been check in, and is in "in-house" status.
The guest has checked out and the reservation has been changed to "Checked out" status
This reservation is in waitlist status and the reservation has not been confirmed.
The 2 digit code used that references the credit card used.
American Express
Bank Card
Carte Bleu
Carte Blanche
Diners Club
Discover Card
Eurocard
Japanese Credit Bureau Credit Card
Master Card
Universal Air Travel Card
Visa
This is intended to be used when the above enumeration list does not meet your needs.
Used for percentage values
Used to specify a preference level for something that is or will be requested (e.g. a supplier of a service, a type of service, a form of payment, etc.).
Preference level that indicates request is only for a specific criterion.
Preference level that indicates request is unnacceptable for a specific criterion.
Preference level that indicates request is preferred for a specific criterion.
Preference level that indicates request is required for a specific criterion.
Preference level that indicates there is no preference.
An enumerated type that defines how a service is priced. Values: Per stay, Per person, Per night, Per person per night, Per use.
(Reference Place Holder) - an index code to identify an instance in a collection of like items.. For example, used to assign individual passengers or clients to particular itinerary items.
An enumerated type indicating special conditions with the rate Valid values: ChangeDuringStay, MultipleNights, Exclusive, OnRequest, LimitedAvailability.
Availability is limited based on guest qualification criteria e.g. AAA member or Government Employee
Indicates an issue that precluded the ability to provide the information.
Availability is limited based on distribution channel qualification criteria (e.g., Expedia or Sabre).
The rate plan does not exist.
The standard code or abbreviation for the state, province, or region
Used for Character Strings, length 0 to 128
Used for Character Strings, length 0 to 32
Used for Character Strings, length 0 to 64
Used for Character Strings, length 1 to 128
Used for Character Strings, length 1 to 16
Used for Character Strings, length 1 to 255
Used for Character Strings, length 1 to 32
Used for Character Strings, length 1 to 64
Used for Character Strings, length 1 to 8
Used for Strings, length exactly 3
Specifies the type of ticket document.
An electronic ticket
A paper ticket
A miscellaneous charge order
Allows for the specification of a date time or just time.
An enumerated type defining the unit in which the time is expressed.
To specify the type of action requested when more than one function could be handled by the message.
Commit the transaction and override the end transaction edits.
Used for an Alpha String, length 2 (for letter codes)
Used for an Upper Alpha String and Numeric, length 2 to 3.
Used for an Upper Alpha String and Numeric, length 3 to 5.
Used to indicate a positive or negative choice. Not recommended for use, use xs:boolean.
The VehicleCoreType complex type identifies the core data that is used to describe a vehicle.
Type of vehicle, for example, truck, car
Class of vehicle, for example, intermediate, compact
The kind of fuel the vehicle uses.
The type of fuel is not known.
The type of fuel is diesel.
The type of fuel is hybrid.
The type of fuel is electric.
The type of fuel is LPG/Compressed gas.
The type of fuel is hydrogen.
The type of fuel is multi.
The type of fuel is petrol.
The type of fuel is ethanol.
Used to define the drive type of a vehicle.
Defines all wheel drive.
Defines four wheel drive.
The drive type of the vehicle is unknown.
The VehiclePrefType complex type defines the information that is used when defining a preference of a vehicle.
An internal car type assigned by the vendor. This is not the SIPP code.
The total number of cars a customer is eventually interested in reserving. This is not used by suppliers and is in no way intended to imply that multiple cars may be booked in a single reservation.
Code used to identify the vehicle. May be used in place of VehicleCoreType. Typically a SIPP code would be passed here. CodeContext Identifies the source authority for the code (e.g., SIPP).
Vehicle rental preferences can be specified for customers or companies to indicate their preferences for types of vehicles to be rented in specific travel situations. Companies may wish to specify certain class or types of cars that their employees are allowed to rent, or indicate special business needs for trucks for hauling goods, etc. Personal travelers may wish to indicate preferences for types of vehicles such as vans or SUVs for family vacations, or smaller, more sporty models when travelling alone. A customer may prefer to have a convertible or sun roof in a warm destination, but request a ski rack when vacationing in the wintertime. The VehicleProfileRentalPrefType complex type has elements for specific features on rental cars including vehicle type (major category such as car, truck, SUV) and vehicle class (more precise kind of vehicle), air conditioning, transmission, and special equipment. In addition, the specification captures preferences for vendors and loyalty programs, insurance coverage, forms of payment for rental cars, and other special requirements.
Indicates a preference for the loyalty program to be used for vehicle rental. The RPH (Reference Place Holder) attribute designates a specific loyalty program from a collection stored in the profile.
Vendor Preferences indicates a preference for a specific car rental agency when used in a travel collection. The VendorPref element uses the Company Name entity to identify the preferred company by name and by vendor code.
A preference for a payment indicates a specific type of payment, such as a credit card or direct bill, to be assigned to the car rental preference collection. The RPH (Reference Place Holder) attribute designates a specific payment form in a collection stored in the profile.
A preference for a specific type of vehicle coverage to be used when renting a car in a given travel situation.
The special request preference element allows the customer to designate a special request to be associated with the vehicle rental.
The vehicle type preference element allows the customer to designate a major category of vehicle preferred for rental.
Indicates a preference for special equipment in a rented car.
The GasPrePay attribute defines a set of valid values for the choice of prepaying for gas at the time of the pick up of the rental vehicle. This information is useful in that it allows a customer's preference to be made known to the vendor. It also allows the vendor to provide more detailed and accurate pricing up front.
The VehicleSpecialReqPrefType complex type defines a preference for a particular special request. The preference is expressed using the attribute group PreferLevelType.
The CoverageCoreType complex type defines the required and most often used components that together define a specific Vehicle Coverage.
Identifies the type of coverage, for example, collision damage waiver. Refer to OTA Code List Vehicle Coverage Type (VCT).
Allows for an industry-specific code that describes this coverage to be specified, for example, CDW may be indicated when the coverage type is Collision Damage Waiver.
The VehicleClassType complex type defines what is referred to as the class of vehicle. Within a type of vehicle (for example, within the type "Car") there is still a wide range of different vehicles. A class of vehicle is used to define that specific vehicle within the broader range of the vehicle in that same vehicle type. Use of vehicle class in conjunction with a vehicle type aids in clarifying a request and aids in describing a specific vehicle. A vehicle class is currently defined as just the size of the vehicle.
The Size attribute identifies the size of a vehicle. Refer to OTA Code List Size (SIZ).
The VehicleCoveragePrefType complex type defines a preference for a particular type of insurance coverage for a rental vehicle. The preference is expressed using the attribute group PreferLevelType.
The VehicleEquipmentCoreType complex type identifies the core data that descrbes a piece of special equipment in association with the renting of a vehicle.
Identifies the specific type of special equipment. Refer to OTA Code List Equipment Type (EQP).
The VehicleEquipmentPrefType complex type identifies the data that is used to provide information on a preferred special equipment when renting a vehicle.
Identifes an action to take place. Typically used to modify the EquipType and/or Quantity.
The VehicleTypeType complex type defines what is referred to as the type of vehicle. The range of vehicles is divided into types to aid in clarifying a request and to aid in describing a specific vehicle. A vehicle type is defined to be the combination of the vehicle category (Car, Truck, etc) and the number of doors on that vehicle.
The VehicleCategory attribute provides the catgeory of a vehicle. Refer to OTA Code List Vehicle Category (VEC).
The number of doors on a vehicle. This may be an exact number or a range, i.e. 2-4.
The VehicleTransmissionSimpleType simple type defines a set of valid values for the transmission type of a vehicle. The valid values are automatic and manual. Use of this attribute can help in describing a vehicle.
A placeholder in the schema to allow for additional elements and attributes to be included if required, per Trading Partner Agreement (TPA).
Used to define the types of payments accepted.
An acceptable form of payment.
Information about an address that identifies a location for a specific purposes.
Indicates whether or not this is the default address.
Describes the use of the address (e.g. mailing, delivery, billing, etc.). Refer to OTA Code List Address Use Type (AUT).
Used elsewhere in the message to reference this specific address.
Provides address information.
May contain the street number and optionally the street name.
Usually a letter right after the street number (A in 66-A, B in 123-B etc).
Street direction of an address (e.g., N, E, S, NW, SW).
Numerical equivalent of a rural township as defined within a given area (e.g., 12, 99).
Building name, room, apartment, or suite number.
When true, the information is a building name.
When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.
City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
Post Office Code number.
County or Region Name (e.g., Fairfax).
State or Province name (e.g., Texas).
Country name (e.g., Ireland).
Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted.
Allows for control of the sharing of address information between parties.
Defines the type of address (e.g. home, business, other). Refer to OTA Code List Communication Location Type (CLT).
Customer bank accounts for payments, either for paper checks or electronic funds transfer.
The name the account is held under.
Allows for control of the sharing of bank account information between parties.
Code assigned by authorities to financial institutions; sometimes called bank routing number.
Describes the bank account used for financing travel (e.g., checking, savings, investment).
Identifier for the account assigned by the bank.
If true, checks are accepted. If false, checks are not accepted.
A collection of comments.
Comment details.
Unique identifier for the system which created the comment.
When true, the comment may be shown to the consumer. When false, the comment may not be shown to the consumer.
Contains details pertaining to commissions.
Identifies the recipient of the commission.
The amount on which commission is calculated.
Provides the currency amount on which the commission is applied.
When true, indicates that the commission is calculated using the rate including tax. When false, indicates that the commission is calculated using the net rate.
The amount of commission paid to the agency prior to the service being rendered.
Provides the amount of commission paid to the agency prior to the service being rendered.
A fixed commission amount.
A fixed commission amount.
The amount of commission to be paid.
The amount of commission to be paid.
Text related to the commission.
Indicates the status of the commission payment itself (e.g. no-show indicates that a different commission may be applied if the reservation is not fulfilled).
Indicates full commission.
Indicates partial commission.
Indicates no commission.
Indicates customer did not use the reserved product or service and did not cancel. This "no show" may impact commission.
Indicates the commission is being adjusted.
The percent applied to the commissionable amount to determine the commission payable amount.
Indicates the currency to be applied to the amounts located in the child elements.
Identifies the reason why a commission is not paid or not paid in full.
Identifies who should be billed for the commission amount.
This is the frequency at which the commission is applied (e.g. per stay, daily). Refer to OTA Code List Charge Type (CHG).
Maximum number of units for which the commission will be applied. This may be used in conjunction with the frequency attribute.
The highest monetary value that may be paid for the commission.
Identifies a company by name.
Provides detailed information on a company.
The division name or ID with which the contact is associated.
The department name or ID with which the contact is associated.
Name of an individual and appropriate contact information. May be contact information for the customer or someone affiliated with the customer.
This provides name information for a person.
Information about a telephone number, including the actual number and its usage
Information about a contact's telephone number, including the actual number and its usage.
Information about an address that identifies a location for a specific purposes.
Electronic email addresses, in IETF specified format.
Web site address, in IETF specified format.
Identifies a company by name.
Employment identification; using an employee ID number, title, level within the company, and an indication of their status, i.e.: active, retired, on leave, or terminated from employment. Additional information about an employee can be entered into the element, including the name of the employee, if it differs from the person name identified as a customer or contact.
Allows for control of the sharing of data between parties.
Indicates that the receiving system should assume the default value if the user specifies no overriding value or action.
Type of contact in the context of use for the travel experience; such as permanent, temporary, affiliation,
travel arranger, etc.
Indicates the type of relationship with the person or company in the profile, such as Spouse, Child, Family, Business Associate, Interest Group, Medical, Security,Other, etc.
Indicates if this contact should be used in the case of an emergency.
Provides a unique reference to this contact person.
Provides the preferred method of communication. Refer to OTA code list Distribution Type (DTB).
Indicates the method of distribution for the booking documentation. Refer to OTA code list Distribution Type (DTB).
The name or code of a country (e.g. as used in an address or to specify citizenship of a traveller).
ISO 3166 code for a country.
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
Detailed name information for the customer.
Information on a telephone number for the customer.
The first and last dates between which this telephone number is in effect.
Information about a telephone number, including the actual number and its usage.
Information on an email address for the customer.
Detailed information on an address for the customer.
Identifies a company.
The first and last dates between which this address is in effect.
Information on a URL for the customer.
Name of the (self-professed) country that is claimed for citizenship.
Name of the (self-professed) country that is claimed for citizenship.
Describes the customer's physical challenge.
Describes the customer's pet.
Method of providing funds for travel by the customer.
Identifies a traveler associated with the customer.
Information on a contact person for the customer.
Detailed document information for the customer (e.g., driver license, passport, visa).
Loyalty program information for the customer.
Program rewarding frequent use by accumulating credits for services provided by vendors.
Employment information for the customer.
Identifies the customer's employer.
Identifies the gender of the customer.
When true the customer is deceased.
Indicates reason for locking out record, such as Emergency, Incident, etc.
Identifies the birth date of the customer.
Type of funds preferred for reviewing monetary values, in ISO 4217 codes.
If true, indicates a very important person.
Used to specify textual information about the customer.
The primary language of the customer.
Used to specify a time window range by either specifying an earliest and latest date for the start date and end date or by giving a date with a time period that can be applied before and/or after the start date.
Specifies a time period that can be applied before and/or after the start date.
The earliest and latest dates acceptable for the start date.
Identifies a date range.
The earliest and latest dates acceptable for the end date.
Identifies a date range.
Defines the date and/or time span.
Company name and location for sending invoice for remittances for travel services.
Company name to whom remittance should be directed.
This may be used to pass the name of the contact at the company for which the direct bill applies.
Address where remittance should be directed.
Allows for control of the sharing of direct bill data between parties.
Identifier for the organization to be billed directly for travel services.
The number assigned by the subscriber for billing reconciliation of a corporate account.
Provides information on a specific document.
The name of the document holder in unformatted text (Mr. Sam Jones).
The name of document holder in formatted text.
Used to indicate any limitations on the document (e.g. as a person may only be allowed to spend a max of 30 days in country on a visitor's visa).
A container for additional person names.
The name of an additional person listed on this document.
Allows for control of the sharing of document data between parties.
Indicates the group or association that granted the document.
Indicates the location where the document was issued.
Unique number assigned by authorities to document.
Indicates the type of document (e.g. Passport, Military ID, Drivers License, national ID, Vaccination Certificate). Refer to OTA Code List Document Type (DOC).
The gender of the document holder.
The birth date of the document holder.
The effective and expiry date of the document.
State or Province where the document was issued.
Country where the document was issued.
Specifies the birth country of the document holder.
The country code of the nationality of the document holder.
Provides contact name associated with the document.
Provides the type of document holder.
The document holder is an infant.
The document holder is a head of household.
Electronic email addresses, in IETF specified format.
Allows for control of the sharing of email information between parties.
Identifies whether or not this is the default email address.
Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OTA Code List Email Address Type (EAT).
Used elsewhere in the message to reference this specific email address.
Employment identification; using an employee ID number, title, level within the company, and an indication of their status (e.g., active, retired, on leave, or terminated from employment). Additional information about an employee can be entered into the element, including the name of the employee, if it differs from the person name identified as a customer or contact.
Identifier assigned to the employee.
Level in employer organization (e.g. seniority) that coveys privileges.
Title of employee in the employer company that conveys rank or privileges.
Status of employment. Refer to OTA Code List Employee Status (EMP).
Specifies the aircraft equipment type.
This is the 3 character IATA code.
Indicates there is an equipment change.
Standard way to indicate that an error occurred during the processing of an OTA message
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". Refer to OTA Code List Error Warning Type (EWT).
Details of the error.
An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional contraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message.
A collection of errors that occurred during the processing of a message.
An error that occurred during the processing of a message.
Used for non-tax fees and charges (e.g. service charges) .
Used for taxes on the associated fee.
Text description of the fees in a given language.
Indicates whether taxes are included when figuring the fees.
Provides details of the fee.
Provides the effective and expiry dates for the fee.
When true, indicates the fee is mandatory. When false, the fee is not mandatory.
An index code to identify an instance in a collection of like items.
Specifies charge information by unit (e.g., room, person, item) and frequency (e.g., daily, weekly, stay).
When true, indicates that the fee is subject to tax.
A collection of fees.
Fee Amount that is applied to the rate. Fees are used for non tax amounts like service charges.
Used to provide subsection formatted text information.
Details and content of a paragraph for a formatted text message.
This attribute may be used to provide a title for a sub-section of the formatted free text. A sub-section may have multiple related paragraphs of information. For example, if used to provide driving directions there may be multiple paragraphs, and these paragraphs may be grouped into a sub-section called "Driving from the North". A second subsection may be titled "Driving from the South", and may contain several paragraphs to describe the driving directions when driving from the south.
An optional code that may be assigned to this sub-section of formatted free text.
This attribute may be used when there is a need to number all of the sub-sections of information that is to be presented.
Provides text and indicates whether it is formatted or not.
Textual information, which may be formatted as a line of information, or unformatted, as a paragraph of text.
The language in which the text is provided.
Collection of formatted text sub sections.
Subsection formatted text information.
This attribute may be used to provide a title for the formatted free text,
for example, Driving Directions. Each of the sub sections that are defined
to be a part of the formatted text would provide detailed information about
the subject identified by the title.
The language in which the content is provided.
Textual information to provide descriptions and/or additional information.
Language of the text.
Describes an image item.
A set of images for a given category which may be provided in multiple formats.
Detailed information about an image.
The language in which the image text is provided.
code list to create to identof the different format of an Image
The name of the image file.
The size of the image file.
Associates the image size to a given category (e.g., 70x70, 100x100, 480x480). For example, if an image with a dimension of 72x73 is sent, it may be categorized as a 70x70 image.
When true, the image is the original file and format. When false, the image is not the original file and format.
The description associated with the image in a specific language.
The caption associated to a specific image category which can be provided in different languages.
Specifies the image category. Refer to OTA code list Picture Category Code (PIC).
Details for an image of a given category.
URL of the multimedia item for a specific format.
The unit of measure for the image item. Refer to OTA code list Unit of Measure (UOM).
The width of the image item (unit specified by unit of measure).
The height of the image item (unit specified by unit of measure).
Collection of image items.
Image of a given category.
Creation and modification information for this image item.
If true, this item is obsolete and should be removed from the receiving system.
The version of the image item.
A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
Identifies the criterion for a search.
The Position element contains three attributes, Latitude, Longitude, and Altitude, used to indicate the geographic location(s) requested by the search, expressed in notation specified by ISO standard 6709. It is likely that only the first two attributes, Latitude and Longitude, would be needed to define a geographic area.
The geographic coordinates for the search.
Uses any part of address information, such as street name, postal code, or country code.
When true, only locations in the same country as the specified city's country should be selected.
Telephone number(s) used in the search.
Detailed telephone information for the search.
The Reference Point element allows for a search by proximity to a designated reference point by name.
The state or province in which the reference point is located.
The country in which the reference point is located.
Used to specify a reference point by a code.
Indicates the type of location being referenced (e.g., Airport, Hotel). Refer to the OTA code table Index Point Code (IPC).
The name of the reference point.
The name of the city associated with this reference point.
Indicates the location of points of interest.
Used to identify the vicinity of the location. Refer to OTA Codelist Vehicle Where at Facility (VWF).
Indicates the detail of hotel reference information.
Detailed hotel information for the search.
Used to search for hotels within a particular market segment. Refer to OTA Code Segment Category Code Type (SEG).
Refer to OTA Code list OTA Code List Property Class Type (PCT).
Refer to OTA Code List Architectural Style Code (ARC).
The level of integration of a property to provide automated transaction information. The lower the number, the higher the integration (e.g., a 1 means the supplier has the highest level of integration automation).
Used to search for hotels in a specific location category (e.g. downtown, airport or suburban, etc.). Refer to OTA Code List Location Category Codes (LOC).
When true indicates the search should be performed beyond the hotel city code, typically this could include neighboring cities to the specified hotel city code.
Used to specify the extent of a search area. The extent is relative to an element (position, address, hotel reference, etc.) present in this ItemSearchCriterionType that specifies a location.
Used to provide distance and direction information from the referenced location.
Values of "true" or "false", indicating whether the string of the search value must be an exact match.
An enumerated list, indicating the level of importance of the search criterion. Acceptable values are "Mandatory", "High", "Medium", or "Low."
Indicates the item is required.
Indicates a high level of importance.
Indicates a medium level of importance.
Indicates a low level of importance.
Defines a ranking scale expressed as integers; meaning and scale are based on individual implementations.
Code and optional string to describe a location point.
A code identifying a location.
Describes multimedia item(s).
A collection of video items.
A collection of image items.
A collection of text items.
Used to designate a particular type of description such as marketing. Refer to OTA Code List Information Type (INF).
Used to designate a particular type of additional information. Refer to OTA Code List Additional Detail Type (ADT).
A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
Contains multimedia item(s).
A multimedia item.
The date and time when the multimedia information was last updated.
Details of an operating schedule (e.g. a golf tee time may be more expensive during peak hours v. off peak hours).
A collection of OperationTimes.
Provides operating times of a facility.
The day(s) of week to which the operation time applies.
The date span applicable to the operation.
Used to provide additional information regarding operation times (e.g., after hours operations, restricted times). Refer to OTA Codelist Additional Operation Info (OPR).
The frequency with which this operation occurs (e.g., 'on the hour', 'on the half hour').
Textual information for this period of operation.
The date span applicable to the operation schedule.
Collection of operation schedules.
The OperationSchedule class defines the dates and hours of operation.
The date range for which the operation schedule information is valid.
Point of Sale (POS) is the details identifying the party or connection channel making the request.
This holds details regarding the requestor. It may be repeated to also accommodate the delivery systems.
An indication of a new paragraph for a sub-section of a formatted text message.
Formatted text content.
An image for this paragraph.
A URL for this paragraph.
Formatted text content and an associated item or sequence number.
In many cases the description repeats, this will allow you to define the information that is being sent, typically used when multiple occurrences of ParagraphType are being sent.
The sequence number for the paragraph.
Creation date time, Creator ID, last modification date time and last modifier ID for the paragraph.
The language for this paragraph.
Identification about a specific credit card
Name of the card holder.
Issuer of the card.
Name of bank or organization issuing the card (e.g., alumni association, bank, fraternal organization).
Card holder's address.
Allows for control of the sharing of payment card data between parties.
Indicates the type of magnetic striped card. Refer to OTA Code ListCard Type (CDT).
The 2 character code of the credit card issuer.
Credit card number embossed on the card.
Verification digits printed on the card following the embossed number. This may also accommodate the customer identification/batch number (CID), card verification value (CVV2 ), card validation code number (CVC2) on credit card.
Date the card becomes valid for use (optional) and the date the card expires (required) in ISO 8601 prescribed format.
May be used to send a concealed credit card number (e.g., xxxxxxxxxxxx9922).
Provides a reference pointer that links the payment card to the payment card holder.
When true, the credit card company is requested to delay the date on which the amount of this transaction is applied to the customer's account.
Ways of providing funds for travel by the individual.
Details of a debit or credit card.
Details of a bank account.
Details of a direct billing arrangement.
Details of a paper or electronic document indicating prepayment.
The effective date, expiry date and series code of the voucher.
Reference of the billing account which handles the payment transaction.
Unique identifier of the electronic voucher, created by the supplier.
Unique identifier of the electronic voucher.
Defines the type of voucher (e.g., full credit or partial credit).
When true, indicates the voucher is electronic. An E-voucher is a value document issued by the Travel Agent for the customer. The e-voucher can be used as a proof of reservation, but more normally, as a full-payment or partial payment.
Details of a loyalty redemption arrangement. This is normally miles or points.
A certificate may be needed in order to redeem miles or points. Certificates may be used in combination with each other as part of a reservation.
Identifies the loyalty scheme, programs and promotions within the scheme, membership reference, format of the certificate, the number of nights it can be used and its current status.
Identifies the Loyalty scheme, programs and promotions within the scheme, membership reference, form factor used by the certificate, the number of nights it can be used for and its current status.
Used to provide a promotion code of the loyalty redemption.
The quantity of loyalty units being redeemed.
Details of a miscellaneous charge order (MCO).
The ticket number of the miscellaneous charge order (MCO).
Used to indicate payment in cash.
If true, this indicates cash is being used.
Allows for control of the sharing of payment form data between parties.
A reference to identify the billing department for allocating cost of travel to company account.
Provides a reference to a specific form of payment.
This is used to indicate either a charge or reserve (deposit).
This indicates that an actual payment has been made.
This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment.
This provides name information for a person.
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
Given name, first name or names
The middle name of the person name
e.g "van der", "von", "de"
Family name, last name.
Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.).
Degree or honors (e.g., Ph.D., M.D.)
Allows for control of the sharing of person name data between parties.
Type of name of the individual, such as former, nickname, alternate or alias name. Refer to OTA Code List Name Type (NAM).
Other traveler profiles associated with an specific individual.
Identifies the profile of the related traveler.
Person associated with the traveler.
Allows for control of the sharing of related traveler data between parties.
Indicates the type of relationship with the person in the profile, such as Spouse, Child, Family, Business Associate, Interest Group, Medical, Security, Other, etc.
The RelativePosition object contains information about the direction, distance and travel time to/from a facility (hotel, car rental location, or airport) or to/from a designated location.
Defines the position of an entity in relation to another entity (e.g. from an airport to a hotel, the relationship is dependant on use).
The indicator for whether this location is nearest.
This is the object referred to by the relative position (e.g. cross street, airport). Refer to OTA Code List Index Point Code (IPC).
This is used to accommodate a city name, rail station name etc. when using the indexPoint attribute.
Indicates whether the reference point is considered the main reference point for the specific type of IndexPointCode (e.g., in Dallas, where IndexPointCode=airport Dallas/Fort Worth airport would be the primary airport even if another airport such as Love Field is closer).
Used to indicate whether the context is to a facility or from a facility.
Indicates the direction is to the facility based on use (e.g., hotel, car rental location, airport).
Indicates the direction is from the facility based on use (e.g., hotel, car rental location, airport).
When true, the distance information is approximate.
Provides information on the source of a request.
An identifier of the entity making the request (e.g. ATA/IATA/ID number, Electronic Reservation Service Provider (ERSP), Association of British Travel Agents (ABTA)).
This password provides an additional level of security that the recipient can use to validate the sending party's authority to use the message.
Specifies the latitude and longitude of a source.
Used to specify the geographic coordinates of the source of the request.
Specifies the booking channel type and whether it is the primary means of connectivity of the source.
Identifies the company that is associated with the booking channel.
Specifies the booking channel type and whether it is the primary means of connectivity of the source.
Identifies the party within the requesting entity.
An identification code assigned to an office/agency by a reservation system.
The country code of the requesting party.
The currency code in which the reservation will be ticketed.
An authority code assigned to a requestor.
The IATA assigned airline code.
The IATA assigned airport code.
The point of first departure in a trip.
Electronic Reservation Service Provider (ERSP) assigned identifier used to identify the individual using the ERSP system.
This is the electronic address of the device from which information is entered.
SpecialRequests : SpecialRequest
A collection of SpecialRequest objects. The collection of all special requests associated with any part of the reservation (the reservation in its entirety, one or more guests, or one or more room stays). Which special requests belong to which part is determined by each object's SpecialRequestRPHs collection.
The SpecialRequest object indicates special requests for a particular guest, service or reservation. Each of these may be independent of any that are tied to the profile (see Profile Synchronization standard).
This identifies a special request for this reservation and is typically hotel-specific.
Identifies the source authority for the RequestCode.
Allows you to pass the number of units that the special request is for (e.g., if 4 rooms are booked you may want 3 with double/double beds and 1 with a king).
State, province, or region name or code needed to identify location.
The standard code or abbreviation for the state, province, or region.
Street name; number on street.
Defines a Post Office Box number.
Standard way to indicate successful processing of an OTA message. Returning an empty element of this type indicates success.
Allows extensions
to be added to the OTA specification per trading partner agreement.
Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.
Text description of the taxes in a given language.
Provides details of the tax.
Provides the effective and expiry dates for the tax.
Specifies charge information by unit (e.g., room, person, item) and frequency (e.g., daily, weekly, stay).
A collection of taxes.
An individual tax.
Used to provide a total of all the taxes.
Describes a text item.
The URL for a specific text item..
The text in a specific language.
Sequence number associated with this description.
Specifies the text category. Refer to OTA code list Picture Category Code (PIC).
Generic information about the text multimedia item.
The language of the text item.
Collection of text items.
Text description of a given category.
Creation and modification information for this text item.
If true, this item is obsolete and should be removed from the receiving system.
The version of the text item.
Specifies a time window.
A period of time that can be applied to another time resulting in an earlier range of time.
A period of time that can be applied to another time resulting in a later range of time.
When true the requested period may extend over the previous or following day. When false, the search period is restricted to the date specified. Normally used when the window duration is in hours.
The total amount charged for the service including additional amounts and fees.
A collection of taxes.
The total before taxes are applied.
The total after taxes have been applied.
When true, amounts do not contain additional fees or charges.
Defines the type of transportation offered.
Contains the directions to/from a specific location for a mode of travel.
Multimedia information about the transportation.
Collection of operation schedules for the transportation.
Descriptive text that describes the transportation.
This would be used for information such as a shuttle needs to be requested or a reservation is required.
The mode of transportation. Refer to OTA Code List Transportation Code (TRP).
Refer to OTA Codelist Charge Type (CHG).
When true there is no additional charge for transportation.
May be used to give further detail on the code (e.g. if a trolley is chosen, the trolley name could be added here) or to remove an obsolete item.
Descriptive information about the mode of transportation.
The normal (average) travel time required to get to or from the location, measured in minutes.
The currency amount of the tranportation charge.
This attribute is used to explicitly define whether the type of transportation applies. Refer to OTA Code list Option Type Code (OTC). This is used in conjunction with TransportationCode.
A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
Used to define the types of transportation offered.
Collection of directions to/from a specific location via various modes of transportation
Web site address, in IETF specified format.
Allows for control of the sharing of URL data between parties.
Defines the purpose of the URL address, such as personal, business, public, etc.
Indicates whether or not this is the default URL.
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).
Identifies the company that is associated with the UniqueID.
Provides formatted textual information that a vendor wishes to make known. The type of information is indicated
To define the type of information such as Description, Policy, Marketing, etc. Refer to OTA Code List Information Type (INF).
Collection of vendor messages.
A specific message associated with this vendor
Describes a video item.
A set of video of a given category can be provided in different Format , each format will be described in this element
Multimedia information for the video file.
A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
Specifies the video category. Refer to OTA code list Picture Category Code (PIC).
Details for a video of a given category.
URL of the multimedia item for a specific format.
The unit of measure associated with all the dimensions of the multimedia item. Refer to OTA code list Unit of Measure (UOM).
The width of the video item (unit specified by unit of measure).
The height of the video item (unit specified by unit of measure).
The bit rate of the video item.
The length of the video item (unit specified by unit of measure).
Multimedia information for the video item.
Collection of video items.
Each video item represents a specific category.
The language associated with the caption for the video.
The caption associated to a specific video category which can be provided in different languages.
If true, this item is obsolete and should be removed from the receiving system.
The version of the video item.
Creation and modification information for this video item.
Standard way to indicate successful processing of an OTA message, but one in which warnings are generated
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". Refer to OTA Code List Error Warning Type (EWT).
Details of the warning.
Reference Place Holder used as an index for this warning.
Collection of warnings.
Used in conjunction with the Success element to define a business error.
Identifies the alternate language for a customer or message. The human language is identified by ISO 639 codes.
Identifies the alternate language for a customer or message. The human language is identified by ISO 639 codes.
An identifier of a geographical area.
An identifier of an area as defined by a hotel reservation system.
Used to provide a date of birth.
Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.
Specifies the booking channel types and whether it is the primary means of connectivity of the source.
The type of booking channel (e.g. Global Distribution System (GDS), Alternative Distribution System (ADS), Sales and Catering System (SCS), Property Management System (PMS), Central Reservation System (CRS), Tour Operator System (TOS), Internet and ALL). Refer to OTA Code List Booking Channel Type (BCT).
Indicates whether the enumerated booking channel is the primary means of connectivity used by the source.
Specifies charge information by unit (e.g., room, person, item) and frequency (e.g., daily, weekly, stay).
This is the unit for which the charge applies (e.g. room, person, seat). Refer to OTA Code List Charge Type (CHG).
This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OTA Code List Charge Type (CHG).
Number of units permitted before charges are applied (e.g., more than 4 persons).
ChargeFrequency exemptions before charges are applied (e.g. after 2 nights).
Maximum number of Units for which the charge will be applied (e.g., waive charges above 10 rooms).
Maximum number of times the charge will be applied (e.g. waive charges above 30 nights).
Name of the (self-professed) country that is claimed for citizenship
Indicates that the receiving system should assume the default value if the user specifies no overriding value or action.
Used to specify a code and the context of the code.
Any code used to specify an item, for example, type of traveler, service code, room amenity, etc.
Identifies the source authority for the code.
This is intended to be used in conjunction with an attribute that uses an OTA code list. It is used to provide additional information about the code being referenced.
May be used to give further detail on the code or to remove an obsolete item.
May be used to give further detail on the code.
This is used to indicate that an item is obsolete.
Used to specify a code and its associated attributes; meaning is derived from actual use.
Used to specify a code and the context of the code.
Identifies the location of the code table
Specifies the number of items that are identified by the Code (e.g., 2 adults, 5 first class seats).
Provides detailed information on a company.
Used to provide the company common name.
Refer to OTA Code List Travel Sector (TVS).
Identifies a company by the company code.
Identifies the context of the identifying code, such as DUNS, IATA or internal code, etc.
Provides a monetary amount and the currency code to reflect the currency in which this amount is expressed.
A monetary amount.
Provides a currency code to reflect the currency in which an amount may be expressed as well as the number of decimal places of that currency.
Provides a currency code to reflect the currency in which an amount may be expressed.
The code specifying a monetary unit. Use ISO 4217, three alpha code.
Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85).
Program rewarding frequent use by accumulating credits for services provided by vendors.
Identifier to indicate the company owner of the loyalty program.
Unique identifier of the member in the program (membership number, account number, etc.).
Identifies the travel sector. Refer to OTA Code List Travel Sector (TVS).
Provides the level of this customer within a loyalty program.
Indicates the alliance status of a program.
Provides the date of registration for this customer for the loyalty program.
The effective date and/or expiration date of this customer's membership in this loytalty program.
A reference placeholder for this loyalty membership.
Indicate the partner(s)/vendor(s) for which the customer loyalty number is valid.
If a day(s) of the week is set to true then the associated item is available on that day of the week (e.g. if Mon="T" then a flight operates on Mondays or a certain rate is available on Mondays).
When true, apply to Monday.
When true, apply to Tuesday.
When true, apply to Wednesday.
When true, apply to Thursday.
When true, apply to Friday.
When true, apply to Saturday.
When true, apply to Sunday.
The attributes of the OTA DateTimeSpan data type are based on the W3C base data types of timeInstant and timeDuration. The lexical representation for timeDuration is the [ISO 8601] extended format PnYn MnDTnH nMnS, where nY represents the number of years, nM the number of months, nD the number of days, 'T' is the date/time separator, nH the number of hours, nM the number of minutes and nS the number of seconds. The number of seconds can include decimal digits to arbitrary precision. As an example, 7 months, 2 days, 2hours and 30 minutes would be expressed as P0Y7M2DT2H30M0S. Truncated representations are allowed provided they conform to ISO 8601 format. Time periods, i.e. specific durations of time, can be represented by supplying two items of information: a start instant and a duration or a start instant and an end instant or an end instant and a duration. The OTA standards use the XML mapping that provides for two elements to represent the specific period of time; a startInstant and a duration.
The starting value of the time span.
The duration datatype represents a combination of year, month, day and time values representing a single duration of time, encoded as a single string.
The ending value of the time span.
Creation date time, Creator Id, last modification date time and last Modifier Id.
Time stamp of the creation.
ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.
Time stamp of last modification.
Identifies the last software system or person to modify a record.
Date an item will be purged from a database (e.g., from a live database to an archive).
The absolute deadline or amount of offset time before a deadline for a payment of cancel goes into effect.
Defines the absolute deadline. Either this or the offset attributes may be used.
The units of time, e.g.: days, hours, etc., that apply to the deadline.
The number of units of DeadlineTimeUnit.
An enumerated type indicating when the deadline drop time goes into effect.
The deadline information applies from when the reservation was confirmed. In some systems the confirmation time will differ from the booking time.
Indicates that the receiving system should assume the default value if the user specifies no overriding value or action.
When true, indicates a default value should be used.
Used to provide distance and direction information.
An optional attribute indicating the distance to/from a reference point. When used in conjunction with DistanceMax, this represents the minimum distance.
When the Distance attribute contains a value, (presumably a numerical value), the unit of measure is a string value that indicate what units are used for the value.
An optional string value used to indicate the compass point(s) direction, e.g.: S, SE (South, Southeast), FROM the Reference Point TO the hotel location if the search is not a full circumference from the reference point.
An optional attribute indicating the maximum distance to/from a reference point.
The unit of measure in a code format. Refer to OTA Code List Unit of Measure Code (UOM).
Used to send the effective date and/or expiration date.
Indicates the starting date.
Indicates the ending date.
Used to identify an application error by either text, code, or by an online description and also to give the status, tag, and/or identification of the record that may have caused the error.
An abbreviated version of the error in textual format.
If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to OTA Code List Error Codes (ERR).
If present, this URL refers to an online description of the error that occurred.
If present, recommended values are those enumerated in the OTA_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.
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].
If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.
Defines the fees and/or taxes associated with a charge (e.g. taxes associated with a hotel rate).
Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).
Code identifying the fee (e.g.,agency fee, municipality fee). Refer to OTA Code List Fee Tax Type (FTT).
Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).
Provides a currency code and an amount for the fee or tax.
Identifies if the associated data is formatted into its individual pieces, or exists as a single entity.
Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted.
Used to indicate the gender of a person, if known.
Identifies the gender.
HotelReference: The hotel reference identifies a specific hotel by using the Chain Code, the Brand Code, and the Hotel Code. The codes used are agreed upon by trading partners.
The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.
A code that identifies the brand or flag of a hotel, often used for independently-owned or franchised properties who are known by a specific brand.
The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.
The IATA city code; for example DCA, ORD.
A text field used to communicate the proper name of the hotel.
A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.
The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).
The name of a brand of hotels (e.g., Courtyard, Hampton Inn).
An identifier of an area as defined by a hotel reservation system.
Used to provide a required unique identifier.
A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
Provides employee information.
Identifier assigned to the employee.
Level in employer organization (e.g. seniority) that conveys privileges.
Title of employee in the employer company that conveys rank or privileges.
Used to provide an optional unique identifier.
A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
Name of bank or organization issuing the card (e.g., alumni association, bank, fraternal organization, etc.).
Code of bank issuing the card.
Identifies language.
Language identification.
A code identifying a location.
Code used to identify a location.
Identifies the context of the identifying code (e.g., IATA, ARC, or internal code).
Provides the level within a loyalty program.
Indicates special privileges in program assigned to individual.
Identifies the Loyalty Program, membership, form factor used by the certificate and its current status
Identifies the individual program or promotion within a loyalty scheme
Identifies the source of the code that identifies program or promotion within a loyalty scheme
Identifies the unique certificate number and the loyalty program and the membership ID associated with this certificate
Identifies either the date range when the Certificate is valid or the dates against which the certificate is being applied
The number of nights of the hotel stay that are used to calculate the redemption amount.
Indicates what form the certificate is in e.g. Paper or Electronic
Used to define the status of the certificate e.g. Available, Voided, Cancelled, Reserved, Used.
Identifies a loyalty certificate.
The loyalty redemption certificate identifier.
Unique identifier of the member in the program.
This identifies the loyalty program.
Generic information about a multimedia item.
The content ID of a file attachment with the prefix 'cid:'. The value of this can be used to retrieve the corresponding attachment by the receiving system.
The title of the multimedia object.
The author of the multimedia object.
A copyright notice for the multimedia object.
Owner of the copyright for the multimedia content.
The start date for which the multimedia content rights are claimed.
The end date for which the multimedia content rights are claimed.
The start date for which the content is considered valid.
The end date for which the content is considered valid.
Start month and day or date for which the multimedia content is relevent (e.g. the start of a season or the start of an event). When a year is not used (i.e. only the month and day) it signifies a recurring event.
End month and day or date for which the multimedia content is relevent (e.g. the end of a season or the start of an event). When a year is not used (i.e. only the month and day) it signifies a recurring event.
Uniquely identifies this file in the message.
Unique identifier for the source of the multimedia object (e.g., the original image file).
Specific information about a multimedia item.
Identifies the language of the multimedia item.
The code associated with the format of the multimedia item.
Refer to OTA code list Content Format Code (CFC)
The size of the multimedia file in bytes.
The name of the multimedia file.
The OTA_PayloadStdAttributes defines the standard attributes that appear on the root element for all OTA payloads.
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.
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).
Used to indicate whether the request is for the Test or Production system.
For all OTA versioned messages, the version of the message is indicated by a decimal value.
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).
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.
This indicates where this message falls within a sequence of messages.
This is the first message within a transaction.
This is the last message within a transaction.
This indicates that all messages within the current transaction must be ignored.
This is any message that is not the first or last message within a transaction.
Specifies that this is a followup request asking for more of what was requested in the previous request.
This request message is a subsequent request based on the previous message sent in this transaction.
Identifes the primary language for the message.
Identifes the alternate language for the message.
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.
Designates the office category within an organization.
Indicates main office, field office, or division of the organization.
Indicates the start and end date for a payment card.
Indicates the starting date.
Indicates the ending date.
Used to specify the geographic coordinates of a location.
The measure of the angular distance on a meridian north or south of the equator.
The measure of the angular distance on a meridian east or west of the prime meridian.
The height of an item, typically above sea level.
Provides the unit of measure for the altitude (e.g., feet, meters, miles, kilometers). Refer to OTA Code List Unit of Measure Code (UOM).
Used to indicate a level of preference for an associated item (i.e., only, unacceptable, preferred).
Used to indicate a level of preference for an associated item.
Identifes the primary language preference for the message.
Identifes the primary language preference for the message. The human language is identified by ISO 639 codes.
Allows for control of the sharing of data between parties.
value="Inherit" Permission for sharing data for synchronization of information held by other travel service providers.
value="Inherit" Permission for sharing data for marketing purposes.
Used to specify a profile type.
Code to specify a profile such as Customer, Tour Operator, Corporation, etc. Refer to OTA Code List Profile Type (PRT).
Used to provide a promotion code.
Promotion code is the identifier used by the host to link directly with a specific named advertising campaign. By including the required code, the client is able to gain access to special offers which may have been created for a specifically targeted group via a CRM system or for a wider advertising campaign using Television or press adverts.
List of the vendor codes associated with a promotion.
Used to define a quantity.
Used to define the quantity for an associated element or attribute.
Indicates a preference for an item that is referred to using a Reference Place Holder (RPH). Often an object is stored in a collection of similar objects, and a preference for use of one these objects is to be made known. This complex type can be used to specify the preference level, and to provide the indicator to the object in the collection.
Used to indicate a level of preference for an item associated with the reference place holder.
The unique reference for an object within this message.
A range of monetary values within which the cost of the available products are requested.
A decimal value that indicates the minimum monetary value to be considered in a request for an available product.
A decimal value that indicates the maximum monetary value to be considered in a request for an available product.
The rate amount used in place of MinRate and MaxRate when a specific rate is being requested.
Used to specify the period of time to which the rates apply.
Used to provide currency code and decimal places for the rate attributes.
Defines the position of an entity in relation to another entity (e.g. from an airport to a hotel, the relationship is dependant on use).
Defines the cardinal direction (e.g., north, south, southwest).
Defines the distance between two points.
Candidate for potential removal, usage is not recommended. Deprecation Warning added in 2006A.
Provides the ability to specify the unit of measure to which the "Distance" attribute is referring.
The unit of measure in a code format. Refer to OTA Code List Unit of Measure Code (UOM).
This is used to indicate that an item is obsolete.
If true, this item is obsolete and should be removed from the receiving system.
Attributes for seat request. Note: you can choose a specific seat or just a general preference
Used to provide the seat number.
Refer to OTA Code List Seat Preference (STP).
Indicates whether or not smoking is allowed.
Used to indicate whether information can be shared.
Permission for sharing all data in profile for synchronization of profiles held by other travel service providers.
Permission for sharing all data in profile for marketing purposes.
Provides the date of registration for a loyalty program.
Indicates when the member signed up for the loyalty program.
Indicates the alliance status of a program.
Indicates if program is affiliated with a group of related offers accumulating credits.
Indicates the program is not part of an alliance.
Indicates the program is part of an alliance.
Identifies a position with regard to the smoking of cigarettes, either Allowed or NotAllowed. This may be of use when expressing a preference (I prefer a room that allows smoking) or when stating the attributes of an item (smoking in this rental car is not allowed).
Indicates smoking is allowed when true and is not allowed when false.
Provides telephone information details.
Refer to OTA Code List Phone Location Type (PLT).
Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OTA Code List Phone Technology Type (PTT).
Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Refer to OTA Code List Phone Use Type (PUT).
Code assigned by telecommunications authorities for international country access identifier.
Code assigned for telephones in a specific region, city, or area.
Telephone number assigned to a single location.
Extension to reach a specific party at the phone number.
Additional codes used for pager or telephone access rights.
A remark associated with the telephone number.
Detailed telephone information.
Allows for control of the sharing of telephone information between parties.
Provides telephone information details.
Identifies if the associated data is formatted into its individual pieces, or exists as a single entity.
Information about a telephone number, including the actual number and its usage
Detailed telephone information.
Indicates that the receiving system should assume the default value if the user specifies no overriding value or action.
Used elsewhere in the message to reference a specific telephone number (including faxes).
Total time span covered by this availability request (from the earliest arrival to the latest departure)
The earliest ending date/time for the availability requested, expressed in dateTime format as prescribed by ISO 8601.
The latest ending date/time for the availability requested, expressed in dateTime format as prescribed by ISO 8601.
The Day of Week of the starting date for the availability requested. Enumerated values of StartDOW are the seven days of the week: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, or Sunday.
Provides unique identification information.
URL that identifies the location associated with the record identified by the UniqueID.
A reference to the type of object defined by the UniqueID element. Refer to OTA Code List Unique ID Type (UIT).
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.
Used to provide a required unique identifier.
Used to identify the source of the identifier (e.g., IATA, ABTA).
A form of payment using a voucher or coupon.
The date when a voucher becomes valid for use, if applicable, and the the date when a voucher or series of coupons expires and is no longer valid.
Identification of a series of coupons or vouchers identified by serial number(s).