Versions Compared

Version Old Version 3 New Version Current
Changes made by

Yana Brilevskaya

Yana Brilevskaya

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: HUB-11080 New elements TransferDeparture/Position and TransferDestination/Position were added

Transfer Availability Request is used to search for transfer availability and prices for the requested dates and passenger groups.

GP_TransferAvailRQ*:

*mandatory

Element

Attribute

Type

Description

Min…Max occurs

AvailRatesOnly

boolean

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

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

0...1

PrimaryLangID

For more information see Common Data Description section in Glossary.

0...1

RequestedCurrency

For more information see Common Data Description section in Glossary.

0...1

TransferType

string (“Individual“, “Group“)

Indicates transfer type.

0…1

ShowCharges

boolean

Influences on CancellationPenalties block's appearance on Transfer 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 transfer required.

1..1

GP_TransferAvailRQ/AvailRequestSegments/AvailRequestSegment*:

Element

Attribute

Type

Description

Min…Max occurs

TransferDate*

Describes the transfer date and (optionally) time.

1..1

DateTime*

date or datetime

Can accept both DateTime and Date data values.

Info

Note: In most cases it is enough to provide transfer date to search for transfers. But some suppliers return more precise results if both date and time of transfer are specified. In that case set TransferDate/@DateTime value as DateTime (e.g. “2009-10-16T14:30:00”). In case departure point is Airport, the TransferDate/@DateTime value normally corresponds to the flight’s arrival time. In case the destination point is Airport, the TransferDate/@DateTime value normally corresponds to flights departure time.

1..1

ReturnDateTime

date or datetime

Identifies when return transfer is needed. If the value specified then availability response returns transfer offers for both directions ‘to’ and ‘from’.

0..1

TransferCandidates/TransferCandidate*

Describes passengers for transfer.

1..1

RPH*

int (1)

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

1..1

Quantity*

int (1)

The number of requested vehicles. It must be "1" in current implementation (only one transfer can be booked).

1..1

TransferCandidates/TransferCandidate/GuestCounts/GuestCount*

Is used to provide number of tourists for the transfer as well as their age category.

1..99

AgeQualifyingCode*

For more information see Common Data Description section in Glossary.

1...1

Count*

int (1 - 99)

Specifies how many passengers of this age are presented.

1...1

Age

int (0 - 120)

Mandatory for children. 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

TransferSearchCriteria/Criterion*

Describes departure and destination points.

1..1

GP_TransferAvailRQ/AvailRequestSegments/AvailRequestSegment/TransferSearchCriteria/Criterion*:

Attribute

Type

Description

Min…Max occurs

TransferCode

string (1 - 64)

Allows to check availability for certain transfer.

Info

Note: transfer code is supplier-specific.

0..1

CodeContext

string

Specifies the context the TransferCode should be taken from. The possible value is supplier code.

0..1

TransferRef

TransferCategoryCode

string

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

0...1

TransferDeparture*

Specifies departure point.

1..1

LocationType*

string ("Airport", "City", “GEO”)

Specifies Location type.

Availability search result returns transfer offers from the departure point to the destination point on the date specified in DateTime.

If only TransferDeparture element specified, then the departure point must be Airport. Availability search result returns transfer offers from the Airport to a City that the Airport belongs to, and back.

1..1

LocationCode*

string (1 - 99)

Depending on LocationType: specify IATA Airport code for “Airport” point; specify City Code for “City” point.

1..1

CodeContext*

string

Defines the context in which the LocationCode specified: for “Airport” point there must be IATA airport code, for “City” point there could be GEO or supplier or client context (see details in Possible Search Options section).

1..1

TransferDeparture/HotelRef

Allows to request for transfer from Airport/Port to the particular Hotel.

Info

Note: The HotelRef criterion only works for suppliers that support transfers to particular hotel. If supplier does not support transfer to a hotel, then the HotelRef element will be ignored in request to supplier; GP Travel HUB response will return all transfers available from Airport to City specified in TransferDestination.

0..*

HotelCityCode

string

City code where hotels to search.

0..1

HotelCodeContext*

string

Specifies the context the HotelCityCode and HotelCode should be taken from. The possible option is supplier code.

1..1

HotelCode

string

Hotel code, if you already know it and would like to check available offers to certain hotel.

Info

Note: hotel code depends on vendor.

0..1

HotelName

string

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

0..1

TransferDeparture/Position

 

 

Allows to search for transfers from the Airport to a specific point. Must be specified if TransferDeparture/@LocationType = ‘GEO’

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

TransferDestination

Specifies destination point. Attributes are the same as in TransferDeparture element, mentioned above.

0..1

TransferDestination/HotelRef

Allows to request for transfer from Airport to the particular Hotel. Attributes are the same as in TransferDeparture/HotelRef element, mentioned above.

0..*

TransferDestination/Position

 

 

Allows to request for transfer from Airport to a specific point. Attributes are the same as in TransferDeparture/Position element, mentioned above.

0..1

Expand
titleTransfer Availability Request Sample XML
Code Block
languagexml
<GP_TransferAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" AvailRatesOnly="true" EchoToken="EchoToken" PrimaryLangID="en" RequestedCurrency="EUR" Version="2">
  <POS>
    <Source>
      <RequestorID ID="client" MessagePassword="pwd" Type="22"/>
      <BookingChannel PriceDomain="1" Type="7"/>
    </Source>
  </POS>
  <AvailRequestSegments>
    <AvailRequestSegment>
      <TransferDate DateTime="2020-10-29T14:00:00"/>
      <TransferCandidates>
        <TransferCandidate Quantity="1" RPH="1">
          <GuestCounts>
            <GuestCount AgeQualifyingCode="10" Count="1"/>
            <GuestCount Age="7" AgeQualifyingCode="8" Count="1"/>
          </GuestCounts>
        </TransferCandidate>
      </TransferCandidates>
      <TransferSearchCriteria>
        <Criterion>
          <TransferDeparture CodeContext="IATA.supplierCode" LocationCode="ZRH" LocationType="Airport"/>
          <TransferDestination CodeContext="GEO.supplierCode" LocationCode="4717" LocationType="City"/>
        </Criterion>
      </TransferSearchCriteria>
    </AvailRequestSegment>
  </AvailRequestSegments>
</GP_TransferAvailRQ>