GenHTNG - Group Blocks

1 Overview
2 Business Rules
3 OTA_HotelInvBlockNotifRQ Elements & Attributes
4 OTA_HotelInvBlockNotifRQ Sample Group Add Message
5 OTA_HotelInvBlockNotifRQ Sample Cancel Block Message
6 OTA_HotelInvBlockNotifRS Elements & Attributes

Overview

The Inventory Block Notification is the message that sends the notification of a new inventory block created for a hotel, indicating where to procure that inventory, and to synchronize the inventory block between systems for booking.

Once rooms are sold against the block, the synchronization of inventory blocks can be a complicated process. The Hotel Inventory Block Notification message tells the target system whether this is an initial announcement of a new inventory block, an update of an active (bookable) block, or a notification of a block that is no longer in effect and should be deactivated.

When a hotel system sends out a status message to notify other systems of the availability at the property, the Status Application Control uses the Inventory Block codes to determine the status of availability for the block.
The <OTA_HotelInvBlockNotifRS> returns a response to the Hotel Inventory Block Notification, indicating that the message was successfully processed.

Business Rules

If a RatePlanCode is provided, that rate code must already exist in the CRS in order for it to post along with the group. If the provided RatePlanCode is not already created in the CRS, this will be ignored and an auto generated RatePlanCode will be used instead. This rate code will be G:InvBlockCode. Example using sample provided below - G:30010000087
If a RatePlanCode is provided and does pre-exist in the CRS, any rate amounts sent along with the block request will be ignored and the rate amounts already posted for that RatePlanCode will be in effect for the group. If there are no rate amounts found on that rate plan for the dates of the block, then this will mean the group cannot be booked.
If a RatePlanCode is not provided but rate amounts are included, a RatePlanCode will be auto generated. This rate code will be G:InvBlockCode. Example using sample provided below - G:30010000087
A Group block cannot be cancelled (deleted) once reservations have been made against it.

OTA_HotelInvBlockNotifRQ Elements & Attributes

