Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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

  • The RatePlanCode will be automatically created in the CRS for use with the block. Any rate plan codes specified by the PMS are ignored.

  • 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  

 0..1  

 This field would be used to pass the  

 

 

 /InvBlocks/Contacts/  

 contact’s First name.  

 

 

 Contact/PersonName/Given  

   

 

 

 Name  

   

 OTA_HotelInvBlockNotifRQ  

 0..1  

 This field would be used to pass the  

 

 

 /InvBlocks/Contacts/  

 contact’s Middle name.  

 

 

 Contact /PersonName/  

   

 

 

 MiddleName  

   

 OTA_HotelInvBlockNotifRQ  

 1  

 If a contact is passed then at least  

 

 

 /InvBlocks/Contacts/  

 Surname must be passed. This field would 

 

 

 Contact /PersonName/  

 be used to pass the contact’s Surname.  

 

 

 Surname  

   

 OTA_HotelInvBlockNotifRQ  

 0..1  

 This element and attributes will be sent to  

 

 

 /InvBlocks/Contacts/  

 transfer the name of contacts that are  

 

 

 Contact/CompanyName  

 “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  

 0..5  

 This field would be used to pass the  

 

 

 /InvBlocks/ Contacts/  

 contact’s phone number and fax numbers.  

 

 

 Contact/Telephone  

   

 @PhoneLocationType  

 0  

 The PhoneLocationType attribute refers to  

 

 

 @PhoneTechType  

 the OTA PLT code list and indicates  

 

 

 @CountryAccessCode  

 where the phone number is based – the  

 

 

 @Area City Code  

 two codes to be used by HTNG are code  

 

 

 @DefaultInd  

 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.

OTA_HotelResNotifRQ Sample Reservation New/Add Message

