Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Current »

Car Availability Search Request is used to request car availability from location(s) specified.

Note: Only one set of dates/times may be sent for the availability message. Multiple dates and times will require multiple messages. This message is used to request car availability from the location(s) specified.

GP_VehAvailRateRQ*:

*mandatory

Element

Attribute

Type

Description

Min…Max occurs

PrimaryLangID

For more information see Common Data Description section in Glossary.

0...1

RequestedCurrency

0...1

AvailRatesOnly

boolean

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

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

0...1

VehAvailRQCore*

Identifies the common information associated with the request for availability of a car.

1...1

VehAvailRQInfo

0...1

PassengerQty

integer

A preferred passenger quantity for the car based on the number of passengers. The value should not include the driver.

0...1

VehAvailRQInfo/Residence

Provides information about drivers' country of residence. It is required because different rates may be available depending on it.

Note: If the element is missed in Availability search, system assumes that the driver is a citizen of the country he/she rents a car. Final price and availability (received in Reservation Initiate response) can differ because rates depend on driver’s country of residence.

0...1

VehAvailRQInfo/Residence/CountryName*

Provides information about drivers' country of residence.

1...1

Code*

string (1 - 64)

Contains country code.

1...1

CodeContext*

string (1 - 16)

Defines the Code context used. It is possible to pass value either from GEO or from supplier or from client context.

1...1

GP_VehAvailRateRQ/VehAvailRQCore*:

Element

Attribute

Type

Description

Min…Max occurs

VehRentalCore*

Contains information that is common to all requests and responses associated with the reservation of a car.

1...1

PickUpDateTime*

yyyy-mm-dd or yyyy-mm-ddThh-mm-ss

Identify The Date & Time to pickup/return a car. In Availability search Time is optional.

Note: offers and prices can change after exact time specified in Reservation Initiate phase.

1...1

ReturnDateTime*

yyyy-mm-dd or yyyy-mm-ddThh-mm-ss

1...1

VehRentalCore/PickUpLocation*

Contains information to identify pick up point. See possible combinations of pick up and drop off options in Possible Search Options section.

1...1

LocationType*

string ("Airport", "City", "Point")

Contains location type. You can select from “Airport” (client wants to take a car in airport), “City” (client wants to take a car from location in a city) or “Point” (in case client knows exactly what location in a city will be used; it means the customer has already performed a location search and has found a specific rental branch).

1...1

LocationCode*

string (1 - 32)

Depending on LocationType: specify IATA Airport code for “Airport” type; specify City Code for “City” type; specify supplier-specific location code for “Point” type.

1...1

CodeContext*

string (1 - 32)

Defines context in which the LocationCode is 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); for “Point” type here must be supplier identifier.

1...1

VehRentalCore/ReturnLocation

Contains information to identify return point. See possible combinations of pick up and drop off options in Possible Search Options section. Attributes are the same as in PickUpLocation mentioned above.

0...1

VehPrefs/VehPref

Allows to specify additional search criteria. Only one VehPref element can be placed inside the VehPrefs element.

0...1

Code

string (1 - 128)

Allow to select particular car option previously found by another availability search. You should use the Vehicle/@Code attribute value from previous Availability response for this specific search.

0...1

CodeContext

string (1 - 32)

Defines context in which the Code is specified.

0...1

VehPrefs/VehPref/VehClass

Allows to search for specific car class.

0...1

Size*

integer (1 - 48)

Contains car class. See valid Size values in the list of Vehicle Classes supported by HUB in Glossary.

1...1

DriverType*

Specifies driver’s age. This will affect what cars are available, and the price of the cars.

1...1

Age*

integer

Contains driver’s age.

1...1

 Vehicle Availability Request Sample XML Point - Point 3 passengers
<GP_VehAvailRateRQ xmlns="http://www.opentravel.org/OTA/2003/05" AvailRatesOnly="true" EchoToken="EchoToken" PrimaryLangID="en" Version="2.00">
  <POS>
    <Source>
      <RequestorID ID="client" MessagePassword="pwd" Type="22"/>
      <BookingChannel Type="7"/>
    </Source>
  </POS>
  <VehAvailRQCore>
    <VehRentalCore PickUpDateTime="2023-10-13T15:20:00" ReturnDateTime="2023-10-23T19:00:00">
      <PickUpLocation CodeContext="supplierCode" LocationCode="W42" LocationType="Point"/>
      <ReturnLocation CodeContext="supplierCode" LocationCode="E43" LocationType="Point"/>
    </VehRentalCore>
    <DriverType Age="30"/>
  </VehAvailRQCore>
  <VehAvailRQInfo PassengerQty="3">
    <Residence>
      <CountryName Code="US" CodeContext="GEO.suppliercode"/>
    </Residence>
  </VehAvailRQInfo>
</GP_VehAvailRateRQ>
 Vehicle Availability Request Sample XML VehicleClass
<GP_VehAvailRateRQ xmlns="http://www.opentravel.org/OTA/2003/05" AvailRatesOnly="true" EchoToken="EchoToken" PrimaryLangID="en" Version="2.00">
   <POS>
      <Source>
         <RequestorID ID="client" MessagePassword="PWD" Type="22" />
         <BookingChannel Type="7" />
      </Source>
   </POS>
   <VehAvailRQCore>
      <VehRentalCore PickUpDateTime="2021-02-13T15:20:00" ReturnDateTime="2021-02-23T19:00:00">
         <PickUpLocation CodeContext="supplierCode" LocationCode="201|AL" LocationType="Point" />
         <ReturnLocation CodeContext="supplierCode" LocationCode="201|AL" LocationType="Point" />
      </VehRentalCore>
      <VehPrefs>
         <VehPref>
            <VehClass Size="4" />
         </VehPref>
      </VehPrefs>
      <DriverType Age="30" />
   </VehAvailRQCore>
   <VehAvailRQInfo PassengerQty="1">
      <Residence>
         <CountryName Code="CA" CodeContext="GEO.supplierCode" />
      </Residence>
   </VehAvailRQInfo>
</GP_VehAvailRateRQ>
  • No labels