Element \| @Attribute	Num	Description/Contents	Origin \| Value
OTA_HotelInvBlockNotifRQ	1	Root element of the message.
@EchoToken	0..1		Unique number for every transaction
@TimeStamp	1	Time of the transaction.	Time the message was assembled
@Version	1	Version is a mandatory attribute in OTA; therefore, it must remain Mandatory in HTNG to be able to use the same message.	4.000
OTA_HotelInvBlockNotifRQ / InvBlocks/	1	At least one InvBlocks containing one InvBlock element should be sent for the message to have meaning.
OTA_HotelInvBlockNotifRQ / InvBlocks / InvBlock	1…n	At least one InvBlock element should be sent for the message to have meaning. For multiple sub block or attendee types, this could be repeated.
@InvBlockStatusCode	0..1	Refers to OTA IBS and indicates the status of the block (such as Tentative, Definite, etc.).	“2”
@InvBlockCode	1	String to identify the Block as a code using the Group system code convention.
@InvBlockLongName	0..1	This is the full name of the inventory block.	Group name
@TransactionAction	1	Enumerated list that describes the action associated to the message. Used to set a new block, modify, cancel, or other action as per enumerated list to be agreed between partners.	"create", "modify", "cancel", “release” depending on Transaction Sub-Type
OTA_HotelInvBlockNotifRQ / InvBlocks / InvBlock / HotelRef	1	Not mandatory in OTA but is Mandatory in the HTNG recommendation. This is the element containing the code of the property whose inventory blocks are being updated.
@HotelCode	1	Not mandatory in OTA but is Mandatory in the HTNG recommendation. This is the code of the property whose inventory blocks are being updated.
OTA_HotelInvBlockNotifRQ / InvBlocks / InvBlock / InvBlockDates	1
@Start	1	Not mandatory in OTA but is Mandatory in the HTNG recommendation. This is the first day for which the inventory block update is being sent.	Arrival Date
@End	1	Not mandatory in OTA but is Mandatory in the HTNG recommendation. This represent the last date for which the inventory block update is being sent.	Departure Date
@AbsoluteCutoff	0..1	Used to determine when the inventory block is released back into house inventory.	Cutoff Date
OTA_HotelInvBlockNotifRQ / InvBlocks / InvBlock / RoomTypes / RoomType	1...n	Should be repeated for each room type that is part of the block as it will also contain allocations and rates for the specific room type.	One for each Room Type in the transaction
@RoomTypeCode	1	Mandatory. Room type codes of each room type used as part of the block.
OTA_HotelInvBlockNotifRQ / InvBlocks / InvBlock / RoomTypes / RoomType / RoomTypeAllocations	0..n
@RoomTypePickUpStatus	0..1	Ability to specify Inventory Count Type. (i.e. 1 Physical, 2 Definitive availability, 3 Tentative availability, 4 Definite sold, 5 Tentative sold)
OTA_HotelInvBlockNotifRQ / InvBlocks / InvBlock / RoomTypes / RoomType / RoomTypeAllocations / RoomTypeAllocation	0..n		One element for each unique combination of allocation, which will be consolidated over the larges possible range of consecutive dates.
@Start	0..1	Used in conjunction with END to determine different number of rooms of a specific type for different dates.	For this room type for the first day of the range.
@End	0..1	Used in conjunction with START to determine different number of rooms of a specific type for different dates.	For this room type for the last day of the range.
@NumberOfUnits	1	Mandatory. Number of units of a specific type that are allocated as part of the inventory block. Comments have been submitted to Open Travel to allow 0 in this field.	(Blocked) for this room type. Same for all days in the range.
@CompRoomQuantity & @CompRoomFactor	0..1	Used to indicate whether a certain number of rooms are allocated as complimentary and whether they are subject to a certain number of rooms being booked first.
OTA_HotelInvBlockNotifRQ /InvBlocks/InvBlock / RoomTypes / RoomType / RatePlans / RatePlan	0..1
@RatePlanCode	1	Mandatory. Rate plan used for the inventory block. If no further rate information is included, the rate plan code refers to rate plan information already passed using the OTA_HotelRatePlanNotifRQ message.
@CurrencyCode	0..1	This is the currency associated to the rate assigned to the block– it could be different to the currency loaded for the property.
OTA_HotelInvBlockNotifRQ / InvBlocks / InvBlock / RoomTypes / RoomType / RatePlans / RatePlanBaseByGuestAmnts	0..1
OTA_HotelInvBlockNotifRQ / InvBlocks / InvBlock / RoomTypes / RoomType / RatePlans / RatePlanBaseByGuestAmnts / BaseByGuestAmt	1..n	Conditionally Mandatory. AT LEAST 1 INSTANCE FOR NUMBEROFGUESTS=1 is Mandatory if the rate information is being defined in the message. Must be repeated for all different type of occupancies of the specific room. We recommend that for varying rates by occupant should be implemented like this.
@NumberOfGuests	1	The NumberOfGuest Attribute indicates what type of rate is being passed – if NumberOfGuests is = 1 then we are transmitting a single rate, if higher than 1 then it is a double or full occupancy rate.
@AmountBeforeTax or @AmountAfterTax	1	Either @AmountBeforeTax or @AmountAfterTax is Mandatory for each @NumberOfGuests. Partners must select whether to send either the @AmountBeforeTax or @AmountAfterTax (or both) attributes.
OTA_HotelInvBlockNotifRQ / InvBlocks / InvBlock / RoomTypes / RoomType / RatePlans / RatePlan / AdditionalGuestAmounts / AdditionalGuestAmount	0..n	Used to transfer extra adult and extra child amount.
@AgeQualifyingCode	0..1	AgeQualifyingCode - 8 = child, 10 = adult.
@Percent OR @Amount	0..1	This is the percentage of the single rate that represents the child rate. Could also be expressed as fixed amount.
OTA_HotelInvBlockNotifRQ / InvBlocks / InvBlock / MethodInfo	0..1
@BillingType	0..1	BillingType is used to indicate charges to be billed to master account (enumeration).
@SignFoodAndBev	0..1	SignFoodAndBev is a Boolean to indicate whether food and drinks should be billed to master account.
@ReservationMethodCode	0..1	ReservationMethodCode indicates the method by which reservations are received.
OTA_HotelInvBlockNotifRQ / InvBlocks / InvBlock / BlockDescriptions / BlockDescription	0…9
OTA_HotelInvBlockNotifRQ / InvBlocks / InvBlock / BlockDescriptions / BlockDescription / Text
OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact	1…9	This element and its sub-elements can be repeated to include all contact information needed. It is down to implementing partners to agree which contacts would be captured by either system and which contacts should indeed be exchanged. At the very least the Group Organizer details should be transferred.	Not mapped
OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / PersonName	0..1	This element and sub-elements will be sent to transfer the name of contacts that are “INDIVIDUAL”. To transfer COMPANY/TA details, the OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / CompanyName path should be used as highlighted below.
OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / PersonName / NamePrefix	0..1	Optional but should be highly recommended by HTNG that partners use it if possible. This path is used to transmit the Contact’s details. This field would be used to pass the contact’s name Prefix.
OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / PersonName / GivenName	0..1	This field would be used to pass the contact’s First name.
OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / PersonName / MiddleName	0..1	This field would be used to pass the contact’s Middle name.
OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / PersonName / Surname	1	If a contact is passed then at least Surname must be passed. This field would be used to pass the contact’s Surname.
OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / CompanyName	0..1	This element and attributes will be sent to transfer the name of contacts that are “Organizations”. To transfer individual details, the OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / PersonName path should be used as highlighted above.
@CompanyShortName	0..1	Used to provide the Company common name.
@Code	0..1	Identifies the company by the company code.
@CodeContext	0..1	Identifies the context of the identifying code, such as DUNS, IATA, or internal code, SIC, etc.
OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / Telephone	0..5	This field would be used to pass the contact’s phone number and fax numbers.
@PhoneLocationType @PhoneTechType @CountryAccessCode @Area City Code @DefaultInd	0	The PhoneLocationType attribute refers to the OTA PLT code list and indicates where the phone number is based – the two codes to be used by HTNG are code 7 – Home and code 8 – Office. The PhoneTechType attribute refers to the OTA PTT code list, and indicates which type of number is transmitted (phone versus fax). The two codes to be used by HTNG are code 1 –Voice and code 3 – Fax. 5-Mobile CountryAccessCode and Area City Code should be Optional.If country code and area code are passed then they should not appear again in the PhoneNumber field. DeafultInd is Optional and would indicate whether the phone number is the primary phone number for the profile.
@Phone Number @FormattedInd	1	PhoneNumber contains the actual as a string of max 32 characters and it is Mandatory. FormattedInd is Mandatory. If the partner can use Country and Area codes then formattedInd would be set to NO. If the partner cannot use country and area code then entire number is passed in the PhoneNumber field and FormattedInd it should be set to YES if the number needs to be parsed as there is a separation of the different parts or set to NO to indicate that the PhoneNumber filed contains the entire phone number without a specific format.
OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / Email	0..1	Optional. This field would be used to pass the contact’s email address.
@EmailType @DefaultInd	0..1	The Email Type attribute uses the OTA code list EAT and indicates the type of email address provided (personal – code 1 versus business – code 2, in the case of the Guest details) and must be passed if more than one email address is passed. If only one email address is passed it can be Optional. DeafultInd is Optional and would indicate whether the email is the primary email for the profile.
OTA_HotelInvBlockNotifRQ /InvBlocks/Contacts/ Contact/Address	0..1	If a contact is passed then at least one address must be passed. This field would be used to pass the contact’s mail address.
OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / Address / AddressLine	0..5	This field would be used to pass the contact’s address. More than one line can be sent.
OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / Address / CityName	0..1	This field would be used to pass the contact’s city.
OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / Address / StateProv
@StateCode	0..1	This field would be used to pass the contact’s State expressed in the Standard 2-8 characters code.
OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / Address / PostalCode	0..1	This field would be used to pass the contact’s Postal/ZIP code.
OTA_HotelInvBlockNotifRQ / InvBlocks / Contacts / Contact / Address / CountryName
@Code	0..1	Optional. This field would be used to pass the contact’s Country expressed in the Standard ISO 3166 code.

