4.3. EXCURSION AVAILABILITY RESPONSE

Success

For more information see Common Data Description section in Glossary.

0...1

Warnings/Warning

For more information see Common Data Description section in Glossary.

0...99

Excursions

Represents excursions from supplier.

0...1

MoreDataEchoToken

string (1 - 128)

The availability response returns the attribute if there is additional data that could not fit within the availability response. The text value should be echoed in the availability request to indicate where to begin the next block of availability data (only if the AllowPartialAvail=true in request). 

0...1

MoreIndicator

boolean

Indicate that there are additional rates that cannot fit in the availability response (only if the AllowPartialAvail=true in request).

0...1

Excursions/Excursion

Represents one excursion from supplier.

0...*

ExcursionRates/ExcursionRate*

Describes excursion offer.

1...*

Services/Service

Indicates price and currency for the service.

0...99

BasicExcursionInfo*

General information about excursion.

1...1

AvailabilityStatus*

string ("AvailableForSale", "OnRequest")

Contains offer availability status, whether it is immediately available (AvailableForSale) or on request (OnRequest).

1...1

NonRefundable

boolean (default - “false“)

If it is set to "true", then the offer is non-refundable, and supplier notifies about this explicitly. If the attribute is missed - there is no clear meaning whether the offer is refundable or not.

0...1

NumberOfUnits

integer

Indicates how many tickets are left for this rate.

0...1

PromotionCode

string(“DI”)

Indicates whether the offer comes from Dynamic Inventory.

0..1

RateCode*

string

Contains offer code as returned by supplier.

1...1

RateName*

string

Contains offer name as returned by supplier.

1...1

Language*

For more information see Common Data Description section in Glossary.

1...1

ExcursionDuration

double

Represents excursion duration in hours. ExcursionDuration=”3.5” means that the excursion takes 3 hours and 30 minutes. Here also possible to have value greater than “24” in case excursion takes more than one full day. The element is skiped in case supplier does not provide that information.

0...1

BookingCode*

string

A specific identifier generated by GP Hub for further referencing to this offer. The <BookingCode> value should be used as unique offer identifier for further excursion reservation step.

1...1

Rates/Rate*

Specifies price breakdown per passenger type (adults, children, infants).

1...*

AgeQualifyingCode

For more information see Common Data Description section in Glossary.

0...1

RateSource*

string ("Calculated", "Provided")

Identifies whether this rate has been provided by supplier (“Provided”) or calculated by GP Hub (“Calculated”).

1...1

PaxTypeCode

string

Contains information about guest type.

0...1

Rates/Rate/Total*

The total price of the offer per passenger type (after discount, if any has been applied).

1...1

AmountAfterTax*

For more information see Common Data Description section in Glossary.

1...1

CurrencyCode*

1...1

Rates/Rate/TotalRetail

The retail price of the offer per passenger type recommended by supplier (if applicable).

0...1

AmountAfterTax*

For more information see Common Data Description section in Glossary.

1...1

CurrencyCode*

1...1

RateDescription

Rate name and description as returned by supplier. Can be empty.

0...1

Name*

string

Name of the rate.

1...1

RateDescription/Text

string

Description of the rate.

0...1

PaxTypes

Contains details about possible pax types.

0…1

MinCount

int

Minimum allowed number of paxes.

0...1

MaxCount

int

Maximum allowed number of paxes.

0...1

PaxTypes/PaxType

Contains details about possible pax types.

1...*

Code*

string

Pax type Code.

1...1

Name*

string

Pax type Name.

1...1

MinAge

int

Minimum age for the type of pax.

0...1

MaxAge

int

Maximum age for the type of pax.

0...1

MinCount

int

Minimum allowed number of paxes of the type.

0...1

MaxCount

int

Maximum allowed number of paxes of the type.

0...1

PaxTypes/PaxType/ValidWithPaxTypes

Indicates that the pax type can only be selected in combination with one of the listed pax type options.

0…1

PaxTypes/PaxType/ValidWithPaxTypes/PaxType*

Contains a pax type option in combination with the pax type can be selected.

1…99

Code*

string

Pax type Code.

1...1

Total*

Total offer price for all requested travelers.

1...1

AmountAfterTax*

For more information see Common Data Description section in Glossary.

1...1

CurrencyCode*

