Tabular overview of all nodes, which may occur in this message. See legend below for description of table columns.
Note: Some sibling elements or complete sub-trees of the hierarchy may be defined as mutually exclusive alternative choices. This information cannot be expressed in this tabular overview. Please refer to schema diagram for a graphical representation of the message schema.
Node | Description | Values | Occurs | Example |
---|---|---|---|---|
<HotelInformationRS> | Hotel Information response root element. | 1 | ||
@version | Version number. | 0..1 | 1.0 | |
@Lang | ISO language code. A two letter code as defined by ISO-639-1. This code specifies the requested language for text content. Default value is 'en'. | 0..1 | ||
<InfoGroup> | Error and information group | 0..1 | ||
<ForInfo> | Information group | 0..N | ||
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@Code | A code to uniquely identify a specific type of ForInfo message. Currently not returned for most ForInfo messages. | 0..1 | I00001 | |
@Lang | ISO language code. A two letter code as defined by ISO-639-1. | 0..1 | de | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
</ForInfo> | ||||
<Error> | Error group | 0..N | ||
@ErrorType | Type of error. | 1 | Air | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<UnderlyingError> | Errors of the backend system can be returned here. | 0..N | ||
@Code | error code of the backend system. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</UnderlyingError> | ||||
</Error> | ||||
<BackOffice> | Generic back office response container. Serves as a placeholder for any context specific content. | 0..1 | ||
</BackOffice> | ||||
</InfoGroup> | ||||
<HotelInformation> | Hotel Information Header group | 1 | ||
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@Latitude | Degree of latitude. Values range from -90 to +90 Positive values refer to latitudes north, negative values to latitudes south of the equator. | [-90] to [90] | 0..1 | -49.9856 |
@Longitude | Degree of longitude. Values range from -180 to +180 Positive values refer to longitudes east, negative values to longitudes west of the zero (Greenwich) meridian. | [-180] to [180] | 0..1 | -123.87611 |
<CheckInDate/> | Check in date in ISO 8601 format (yyyy-mm-dd). This is the date the customer will arrive (check in) at the hotel. | 0..1 | 2001-12-25 | |
<CheckOutDate/> | Check out date in ISO 8601 format (yyyy-mm-dd). This is the date the customer will depart(check out) the hotel. | 0..1 | 2001-12-31 | |
<NumberOfNights/> | Number of nights. | 0..1 | 5 | |
<ChainCode/> | Chain code. | 0..1 | MC | |
<ChainName/> | Chain name. | 0..1 | Marriott | |
<PropertyCode/> | Property code. | 0..1 | MIA345 | |
<PropertyName/> | Property name. | 0..1 | Marriott on the sea | |
<BookingCode/> | The booking code for this rate-rule. | 0..1 | A1SRA8 | |
<NumberOfPersons> | Number of persons per room incl. children. If multiple number of rooms were requested and the backend system supports a detailed breakdown of person allocation per room you can get multiple NumberOfPersons elements with a RoomRefID per room that show how many persons/children are using the room. If that is not supported you get only one NumberOfPersons element and NumberOfChildren attribute with the sum of all persons/children in party. | 0..N | 2 | |
@RoomRefID | RoomRefID identifies the room instance where this number of persons or children is assigned to. | 0..1 | 1 | |
@NumberOfChildren | Number of children in the room. | 0..1 | ||
</NumberOfPersons> | ||||
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AlternateCurrencyCode> | Alternate currency used for rate quotes. | 0..1 | GBP | |
@NumberOfDecimals | Decimal position in fare amount. | 0..1 | 2 | |
</AlternateCurrencyCode> | ||||
<Address/> | Street or PO Box address. | 0..N | 5301 Blue Lagoon Drive | |
<City/> | City. | 0..1 | MIAMI | |
<StateCode/> | State code. | 0..1 | FL | |
<Country/> | Country code. | 0..1 | US | |
<PostalCode/> | Postal code or zip code. | 0..1 | 33126 | |
<TelephoneNumber/> | Telephone number. | 0..1 | 305-269-6975 DEPRECATED: Will be replaced by Phone element. | |
<FaxNumber/> | Fax telephone number. | 0..1 | 305-264-6575 DEPRECATED: Will be replaced by Phone element. | |
<Email/> | Hotel eMail address | 0..1 | reservations@hyatt.com | |
<HotelRating> | Rating of this hotel. Note that this element will eventually supercede the AAARating element definition. The latter will be deprecated soon. | 0..N | NTM3 CROWN | |
@RatingSystem | Identifies the rating system used to rate the hotel. Values are: AAA .. AAA Diamond rating AA .. Automobile Association Star Rating AMA .. Amadeus C24 .. check24 CRC .. CorporateRatesClub EAN .. Expedia EHB .. eHotelBar EHS .. eHotelStars EHT .. eHotel GUESTS .. Guest rating HBC .. Booking.com rating HRS .. Hotel Reservation System 'stars' rating JVW .. Jonview rating LSR .. Local Star Rating MIC .. Michelin MOB .. Mobil Hotel Star NTM .. North Star Media 'crown' rating OHG .. Official Hotel Guide TPA .. Tripadvisor VDR .. Verband Deutsches Reisemanagement UNK .. unknown | [AAA] [AA] [AMA] [C24] [CRC] [EAN] [EHB] [EHS] [EHT] [GUESTS] [HBC] [HRS] [JVW] [LSR] [MIC] [MOB] [NTM] [OHG] [TPA] [VDR] [UNK] | 0..1 | |
@RatingType | The category type, the rating applies to. AVG ... average UNK ... unknown COF ... comfort factor ATM ... hotel atmosphere FOR ... friendliness of reception SOE ... service of hotel employees HFA ... hotel facilities RFA ... room facilities RSI ... room size SAN ... sanitary equipment CLE ... cleanliness BFQ ... breakfast quality REQ ... restaurant quality WEL ... wellness PKG ... package VAL ... price value | [AVG] [UNK] [COF] [ATM] [FOR] [SOE] [HFA] [RFA] [RSI] [SAN] [CLE] [BFQ] [REQ] [WEL] [PKG] [VAL] | 0..1 | |
@RatingPersonType | The person type this rating is based on. AVG ... average UNK ... unknown PRI ... private BUS ... business GRP ... group CON ... conference YCP ... young couple ECP ... elder couple FSC ... family with small children FOC ... family with older children | [AVG] [UNK] [PRI] [BUS] [GRP] [CON] [YCP] [ECP] [FSC] [FOC] | 0..1 | |
</HotelRating> | ||||
<YearBuilt/> | Year built. | 0..1 | 1995 | |
<YearRemodelled/> | Year remodelled. | 0..1 | 2000 | |
<PropertyDescription/> | General description of property in free text | 0..1 | ||
<YearlyClosures> | 0..N | |||
@StartDate | Start date of closure in ISO 8601 format (yyyy-mm-dd). | 0..1 | ||
@EndDate | End date of closure in ISO 8601 format (yyyy-mm-dd). | 0..1 | ||
</YearlyClosures> | ||||
<NumberOfRooms/> | Number of rooms. | 0..1 | 300 | |
<NumberOfFloors/> | Number of floors. | 0..1 | 10 | |
<CheckInTime/> | Earliest check in time. Format: ISO 8601 (hh:mm). | 0..1 | 18:00 | |
<CheckOutTime/> | Latest check out time. Format: ISO 8601 (hh:mm). | 0..1 | 11:00 | |
<Phone> | Hotel phone information. | 0..N | ||
@PhoneNumber | Telephone number assigned to a single location. | 1 | ||
@PhoneUseType | 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 OpenTravel Code List Phone Use Type (PUT). | 0..1 | ||
@PhoneTechType | Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT). | 0..1 | ||
@PhoneLocationType | Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT). | 0..1 | ||
</Phone> | ||||
<CityCode/> | City code. | 0..1 | MIA | |
</HotelInformation> | ||||
<RateInformation> | 0..1 | |||
<RateAmount/> | Amount of the initial daily rate (valid for each day of the booking period, unless a rate change occurs - see RateChangeAmount). | 1 | 15000 | |
<RateChange/> | Rate change indicator determines if the rate changes during the stay. Values are: Y = Yes N = No. | [N] [Y] | 1 | N |
<RateChangeAmount> | Amount of the new daily rate resulting from a rate change effective on the date specified by @EffectiveDate. For each rate change during the booking period there will be a RateChangeAmount element. | 0..N | 13000 | |
@EffectiveDate | Effective date for hotel rate change in ISO 8601 format (yyyy-mm-dd). | 1 | 2002-12-01 | |
</RateChangeAmount> | ||||
<TotalAmount> | Total amount for booked rate for the complete booking period (may include taxes, fees, surcharges). | 0..1 | 25000 | |
@TotalAmountType | Total amount type. N .. no taxes and surcharges included T .. includes taxes S .. includes surcharges ST .. includes surcharges and taxes U .. unknown, whether taxes or surcharges are included | [N] [T] [S] [ST] [U] | 0..1 | |
@TotalTaxesValue | Total taxes value. | 0..1 | 9900 | |
@TotalSurchargesValue | Total surcharges value. | 0..1 | 9900 | |
</TotalAmount> | ||||
<AlternateCurrency> | Alternate currency group. Present only if requested in the corresponding request message and the backend systems supports output in alternate currency. | 0..1 | ||
<RateAmount/> | Amount of the initial daily rate in AlternateCurrency (valid for each day of the booking period, unless a rate change occurs - see RateChangeAmount). | 1 | 14000 | |
<RateChangeAmount> | Amount of the new daily rate in AlternateCurrency resulting from a rate change effective on the date specified by @EffectiveDate. For each rate change during the booking period there will be a RateChangeAmount element. | 0..N | 13000 | |
@EffectiveDate | Effective date for hotel rate change in ISO 8601 format (yyyy-mm-dd). | 1 | 2002-12-01 | |
</RateChangeAmount> | ||||
<TotalAmount> | Total amount for booked rate for the complete booking period in AlternateCurrency (may include taxes, fees, surcharges). | 1 | 25000 | |
@TotalAmountType | Total amount type. N .. no taxes and surcharges included T .. includes taxes S .. includes surcharges ST .. includes surcharges and taxes U .. unknown, whether taxes or surcharges are included | [N] [T] [S] [ST] [U] | 0..1 | |
@TotalTaxesValue | Total taxes value. | 0..1 | 9900 | |
@TotalSurchargesValue | Total surcharges value. | 0..1 | 9900 | |
</TotalAmount> | ||||
</AlternateCurrency> | ||||
<RateCode/> | Rate code. | 1 | HDK | |
<RateDescription> | Rate description text. | 0..1 | DERTOUR City Net Rate | |
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</RateDescription> | ||||
<RoomTypeCode/> | Room Type. | 1 | IC1Q | |
<RoomTypeDescription/> | Room type description. | 0..1 | STANDARD CLASS ROOM/QUEEN BED/21SQM/ | |
<MealInformation> | Meal information | 0..1 | ||
@Type | Meal type. M .. meal B .. breakfast H .. halfboard F .. fullboard A .. all inclusive U .. unknown | [A] [B] [F] [H] [M] [U] | 1 | |
@Value | Meal price value. | 0..1 | 500 | |
@PriceType | Price type. I .. inclusive E .. exclusive U .. unknown | [E] [I] [U] | 1 | |
@Description | Freetext description. | 0..1 | ||
</MealInformation> | ||||
</RateInformation> | ||||
<RuleInformation> | Rule information group | 0..1 | ||
<Promotion> | Promotional data text | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Promotion> | ||||
<RateDescription> | Rate description text. | 0..1 | Best Rate | |
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</RateDescription> | ||||
<RoomRate> | Room rate group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</RoomRate> | ||||
<Rate> | Rate group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Rate> | ||||
<Guarantee> | Guarantee group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Guarantee> | ||||
<Cancellation> | Cancellation group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Cancellation> | ||||
<Deposit> | Deposit group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Deposit> | ||||
<CheckIn> | Check in restrictions, for instance earliest check in time. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</CheckIn> | ||||
<CheckOut> | Check out restrictions, for instance latest check out time. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</CheckOut> | ||||
<RoomDetail> | Room detail group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</RoomDetail> | ||||
<ExtraCharges> | Extra charges group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</ExtraCharges> | ||||
<Packages> | Packages group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Packages> | ||||
<Property> | Property group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Property> | ||||
<Location> | Location group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Location> | ||||
<Miscellaneous> | Miscellaneous group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Miscellaneous> | ||||
<RateAmount> | Rate amount group For precise rate information (rate change, total amount) use RateInformation element. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</RateAmount> | ||||
<AlternateRateAmount> | Alternate rate amount group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</AlternateRateAmount> | ||||
<RateComment> | Rate comment group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</RateComment> | ||||
</RuleInformation> | ||||
<PropertyCodeInformation> | Property code Information group | 0..1 | ||
<PropertyType> | Property type indicator group | 0..1 | ||
<Hotel/> | Property type - Hotel. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Motel/> | Property type - Motel. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Inn/> | Property type - Inn. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<AllSuite/> | Property type - AllSuite. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Condominium/> | Property type - Condominium. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Villa/> | Property type - Villa. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Castle/> | Property type - Castle. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Pension/> | Property type - Pension. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Resort/> | Property type - Resort. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Convention/> | Property type - Convention . Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<BedBreakfast/> | Property type - BedandBreakfast. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Other/> | Property type - Other. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
</PropertyType> | ||||
<CheckInTime/> | Earliest check in time. Format: ISO 8601 (hh:mm). | 0..1 | 18:00 | |
<CheckOutTime/> | Latest check out time. Format: ISO 8601 (hh:mm). | 0..1 | 11:00 | |
<NumberOfRooms/> | Number of rooms. | 0..1 | 300 | |
<NumberOfSuites/> | Number of suites. | 0..1 | 5 | |
<NumberOfFloors/> | Number of floors. | 0..1 | 10 | |
<ConferenceRoomCapacity/> | Conference room capacity. | 0..1 | 1 | |
<YearBuilt/> | Year built. | 0..1 | 1995 | |
<YearRemodelled/> | Year remodelled. | 0..1 | 2000 | |
<AAARating/> | DEPRECATED. DO NOT USE. WILL BE REMOVED FROM SCHEMA JAN 2010. USE HotelRating INSTEAD. AAA rating. | 0..1 | 3 | |
<DepositGuaranteeIndicator/> | Deposit guarantee indicator. Values are: G = Guarantee required D = Deposit required H = Guarantee required for late arrival | [G] [D] [H] | 0..1 | D |
<HoldUntilTime/> | Hold until time. | 0..1 | 15:00 | |
<DepositGuarantee> | Deposit guarantee group | 0..1 | ||
<TimeDue/> | Deposit guarantee time due indicator. Values are: 1=Hours after reservation 2=Days after reservation 3=Hours prior to arrival 4=Days prior to arrival | [1] [2] [3] [4] | 0..1 | 1 |
<TimeDueValue/> | Deposit guarantee time due value, Number of Hours/Days depending on value of previous TimeDue element. | 0..1 | 48 | |
<DepositGuaranteeAmount/> | Deposit guarantee amount indicator. Values are: F = Flat amount D = Number of days to stay P = Percent of full stay | [F] [D] [P] | 0..1 | F |
<AmountValue/> | Deposit guarantee amount value, Amount of Deposit/Guarantee required depending on the value of DepositGuaranteeAmount previous element. If F, = Flat monetary amount deposit/guarantee, If D = Cost of number of days specified, If P = percentage of total cost of stay. | 0..1 | 200 | |
<AlternateCurrencyAmountValue/> | Deposit gurantee amount value indicator in alternate currency. | 0..1 | 3200 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AlternateCurrencyCode> | Alternate currency used for rate quotes. | 0..1 | GBP | |
@NumberOfDecimals | Decimal position in fare amount. | 0..1 | 2 | |
</AlternateCurrencyCode> | ||||
</DepositGuarantee> | ||||
<DepositGuaranteeFormOfPayment> | Deposit guarantee form of payment group | 0..1 | ||
<HotelRulesShared> | Hotel rules shared group | 1 | ||
<PersonalNameAddress/> | Personal name address. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<BusinessNameAddress/> | Business name address. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<AgencyNameAddress/> | Agency name address. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<AgencyID/> | Agency ID. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<AgencyIATA/> | Agency IATA. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<GuaranteeOverrideAllow/> | Guarantee over-ride allowed. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<ClubMemberID/> | Club member ID. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<CorporateID/> | Corporate ID. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<DepositRequiredMethod/> | Deposit required method. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<McoNumber/> | MCO number. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<CreditCard/> | Credit Card. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<TravelVoucherNumber/> | Travel voucher number. | 0..1 | T123456 | |
<PrepayAtRelatedProperty/> | Prepayment at related property. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<Cash/> | Cash. VValues are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<MoneyOrder/> | oney order. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<PersonalCheck/> | Personal check. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<Wire/> | Wire. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<CompanyCheck/> | Company check. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<TourOrder/> | Tour order. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<TravelersCheck/> | Travelers check. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<CertifiedCheck/> | Certified check. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<ElectronicCash/> | Electronic Cash with a debit card, bank card, check card. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
</HotelRulesShared> | ||||
</DepositGuaranteeFormOfPayment> | ||||
<DepositGuaranteeSentTo/> | Deposit guarantee sent to indicator. Values are: S = Property street address C = Property Chain's corporate address M = Property mailing address | [S] [C] [M] | 0..1 | S |
<DepositGuaranteeCreditCardCode> | Deposit Guarantee credit card code group | 0..1 | ||
<CreditCardCode/> | Valid credit card code for deposit guarantee. | 0..N | AX, VI, CA, CB, DC, DS etc | |
</DepositGuaranteeCreditCardCode> | ||||
<PropertyFormOfPayment> | Property Form of payment group | 0..1 | ||
<HotelRulesShared> | Hotel rules shared group | 1 | ||
<PersonalNameAddress/> | Personal name address. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<BusinessNameAddress/> | Business name address. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<AgencyNameAddress/> | Agency name address. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<AgencyID/> | Agency ID. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<AgencyIATA/> | Agency IATA. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<GuaranteeOverrideAllow/> | Guarantee over-ride allowed. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<ClubMemberID/> | Club member ID. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<CorporateID/> | Corporate ID. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<DepositRequiredMethod/> | Deposit required method. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<McoNumber/> | MCO number. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<CreditCard/> | Credit Card. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<TravelVoucherNumber/> | Travel voucher number. | 0..1 | T123456 | |
<PrepayAtRelatedProperty/> | Prepayment at related property. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<Cash/> | Cash. VValues are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<MoneyOrder/> | oney order. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<PersonalCheck/> | Personal check. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<Wire/> | Wire. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<CompanyCheck/> | Company check. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<TourOrder/> | Tour order. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<TravelersCheck/> | Travelers check. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<CertifiedCheck/> | Certified check. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
<ElectronicCash/> | Electronic Cash with a debit card, bank card, check card. Values are: Y = Yes, valid form of payment N = Not a valid form of payment | [Y] [N] | 0..1 | Y |
</HotelRulesShared> | ||||
</PropertyFormOfPayment> | ||||
<PaymentCreditCardCode> | Payment credit card code group | 0..1 | ||
<CreditCardCode/> | Valid credit card code for deposit guarantee. | 0..N | AX, VI, CA, CB, DC, DS etc | |
</PaymentCreditCardCode> | ||||
<CancellationPenalty/> | Cancellation penalty indicator. Values are: Y = Yes, cancel penalty applies N = No cancel penalty applies | [Y] [N] | 0..1 | Y |
<RateData> | Rate data group | 0..N | ||
<RateCategory/> | Rate category. Possible values: ASN = Association CLB = Club CON = Convention COR = Corporate DAY = Day room FAM = Family GOV = Government MIL = Military NEG = Negotiated PKG = Package PRO = Promotional RAC = Standard RAC SPE = Special SRS = Senior citizen STP = Stopover TUR = Tour TVL = Travel industry WKD = Weekend | [ASN] [CLB] [CON] [COR] [DAY] [FAM] [GOV] [MIL] [NEG] [PKG] [PRO] [RAC] [SPE] [SRS] [STP] [TUR] [TVL] [WKD] | 0..1 | GOV |
<MinimumStay/> | Minimum stay. | 0..1 | 3 | |
<MaximumStay/> | Maximum stay. | 0..1 | 99 | |
<AdvanceBooking/> | Advance booking period. | 0..1 | ||
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AlternateCurrencyCode> | Alternate currency used for rate quotes. | 0..1 | GBP | |
@NumberOfDecimals | Decimal position in fare amount. | 0..1 | 2 | |
</AlternateCurrencyCode> | ||||
<TaxIncluded/> | Tax Included. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Commission/> | Commission amount. | 0..1 | 10000 | |
<MealIncluded/> | Meal included. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
</RateData> | ||||
<RuleData> | Rule data group | 0..N | ||
<RoomDescription> | Room Description group | 0..1 | ||
<RoomDescriptionIndicator/> | Room description indicator. Values are: Y = Room Description information provided N = Room Description information NOT provided | [Y] [N] | 0..1 | Y |
<RoomTypeCode/> | Room Type. | 0..1 | A1S | |
<RoomTypeDescription/> | Room type description. | 0..1 | Deluxe single | |
<RoomLocationViewCode/> | Room location view code. Values are: BF = Beach front OF = Ocean front MV = Mountain view SV = Sea view PS = Pool side GC = Golf course view LV = Lake view RV = River view PV = Park view CV = Courtyard view DO = Drive up room Blank = N/A | [BF] [OF] [MV] [SV] [PS] [GC] [LV] [RV] [PV] [CV] [DO] | 0..1 | BF |
<FloorRangeBegin/> | Floor range begin. | 0..1 | 0 | |
<FloorRangeEnd/> | Floor range end. | 0..1 | 35 | |
<NumberOfBedrooms/> | Number of bedrooms. | 0..1 | 100 | |
<AirConditioning/> | Air conditioning. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<BathTub/> | Bath Tub. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Balcony/> | Balcony. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Bidet/> | Bidet. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<ComputerInRoom/> | Computer in room. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<ConcessionLevel/> | Concession level. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<ConnectingRoom/> | Connecting room. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<ContinentalBreakfast/> | Continental breakfast. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Efficiency/> | Efficiency. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<FirePlace/> | Fireplace. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<HandicapFacility/> | Handicap facility. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Kitchen/> | Kitchen. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<MiniBar/> | Mini bar. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<MoviesInRoom/> | Movies in room. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<NoSmokingRoom/> | No smoking room. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<SmallPet/> | Small pet. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<PhoneService/> | Phone service. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Refrigerator/> | Refrigerator. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<OrientalRoomStyle/> | Oriental room style. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<WesternRoomStyle/> | Western room style. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<SafeInRoom/> | Safe in room. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Sauna/> | Sauna. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Shower/> | Shower. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<Spa/> | Spa. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<TV/> | TV. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<CableTV/> | Cable TV. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<VCR/> | VCR. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<WaterBed/> | Waterbed. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<WC/> | WC. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<WetBar/> | Wet bar. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<AC120/> | 120AC. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<DC120/> | 120DC. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<AC220/> | 220AC. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<DC220/> | 220DC. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
<ModemInRoom/> | Modem in room. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
</RoomDescription> | ||||
<ExtraOptions> | Extra options group | 0..1 | ||
<ExtraOptIndicator/> | Extra options indicator. Values are: Y = Yes room description info provided N = No room description info not provided | [Y] [N] | 1 | Y |
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AlternateCurrencyCode> | Alternate currency used for rate quotes. | 0..1 | GBP | |
@NumberOfDecimals | Decimal position in fare amount. | 0..1 | 2 | |
</AlternateCurrencyCode> | ||||
<ExtraAdultCharge/> | Extra options adult charge. | 0..1 | 10000 | |
<ExtraChildCharge/> | Extra options child charge. | 0..1 | 5000 | |
<NumberOfRollaway/> | Number of rollaway beds. | 0..1 | 2 | |
<AdultRollawayCharge/> | Charge for adult rollaway bed. | 0..1 | 5000 | |
<ChildRollawayCharge/> | Charge for child rollaway bed. | 0..1 | 5000 | |
<CribCharge/> | Charge for crib bed. | 0..1 | 3000 | |
<ChildLowestAge/> | Lowest age for child. | 0..1 | 2 | |
<ChildHighestAge/> | Highest age for child. | 0..1 | 16 | |
<AlternateCurrencyExtraAdultCharge/> | Extra options adult charge in alternate currency. | 0..1 | 30000 | |
<AlternateCurrencyExtraChildCharge/> | Extra options child charge in alternate currency. | 0..1 | 15000 | |
<AlternateCurrencyAdultRollawayCharge/> | Extra options adult rollaway charge in alternate currency. | 0..1 | 15000 | |
<AlternateCurrencyChildRollawayCharge/> | Extra options child rollaway charge in alternate currency. | 0..1 | 7000 | |
<AlternateCurrencyCribCharge/> | Extra options crib charge in alternate currency. | 0..1 | 9000 | |
</ExtraOptions> | ||||
<RateText> | Rate Text group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</RateText> | ||||
<RateQualifierText> | Rate qualifier text group | 0..1 | ||
<Text/> | Information text or error text. | 0..1 | Free flow text. Example: Invalid flight number | |
</RateQualifierText> | ||||
<RateAmountText> | Rate amount text group | 0..N | ||
<Amount/> | Amount. | 0..1 | 15000 | |
<AlternateCurrencyAmount/> | Amount in alternate currency. | 0..1 | 32000 | |
<NumberOfNights/> | Number of nights. | 0..1 | 5 | |
<BeginDate/> | Rate Begin Date ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
<EndDate/> | Rate End Date ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
</RateAmountText> | ||||
<TaxText> | Tax text group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</TaxText> | ||||
<SendDepositToAddress> | Send deposit to address group | 0..1 | ||
<Text/> | Information text or error text. | 0..1 | Free flow text. Example: Invalid flight number | |
</SendDepositToAddress> | ||||
<DepositGuaranteeText> | Deposit guarantee text group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</DepositGuaranteeText> | ||||
<Cancel> | Cancel group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Cancel> | ||||
<FormOfPaymentText> | For of payment text group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</FormOfPaymentText> | ||||
<RoomDescriptionText> | Room description text group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</RoomDescriptionText> | ||||
<ExtraOptionsText> | Extra options text group | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</ExtraOptionsText> | ||||
</RuleData> | ||||
<HotelRating> | Rating of this hotel. Note that this element will eventually supercede the AAARating element definition. The latter will be deprecated soon. | 0..N | NTM3 CROWN | |
@RatingSystem | Identifies the rating system used to rate the hotel. Values are: AAA .. AAA Diamond rating AA .. Automobile Association Star Rating AMA .. Amadeus C24 .. check24 CRC .. CorporateRatesClub EAN .. Expedia EHB .. eHotelBar EHS .. eHotelStars EHT .. eHotel GUESTS .. Guest rating HBC .. Booking.com rating HRS .. Hotel Reservation System 'stars' rating JVW .. Jonview rating LSR .. Local Star Rating MIC .. Michelin MOB .. Mobil Hotel Star NTM .. North Star Media 'crown' rating OHG .. Official Hotel Guide TPA .. Tripadvisor VDR .. Verband Deutsches Reisemanagement UNK .. unknown | [AAA] [AA] [AMA] [C24] [CRC] [EAN] [EHB] [EHS] [EHT] [GUESTS] [HBC] [HRS] [JVW] [LSR] [MIC] [MOB] [NTM] [OHG] [TPA] [VDR] [UNK] | 0..1 | |
@RatingType | The category type, the rating applies to. AVG ... average UNK ... unknown COF ... comfort factor ATM ... hotel atmosphere FOR ... friendliness of reception SOE ... service of hotel employees HFA ... hotel facilities RFA ... room facilities RSI ... room size SAN ... sanitary equipment CLE ... cleanliness BFQ ... breakfast quality REQ ... restaurant quality WEL ... wellness PKG ... package VAL ... price value | [AVG] [UNK] [COF] [ATM] [FOR] [SOE] [HFA] [RFA] [RSI] [SAN] [CLE] [BFQ] [REQ] [WEL] [PKG] [VAL] | 0..1 | |
@RatingPersonType | The person type this rating is based on. AVG ... average UNK ... unknown PRI ... private BUS ... business GRP ... group CON ... conference YCP ... young couple ECP ... elder couple FSC ... family with small children FOC ... family with older children | [AVG] [UNK] [PRI] [BUS] [GRP] [CON] [YCP] [ECP] [FSC] [FOC] | 0..1 | |
</HotelRating> | ||||
</PropertyCodeInformation> | ||||
<Media> | 0..N | |||
<Url/> | Hyperlink defining the location of the referenced media (e.g. location of a JPG file). | 1 | ||
<Width> | Width of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Width> | ||||
<Height> | Height of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Height> | ||||
<Type> | Type of media content. For value 'OTA' the attributes @Type and @Code contain the media type information. Values other than 'OTA' are deprecated. Values: OTA image webcam video logo gallery 360 (panorama view) | [OTA] [image] [webcam] [360] [video] [logo] [map] [gallery] | 1 | OTA |
@Type | OTA code type. CTT .. Content Code PIC .. Picture Category Code | [CTT] [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 16 | |
@Description | Free text description. If none available the OTA code name is used. | 0..1 | Streaming video | |
</Type> | ||||
<Preview> | Preview of the referenced media content (e.g. thumbnail of the picture). | 0..N | ||
<Url/> | Hyperlink defining the location of the referenced media (e.g. location of a JPG file). | 1 | ||
<Width> | Width of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Width> | ||||
<Height> | Height of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Height> | ||||
<Type> | Type of media content. For value 'OTA' the attributes @Type and @Code contain the media type information. Values other than 'OTA' are deprecated. Values: OTA image webcam video logo gallery 360 (panorama view) | [OTA] [image] [webcam] [360] [video] [logo] [map] [gallery] | 1 | OTA |
@Type | OTA code type. CTT .. Content Code PIC .. Picture Category Code | [CTT] [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 16 | |
@Description | Free text description. If none available the OTA code name is used. | 0..1 | Streaming video | |
</Type> | ||||
</Preview> | ||||
<Description> | Media content description (e.g. exterior view). | 0..1 | ||
@Type | OTA code type. PIC .. Content Code | [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 3 | |
@Description | OTA code name. | 0..1 | Pool view | |
</Description> | ||||
<Caption/> | Title for the media. | 0..1 | Exterior | |
</Media> | ||||
<BookingPolicy> | Booking policy | 0..N | ||
@Type | Booking policy restriction type. Y .. sell restrictions apply N .. no sell restrictions if detailed informations on sell restrictions are available, the following restriction types can be specified: A .. age AC .. children age (for a child price) B .. booking D .. duration (min/max stay) R .. arrival T .. number of travelers UFC .. usual free child rules The existence of a UFC typed BookingPolicy indicates, that children stay free. This general fact can be further restricted by the MAX, MAX2 and Description attributes. | [Y] [N] [A] [AC] [B] [D] [R] [T] [UFC] | 1 | |
@MAX | Maximum value. Either contains a maximum value or just Y if no detailed information is available, but only the information about the existance of a restriction. For Type = A: Maximum age to make the booking. For Type = AC: Maximum age for a child price. For Type B: Maximum amount of time (depending on interval type in UMAX) before checkin to make the booking. For Type = D: Maximum stay to make the booking. For Type = T: Maximum number of travelers per room. For Type = UFC: Usual number of children that are allowed to stay free with an adult. If this value is not set, then there is no such limit. | 0..1 | 3 | |
@UMAX | Units for MAX value. If MAX is specified, this field is mandatory for the following types: A,AC,B,D,R. H .. hours N .. number of nights D .. days W .. weeks M .. month Y .. years | [D] [H] [M] [N] [W] [Y] | 0..1 | |
@MAX2 | An additional Maximum value. Either contains a maximum value or just Y if no detailed information is available, but only the information about the existance of a restriction. For Type = UFC: Age limit for a child, which can stay free with an adult at the hotel facility. | 0..1 | 8 | |
@UMAX2 | Units for MAX2 value. If MAX2 is specified, this field is mandatory for the following types: UFC. H .. hours N .. number of nights D .. days W .. weeks M .. month Y .. years | [D] [H] [M] [N] [W] [Y] | 0..1 | |
@MIN | Minimum value. Either contains a minimum value or just Y if no detailed information is available, but only the information about the existance of a restriction. For Type = A: Minimum age to make the booking. For Type = AC: Minimum age for a child price. For Type B: Minimum amount of time (depending on interval type in UMIN) before checkin to make the booking. For Type = D: Minimum stay to make the booking. For Type = T: Minimum number of travelers per room. | 0..1 | 3 | |
@UMIN | Units for MIN value. If MIN is specified, this field is mandatory for the following types: A,AC,B,D,R. H .. hours N .. number of nights D .. days W .. weeks M .. month Y .. years | [D] [H] [M] [N] [W] [Y] | 0..1 | |
@Date | Date. For Type = B: Latest date to make the booking. | 0..1 | 2010-06-30 | |
@Time | Time. For Type = B: Latest time to make the booking. For Type = R: Latest arrival time. | 0..1 | 16:00 | |
@Description | Freetext description. For Type = UFC: This can contain a freetext description, which might restrict the usual free child rule. | 0..1 | ||
</BookingPolicy> | ||||
<CommissionPolicy> | Commission policy | 0..1 | ||
@Type | Commission type. N .. no commission U .. unknown P .. percentage A .. amount F .. freetext description only | [A] [F] [N] [P] [U] | 1 | |
@Value | Commission value. Content depends on type. Examples: 500 for A 7.5 for P | 0..1 | ||
@Description | Freetext description. | 0..1 | ||
</CommissionPolicy> | ||||
<CancellationPolicy> | Cancellation policy | 0..N | ||
@Type | Cancellation type. N .. no cancellation penalty U .. unknown Y .. cancellation penalty, but no details available P .. percentage A .. amount NN .. number of nights charged T .. freetext description only Value set to 'P' and V='100' shows that the rate cannot be cancelled. Applies usually to certain rates with deposit requirement where full payment is required in advance and the reservation cannot be cancelled. Usually means that the amounts paid are non-refundable. In such cases it is recommended to see results of HotelInformationRQ/RS. | [A] [N] [NN] [P] [T] [U] [Y] | 1 | |
@Value | Cancellation penalty value. Content depends on type. Examples: 500 for A 7.5 for P 2 for NN | 0..1 | ||
@LatestCancelDate | Latest cancellation date to avoid penalties. | 0..1 | 2010-06-30 | |
@LatestCancelTime | Latest cancellation time to avoid penalties. | 0..1 | 16:00 | |
@IntervalUnits | Interval units. H .. hours D .. days W .. weeks M .. month | [D] [H] [M] [W] | 0..1 | |
@Interval | Amount of time (depending on interval type) before checkin to cancel a reservation to avoid penalty. | 0..1 | 12 | |
@IntervalType | Defines meaning of interval, default: BeforeArrival. Values: BeforeArrival, AfterBooking | [BeforeArrival] [AfterBooking] | 0..1 | BeforeArrival |
@Description | Freetext description. | 0..1 | ||
</CancellationPolicy> | ||||
<FormOfPaymentPolicy> | Form of payment policy | 0..N | ||
@Type | OTA code type. CDT .. CardType PMT .. Payment Type | [PMT] [CDT] | 1 | |
@Code | OTA code. Examples for PMT (payment type): 1 .. Cash 2 .. Direct bill 5 .. Credit card 7 .. Check 10 .. Central bill (Airplus) 19 .. Travel agency IATA number | 1 | ||
@Description | Free text description. If none available the OTA code name is used. | 0..1 | ||
@AcceptanceStatus | Acceptance status for this payment method U .. Unknown AF .. Accepted with Fees A .. Accepted (no fees) N .. Not accepted | [U] [AF] [A] [N] | 0..1 | |
</FormOfPaymentPolicy> | ||||
<DepositPolicy> | Deposit policy | 0..1 | ||
@Type | Deposit type. N .. no deposit required U .. unknown Y .. deposit required, but no details available P .. percentage A .. amount NN .. number of nights charged F .. freetext description only | [A] [F] [N] [NN] [P] [U] [Y] | 1 | |
@Value | Deposit value. Content depends on type. Examples: 500 for A 7.5 for P 2 for NN | 0..1 | ||
@LatestDepositDate | Latest date to provide deposit. | 0..1 | 2010-06-30 | |
@LatestDepositTime | Latest time to provide deposit. | 0..1 | 16:00 | |
@IntervalUnits | Interval units. H .. hours D .. days W .. weeks M .. month | [D] [H] [M] [W] | 0..1 | |
@Interval | Amount of time (depending on interval type) before checkin to provide deposit for reservation. | 0..1 | 12 | |
@Description | Freetext description. | 0..1 | ||
@NVB | Identifies "not valid before" date. Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2012-01-03 | |
@NVA | Identifies "not valid after" date. Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2012-01-18 | |
<Method> | Method | 0..N | ||
@Type | Method type. OTA code of type PMT (payment type). Examples: 1 .. Cash 5 .. Credit card 7 .. Check 19 .. Travel agency IATA number | 1 | ||
@SecurityID | Only applies to @Type="5" (credit card): If a credit card security number (referred to also as CVV2, CVC, CVC2, CSC or CID) must be provided for the credit card, @Security="Y" is returned. | [Y] | 0..1 | Y |
</Method> | ||||
</DepositPolicy> | ||||
<GuaranteePolicy> | Guarantee Policy | 0..1 | ||
@Type | Guarantee type. N .. no guarantee required Y .. guarantee required F .. freetext description only U .. unknown | [N] [U] [F] [Y] | 1 | |
@LatestGuaranteeTime | Guarantee latest arrival time. | 0..1 | 16:00 | |
@IntervalUnits | Interval units. H .. hours D .. days W .. weeks M .. month | [D] [H] [M] [W] | 0..1 | |
@Interval | Amount of time (depending on interval type) before checkin to guarantee a reservation. | 0..1 | 12 | |
@Description | Freetext description. | 0..1 | ||
@NVB | Identifies "not valid before" date. Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2012-01-03 | |
@NVA | Identifies "not valid after" date. Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2012-01-18 | |
<Method> | Method | 0..N | ||
@Type | Method type. OTA code of type PMT (payment type). Examples: 1 .. Cash 5 .. Credit card 7 .. Check 19 .. Travel agency IATA number | 1 | ||
@SecurityID | Only applies to @Type="5" (credit card): If a credit card security number (referred to also as CVV2, CVC, CVC2, CSC or CID) must be provided for the credit card, @Security="Y" is returned. | [Y] | 0..1 | Y |
</Method> | ||||
</GuaranteePolicy> | ||||
<TaxPolicy> | 0..1 | |||
@Type | OTA code type. FTT .. Fee Tax Type | [BUS] [GRI] [HAC] [LOC] [MPT] [PCT] [PHY] [RST] [SEC] [PET] [RMA] | 1 | |
@Code | OTA code. | 1 | ||
@Description | Free text description. If none available the OTA code name is used. | 0..1 | ||
@Percent | Percentage | 0..1 | 15 | |
@Amount | charge amount for this fee or tax | 0..1 | 2000 | |
@ChargeUnit | OTA CHG Code (Charge Type) | 0..1 | 19 | |
</TaxPolicy> | ||||
<HotelCharacteristics> | Amenities, services and features the hotel is offering. | 0..N | ||
@Type | OTA code type or 'VS'. ACC .. Attraction Category Code ADT .. Additional Detail Type AMC .. Available Meal Category Codes BUS .. Business Srvc Type GRI .. Guest Room Info HAC .. Hotel Amenity Code INF .. Information Type LOC .. Location Category Codes MPT .. Meal Plan Type MRC .. Meeting Room Code PCT .. Property Class Type PET .. Pets Policy Code PHY .. Physically Challenged Feature Code RMA .. Room Amenity Type RST .. Recreation Srvc Type SEC .. Security Feature Code SEG .. Segment Category Code TRP .. Transportation Code VS .. Vendor specific Non-OTA Code | [ACC] [ADT] [AMC] [BUS] [GRI] [HAC] [INF] [LOC] [MPT] [MRC] [PCT] [PET] [PHY] [RMA] [RST] [SEC] [SEG] [TRP] [VS] | 1 | |
@Code | OTA code or vendor specific code. | 1 | ||
@Quantity | If necessary a quantity for an item can be specified here. | 0..1 | ||
@Description | Free text description. If none available the OTA code name is used. | 0..1 | ||
@Included | Indicates, whether this is included in the rate or not. Y .. is included in rate N .. is NOT included in rate U .. unknown | [Y] [N] [U] | 0..1 | |
@ChargeAmount | Cost amount for this item. | 0..1 | 2000 | |
<Details> | 0..N | |||
@Type | OTA code type. PRX .. Proximity REC .. Recreation Srvc Detail Code | [PRX] [REC] | 1 | |
@Code | OTA code. | 1 | ||
@Description | Free text description. If none available the OTA code name is used. | 0..1 | ||
</Details> | ||||
<OperationSchedule> | 0..N | |||
<OperationTime> | 1..N | |||
@Mon | [Y] [N] | 0..1 | ||
@Tue | [Y] [N] | 0..1 | ||
@Weds | [Y] [N] | 0..1 | ||
@Thurs | [Y] [N] | 0..1 | ||
@Fri | [Y] [N] | 0..1 | ||
@Sat | [Y] [N] | 0..1 | ||
@Sun | [Y] [N] | 0..1 | ||
@Start | Start time. | 0..1 | 08:00 | |
@End | Start time. | 0..1 | 18:00 | |
</OperationTime> | ||||
<Charge> | 0..1 | |||
@Amount | Charge amount. | 0..1 | 2000 | |
@ChargeUnit | OTA CHG Code (Charge Type) | 0..1 | 19 | |
</Charge> | ||||
</OperationSchedule> | ||||
</HotelCharacteristics> | ||||
<Restaurants> | 0..N | |||
@ID | ID of restaurant | 0..1 | ||
@Name | Name of the restaurant | 0..1 | ||
@Description | Free text description. | 0..1 | ||
<Details> | 0..N | |||
@Type | OTA code type. RES .. Restaurant Category Code PRX .. Proximity AMC .. Available Meal Category Codes CUI .. Main Cuisine Code RSI .. Restaurant Srvc Info | [RES] [PRX] [AMC] [CUI] [RSI] | 1 | |
@Code | OTA code. | 1 | ||
@Description | Free text description. If none available the OTA code name is used. | 0..1 | ||
</Details> | ||||
</Restaurants> | ||||
<Rooms> | 0..N | |||
<RoomTypeCode/> | Room Type. | 0..1 | A1S | |
<RoomTypeDescription/> | Room type description. | 0..1 | Deluxe single | |
<RoomCharacteristics> | Amenities, services and features the room is offering. | 0..N | ||
@Type | OTA code type. ADT .. Additional Detail Type BED .. Bed Type FTT .. Fee Tax Type GRI .. Guest Room Info HAC .. Hotel Amenity Code RMA .. Room Amenity Type RVT .. Room View Type RLT .. Room Location Type MPT .. Meal Plan Type BUS .. Business Srvc Type SEC .. Security Feature Code PHY .. Physically Challenged Feature Code SEG .. Segment Category Code | [ADT] [BED] [FTT] [GRI] [HAC] [RMA] [RVT] [RLT] [MPT] [BUS] [SEC] [PHY] [SEG] | 1 | |
@Code | OTA code. | 1 | ||
@Quantity | If necessary a quantity for an item can be specified here. | 0..1 | ||
@Description | Free text description. If none available the OTA code name is used. | 0..1 | ||
@Included | Indicates, whether this is included in the rate or not. Y .. is included in rate N .. is NOT included in rate U .. unknown | [Y] [N] [U] | 0..1 | |
@ChargeAmount | Cost amount for this item. | 0..1 | 2000 | |
<OperationSchedule> | 0..N | |||
<Charge> | 0..1 | |||
@Amount | Charge amount. | 0..1 | 2000 | |
@ChargeUnit | OTA CHG Code (Charge Type) | 0..1 | 19 | |
</Charge> | ||||
</OperationSchedule> | ||||
</RoomCharacteristics> | ||||
</Rooms> | ||||
<MeetingRooms> | 0..N | |||
@ID | ID of meeting room | 0..1 | ||
@Name | Name of the meeting room. | 0..1 | ||
@Description | Free text description. | 0..1 | ||
@Units | Description of the units of measure for the meeting room size attributes F .. feet M .. meter U .. unknown | [F] [M] [U] | 0..1 | |
@Size | Meeting room size - in Units squared | 0..1 | ||
@Capacity | Capacity of the meeting room. | 0..1 | ||
<MeetingRoomCharacteristics> | Amenities, features the meeting room is offering. | 0..N | ||
@Type | OTA code type. MRC .. Meeting Room Code MRF .. Meeting Room Format Code | [MRC] [MRF] | 1 | |
@Code | OTA code. | 1 | ||
@Description | Free text description. If none available the OTA code name is used. | 0..1 | ||
@Capacity | Capacity of the meeting room in the configuration described by the OTA code for OTA type MRF. | 0..1 | ||
@Included | Indicates, whether this is included in the rate or not. Y .. is included in rate N .. is NOT included in rate U .. unknown | [Y] [N] [U] | 0..1 | |
</MeetingRoomCharacteristics> | ||||
</MeetingRooms> | ||||
<Attractions> | 0..N | |||
@Type | OTA code type. ACC .. Attraction Category Code IPC .. Index Point Code | [ACC] [IPC] | 1 | |
@Code | OTA code. | 1 | ||
@ID | ID of attraction | 0..1 | ||
@Name | Name of the attraction | 0..1 | ||
@Description | Free text description. If none available the OTA code name is used. | 0..1 | ||
<RefPoints> | 0..N | |||
@Direction | Direction from the attraction to the hotel | 0..1 | ||
@Distance | Distance attraction / hotel | 0..1 | ||
@DistanceUnit | OTA UOM Code (Unit of Measure Code) Values: 1 .. Miles 2 .. Kilometers 3 .. Meters 10 .. Block | [1] [2] [3] [10] | 0..1 | 10 |
@Primary | primary within its category. Values: Y, N | [Y] [N] | 0..1 | Y |
@Description | Free text description. | 0..1 | ||
<Transportations> | 0..N | |||
@Type | OTA code type. TRP .. Transportation Code | [TRP] | 1 | |
@Code | OTA code. | 1 | ||
@Description | Free text description. If none available the OTA code name is used. | 0..1 | ||
@Amount | Cost of transportation. | 0..1 | 1000 | |
</Transportations> | ||||
</RefPoints> | ||||
<Url/> | 0..N | |||
</Attractions> | ||||
</HotelInformationRS> |
Column | Description |
---|---|
Node | Name of message node (element or attribute). Nodes in bold type are mandatory, if their parent element occurs in the message. Point mouse cursor at table cell to view complete XPath. |
Description | Description of meaning and usage of the node. |
Values | List of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema. |
Occurs | Minimum and maximum number of times the node must/may occur, if its parent element occurs in the message. Examples: 0..3 Node is optional and may occur up to 3 times. 1..N Node must occur at least one (mandatory) and may occur any number of times. 2 Node must occur exactly twice. |
Example | Example value for the node. |
XML Schema documentation generated with XX/1 server