OTA_HotelInvBlockNotifRQ Sample Group Add Message

<OTA_HotelInvBlockNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLXSchema-instance" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_HotelInvBlockNotifRQ.xsd" Version="4.000" TimeStamp="2010-12-23T12:53:54.19">
	<InvBlocks>
		<InvBlock InvBlockStatusCode="2" TransactionAction="Book" InvBlockCode="30010000087" InvBlockLongName="CONFERENCE CHRISTMAS 2010">
			<HotelRef HotelCode="16886"/>
			<InvBlockDates Start="2010-12-23" End="2010-12-25" AbsoluteCutOff="2010-12-22"/>
			<RoomTypes>
				<RoomType RoomTypeCode="CSUITE">
					<RoomTypeAllocations RoomTypePickUpStatus="1">
						<RoomTypeAllocation Start="2010-12-23" End="2010-12-25" NumberOfUnits="1"/>
					</RoomTypeAllocations>
					<RatePlans>
						<RatePlan Start="2010-12-23" End="2010-12-25" CurrencyCode="USD" RatePlanCode="30010000087">
							<BaseByGuestAmts>
								<BaseByGuestAmt AmountBeforeTax="300.00" NumberOfGuests="1" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="300.00" NumberOfGuests="2" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="300.00" NumberOfGuests="3" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="300.00" NumberOfGuests="4" AgeQualifyingCode="10"/>
							</BaseByGuestAmts>
							<AdditionalGuestAmounts>
								<AdditionalGuestAmount AgeQualifyingCode="10" Amount="100.00"/>
								<AdditionalGuestAmount AgeQualifyingCode="8" Amount="20.00"/>
							</AdditionalGuestAmounts>
						</RatePlan>
					</RatePlans>
				</RoomType>
				<RoomType RoomTypeCode="KING">
					<RoomTypeAllocations RoomTypePickUpStatus="1">
						<RoomTypeAllocation Start="2010-12-23" End="2010-12-25" NumberOfUnits="2"/>
					</RoomTypeAllocations>
					<RatePlans>
						<RatePlan Start="2010-12-23" End="2010-12-25" CurrencyCode="USD" RateTier="1" RatePlanCode="30010000087">
							<BaseByGuestAmts>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="1" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="2" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="3" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="4" AgeQualifyingCode="10"/>
							</BaseByGuestAmts>
							<AdditionalGuestAmounts>
								<AdditionalGuestAmount AgeQualifyingCode="10" Amount="20.00"/>
								<AdditionalGuestAmount AgeQualifyingCode="8" Amount="10.00"/>
							</AdditionalGuestAmounts>
						</RatePlan>
					</RatePlans>
				</RoomType>
				<RoomType RoomTypeCode="KN">
					<RoomTypeAllocations RoomTypePickUpStatus="1">
						<RoomTypeAllocation Start="2010-12-23" End="2010-12-25" NumberOfUnits="2"/>
					</RoomTypeAllocations>
					<RatePlans>
						<RatePlan Start="2010-12-23" End="2010-12-25" CurrencyCode="USD" RateTier="1" RatePlanCode="30010000087">
							<BaseByGuestAmts>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="1" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="2" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="3" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="4" AgeQualifyingCode="10"/>
							</BaseByGuestAmts>
							<AdditionalGuestAmounts>
								<AdditionalGuestAmount AgeQualifyingCode="10" Amount="20.00"/>
								<AdditionalGuestAmount AgeQualifyingCode="8" Amount="10.00"/>
							</AdditionalGuestAmounts>
						</RatePlan>
					</RatePlans>
				</RoomType>
				<RoomType RoomTypeCode="QQPRM">
					<RoomTypeAllocations RoomTypePickUpStatus="1">
						<RoomTypeAllocation Start="2010-12-23" End="2010-12-25" NumberOfUnits="2"/>
					</RoomTypeAllocations>
					<RatePlans>
						<RatePlan Start="2010-12-23" End="2010-12-25" CurrencyCode="USD" RateTier="1" RatePlanCode="30010000087">
							<BaseByGuestAmts>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="1" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="2" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="3" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="4" AgeQualifyingCode="10"/>
							</BaseByGuestAmts>
							<AdditionalGuestAmounts>
								<AdditionalGuestAmount AgeQualifyingCode="10" Amount="20.00"/>
								<AdditionalGuestAmount AgeQualifyingCode="8" Amount="10.00"/>
							</AdditionalGuestAmounts>
						</RatePlan>
					</RatePlans>
				</RoomType>
				<RoomType RoomTypeCode="QUEEN">
					<RoomTypeAllocations RoomTypePickUpStatus="1">NumberOfUnits="2"/>
						<RoomTypeAllocation Start="2010-12-23" End="2010-12-25"</RoomTypeAllocations>
					<RatePlans>
						<RatePlan Start="2010-12-23" End="2010-12-25" CurrencyCode="USD" RateTier="1" RatePlanCode="30010000087">
							<BaseByGuestAmts>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="1" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="2" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="3" AgeQualifyingCode="10"/>
								<BaseByGuestAmt AmountBeforeTax="170.00" NumberOfGuests="4" AgeQualifyingCode="10"/>
							</BaseByGuestAmts>
							<AdditionalGuestAmounts>
								<AdditionalGuestAmount AgeQualifyingCode="10" Amount="20.00"/>
								<AdditionalGuestAmount AgeQualifyingCode="8" Amount="10.00"/>
							</AdditionalGuestAmounts>
						</RatePlan>
					</RatePlans>
				</RoomType>
			</RoomTypes>
			<BlockDescriptions>
				<BlockDescription>
					<Text>The is the block Description</Text>
				</BlockDescription>
			</BlockDescriptions>
			<Contacts>
				<Contact>
					<PersonName>
						<Surname>BOGUS III, MR SEAN</Surname>
					</PersonName>
					<Telephone FormattedInd="false" PhoneNumber="316 555 1212" PhoneTechType="1"/>
					<Telephone FormattedInd="false" PhoneNumber="316 555 1200" PhoneTechType="3"/>
					<Address>
						<AddressLine>1907 N Murdock</AddressLine>
						<AddressLine>Suite 200A</AddressLine>
						<CityName>Wichita</CityName>
						<PostalCode>67208</PostalCode>
						<StateProv StateCode="KS"/>
						<CountryName Code="US"/>
					</Address>
				</Contact>
			</Contacts>
		</InvBlock>
	</InvBlocks>
