> For the complete documentation index, see [llms.txt](https://developer.rategain.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.rategain.com/ultradirect/ultradirect-transaction-sets-xml/single-property-availability/request-message-format.md). # Request message format

Element Path	Attribute	Occ	Type	Notes
HotelML/Head/Process		1
	DataPath	1	Char	Set to "/HotelML/Form/PropertyInformation”
	Function	1	Char	Set to “TI_PropertyInformationV1_1”
	Token	1	Char	Unique ID for the transaction generated by the system sending the transaction.
HotelML/Head/Route		1
	Source	1	Char 2-3	Identifies the organization sending the transaction. The value to use will be provided during the implementation project.
	Destination	1	Char 2	Always set to “00” (i.e. zero zero).
	RequestedAccuracy	0..1	Enum	This specifies whether the response can be generated from the UltraDirect transaction cache. Note: this is a preference, since it can be overridden by the hotel chain. Valid values are: “CacheOrSource” (default if attribute is omitted) - First attempt to respond with data from the cache, but if data is not available, deliver the request to the source (hotel CRS) for processing. “SourceOnly” - Bypass the cache and return availability from the source (hotel CRS) only. “CacheOnly” - Only return data from the cache. If data is not available in the cache for the requested parameters, then an error will be returned It is strongly recommended to set this to “CacheOrSource”.
HotelML/Form/PropertyInformation/ Property		1
	PropertyCode	1	Char	Chain and property code, separated by a semi-colon – e.g. “UI;AB1234”
HotelML/Form/PropertyInformation/ Property/Locale		0..1		This is used to request the room/rate descriptions in the response to be in a specific language.

Element Path

Attribute

Occ

Type

Notes

HotelML/Head/Process

DataPath

Char

Set to "/HotelML/Form/PropertyInformation”

Function

Char

Set to “TI_PropertyInformationV1_1”

Token

Char

Unique ID for the transaction generated by the system sending the transaction.

HotelML/Head/Route

Source

Char 2-3

Identifies the organization sending the transaction. The value to use will be provided during the implementation project.

Destination

Char 2

Always set to “00” (i.e. zero zero).

RequestedAccuracy

0..1

Enum

This specifies whether the response can be generated from the UltraDirect transaction cache. Note: this is a preference, since it can be overridden by the hotel chain. Valid values are:

“CacheOrSource” (default if attribute is omitted) - First attempt to respond with data from the cache, but if data is not available, deliver the request to the source (hotel CRS) for processing.

“SourceOnly” - Bypass the cache and return availability from the source

(hotel CRS) only.

“CacheOnly” - Only return data from the cache. If data is not available in the cache for the requested parameters, then an error will be returned

It is strongly recommended to set this to “CacheOrSource”.

HotelML/Form/PropertyInformation/ Property

PropertyCode

Char

Chain and property code, separated by a semi-colon – e.g. “UI;AB1234”

HotelML/Form/PropertyInformation/ Property/Locale

0..1

This is used to request the room/rate descriptions in the response to be in a specific language.


	Language	1	Char 2	Language code – e.g. “FR”
	Country	0..1	Char	Optional country name – e.g. “France”.
HotelML/Form/PropertyInformation/ PropertyRate		1		Specifies rate selection criteria.
	VersionCompliance	0..1	Enum	Specifies the version of the transaction being used. All new implementations should set this to “Enhanced_V1”. In older implementations of this message where the VersionCompliance is not sent, some of the elements & attributes listed in the request and response messages will not be supported.
	Usage	0..1	Enum	Values are: “PreBook” – re-check the rate and/or availability status prior to making a booking “CacheShopping” – availability transactions that are automatically generated by the demand partner’s system to fill and/or refresh a local cache. “ProductDetails” – availability transaction to obtain additional information about a room/rate during the booking flow “UserShopping” – availability transaction generated by an end-user event (e.g. searching on a website) “Shop2Push” (RateGain Internal Use Only)
	MatchingQualifier	0..1	Enum.	Valid only when at least one rate plan code (RateCriteria/RateSearch/@RatePlanCode) is included in the request. If “ExactAndPublic” the CRS should return the requested rate plans (if available) plus the public rates. If “Exact” the CRS should return rates for the requested rate plans only. An Error will be returned when the requested rate is not found or available. If “ExactOrPublic” the CRS should return rates for the requested rate plans when available, or return public rates if requested rate plans are not available.
	CalculationMethod	0..1	Enum.	Specifies the preferred rate calculation method to use when a rate change occurs across the length of stay. Valid values are: “First” – rate for the first nightly “Highest” – highest nightly rate “Average” – average nightly rate “Frequent” – most frequently occurring rate When this element is not included on the request, the CRS will apply their default method to calculate the rate range.
	Commissionable Status	0..1	Enum.	Specifies whether commissionable and/or non-commissionable rate are required. “Commissionable” - Return commissionable rates only “NonCommissionable” - Return non-commissionable rates only

Language

Char 2

Language code – e.g. “FR”

Country

0..1

Char

Optional country name – e.g. “France”.

HotelML/Form/PropertyInformation/ PropertyRate

Specifies rate selection criteria.

VersionCompliance

0..1

Enum

Specifies the version of the transaction being used. All new implementations should set this to “Enhanced_V1”.

In older implementations of this message where the VersionCompliance is not sent, some of the elements & attributes listed in the request and response messages will not be supported.

Usage

0..1

Enum

Values are:

“PreBook” – re-check the rate and/or availability status prior to making a booking

“CacheShopping” – availability transactions that are automatically generated by the demand partner’s system to fill and/or refresh a local cache.

“ProductDetails” – availability transaction to obtain additional information about a room/rate during the booking flow

“UserShopping” – availability transaction generated by an end-user event (e.g. searching on a website)

“Shop2Push” (RateGain Internal Use Only)

MatchingQualifier

0..1

Enum.

Valid only when at least one rate plan code

(RateCriteria/RateSearch/@RatePlanCode) is included in the request.

If “ExactAndPublic” the CRS should return the requested rate plans (if available) plus the public rates.

If “Exact” the CRS should return rates for the requested rate plans only. An

Error will be returned when the requested rate is not found or available.

If “ExactOrPublic” the CRS should return rates for the requested rate plans when available, or return public rates if requested rate plans are not available.

CalculationMethod

0..1

Enum.

Specifies the preferred rate calculation method to use when a rate change occurs across the length of stay. Valid values are:

“First” – rate for the first nightly “Highest” – highest nightly rate “Average” – average nightly rate

“Frequent” – most frequently occurring rate

When this element is not included on the request, the CRS will apply their default method to calculate the rate range.

Commissionable

Status

0..1

Enum.

Specifies whether commissionable and/or non-commissionable rate are required.

“Commissionable” - Return commissionable rates only

“NonCommissionable” - Return non-commissionable rates only


				“Both” - Return both non-commissionable and commissionable rates. This is the default if not sent.
	ReturnUnavailable	0..1	Boolean	If “true”, closed properties will be included in the response. If “false”, closed properties will not be included in the response.
	NumberOfAdults	1	Integer	Number or adults per room. This attribute is deprecated – new implementation using transaction version “Enhanced_V1” should use the GuestCount element instead.
	NumberOfChildren	0..1	Integer	Number of children per room. This attribute is deprecated, as NumberOfAdults.
	NumberOfRooms	1	Integer	Total number of rooms required, which is used when checking availability. The prices in the response will be per room.
	NumberOfBeds	0..1	Integer	Preferred number of beds per room.
	BedType	0..1	Enum	Indicates the preferred bed type. Values are: Single, Twin, Double, King, Queen, Futon, MurphyBed, SofaBed, TatamiMats, Rollaway, Crib This attribute is only processed when version is “Enhanced_V1”.
	ReturnRateChanges	0..1	Boolean	Preference for whether response should include each distinct rate if it changes during the stay.
	RoomCategory	0..1	Enum	Indicates the preferred quality of room. The following values are most commonly used: Deluxe, Superior, Standard, Moderate, Economy, Premium The attribute also supports the following values but these are generally not used in this context: FirstClass, Budget, Upscale, Luxury, MeetingConvention, ResidentialApartment, Resort, CorporateBusinessTransient, AllSuite, ExtendedStay, Tourist, Efficiency
HotelML/Form/PropertyInformation/ PropertyRate/GuestCount		0..M		This element specifies the number of adults and children (optionally including child counts by age). GuestCount must occur once (and only once) with Type=”Adult”. It can also occur once with Type=”Child” if no Age attribute is supplied.

“Both” - Return both non-commissionable and commissionable rates. This is the default if not sent.

ReturnUnavailable

0..1

Boolean

If “true”, closed properties will be included in the response.

If “false”, closed properties will not be included in the response.

NumberOfAdults

Integer

Number or adults per room. This attribute is deprecated – new implementation using transaction version “Enhanced_V1” should use the GuestCount element instead.

NumberOfChildren

0..1

Integer

Number of children per room. This attribute is deprecated, as

NumberOfAdults.

NumberOfRooms

Integer

Total number of rooms required, which is used when checking availability. The prices in the response will be per room.

NumberOfBeds

0..1

Integer

Preferred number of beds per room.

BedType

0..1

Enum

Indicates the preferred bed type. Values are:

Single, Twin, Double, King, Queen, Futon, MurphyBed, SofaBed, TatamiMats, Rollaway, Crib

This attribute is only processed when version is “Enhanced_V1”.

ReturnRateChanges

0..1

Boolean

Preference for whether response should include each distinct rate if it changes during the stay.

RoomCategory

0..1

Enum

Indicates the preferred quality of room. The following values are most commonly used:

Deluxe, Superior, Standard, Moderate, Economy, Premium

The attribute also supports the following values but these are generally not used in this context:

FirstClass, Budget, Upscale, Luxury, MeetingConvention, ResidentialApartment, Resort, CorporateBusinessTransient, AllSuite, ExtendedStay, Tourist, Efficiency

HotelML/Form/PropertyInformation/ PropertyRate/GuestCount

0..M

This element specifies the number of adults and children (optionally including child counts by age).

GuestCount must occur once (and only once) with Type=”Adult”.

It can also occur once with Type=”Child” if no Age attribute is supplied.


				Alternatively, it can multiple times for Type=”Child” when an Age attribute is specified. This element is only processed when transaction version is “Enhanced_V1”. It should be used instead of the NumberOfAdults and NumberOfChildren attributes of PropertyRate because it allows the age of each child to be specified.
	Type	1	Enum	Values “Adult” or “Child”
	Count	1	Integer	Number of guests of this type
	Age	0..1	Integer	The optional age of the guest. Only applicable when Type=”Child”.
HotelML/Form/PropertyInformation/ PropertyRate/ExtraBed		0..1		This is used to request rollaway beds or cots/cribs. The element can occur up to three times - once for each type of extra bed – as defined by the Type attribute. This element is only processed when transaction version is “Enhanced_V1”.
	Type		Enum	Type of extra bed required. Valid values are: AdultRollAway, ChildRollAway, Crib
	Number		Integer	The number of beds of this type
HotelML/Form/PropertyInformation/ PropertyRate/AgentInfo		0..1
	Number	1	Char 8	Travel agent identifier – often the IATA number.
	Type	1	Enum.	Identifies the type of travel agent identifier. Values are: “ARC” , “IATA”, “TIDS”, “CLIA”, “AAA”, “GDS”, “Other”.
	City	0..1	Char 3	Originating Agent’s City. Not normally required.
	Country	0..1	Char 2	Originating Agent’s Country Code (ISO Standard Codes). Not normally required.
HotelML/Form/PropertyInformation/ PropertyRate/Amenity		0..6		This is used to request specific room or rate features, such as breakfast (“BRKFST”) or a non-smoking room (“NSMK”) etc.
	Code	1	Char 6	Amenity code. This is a string for Enhanced V2. For V1 please see Appendix 1b for possible values . (*Only Applicable for “Enhanced_V2”)
HotelML/Form/PropertyInformation /RateCriteria/DateRange		1

Alternatively, it can multiple times for Type=”Child” when an Age attribute is specified.

This element is only processed when transaction version is “Enhanced_V1”. It should be used instead of the NumberOfAdults and NumberOfChildren attributes of PropertyRate because it allows the age of each child to be specified.

Type

Enum

Values “Adult” or “Child”

Count

Integer

Number of guests of this type

Age

0..1

Integer

The optional age of the guest. Only applicable when Type=”Child”.

HotelML/Form/PropertyInformation/ PropertyRate/ExtraBed

0..1

This is used to request rollaway beds or cots/cribs. The element can occur up to three times - once for each type of extra bed – as defined by the Type attribute.

This element is only processed when transaction version is “Enhanced_V1”.

Type

Enum

Type of extra bed required. Valid values are:

AdultRollAway, ChildRollAway, Crib

Number

Integer

The number of beds of this type

HotelML/Form/PropertyInformation/ PropertyRate/AgentInfo

0..1

Number

Char 8

Travel agent identifier – often the IATA number.

Type

Enum.

Identifies the type of travel agent identifier. Values are: “ARC” , “IATA”, “TIDS”, “CLIA”, “AAA”, “GDS”, “Other”.

City

0..1

Char 3

Originating Agent’s City. Not normally required.

Country

0..1

Char 2

Originating Agent’s Country Code (ISO Standard Codes). Not normally required.

HotelML/Form/PropertyInformation/ PropertyRate/Amenity

0..6

This is used to request specific room or rate features, such as breakfast

(“BRKFST”) or a non-smoking room (“NSMK”) etc.

Code

Char 6

Amenity code. This is a string for Enhanced V2. For V1 please see Appendix 1b

for possible values .
(*Only Applicable for “Enhanced_V2”)

HotelML/Form/PropertyInformation

/RateCriteria/DateRange


	InDate	1	Date	The arrival date in format “2011-12-24”
	OutDate	1	Date	The departure date in format “2011-12-27”
HotelML/Form/PropertyInformation /PropertyRate/PriceRange		0..1		Specifies the required maximum and/or minimum rate (per room per night). Rarely used.
	Currency	1	Char	ISO currency code – e.g. “USD”
	Max	0..1	Decimal	Maximum required daily rate per room - e.g. “150.00”
	Min	0..1	Decimal	Minimum required daily rate per room - e.g. “150.00”
HotelML/Form/PropertyInformation/ PropertyRate/RateSearch		0..15		The RateSearch element is used to request one or more specific rate plan codes. This is used in conjunction with PropertyRate/@MatchingQualifier to specify whether the CRS should return the requested rate plans and/or public rates. If this element is not present, the CRS may return any available rate plan codes it wishes to promote.
	RatePlanCode	0..1	Char 10	Rate access code. This can be used to request special types of rate, such as specific negotiated or corporate rates. If this functionality is required, the actual RatePlanCode and RatePlanType to send will be provided to the affiliate by the hotel chain or RateGain as part of the UltraDirect implementation project. Also, many hotels recognize the following standard (generic) rate plan codes. These all require RatePlanType=”Standard”. "PRO" = Promotional "COR" = Corporate "WKD" = Weekend "RAC" = Rack "SNR" = Senior "GOV" = Government "MIL" = Military "PKG" = Package “WEB” = Web/Internet “CLB” = Club “FAM” / “FPM” = Family “CVN” or “CNV” = Convention "TVL” = Travel Agent

InDate

Date

The arrival date in format “2011-12-24”

OutDate

Date

The departure date in format “2011-12-27”

HotelML/Form/PropertyInformation

/PropertyRate/PriceRange

0..1

Specifies the required maximum and/or minimum rate (per room per night). Rarely used.

Currency

Char

ISO currency code – e.g. “USD”

Max

0..1

Decimal

Maximum required daily rate per room - e.g. “150.00”

Min

0..1

Decimal

Minimum required daily rate per room - e.g. “150.00”

HotelML/Form/PropertyInformation/ PropertyRate/RateSearch

0..15

The RateSearch element is used to request one or more specific rate plan codes. This is used in conjunction with PropertyRate/@MatchingQualifier to specify whether the CRS should return the requested rate plans and/or public rates.

If this element is not present, the CRS may return any available rate plan codes it wishes to promote.

RatePlanCode

0..1

Char 10

Rate access code.

This can be used to request special types of rate, such as specific negotiated or corporate rates. If this functionality is required, the actual RatePlanCode and RatePlanType to send will be provided to the affiliate by the hotel chain or RateGain as part of the UltraDirect implementation project.

Also, many hotels recognize the following standard (generic) rate plan codes. These all require RatePlanType=”Standard”.

"PRO" = Promotional "COR" = Corporate "WKD" = Weekend "RAC" = Rack

"SNR" = Senior

"GOV" = Government "MIL" = Military "PKG" = Package

“WEB” = Web/Internet

“CLB” = Club

“FAM” / “FPM” = Family “CVN” or “CNV” = Convention "TVL” = Travel Agent


				"TUR" = Tour
	RatePlanType	0..1	Char	Specifies the type of RatePlanCode. Values are: Corporate, Negotiated, NetRate, Standard
HotelML/Form/PropertyInformation/ PropertyRate/RateSearch/AutoInfo	Code	0..1	Char 25	Auto Frequent Traveler Number
HotelML/Form/PropertyInformation /PropertyRate/RateSearch/CorpInfo	Code	0..1	Char 25	Corporate Account Number. This should only be sent when RateSearch/@RatePlanType=”Corporate”.
HotelML/Form/PropertyInformation /PropertyRate/RateSearch/ FlyerInfo	Code	0..1	Char 25	Frequent Flyer Number
HotelML/Form/PropertyInformation /PropertyRate/RateSearch/ FreqGuest	Code	0..1	Char 25	Frequent Guest Number

"TUR" = Tour

RatePlanType

0..1

Char

Specifies the type of RatePlanCode. Values are:

Corporate, Negotiated, NetRate, Standard

HotelML/Form/PropertyInformation/ PropertyRate/RateSearch/AutoInfo

Code

0..1

Char 25

Auto Frequent Traveler Number

HotelML/Form/PropertyInformation

/PropertyRate/RateSearch/CorpInfo

Code

0..1

Char 25

Corporate Account Number. This should only be sent when

RateSearch/@RatePlanType=”Corporate”.

HotelML/Form/PropertyInformation

/PropertyRate/RateSearch/ FlyerInfo

Code

0..1

Char 25

Frequent Flyer Number

HotelML/Form/PropertyInformation

/PropertyRate/RateSearch/ FreqGuest

Code

0..1

Char 25

Frequent Guest Number

--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://developer.rategain.com/ultradirect/ultradirect-transaction-sets-xml/single-property-availability/request-message-format.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.