Message Description
The kiosk obtains a list of rooms that can be assigned to an arriving reservation (rooms can be clean or dirty), based on guest preferences. Basic course of events: the use case begins after an arriving guest has found their booking.
- The guest chooses an option to select a room.
- The kiosk collects the desired room preferences from the guest.
- The kiosk requests the list of available rooms from the PMS which match the criteria specified by the guest, plus an indicator of ‘maximum number of responses’ desired by the kiosk.
- The PMS returns a list of available rooms which can be assigned; the response can contain both rooms available for check-in (i.e.,vacant/clean) and rooms available for pre-assignment (departing, dirty,etc.) immediately assigned, sorted by status (vacant/clean first) and PMS ranking scheme. The list contains no more than the maximum responses requested by the kiosk.
Exceptions: There may be no rooms (dirty or clean) that can be assigned to the reservation. The PMS sends an error message to the kiosk. The kiosk indicates to the guest that no rooms are available and follows its business logic for this exception (usually guest is sent to front desk)
Alternative paths: Dependent on kiosk implementation, steps 2 and (3, 4) could be reversed, in that kiosk first requests rooms for assignment, then presents the guest with preference selections that match only the available rooms presented by the PMS.
Trigger: Guest opts to select a room prior to checking in.
Assumptions: The PMS will return all available rooms prioritized by the PMS ranking scheme.
Requirement: Guest has an arriving reservation which may or may not have a room assigned.
Alerts:
- AvailRS's purpose is to book 1 room at a time for walk-in reservations.
- AvailRS can not replace outbound ARI messages
- The number of room IDs referenced in the AvailRS shows how many rooms can be assigned to a reservation - and not how many room can be booked for new reservations
Sample Worflow:
Message Attributes
OTA_HotelAvailRQ
| Element | @Attribute | Type | Num | Description | Comments + Content inbound | pAIR | onPrem |
|---|---|---|---|---|---|---|
| OTA_HotelAvailRQ | 1 | Requests availability of hotel properties by specific criteria that may include: dates, date ranges, price range, room types, regular and qualifying rates, and/or services and amenities. The availability message can be used to get an initial availability or to get availability for the purpose of modifying an existing reservation. |  | | ||
@EchoToken | StringLength1to128 | 0..1 | 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 echotoken with an identical value. | Unique string | | |
@CorrelationID | StringLength1to64 | 1 | Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory. | Unique string | | |
@TimeStamp | dateTime | 1 | Timestamp of the transaction. | YYYY-MM-DDThh:mm:ssZ | | |
@Version | decimal | 0..1 | Version of the message | Version="1.0" | | |
@PrimaryLangID | language | 0..1 | Default language of the property. | | | |
| @MaxResponses | integer | 0..1 | Indicates and limits the number of of responses. | | | |
| @ExactMatchOnly | boolean | 0..1 | Indicates that the response message should send back only those rates that are an exact match to requested criteria. | | | |
| @Target | NMTOKEN | 0..1 | Used to indicate wether the request is for the Test or the Production system. |
| | |
| @AvailRatesOnly | boolean | 0..1 | Indicates that the response should include only those rates that are available in the date range specified or wether rates that are not available should be shown. |  | ||
| @IsModify | boolean | 0..1 | A boolean flag that indicates the response message should return only HotelStay information. | If the flag is true, the AvailRS will not hold the Errors element, if only no available inventory is found, but return an empty result with the TPA_Extensions AvailabilityExtensions filled (for room assignment). | | |
| OTA_HotelAvailRQ | POS | 0..1 | Point of sale object. | | | ||
| OTA_HotelAvailRQ | POS | Source | 1..10 | Provides information on the source of a request. | | | ||
| OTA_HotelAvailRQ | POS | Source | RequestorID | 0..1 | 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)). | | | ||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT) | | | |
@ID | StringLength1to32 | 1 | The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages. | | | |
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | “protelIO” | | |
| OTA_HotelAvailRQ | POS | Source | BookingChannel | 0..1 | Specifies the booking channel type and wether it is the primary one. | | | ||
| @Type | OTA_CodeType BCT | 1 | The type of booking channel. Refer to OTA Code List Booking Channel Type (BCT). | | | |
| @Primary | boolean | 0..1 | Indicates wether the enumerated booking channel is the primary means of connectivity used by the source. | | | |
| OTA_HotelAvailRQ | AvailRequestSegments | 1 | A collection of AvailRequestSegment elements. | | | ||
| OTA_HotelAvailRQ | AvailRequestSegments | AvailRequestSegment | 1..n | A collection of criteria that requests a bookable entity (in this case, a listing of physical rooms available for occupancy for a given date range). | | | ||
| @AvailReqType | StringLength1to16 | 0..1 | An enumerated type that indicates whether the availability request is for a room or non-room product. | We only use "Room" | | |
| OTA_HotelAvailRQ | AvailRequestSegments | AvailRequestSegment | HotelSearchCriteria | 0..1 | Availability search criteria should be specified here. | | | ||
| OTA_HotelAvailRQ | AvailRequestSegments | AvailRequestSegment | HotelSearchCriteria | Criterion | 1..n | Child elements that identifies a single search criterion by criteria type. | | | ||
| OTA_HotelAvailRQ | AvailRequestSegments | AvailRequestSegment | HotelSearchCriteria | Criterion | StayDateRange | 0..1 | Range of dates or fixed set of dates for availability request. | | | ||
| @End | date | 1 | The departure date for the reservation. | YYYY-MM-DD | | |
| @Start | date | 1 | The arrival date for the reservation. | YYYY-MM-DD | | |
| OTA_HotelAvailRQ | AvailRequestSegments | AvailRequestSegment | HotelSearchCriteria | Criterion | RoomStayCandidates | 0..1 | A collection of room stay candidates. | | | ||
| OTA_HotelAvailRQ | AvailRequestSegments | AvailRequestSegment | HotelSearchCriteria | Criterion | RoomStayCandidates | RoomStayCandidate | 1..n | Element used to identify available room products. | | | ||
| @RoomTypeCode | StringLength1to64 | 1 | Specific system room type code | e.g.; A1K, A1Q etc. | | |
| @RoomID | StringLength1to64 | 0..1 | Specific room ID | e.g. 101 | | |
| @Floor | Numeric1to999 | 0..1 | Specific floor | | | |
| @NonSmoking | boolean | 0..1 | Non-smoking indicator | |||
| OTA_HotelAvailRQ | AvailRequestSegments | AvailRequestSegment | HotelSearchCriteria | Criterion | RoomStayCandidates | RoomStayCandidate | GuestCounts | 1 | A collection of GuestCounts by age group. | | | ||
| @IsPerRoom | boolean | 0..1 | 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. | | | |
| OTA_HotelAvailRQ | AvailRequestSegments | AvailRequestSegment | HotelSearchCriteria | Criterion | RoomStayCandidates | RoomStayCandidate | GuestCounts | GuestCount | 1..n | A recurring element that identifies the number of guests and ages of the guests. | | | ||
| @AgeQualifyingCode | OTA_CodeType AQC | 1 | Defines an age range or age category of a guest (e.g., under 21, over 65, teen, infant). Refer to OpenTravel Code List Age Qualifying Code (AQC) | Age Qualifying Code (AQC) | | |
| @Count | Numeric1to999 | 1 | The number of guests in one AgeQualifyingCode. | | | |
| OTA_HotelAvailRQ | AvailRequestSegments | AvailRequestSegment | HotelSearchCriteria | Criterion | RoomStayCandidates | RoomStayCandidate | RoomAmenity | 0..5 | This element is used to pass room attributes like smoking, non-smoking, wheelchair access etc. | | | ||
| @RoomAmenity | 0..1 | Identifies the type of room amenities. Refer to Open Travel Code list Room Amenity Type (RMA). | | | ||
| OTA_HotelAvailRQ | AvailRequestSegments | AvailRequestSegment | HotelSearchCriteria | Criterion | Profiles | 0..1 | A collection of profile objects or unique IDs of profiles | | | ||
| OTA_HotelAvailRQ | AvailRequestSegments | AvailRequestSegment | HotelSearchCriteria | Criterion | Profiles | ProfileInfo | 1..n | A collection of profiles or unique IDs of profiles | | | ||
| OTA_HotelAvailRQ | AvailRequestSegments | AvailRequestSegment | HotelSearchCriteria | Criterion | Profiles | ProfileInfo | UniqueID | 0..9 | A unique ID for a profile. | | | ||
@ID | StringLength1to32 | 1 | The ID will transfer the profileID. | | | |
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | "protelIO" | | |
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT) | | | |
| OTA_HotelAvailRQ | AvailRequestSegments | AvailRequestSegment | HotelSearchCriteria | Criterion | Profiles | ProfileInfo | Profile | 1 | Not validated in PMS, but mandatory in OTA, so we need an empty element. | | | ||
| OTA_HotelAvailRQ | HotelReservationIDs | 0..1 | A collection of HotelReservationID objects for a given reservation. The collection of all ReservationIDs can include Passenger Name Record (PNR), Guest Name Record (GNR) and Guest Folio numbers. Associated with each can be a confirmation number which is usually given to the Guest. | | | ||
| OTA_HotelAvailRQ | HotelReservationIDs | HotelReservationID | 1..n | The HotelReservationID object contains various unique (ReservationID) and non-unique (ConfirmationID, CancellationID) identifiers that the trading partners associate with a given reservation. | | | ||
| @ResID_Type | OTA_CodeType UIT | 1 | Defines the type of Reservation ID (e.g.; reservation number, cancellation number). Refer to OpenTravel Alliance Code List Unique ID Type (UIT). | | | |
| @ResID_Value | StringLength1to64 | 1 | This is the actual value associated with ResID_Type as generated by the system that is the source of the ResID_Type. | | | |
| @ResID_Source | StringLength1to64 | 0..1 | A unique identifier to indicate the source system which generated the ResID_Value. | "protelIO" | | |
OTA_HotelAvailRS
| Element | @Attribute | Type | Num | Description | Comments + Content outbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|
| OTA_HotelAvailRS | 1 | 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. | | | ||
@EchoToken | StringLength1to128 | 0..1 | 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. | Unique string | | |
@CorrelationID | StringLength1to64 | 1 | Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory. | Unique string | | |
@TimeStamp | dateTime | 1 | Timestamp of the transaction. | YYYY-MM-DDThh:mm:ssZ | | |
@Version | decimal | 0..1 | Version of the message | pAir: "1" onPrem: "6.001" | | |
@PrimaryLangID | language | 0..1 | Default language of the property. | ISO 639 | | |
| OTA_ HotelAvailRS | Success | 1 | The presence of the empty success element explicitly indicates that the message succeeded. | | | ||
| OTA_ HotelAvailRS | Warnings | 0..1 | Used in conjunction with the success element to define one or more business errors. | | | ||
| OTA_ HotelAvailRS | Warnings | Warning | 1..999 | Used when a message has been successfully processed to report any warnings or business errors that occurred. | | | ||
@Type | OTA_CodeType EWT | 1 | Mandatory. Refer to the OTA Code List: Error Warning Type (EWT). | | | |
@Code | OTA_CodeType ERR | 0..1 | Refers to the OTA Code List: Error Codes (ERR). | | | |
@RecordID | StringLength1to64 | 0..1 | If the receiving system is able to identify within a batch of AvailRequestSegment messages which specific message failed, the UniqueID of the message should be reported here. | | | |
@ShortText | StringLength1to64 | 0..1 | Describes the occurring error in short. Example: "A rate plan 'XY' was not found for the code provided." | | | |
| OTA_HotelAvailRS | HotelStays | 0..1 | A collection of HotelStay summarized information about the requested hotels' general availability for each day in the requested range. | | | ||
| OTA_HotelAvailRS | HotelStays | HotelStay | 1..n | A quick view of the requested hotels' general availability for each day in the requested range. | | | ||
| @RoomStayRPH | ListOfRPH | 0..1 | References one or more room stays associated with the hotel stay. | | | |
| OTA_HotelAvailRS | HotelStays | HotelStay | Availability | 0..n | Details on the hotel stay including the type of availability and the date range for which it applies. | | | ||
| @Status | AvailabilityStatusType | 1 | Used to specify an availability status at the Hotel Stay level for a property. | "Open" "Close" "ClosedOnArrival" "ClosedToDeparture" | | |
| @End | date | 1 | The reservation departure date. | "2019-03-28T12:00:00Z" | | |
| @Start | date | 1 | The reservation arrival date. | "2019-03-27T12:00:00Z" | | |
OTA_HotelAvailRS | HotelStays | HotelStay | BasicPropertyInfo | 1 | Property information for the Hotel Stay. | | | ||
| @HotelCode | StringLength1to16 | 0..1 | The code that uniquely identifies a single hotel property, decided between vendors. | | | |
| @HotelName | StringLength1to128 | 0..1 | A text field used to communicate the proper name of the hotel. | | | |
| @ChainCode | StringLength1to8 | 0..1 | The code that identifies a hotel chain, decided between vendors. This attribute is optional if the the hotel is an independent property that can be identified by the HotelCode attribute. | "n/a" | | |
| @HotelCodeContext | StringLength1to32 | 0..1 | A text field used to communicate the context the HotelReferenceGroup codes. | "protelIO" | | |
| OTA_HotelAvailRS | RoomStays | 0..1 | A collection of RoomStay objects. | | | ||
| OTA_HotelAvailRS | RoomStays | RoomStay | 1..n | 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. | | | ||
| @AvailableIndicator | boolean | 0..1 | 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. For the purposes of this message, this flag indicates whether the room is available for immediate occupancy (e.g., the room is vacant and clean.) | By default, only available rooms are listed in the RS. (i.e. "true") | | |
| @AvailabilityStatus | RateIndicatorType | 0..1 | Used to specify an availability status at the room stay level for a property. | "AvailableForSale" | | |
| @RPH | RPH_Type | 0..1 | Identifies the room stay for use in the hotel stay. | | | |
| @InfoSource | InfoSourceType | 0..1 | Used to specify the source of the data being exchanged as determined by trading partners. | "PMS" | | |
| @ResponseType | StringLength1to16 | 0..1 | Defines whether the response is a property list or an area list. | "PropertyRateList" | | |
| @RoomStayStatus | HotelResStatusType | 0..1 | Identifies the status of the room stay. | "Quote" | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RoomTypes | 0..1 | A collection of RoomType objects. | | | ||
| OTA_HotelAvailRS | RoomStays | RoomStay | RoomTypes | RoomType | 1..n | Element used to identify available room products. | | | ||
| @RoomID | StringLength1to64 | 0..1 | A string value representing the unique identification of a room if the request is looking for a specific room. | | | |
| @RoomType | StringLength1to16 | 0..1 | 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 code specific to the property or hotel brand. | | | |
| @RoomTypeCode | StringLength1to64 | 1 | Specific system room type code | "A1K", "A1Q" etc. | | |
| @IsRoom | boolean | 1 | Indicates the type of room. | "true" - refers to regular sleeping rooms | | |
| @Quantity | Numeric1to999 | 0..1 | Defines the number of the item in question. | | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RoomTypes | RoomType | Occupancy | 0..5 | Provides parameters of occupancy limits. | | | ||
| @MaxOccupancy | Numeric1to99 | 0..1 | Maximum number of persons allowed in a unit of accommodation or place. | | | |
| @MinOccupancy | Numeric0to99 | 0..1 | Miniimum number of persons allowed in a unit of accommodation or place. | | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RoomTypes | RoomType | RoomDescription | 0..1 | Textual information regarding the room. | | | ||
| @Name | StringLength1to64 | 0..1 | For the purpose of this message, this should be set to “Short Description.” | "Short Description" | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RoomTypes | RoomType | RoomDescription | Text | 1 | A short description of the room. | | | ||
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | 0..1 | A collection of Rate Plans associated with a particular Room Stay. | | | ||
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | RatePlan | 1..n | Rate Plan details. | | | ||
| @PriceViewableInd | boolean | 0..1 | When "true", the price for this rate plan can be viewed by the guest. | Always "true" | | |
| @RatePlanCode | StringLength1to64 | 1 | The RatePlanCode assigned by the receiving system for the inventory item. | | | |
| @RatePlanID | StringLength1to64 | 0..1 | 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. | | | |
| @RatePlanName | StringLength1to64 | 0..1 | Provides the name of the rate plan or group. | | | |
| @EffectiveDate | date | 1 | Indicates the starting date | | | |
| @ExpireDate | date | 1 | Indicates the ending date | | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | RatePlan | AdditionalDetails | | 0..1 | A collection of AdditionalDetail elements. | | | ||
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | RatePlan | AdditionalDetails | AdditionalDetail | 1..n | Used to send additional information. | | | ||
| @Type | OTA_CodeType ADT | 0..1 | Used to define the type of information being sent (e.g., rate description, property description, room information). Refer to OpenTravel Code List Additional Detail Type (ADT). | | | |
| @Code | StringLength1to16 | 0..1 | Trading partner code associated to AdditionalDetailType. | RoomType code | | |
| @Amount | Money | 1 | A monetary amount. | | | |
| @CurrencyCode | AlphaLength3 | 1 | The code specifying the monetary unit. Use ISO 4217, three alpha code | "EUR" | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | RatePlan | AdditionalDetails | AdditionalDetail | DetailDescription | 0..1 | An indication of a new paragraph for a subsection of a formatted text message. | | | ||
| @Name | StringLength1to64 | 0..1 | 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. | | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | RatePlan | AdditionalDetails | AdditionalDetail | DetailDescription | Text | 0..1 | Formatted text content. Provides text and indicates whether it is formatted or not. | | | ||
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | RatePlan | Guarantee | 0..5 | Guarantee information that applies to the rate plan. | | | ||
| @GuaranteeCode | StringLength1to32 | 0..1 | Guarantee code. | | | |
| @GuaranteeType | StringLength1to32 | 1 | An enumerated type defining the guarantee to be applied to this reservation. | "GuaranteeRequired" "None" "CC/DC/Voucher" "Profile" "Deposit" "PrePay" | ||
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | RatePlan | Guarantee | GuaranteeDescription | 0..9 | Text description of the guarantee in a given language. | | | ||
| @Name | StringLength1to64 | 0..1 | Allows to define the information that is being sent. | "Description" | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | RatePlan | Guarantee | GuaranteeDescription | Text | 0..1 | Formatted text content. | | | ||
| @TextFormat | NMTOKEN | 0..1 | Indicates the format of the text sent in the description. | "PlainText" "HTML" | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | RatePlan | CancelPenalties | 0..1 | Cancel penalty information that applies to the rate plan. | | | ||
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | RatePlan | CancelPenalties | CancelPenalty | 0..n | | | |||
| @PolicyCode | StringLength1to16 | 0..1 | Indicates the Policy class. | | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | RatePlan | CancelPenalties | CancelPenalty | PenaltyDescription | 0..9 | Describes the Cancel Penalty. | | | ||
| @Name | StringLength1to64 | 0..1 | Allows to define the information that is being sent. | e.g.: "Description" | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | RatePlan | CancelPenalties | CancelPenalty | PenaltyDescription | Text | 0..1 | Formatted text content. | | | ||
| @TextFormat | StringLength1to64 | 0..1 | Indicates the format of the text sent in the description. | "PlainText" "HTML" | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | RatePlan | RatePlanDescription | 0..1 | Describes the rate plan. | | | ||
| @Name | string | 0..1 | Allows to define the information that is being sent. | e.g.: "Long Description" | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RatePlans | RatePlan | RatePlanDescription | Text | 0..1 | Formatted text content. | | | ||
| @TextFormat | NMTOKEN | 0..1 | Indicates the format of the text sent in the description. | "PlainText" "HTML" | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RoomRates | 1 | 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. | | | ||
| OTA_HotelAvailRS | RoomStays | RoomStay | RoomRates | RoomRate | 1..n | | | |||
@RatePlanCode | StringLength1to64 | 1 | 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. | | | |
| @RatePlanID | StringLength1to64 | 0..1 | 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. | | | |
| @RoomTypeCode | StringLength1to64 | 1 | Specfic system room type code | ex: A1K, A1Q etc. | | |
| @EffectiveDate | date | 1 | Indicates the starting date. | | | |
| @ExpireDate | date | 1 | Indicates the ending date. | | | |
| @NumberOfUnits | integer | 1 | The number of rooms. | | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RoomRates | RoomRate | Rates | 0..1 | Individual rate amount. This rate is valid for a range of number of occupants and an occupant type. | | | ||
| OTA_HotelAvailRS | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | 1..n | 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 rates 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. | | | ||
| @RateTimeUnit | TimeUnitType | 0..1 | Indicates the time unit for the rate. | | | |
| @EffectiveDate | date | 1 | Indicates the starting date. | | | |
| @ExpireDate | date | 1 | Indicates the ending date. | | | |
| @UnitMultiplier | integer | 0..1 | Indicates the number of rate time units such as "3 Days". | | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | Base | 0..1 | 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.The total amount charged for the service including additional amounts and fees. | | | ||
| @AmountAfterTax | Money | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | | | |
| @AmountBeforeTax | Money | 0..1 | | | ||
| @CurrencyCode | AlphaLength3 | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | Total | 0..1 | The total amount charged for this rate including additional occupant amounts and fees. | | | ||
| @AmountAfterTax | Money | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | | | |
| @AmountBeforeTax | Money | 0..1 | | | ||
| @CurrencyCode | AlphaLength3 | 1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | TPA_Extensions | 0..1 | | | |||
| OTA_HotelAvailRS | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | TPA_Extensions | FixedChargesAmountsExtensions | 0..1 | Information about exclusive fixed charge packages. | | | ||
| @AlternateCurrencyInd | boolean | 0..1 | 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. |
| | |
| @Start | date | 1 | Indicates the starting date | yyyy-mm-dd | | |
| @End | date | 1 | Indicates the ending date | yyyy-mm-dd | | |
| OTA_HotelAvailRS | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | TPA_Extensions | FixedChargesAmountsExtensions | RateAmount | 0..1 | | | |||
| @AmountAfterTax | Money | 1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | The value is NOT included in the Base / Total amounts and should NOT be used for OTA_HotelResNotifRQ to the PMS. This value has informative purpose to the walk-in guest - since the charge will be added automatically by the PMS logic during EOD. | | |
| @AmountBefore Tax | Money | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | | | |
| @RevenueCategoryCode | OTA_CodeType RCC | 1 | Code value from OpenTravel Alliance Code List Revenue Category Code (RCC). | Revenue Category Code (RCC) | | |
| @CurrencyCode | AlphaLength3 | 1 | Currency code used ISO 4217 codes to indicate the currency of the rate that is being booked | | | |
| OTA_HotelAvailRS | TPA_Extensions | 0..1 | | | |||
| OTA_HotelAvailRS | TPA_Extensions | AvailabilityExtensions | 0..1 | Holds additional information for booking availability | | | ||
| OTA_HotelAvailRS | TPA_Extensions | AvailabilityExtensions | px:RoomAvailable | 0..n | Provides details regarding rooms, usually guest rooms. | | | ||
@IsRoom | boolean | 1 | Indicates the room is a sleeping room when true. | | | |
| @RoomTypeCode | StringLength1to64 | 1 | Specific system room type code | ex: A1K, A1Q etc. | | |
| @RoomID | StringLength1to64 | 0..1 | A string value representing the unique identification of a room if the request is looking for a specific room. | | | |
| @RoomType | StringLength1to16 | 0..1 | (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. | | | |
| @Quantity | Numeric1to999 | 0..1 | Defines the number of the item in question. Used fornNumeric values, from 1 to 9999 inclusive. | | | |
| OTA_HotelAvailRS | TPA_Extensions | AvailabilityExtensions | px:RoomAvailable | RoomDescription | 0..1 | Textual information regarding the room. | | | ||
| @Name | StringLength1to64 | 0..1 | 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. | | | |
| OTA_HotelAvailRS | TPA_Extensions | AvailabilityExtensions | px:RoomAvailable | RoomDescription | Text | 0..1 | Formatted text content. Provides text and indicates whether it is formatted or not. | | | ||
| OTA_HotelAvailRS | TPA_Extensions | AvailabilityExtensions | px:RoomAvailable | Occupancy | 0..5 | Provides parameters of occupancy limits. | | | ||
| @MinOccupancy | Numeric0to99 | 0..1 | Minimum number of persons allowed in a unit of accommodation or place. Used for Numeric values, from 0 to 99 inclusive. | | | |
| @MaxOccupancy | Numeric1to99 | 0..1 | Maximum number of persons allowed in a unit of accommodation or place. Used for Numeric values, from 1 to 99 inclusive. | | | |
| OTA_HotelAvailRS | TPA_Extensions | AvailabilityExtensions | px:RoomAvailable | px:Amenities | 0..1 | A collection of amenities objects | | | ||
| OTA_HotelAvailRS | TPA_Extensions | AvailabilityExtensions | px:RoomAvailable | px:Amenities | px:Amenity | 0..n | | | |||
| @RoomAmenity | OTA_CodeType RMA | 0..1 | Identifies the types of room amenities offered by the property | | | |
| OTA_HotelAvailRS | Errors | 1 | Indicates that an error occured in the processing of the incoming request message. | | | ||
| OTA_HotelAvailRS | Errors | Error | 1..99 | An error that occurred during the processing of a message. | | | ||
@Type | OTA_CodeType EWT | 1 | Mandatory. Refer to the OTA Code List: Error Warning Type (EWT). | | | |
@Code | OTA_CodeType ERR | 0..1 | Refers to the OTA Code List: Error Codes (ERR). | | | |
@RecordID | StringLength1to64 | 0..1 | If the receiving system is able to identify within a batch of availability status messages which specific message failed, the UniqueID of the message should be reported here. | | | |
@ShortText | StringLength1to64 | 0..1 | Describes the occurring error in short.Example: "A rate plan 'XY' was not found for the code provided." | | |