1...1

Total/Taxes/Tax

Provides information about taxes applied or defines taxes applied.

0...100

Code

integer

Tax code value, according to Сodes of taxes (FTT).

0...1

Amount

decimal

Amount of tax.

0...1

CurrencyCode

For more information see Common Data Description section in Glossary.

0...1

TaxInclusiveInd

boolean (default - false)

Defines inclusion of a particular tax into the total price.

0...1

CitizenCountryName

Shows if it is enough to provide information about citizenship only for tour lead. Missing attribute means that there is no clear meaning whether the citizenship should be provided or not.

0...1

OnlyLead*

string ("Yes", "No", "Mixed")

Shows if it is enough to provide information only for tour leader (Yes), or it is necessary to provide for all passengers (No), or both options are possible (Mixed). By default it is necessary to provide this information for all passenger (No).

1...1

PersonName

Shows if it is enough to provide name only for tour lead.

0...1

OnlyLead*

string ("Yes", "No", "Mixed")

Identifies the rule, if it's necessary to provide name of each passenger (No), or only tour leader (Yes), or both variants are possible (Mixed).

1...1

Services/Service

Contains the information about services if supplier supports delivery of tickets or other additional services that could be booked in advance for the offer. When Services received in response - it is possible to add them during booking (at Reservation stage).

0...999

ServiceRPH*

string (1 - 32)

Refers to service which is situated in full list. Full list is available in ExcursionRates/Services list, see description above.

1...1

Inclusive

boolean

Price for this service is included or not in the Total.

0...1

RequiredInd

boolean

Indicates whether this service is mandatory or not.

0...1

CancelPenalties/CancelPenalty*

For more information see Excursion Charges Response section. Occurs only when @ShowCharges “true“ on Excursion Availability Request.

0...*

ExcursionDate*

For more information see Common Data Description section in Glossary.

1...1

AvailableTicketQuantities

Contains information about tickets that can be booked in one reservation request.

0…1

AvailableTicketQuantities/AvailableTicketQuantity*

Each element shows how many tickets can be booked in one reservation request.

1…*

AdditionalDetails/ AdditionalDetail

Provides an additional information the supplier can return about the offer.

0…*

Code

string

Trading partner code associated to AdditionalDetailType. At the moment HUB uses the name of the element from the supplier's response, e.g. MaxSCU, LastBookableDate etc.

0…1

Type

integer (1 - 73)

Defines the type of the information recieved (e.g., rate description, property description, excursion information). Refers to Additional Detail Type.

0…1

AdditionalDetails/ AdditionalDetail/DetailDescription

Contains additional details description.

0…1

Language

For more information see Common Data Description section in Glossary.

0...1

AdditionalDetails/ AdditionalDetail/DetailDescription/Text

string

Contains additional text information.

0…*

SpecialServiceType

string ("DeliveryToHotel", "DeliveryToAddress", "SelfPickUp", "E-Delivery", “Supplement”)

Could have the following values:

DeliveryToHotel - requires Guest Full Name, Hotel name, Check-in date, Hotel Address (Incl. zip code).

DeliveryToAddress - requires Guest Full Name, Guest home Address (Incl. zip code, City, Province, Country).

SelfPickUp - requires Mandatory data only (LeadName, Email, Phone, Country).

E-Delivery - requires Mandatory data only (LeadName, Email, Phone, Country).

Supplement - defines extras for excursion (e.g. Lunch, Guide).

0...1

ServiceRPH*

string (1 - 32)

Refers to service which is situated in full list.

1...1

Inclusive

boolean

Price for this service is included or not in the Total.

0...1

RequiredInd

boolean

Indicates whether this service is mandatory or not.

0...1

Price

Indicates price and currency for the service.

0...99

Price/Base

0...1

AmountAfterTax*

For more information see Common Data Description section in Glossary.

1...1

CurrencyCode*

1...1

ServiceDetails

Contains service details.

0...1

ShortName

string

Name of the service provided by supplier.

0...1

ServiceDetails/ServiceDescription/Text

string

Description of the service provided by supplier.

0...1

ExcursionCityCode*

string

Supplier-specific city code of where excursion is located.

1...1

ExcursionCodeContext*

string

Contains supplier code.

1...1

ExcursionCode*

string

Excursion code as returned by supplier.