</OTA_HotelInvBlockNotifRQ>

OTA_HotelInvBlockNotifRQ Sample Cancel Block Message

<?xml version="1.0" encoding="UTF8" ?>
<OTA_HotelInvBlockNotifRQ xmlns:xsi=http://www.w3.org/2001/XMLSchemainstance xmlns="http://www.opentravel.org/OTA/2003/05" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05/OTA_HotelInvBlockNotifRQ.xsd" TimeStamp="2010-12- 23T12:53:54.19" Version="1.00">
	<InvBlocks>
		<InvBlock BookingStatus="Close" InvBlockCode="GRPINV001" TransactionAction="cancel">
			<HotelRef ChainCode="SW" HotelCode="00000" HotelName="The Westin" />
		</InvBlock>
	</InvBlocks>
</OTA_HotelInvBlockNotifRQ>

OTA_HotelInvBlockNotifRS Elements & Attributes

Element \| @Attribute	Num	Description/Contents	Origin \| Value
OTA_HotelInvBlockNotifRS	EchoToken	Optional.
	Version	Version is a mandatory attribute in OTA; therefore, it must remain Mandatory in HTNG to use the same message.
	TimeStamp	Not mandatory in OTA but is Mandatory in the HTNG recommendation – time of the transaction.
OTA_HotelInvBlockNotifRS / Errors / Error	Type	Mandatory in OTA. Refers to OTA EWT list (error warning type).	Log value and all attributes if present. The value of the element should be the text of the error message.
OTA_HotelInvBlockNotifRS / Errors / Error	Code	Optional. Refers to OTA list ERR. Should be used wherever possible.
OTA_HotelInvBlockNotifRS / Errors / Error	RecordID	Optional. If the receiving system can identify within a batch of inventory blocks messages which specific message failed, the InvBlockCode of the specific inventory that failed should be reported here.
OTA_HotelInvBlockNotifRS / Success		Mandatory in OTA and in the HTNG recommendations. This is the annotation that the inventory block message batch was received successfully. It could be combined with warning messages if some of the messages in the batch had issues.	Log if present
OTA_HotelInvBlockNotifRS / Warnings / Warning	Type	Mandatory in OTA. Refers to OTA EWT list (error warning type).	Log value and all attributes if present. The value of the element should be the text of the error message.
	Code	Optional. Refers to OTA list ERR. Should be used wherever possible.
	RecordID	Optional. If the receiving system can identify within a batch of inventory block messages which specific inventory block failed, the Inventory Block code of the inventory block that failed should be reported here.
OTA_HotelInvBlockNotifRS / InvBlockCodeRefs / InvBlockCodeRef	InvSystem InvBlockCode	Optional. Used to reconfirm back to the sending partner the inventory block that was uploaded using the code created for that inventory code by the receiving system. It is up to the trading partners whether to use this field.
OTA_HotelInvBlockNotifRS / InvBlockCodeRefs / HotelRef	HotelCode	Optional. Used to reconfirm back to the sending partner the hotel for which the inventory block/s were sent.