<OTA_HotelResNotifRQ xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" EchoToken="WTST20170322212320" TimeStamp="2017-03-22T21:23:20.5081898-06:00" Version="3.002" ResStatus="Commit" PrimaryLangID="en- us" xmlns="http://www.opentravel.org/OTA/2003/05">
	<POS>
		<Source>
			<RequestorID Type="22" ID="CRS" ID_Context="CRS"/>
			<BookingChannel Type="5" Primary="true">
				<CompanyName Code="IBE"/>
			</BookingChannel>
		</Source>
	</POS>
	<HotelReservations>
		<HotelReservation RoomStayReservation="true" CreateDateTime="2017-03- 22T21:23:20.5081898-06:00" CreatorID="Whiteboard" ResStatus="Reserved">
			<UniqueID Type="14" ID="RXV7523MU"/>
			<RoomStays>
				<RoomStay MarketCode="BAR" SourceOfBusiness="IBE">
					<RatePlans>
						<RatePlan RatePlanCode="RACK" EffectiveDate="2017-04-19" ExpireDate="2017-04-21">TaxInclusive="false"/>
							<RatePlanInclusions</RatePlan>
					</RatePlans>
					<RoomRates>
						<RoomRate EffectiveDate="2017-04-19" ExpireDate="2017-04-21" RoomTypeCode="OQNS" NumberOfUnits="1" RatePlanCode="RACK">
							<Rates>
								<Rate EffectiveDate="2017-04-19" ExpireDate="2017-04-21" RateTimeUnit="Day" UnitMultiplier="1">
									<BaseAmountBeforeTax="300" CurrencyCode="USD"/>
								</Rate>
							</Rates>
						</RoomRate>
					</RoomRates>
					<GuestCounts IsPerRoom="true">
						<GuestCount AgeQualifyingCode="10" Count="1"/>
					</GuestCounts>
					<TimeSpan Start="2017-04-19" Duration="P2N" End="2017-04-21"/>
					<Guarantee GuaranteeCode="GX" GuaranteeType="GuaranteeRequired">
						<GuaranteesAccepted>
							<GuaranteeAccepted PaymentTransactionTypeCode="charge">
								<PaymentCard CardType="1" CardCode="VI" CardNumber="4444333322221111" ExpireDate="0123">
									<CardHolderName>Bond</CardHolderName>
								</PaymentCard>
							</GuaranteeAccepted>
						</GuaranteesAccepted>
					</Guarantee>
					<Total AmountBeforeTax="600" AmountAfterTax="660" CurrencyCode="USD">
						<Taxes Amount="60"/>
					</Total>
					<BasicPropertyInfo ChainCode="WSD" HotelCode="WTST"/>
					<ResGuestRPHs>
						<ResGuestRPH RPH="0"/>
					</ResGuestRPHs>
					<Comments>
						<Comment CommentOriginatorCode="GUEST" GuestViewable="true">
							<Text>Will be Travelling with Mrs Bardot.</Text>
						</Comment>
					</Comments>
				</RoomStay>
			</RoomStays>
			<Services>
				<Service Type="1" ID="DN" ServicePricingType="Per stay" ServiceInventoryCode="Dinner" Inclusive="false" Quantity="1">
					<Price>
						<Total AmountBeforeTax="15" CurrencyCode="USD"/>
					</Price>
					<ServiceDetails>
						<TimeSpan Start="2017-04-19T12:00:00" End="2017-04-19T12:00:00"/>
						<Comments>
							<Comment>
								<Text>Dinner</Text>
							</Comment>
						</Comments>
					</ServiceDetails>
				</Service>
			</Services>
			<ResGuests>
				<ResGuest ResGuestRPH="0" AgeQualifyingCode="10" PrimaryIndicator="true">
					<Profiles>
						<ProfileInfo>
							<UniqueID Type="1" ID="12091943" ID_Context="CRS"/>
							<Profile ProfileType="1">
								<Customer Gender="Male" BirthDate="1974-03-10">
									<PersonName>
										<NamePrefix>Mr.</NamePrefix>
										<GivenName>James</GivenName>
										<Surname>Bond</Surname>
									</PersonName>
									<Telephone PhoneTechType="1" PhoneUseType="3" PhoneNumber="446966564101" FormattedInd="false"/>
									<Email ShareMarketInd="Yes" DefaultInd="true">james.bond@shr.global</Email>
									<AddressLine>Claretta House</AddressLine>
									<Address>
										<AddressLine>Tower Bridge Close</AddressLine>
										<CityName>London</CityName>
										<PostalCode>EC1 2PG</PostalCode>
										<StateProv StateCode="ENG"/>
										<CountryName Code="GB"/>
									</Address>
								</Customer>
							</Profile>
						</ProfileInfo>
					</Profiles>
					<InHouseTimeSpan Start="2017-04-19" Duration="P2N" End="2017-04-21"/>
				</ResGuest>
			</ResGuests>
			<ResGlobalInfo>
				<HotelReservationIDs>
					<HotelReservationID ResID_Type="14" ResID_Value="RXV7523MU" ResID_Source="CRS" ResID_SourceContext="CrsConfirmNumber" ResID_Date="2017-03-22T21:21:18.4399842-06:00"/>
				</HotelReservationIDs>
			</ResGlobalInfo>
			<TPA_Extensions>
				<Success/>
			</TPA_Extensions>
		</HotelReservation>
	</HotelReservations>
</OTA_HotelResNotifRQ>

OTA_HotelResNotifRS Elements & Attributes

Element | @Attribute

Num

Description/Contents

Origin | Value

OTA_HotelResNotifRS

 1  

Root element of the message.  

   

@EchoToken  

 0..1  

As per OTA Specifications.  

   

@Version  

 1  

Version is a mandatory attribute in OTA; therefore, it must remain Mandatory in HTNG to be able to use the same message.  

 1.00  

@TimeStamp  

 1  

Time of the transaction.  

   

@ResResponseType  

 1  

Given that the OTA_HotelResNotifRQ message is used for additions, modifications, and cancellations, this attribute is used to replicate whether the original message was an addition, a modification, or a cancellation and does not refer to the status of the transaction itself but rather to the nature of the original message. The only three enumerations allowed will therefore be: Committed, Modified, and Cancelled. In this case Committed would be used.

“ADD” -> “Committed”

“CHANGE” -> “Modified”

