# 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).
HotelML/Form/PropertyInformation/ Property		1
	PropertyCode	1	Char	Chain and property code, separated by a semi-colon – e.g. “UI;AB1234”
	CityCode	0..1	Char	Property’s city code. Not normally required. (*Only Applicable for “Enhanced_V2”)
HotelML/Form/PropertyInformation/ Property/Locale		0..1		This is used to request the response 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	Must be set to “Enhanced_V1” for enhanced rate rule features.
	NumberOfAdults	0..1	Integer	Number of adults per room. This attribute is deprecated. Should use GuestCount element instead (when using the Enhanced_V1 version). If this is missing, Guest Count with Type=”Adult” is required.
	NumberOfChildren	0..1	Integer	Number of children per room. This attribute is deprecated. Should use GuestCount element instead.
	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
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. It should be used instead of the NumberOfAdults and NumberOfChildren attributes of PropertyRate because it allows the age of each child to be specified. This element is an enhanced rate rule feature, and VersionCompliance must be set to “Enhanced_V1” for this to be used in the request.
	Type	1	Enum	Values “Adult” or “Child” This attribute is an enhanced rate rule feature, and VersionCompliance must be set to “Enhanced_V1” for this to be used in the request.
	Count	1	Integer	Number of guests of this type This attribute is an enhanced rate rule feature, and VersionCompliance must be set to “Enhanced_V1” for this to be used in the request.
	Age	0..1	Integer	The optional age of the guest. Only applicable when Type=”Child”. This attribute is an enhanced rate rule feature, and VersionCompliance must be set to “Enhanced_V1” for this to be used in the request.
HotelML/Form/PropertyInformation/ PropertyRate/ExtraBed		0..2		This element is an enhanced rate rule feature, and VersionCompliance must be set to “Enhanced_V1” for this to be used in the request.
	Number	0..2	Integer	Number of extra beds This attribute is an enhanced rate rule feature, and VersionCompliance must be set to “Enhanced_V1” for this to be used in the request.
	Type	0..2	Enum	Type of extra bed required. Valid values are: AdultRollAway, ChildRollAway, Crib This attribute is an enhanced rate rule feature, and VersionCompliance must be set to “Enhanced_V1” for this to be used in the request.

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).

HotelML/Form/PropertyInformation/ Property

PropertyCode

Char

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

CityCode

0..1

Char

Property’s city code. Not normally required.
(*Only Applicable for “Enhanced_V2”)

HotelML/Form/PropertyInformation/ Property/Locale

0..1

This is used to request the response in a specific language.

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

Must be set to “Enhanced_V1” for enhanced rate rule features.

NumberOfAdults

0..1

Integer

Number of adults per room. This attribute is deprecated. Should use GuestCount element instead (when using the Enhanced_V1 version).

If this is missing, Guest Count with Type=”Adult” is required.

NumberOfChildren

0..1

Integer

Number of children per room. This attribute is deprecated. Should use GuestCount element instead.

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

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.

It should be used instead of the NumberOfAdults and NumberOfChildren

attributes of PropertyRate because it allows the age of each child to be

specified.

This element is an enhanced rate rule feature, and VersionCompliance must

be set to “Enhanced_V1” for this to be used in the request.

Type

Enum

Values “Adult” or “Child”

This attribute is an enhanced rate rule feature, and VersionCompliance must

be set to “Enhanced_V1” for this to be used in the request.

Count

Integer

Number of guests of this type

This attribute is an enhanced rate rule feature, and VersionCompliance must

be set to “Enhanced_V1” for this to be used in the request.

Age

0..1

Integer

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

This attribute is an enhanced rate rule feature, and VersionCompliance must

be set to “Enhanced_V1” for this to be used in the request.

HotelML/Form/PropertyInformation/ PropertyRate/ExtraBed

0..2

This element is an enhanced rate rule feature, and VersionCompliance must

be set to “Enhanced_V1” for this to be used in the request.

Number

0..2

Integer

Number of extra beds

This attribute is an enhanced rate rule feature, and VersionCompliance must

be set to “Enhanced_V1” for this to be used in the request.

Type

0..2

Enum

Type of extra bed required. Valid values are:

AdultRollAway, ChildRollAway, Crib

This attribute is an enhanced rate rule feature, and VersionCompliance must

be set to “Enhanced_V1” for this to be used in the request.


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.
	PseudoCityCode	0..1	Char 1-6	Agent’s Pseudo City Code. Not normally required (*Only Applicable for “Enhanced_V2”)
	Country	0..1	Char 2	Originating Agent’s Country Code (ISO Standard Codes). Not normally required.
HotelML/Form/PropertyInformation/ PropertyRate/RatePlan		1
	Code	1		Rate plan code
	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/RatePlan/AutoInfo	Code	0..5	Char 25	Auto Frequent Traveler Number
HotelML/Form/PropertyInformation /PropertyRate/RatePlan/CorpInfo	Code	0..1	Char 25	Corporate Account Number.
HotelML/Form/PropertyInformation /PropertyRate/RatePlan/FlyerInfo	Code	0..5	Char 25	Frequent Flyer Number
HotelML/Form/PropertyInformation /PropertyRate/RatePlan/FreqGuest	Code	0..1	Char 25	Frequent Guest Number
HotelML/Form/PropertyInformation/ PropertyRate/RatePlan/RoomType		1
	Code	1	Char 10	Room type code

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.

PseudoCityCode

0..1

Char 1-6

Agent’s Pseudo City Code. Not normally required
(*Only Applicable for “Enhanced_V2”)

Country

0..1

Char 2

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

HotelML/Form/PropertyInformation/ PropertyRate/RatePlan

Code

Rate plan code

InDate

Date

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

OutDate

Date

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

HotelML/Form/PropertyInformation/ PropertyRate/RatePlan/AutoInfo

Code

0..5

Char 25

Auto Frequent Traveler Number

HotelML/Form/PropertyInformation

/PropertyRate/RatePlan/CorpInfo

Code

0..1

Char 25

Corporate Account Number.

HotelML/Form/PropertyInformation

/PropertyRate/RatePlan/FlyerInfo

Code

0..5

Char 25

Frequent Flyer Number

HotelML/Form/PropertyInformation

/PropertyRate/RatePlan/FreqGuest

Code

0..1

Char 25

Frequent Guest Number

HotelML/Form/PropertyInformation/ PropertyRate/RatePlan/RoomType

Code

Char 10

Room type code

--- # Agent Instructions: 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: ``` GET https://developer.rategain.com/ultradirect/ultradirect-transaction-sets-xml/rate-rules/request-message-format.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.