2.2. HOTEL AVAILABILITY REQUEST

AvailRatesOnly*

boolean

If it is set to "true", it is used to search for available hotels only that could be immediately confirmed.

If it is set to "false", it is used to search for all hotels including hotels with "on request" availability.

1…1

ShowCharges

boolean (default - false)

Influences on CancellationPenalties block's appearance on Hotel Availability Response.

0…1

PrimaryLangID

For more information see Common Data Description section in Glossary.

RateRangeOnly*

boolean (always false)

А special option that allows to request price breakdown for selected hotel (see HotelPriceBreakdown).

1…1

RequestedCurrency

For more information see Common Data Description section in Glossary.

BestOnly*

bollean (default - false)

Indicates the response message should send back only the best rate available at the hotel property, as there could be multiple room types and rates that meet the requested criteria.

1…1

PackageRate

boolean (default - false)

Indicates if package rates should be included in response. Possible values are "true" (include package rates), and "false" (don't include package rates).

0…1

AllowPartialAvail 

boolean (default - false)

If it is set to true HUB returns part of all available offers (pagination search). Available request can be repeated until all offers is returned. If it is set to false then usual search is done with all available offers. It works only with search by location. 

0…1

AvailRequestSegments/ AvailRequestSegment:*

1…1

MoreDataEchoToken

string (1 - 128)

Should be specified only if the AllowPartialAvail=true in request. Attribute identifies where the data with offers which was not loaded in primary availability request is located.

0…1

StayDateRange*

Start*

yyyy-mm-dd

Start date of staying in hotel.

1…1

End*

yyyy-mm-dd

End date of staying in hotel.

1…1

RatePlanCandidates/RatePlanCandidate

0…*

RatePlanCode

string

0…1

PromotionCode

string

0…1

RoomStayCandidates/ RoomStayCandidate*

Describes guests for accommodation. Multiple RoomStayCandidate elements must be defined to perform multi search for different rooms.

1…*

HotelSearchCriteria/Criterion

Specifies hotel geographical coordinates.

1…*

Quantity*

integer (default - 1)

 The number of requested rooms for particular guest set. Quantity attribute must be always "1" since HUB 5.4.0. 

1…1

RPH*

integer (default - 1)

A special identifier of requested rooms. Also, RPH identifies the offers related to search accommodation set in the response. If the multi search is performed, the RPHs should be unique for each room.

1…1

GuestCounts/GuestCount*

Paxes in one room.  

1…*

AgeQualifyingCode*

For more information see Common Data Description section in Glossary.

Count*

integer

Specifies the number of tourists of defined age group.

1…1

Age

integer (0 - 150)

Optional attribute; but if a tourist is a child or infant, it is required to specify his/her age. It is assumed that this is full child age on a date of check out from hotel.

0…1

Position

Specifies position of the hotel.

0…1

Latitude*

string (1 - 16)

Specifies the north–south position of a point on the Earth's surface.

1…1

Longitude*

string (1 - 16)

Specifies the east–west position of a point on the Earth's surface.

1…1

HotelRef*

1…1

HotelCityCode

string

City code where hotels to search.

0…1

HotelCodeContext*

string (1-64)

Specifies the context the HotelCityCode and HotelCode should be taken from (GEO, supplier code, customer code).

1…1

AreaID

string

Is Country Code.

0…1

HotelCode

string (1-64)

Hotel code, if you already know it and would like to check available offers for certain hotel. Please note that hotel code depends on vendor.

0…1

HotelName

string

Is a part of hotel name. GP Travel HUB uses 'inclusive' search for hotel name.

0…1

ChainCode

string (1-64)

Is a code of hotel chain.

0…1

MapArea

0…1

NorthLatitude*

string (1 - 16)

The latitude of the northern boundary of the map.

1…1

SouthLatitude*

string (1 - 16)

The latitude of the southern boundary of the map.

1…1

EastLongitude*

string (1 - 16)

The longitude of the eastern boundary of the map.

1…1

WestLongitude*

string (1 - 16)

The longitude of the eastern boundary of the map.

1…1

Radius

0…1

Distance*

integer

Contains distance to the nearest important places.

1…1

UnitOfMeasureCode*

integer (1 - mile, 2 - km)

Units of measure. GP HUB uses standard OTA code "Unit of Measure Code (UOM)".

1…1

Award

Describes the required hotel rating.

0…1

Rating*

integer (0 - 5)

Number of stars. If specified, the search results will include hotels with official star rating greater or equal to defined value.

1…1

Service

Describes the required hotel or room service. In case it specified in request, GP Travel HUB returns only the offers where the services provided. In case several Service elements included in the request, GP Travel HUB returns only the offers where all the included services provided.

0…99

ServiceType*

string ("Hotel", "Room")

Identifies if the service should relate with room or hotel.

1…1

Code*

integer (0 - 1000)

The standard OTA service code. If the ServiceType is "Hotel", then the Code refers to OTA List "Hotel Amenity Code (HAC)". If the ServiceType is "Room", then the Code refers to OTA List "Room Amenity Code (RMA)".

1…1

Quantity

integer

Contains numeric information about service. For example: amount of swimming pools; year of most recent renovation; room size (sqm), etc.

0…1

Profiles/ProfileInfo/Profile/Customer/CitizenCountryName

For some suppliers it is necessary to provide country of domicile for correct pricing. Should contain ISO country code which is tour lead's country of domicile.

0…2

Code

string (2 - 3)

0…1