“CANCEL” -> “Cancelled” 

OTA_HotelResNotifRS / Errors / Error

 1..99  

Mandatory ONLY if Success element is not sent. Only needed if RQ message was unsuccessful.

 

@Type  

 1  

Mandatory in OTA. Refers to OTA EWT list (error warning type).

   

@Code  

 0..1  

Refers to OTA list ERR. Should be used whenever possible.

   

@RecordID  

 0..1  

If the receiving system can identify within a batch of reservations which reservation failed, the uniqueID of the rejected reservation should be reported here.

Not mapped  

OTA_HotelResNotifRS / Success  

 1  

Mandatory if no Errors were sent. This is the annotation that the reservation batch was received successfully. It could be combined with warning messages if some of the reservations in the batch had issues.

   

OTA_HotelResNotifRS / Warnings / Warning

 0..99  

Can be used in conjunction with Success message.

   

@Type  

 1  

Refers to OTA EWT list (error warning type).

   

@Code  

 0..1  

Refers to OTA list ERR. Should be used wherever possible.

   

@RecordID  

 0..1  

If the receiving system can identify within a batch of reservations which reservation has a warning, the uniqueID of that reservation should be reported here.

   

OTA_HotelResNotifRS / HotelReservations / HotelReservation  

   

   

1 for each reservation detail record

@ResStatus  

   

Indicates the status of the reservation. Valid values are dependant on the roles:

Reservation Broker > Reservation Server

• Reserved

• Waitlisted

Reservation Server > Reservation Broker

• Reserved

• Waitlisted

 “Reserved”  

OTA_HotelResNotifRS / HotelReservations / HotelReservation / UniqueID

 1  

This is the confirmation number for the originator of the booking (i.e., the system which sent the OTA_HotelResNotifRQ message for which the OTA_HotelresNotifRS message is sent).

   

@Type

 1  

Type is assigned values from the UIT code list. If the original system was a CRS:

Type = 14 – Reservation

ID is the actual confirmation number

If it was a PMS: Type = 10 - Hotel

“14” (CRS) 

“10” (PMS)

@ID

 1  

ID is the CRS confirmation number (or PMS number if the reservation was originated in the PMS).

   

OTA_HotelResNotifRS /  HotelReservations / HotelReservation / ResGlobalInfo / HotelReservationIDs / HotelReservationID

 1..n  

This is the confirmation number associated by the system which received the booking.

   

@ResID_Type

 1  

ResID_Type is assigned values from the
UIT code list:

10 – Reservation Server
13 – Internet Broker
14 – Reservation Broker
24 – Travel Agent PNR
25- Associated reservation (travelling with)
26- Associated itinerary reservation
27- Associated shared reservation
34 – Master Itinerary


For any other type of system, the implementing partners should agree on the appropriate code from the OTA UIT code list.

   

@ResID_Value

 1  

ResID_Value is the actual confirmation number.

 See above  

@ResID_Source  

 0..1  

A unique identifier to indicate the source system which generated the ResID_Value  

In the descriptions above these are hardcoded as “CRS” and “PMS”. In fact, they are configurable: Use
Info.ResID_Source.Crs and Info.ResID_Source.Pms in code.

 @ForGuest  

 0..1  

When 1 the confirmation number given to the guest. This number should be searchable by the destination.

 Always true  

OTA_HotelResRS Sample Response Message

<OTA_HotelResNotifRS xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_HotelResNotifRS.xsd" Version="1.003" EchoToken="879791878" TimeStamp=" 2005-10-09T18:52:15" ResResponseType="Committed">
	<Success/>
	<HotelReservations>
		<HotelReservation>
			<UniqueID Type="14" ID="3741"/>
			<ResGlobalInfo>
				<HotelReservationIDs>
					<HotelReservationID ResID_Type="10" ResID_Value="82329987"/>
					<!-- Res ID Type 10 = Hotel from OpenTravel Alliance code table UIT -->
				</HotelReservationIDs>
			</ResGlobalInfo>
		</HotelReservation>
	</HotelReservations>
</OTA_HotelResNotifRS>

  

  • No labels