> 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/pre-book/request-message-format.md). # Request message format

Element Path	Attribute	Occ	Type	Notes
HotelML/Head/Process		1
	DataPath	1	Char	Set to "/HotelML/Form/PreBook”
	Function	1	Char	Set to “TI_PreBookV1_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/PreBook/Property		1
	PropertyCode	1	Char	Chain and property code, separated by a semi-colon – e.g. “UI;AB1234”
	Context	0..1	Char
	CityCode	0..1	Char	Prioperty’s city code. Not normally required. (*Only Applicable for “Enhanced_V2”)
HotelML/Form/PreBook/ 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/PreBook/ RateCriteria		1		Specifies rate selection criteria.
	VersionCompliance	0..1	Enum	Must be “PreBook_V1”
	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
	TotalRate	0..1	Decimal	Expected total rate excluding taxes and fees
	TotalRateInclusive	0..1	Decimal	Expected total rate including taxes and fees
	RatePlanCode	0..1	Char	Rate plan for the rate being checked. Will be the same as the rate plan code returned in the availability response
	RateCodeContext	0..1	Char
	RoomCode	0..1	Char	Rate plan for the rate being checked. Will be the same as the rate plan code returned in the availability response
	RoomCodeContext	0..1	Char
HotelML/Form/PreBook/ RateCriteria/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/PreBook/ RateCriteria/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/PreBook/ RateCriteria/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/PreBook/RateCriteria/ DateRange		1
	InDate	1	Date	The arrival date in format “2011-12-24”
	OutDate	1	Date	The departure date in format “2011-12-27”
HotelML/Form/PreBook/RateCrieria/ RateSearch		1
	RatePlanCode	1		Rate access code
	RatePlanType	1	Date	“Negotiated”, “Corporate”, “Standard” etc.
HotelML/Form/PreBook/ RateCriteria/RateSearch/AutoInfo	Code	0..5	Char 25	Auto Frequent Traveler Number
HotelML/Form/PreBook/RateCriteria/ RateSearch/ CorpInfo	Code	0..1	Char 25	Corporate Account Number.
HotelML/Form/ PreBook/RateCriteria/ RateSearch/ FlyerInfo	Code	0..5	Char 25	Frequent Flyer Number
HotelML/Form/ PreBook/RateCriteria/ RateSearch/ FreqGuest	Code	0..1	Char 25	Frequent Guest Number

HotelML/Form/PreBook/ RateCriteria/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/PreBook/RateCriteria/ DateRange

InDate

Date

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

OutDate

Date

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

HotelML/Form/PreBook/RateCrieria/ RateSearch

RatePlanCode

Rate access code

RatePlanType

Date

“Negotiated”, “Corporate”, “Standard” etc.

HotelML/Form/PreBook/ RateCriteria/RateSearch/AutoInfo

Code

0..5

Char 25

Auto Frequent Traveler Number

HotelML/Form/PreBook/RateCriteria/ RateSearch/ CorpInfo

Code

0..1

Char 25

Corporate Account Number.

HotelML/Form/ PreBook/RateCriteria/ RateSearch/ FlyerInfo

Code

0..5

Char 25

Frequent Flyer Number

HotelML/Form/ PreBook/RateCriteria/ 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://developer.rategain.com/ultradirect/ultradirect-transaction-sets-xml/pre-book/request-message-format.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.