Versions Compared

Version Old Version 4 New Version 5
Changes made by

Yana Brilevskaya

Yana Brilevskaya

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Excursion Availability Request is used to check excursions availability and prices for the requested dates and passengers groups.

GP_ExcursionAvailRQ*:

*mandatory

Element

Attribute

Type

Description

Min…Max occurs

AvailRatesOnly

boolean

If it is set to "true", then only available excursions must be returned in response.

If it is set to "false", then both available and on request offers should be shown.

0...1

RequestedCurrency

For more information see Common Data Description section in Glossary.

0...1

PrimaryLangID

For more information see Common Data Description section in Glossary.

0...1

AllowPartialAvail

boolean

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 with all types of search except search by ExcursionCode (see Possible search options section).

Info

Note: This functionality supported for limited suppliers. Please check with GP Travel HUB development if you are interested in specific supplier.

0...1

ShowCharges

boolean

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

Info

Note: This functionality supported for limited suppliers. Please check with GP Travel HUB development if you are interested in specific supplier.

0...1

AvailRequestSegments/AvailRequestSegment*

Contains information about the excursion.

1...1

GP_ExcursionAvailRQ/AvailRequestSegments/AvailRequestSegment*:

Element

Attribute

Type

Description

Min…Max occurs

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.

Info

Note: This functionality supported for limited suppliers. Please check with GP Travel HUB development if you are interested in specific supplier.

0...1

ExcursionStartDateRange*

Describe Excursion start and end date. You can provide date interval to search for excursions. All excursions that start within defined interval should be returned.

1...1

Start*

yyyy-mm-dd

Describe Excursion start date.

1...1

End*

yyyy-mm-dd

Describe Excursion end date.

1...1

ExcursionCandidates/ExcursionCandidate*

Describes tourists for excursion.

1...1

RPH*

int (1)

A special identifier of requested excursion. It must be "1" in current implementation (only one excursion can be booked).

1...1

ExcursionCandidates/ExcursionCandidate/GuestCounts/GuestCount*

Is used to provide number of tourist for the excursion as well as their age category.

1...*

AgeQualifyingCode

int (7, 8, 10)

For more information see Common Data Description section in Glossary.

Info

Note:  Either AgeQualifyingCode or PaxTypeCode must be specified.

0...1

Count*

int (1 - 99)

Specifies how many passengers of these age are presented.

1...1

Age

int (0 - 120)

Mandatory for children if AgeQualifyingCode is specified. Specifies children ages.

Info

Note: Count attribute must always be "1" for children and infants. If you need to add several children in the request then there must be a GuestCount element created for each child (infant). You are not allowed to describe two children in one GuestCount element even if they are the same age.

On the opposite, all adults should go in the same GuestCount element with appropriate quantity, so there could be only one GuestCount with AgeQualifyingCode=10.

0...1

PaxTypeCode

string

Contains information about guest type.

Info

Note: This functionality supported for limited suppliers. Please check with GP Travel HUB development if you are interested in specific supplier.

Either AgeQualifyingCode or PaxTypeCode must be specified.

0...1

ExcursionSearchCriteria/Criterion/ExcursionRef*

Describe search criteria.

1...1

ExcursionCityCode

string

Indicates city code where excursion operates.

0...1

LocationType

string

Specifies type of excursion location.

0...1

ExcursionCodeContext*

string

Specifies the context the LocationCode should be taken from (see Possible Search Options section).

1...1

ExcursionCode

string

Allows to check availability for certain excursion. Please note that excursion code is supplier-specific.

0...1

ExcursionCategoryCode

string

Allows to specify particular excursion category user is interested in. See full list of excursion categories supported in HUB in Excursion Categories.

0...1

AreaID

string

Excursion Country Code.

0...1

CompetitorCode

string

Allows to specify particular competitor ("Teams" or "Bands" or individual "Performers"), user is interested in.

0...1

TournamentCode

string

Allows to specify particular tournament, user is interested in.

0...1

ExcursionCountryCode

string

Specifies country code where excursion operates.

0...1

ExcursionVenueCode

string

Indicates venue code where excursion operates.

0...1

ExcursionSubCategoryCode

string

Allows to specify particular excursion subcategory user is interested in. Is used together with the ExcursionCategoryCode attribute. See full list of excursion subcategories supported in HUB in Excursion Subcategories.

0...1

Expand
titleExcursion Availability Request Sample XML
Code Block
languagexml
      <GP_ExcursionAvailRQ AvailRatesOnly="false" EchoToken="EchoToken" PrimaryLangID="en" RequestedCurrency="EUR" Version="2.0">
         <POS>
            <Source>
               <RequestorID ID="client" MessagePassword="pwd" Type="22"/>
               <BookingChannel Type="7"/>
            </Source>
         </POS>
         <AvailRequestSegments>
            <AvailRequestSegment>
               <ExcursionStartDateRange End="2021-08-22" Start="2020-08-25"/>
               <ExcursionCandidates>
                  <ExcursionCandidate RPH="1">
                     <GuestCounts>
                        <GuestCount AgeQualifyingCode="10" Count="1"/>
                        <GuestCount AgeQualifyingCode="8" Count="1" Age="10"/>
                     </GuestCounts>
                  </ExcursionCandidate>
               </ExcursionCandidates>
               <ExcursionSearchCriteria>
                  <Criterion>
                     <ExcursionRef ExcursionCityCode="1006" ExcursionCode="278255" ExcursionCodeContext="supplierCode"/>
                  </Criterion>
               </ExcursionSearchCriteria>
            </AvailRequestSegment>
         </AvailRequestSegments>
      </GP_ExcursionAvailRQ>