Permitted and Prohibited Hotel Chains

Hotel:PermittedHotelChains

Hotel: ProhibitedHotelChains

By default, Hotel Search responses return properties associated with all supplier hotel chains. However, a Hotel Search Modifier can be added to a request to filter the response options to permitted (included) chains.

The Universal API schema also provides an element to prohibit (exclude) specific suppliers (ProhibitedChains) from the response options. However, this functionality is not currently supported in Universal API.

Implementation by Provider

See Implemented Transactions for provider functionality specific to each transaction.

Provider

Implementation
Galileo (1G)

Supports a maximum of three permitted hotel chains.
Apollo (1V)

Supports a maximum of three permitted hotel chains.
Worldspan (1P)

Supports a maximum of three permitted hotel chains.

Schema

See the following transactions for Hotel Chains in HotelReqRsp.xsd:

HotelSearchAvailabilityReq

HotelSearchAvailabilityRsp

Request

Depending on the provider, permitted hotel chains can be included in a request or prohibited hotel chains can be excluded from a Hotel Search request.

Getting Hotel Chain Codes

Sources of encode/decode data for hotel chains vary by provider.

Chain codes can be retrieved from either:

  • The ReferenceDataRetrieve utility in Universal API
  • The Reference Data tables available from the Travelport Developers site.
  1. In Utility.xsd, use ReferenceDataRetrieveReq to download the data tables.
  2. Set ReferenceDataRetrieveReq @TypeCode to "HotelSupplierType".
  3. Set the provider for the desired table:
  • Set ReferenceDataRetrieveReq/ReferenceDataSearchModifiers @ProviderCode to "1G" to point to the Reference Data table shared by Galileo and Apollo.
  • Set ReferenceDataRetrieveReq/ReferenceDataSearchModifiers @ProviderCode to "1P" to point to the Reference Data table shared by Worldspan .
  1. Open the My Travelport Developers support site at: https://my.travelport.com/
  2. Click the Developer Tools menu and select Travelport Universal API.
  3. Click the Resources tab.
  4. In the Developer Tools section of the Resources tab, click Travelport Reference Data Tables link to save the latest ReferenceData.zip file.
  5. Extract the downloaded ReferenceData.zip file.
  6. Open RHTL.TXT, which contains the encoded and decoded hotel chain data.

Requesting Permitted Chains

In HotelSearchAvailabilityReq, send the permitted chain code in /HotelSearchModifiers/PermittedHotelChains/HotelChain @Code.

Requesting Prohibited Chains

Prohibited chains are not currently supported by Universal API providers. The HotelSearchModifiers/ProhibitedHotelChains element is reserved for future use.

Response

Permitted Chains

For a Permitted Chains request, the Hotel Search response returns only properties owned by the chains or master chains listed in the request.

Chain codes are returned in /HotelSearchResults/VendorLocation @VendorCode.

If the number of permitted chains for a specific provider is exceeded in the request, a warning is returned:
Max number of permitted vendors exceeded for this host. [Vendor(s)] were not included in the request. 

After a hotel property is selected in Hotel Search, subsequent Hotel Rate and Rule Search and Hotel Booking requests must include the chain for the selected property.

Prohibited Chains

For Prohibited Chains, an error message is returned if a value is sent in HotelSearchModifiers/ProhibitedHotelChains/Chain @Code.

<ResponseMessage Code="5239" Type="Warning" ProviderCode="1G">ProhibitedChains modifier is not supported and has been ignored.</ResponseMessage>

Implemented Transactions

Hotel Search (Synchronous and Asynchronous)

HotelReqRsp.xsd

HotelSearchAvailablityReq/HotelSearchModifiers/PermittedChains

HotelSearchAvailablityReq/HotelSearchModifiers/ProhibitedChains

HotelSearchAvailablityAsynchReq/HotelSearchModifiers/PermittedChains

HotelSearchAvailablityAsynchReq/HotelSearchModifiers/ProhibitedChains

 

HotelSearchAvailabilityRsp/HotelSearchResults/VendorLocation @VendorCode

HotelSearchAvailablityAsynchReq/HotelSearchResults/VendorLocation @VendorCode

 

By default, Hotel Search responses return all available hotel chains. However, chain codes can be added to a request to either permit (include) or prohibit (exclude) specific vendors from the response option.

After a hotel property is selected in Hotel Search, the subsequent Hotel Rate and Rule Search and Hotel Booking requests must include the chain for the selected property.

Exceptions

  • Does not support prohibited chains.

  • Supports a maximum of three permitted chains in a single request.

  • Supports master chain codes.

  • Does not support prohibited chain codes.

  • Supports a maximum of three permitted chains in a single request.

  • Supports master chain codes.

  • Does not support prohibited chain codes.

  • Supports a maximum of three permitted chains in a single request.

  • Supports master chain codes.