4.3. CAR AVAILABILITY SEARCH RESPONSE

Success

For more information see Common Data Description section in Glossary.

Warnings/Warning

VehAvailRSCore

Availability and rate information for one specific car.

0...1

VehAvailRSCore/VehRentalCore*

Represents common car information.

1...1

PickUpDateTime*

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

Identify The Date & Time to pickup/return the car.

1...1

ReturnDateTime*

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

1...1

VehAvailRSCore/VehVendorAvails/VehVendorAvail*

Information on the availability of cars for one specific vendor.

1...*

Vendor

Represents vendor. The element exists only if the information available from supplier.

0...1

CompanyShortName*

string (1 - 32)

Specifies vendor's name.

1...1

Code*

string (1 - 32)

Specifies vendor's code.

1...1

CodeContext*

string (1 - 32)

Supplier code context.

1...1

Vendor/Award

Describes the vendor rating.

0...1

Rating*

string

Number of stars.

1...1

Provider*

string

Describes the provider of vendor rating.

1...1

Vendor/URL

URI

Vendors URL.

0...1

VehAvails/VehAvail*

Represents availability and rate information for one specific car.

1...*

VehAvails/VehAvail/VehAvailCore*

1...1

Info*

Supplemental information associated with the vendor and the availability of the cars.

1...1

AvailabilityStatus*

string ("AvailableForSale", "OnRequest")

Defines car availability. It can have the next values: "AvailableForSale" (means that the offer will be immediately confirmed), "OnRequest" (means that you'll need to wait confirmation from vendor).

1...1

BookingCode*

string (1 - 64)

Contains unique ID of the offer. It is required for further reservation of this offer. BookingCode covers the next details: PickUp/Return locations, driver age and residence, car details together with special equipment included in price.

1...1

Vehicle*

Information on one specific car along with detailed information on the charges associated with this car.

1...1

RentalRate

Information on the rates associated with this car. Rate information can include the distance and the base rental cost, along with information on the various factors that may infuence this rate. For example, $20.00 with 100 miles per day or $30.00 for unlimited mileage.

0...1

RentalRate/VehicleCharges/VehicleCharge*

Contains detailed information on one specific charge.

1...99

Amount

For more information see Common Data Description section in Glossary.

0...1

CurrencyCode

0...1

TaxInclusive

boolean

0...1

Description*

string

Contains charge description.

1...1

IncludedInRate*

For more information see Common Data Description section in Glossary.

1...1

Purpose*

integer (1 - 28)

Refers to the list of Vehicle Charge Purpose Types supported by HUB.

1...1

RentalRate/RateQualifier

Indicates the type of rates applicable to the customer, along with any discount number or promotional codes that affect the quoted rate.

0...1

VendorRateID

string (1 - 32)

The identifier assigned to this rate by the vendor.

0...1

TotalCharge*

The total cost of a reservation including taxes.

1...1

EstimatedTotalAmount*

decimal

Total rental charges including any additional mandatory charges (e.g., taxes).

1...1

CurrencyCode*

For more information see Common Data Description section in Glossary.

1...1

Commisionable

0...1

TotalRetailCharge

The total retail cost of a reservation including taxes.

0...1

EstimatedTotalAmount*

decimal

Total rental charges including any additional mandatory charges (e.g., taxes).

1...1

CurrencyCode*

For more information see Common Data Description section in Glossary.

1...1

Commisionable

0...1

PricedEquips/PricedEquip

Special equipment, along with the quantity, restrictions and charge.

0...25

PricedEquips/PricedEquip/Equipment*

Contains details about an equipment, such as text or description.

1...1

EquipType*

integer (1 - 4000)

Denotes the unique equipment id that identifies this Special Equipment item. You require this id when requesting this item.

1...1

Quantity

integer

Number of equipment items. If not specified, then default value is “1”.

0...1

PricedEquips/PricedEquip/Equipment/Description

string

Contains equipment description.

0...1

PricedEquips/PricedEquip/Charge*

The charges as they relate to a single piece of equipment.

1...1

Amount*

For more information see Common Data Description section in Glossary.

1...1

CurrencyCode*

1...1

IncludedInRate*

1...1

TaxInclusive*

1...1

Fees/Fee

A collection of fees associated with this car quotation.

0...99

Amount*

For more information see Common Data Description section in Glossary.

1...1

CurrencyCode*

1...1

Purpose

integer (6, 22, 23)

Refer to OpenTravel Code List Vehicle Charge Purpose Type (VCP). The next values are used:

“6” - Supplier Booking Fee.

“22” - Deposit Fee (This is the estimated deposit fee that will be taken from the customer if they book this car).

“23” - Fee to pay on arrival (Amount customer will pay supplier on collection of car).

1...1

AirConditionInd

boolean

Shows the availability of air conditioning.

0...1

TransmissionType

string ("Automatic", "Manual")

Defines the type of transmission.

0...1

FuelType

string ("Unspecified", "Diesel", "Hybrid", "Electric", "LPG_CompressedGas", "Hydrogen", "MultiFuel", "Petrol", "Ethanol")

Defines the type of fuel.

0...1

DriveType

string "AWD", "4WD", "FWD", "RWD", "Unspecified")

Defines the drive type of a car. The possible types are: "AWD" - Defines all-wheel drive; "4WD" - Defines four-wheel drive; "FWD" - Defines front-wheel drive; "RWD" - Defines rear-wheel drive; "Unspecified" - The drive type of the car is unknown.

0...1

PassengerQuantity

string (1 - 8)

Shows max amount of passengers allowed.

0...1

BaggageQuantity

integer

Shows max amount of baggage items allowed.

0...1

Code*

string (1 - 8)

Identifies Car and its rate at particular Vendor. It could be used as additional Availability search criterion (see VehPref/@Code in Availability request) to check availability of the exact car option.

1...1

CodeContext*

string (1 - 32)

Provider of a car.

0...1

VehType

Describes type of the car (e.g. truck, car).

1...1

VehicleCategory

integer (1 - 23)

Refers to the list of Vehicle Types supported by HUB.

0...1

DoorCount

string (1 - 8)

Number of doors in a car.

0...1

VehClass

Defines class of car.

0...1

Size

integer (1 - 48)

Refers to the list of Vehicle Classes supported by HUB.

0...1

VehMakeModel*

The make and model of the car (e.g., Ford Focus).

1...1

Name*

string (1 - 128)

Contains the name of car.

1...1

Code

string (1 - 8)

Contains vendor's code of car. It can contain the SIPP code provided by some suppliers.

0...1

PictureURL

URI

URL that shows the car.

0...1

VehIdentity

The specific identifiers of the car.

0...1

VehicleAssetNumber*

string (1 - 16)

Motor Vehicle Asset Number.

1...1

VendorMessages/VendorMessage

Contains additional information from supplier about this vendor or car (important warnings, restrictions, payment type, or any promotions associated with the rate). There're may be up to 99 VendorMessage elements in response.

0...99

InfoType*

string

Refers to OTA code "Special instructions".

1...1

VendorMessages/VendorMessage/SubSection/Paragraph*

Each VendorMessage may include only one SubSection with 1 Paragraph with 1 Text.

1...1

Language

For more information see Common Data Description section in Glossary.

0...1

VendorMessages/VendorMessage/SubSection/Paragraph/Text

string

Contains the text of specific vendor message.

0...1

PickUpLocation*

Name, code and code context to identify pick up and return points in supplier’s context.

1...*

ReturnLocation

0...*

Name

string (1 - 255)

Name of the pick up/return point.

0...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;

for “Point” type here must be supplier identifier.

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

LocationDetails

Contains location address information.

0...1

AtAirport*

boolean

Is set to “true” if location is in airport; otherwise AtAirport=”false”.

1...1

LocationDetails/Address*

Contains location address.

1...5

LocationDetails/Address/AddressLine*

string (1 - 255)

Location Address.

1...5

LocationDetails/Address/CityName

string (1 - 64)

Name of the city where location is situated.

0...1

LocationDetails/Address/PostalCode

string (1 - 16)

Postal Code of the location.

0...1

LocationDetails/Address/StateProv

string (0 - 64)

Name of State where location is situated.

0...1

StateCode

string (2 - 8)

Code of state.

0...1

LocationDetails/Address/CountryName

string (0 - 64)

0...1

Code

2 character ISO country code

ISO-2 or ISO-3 country code.

0...1

LocationDetails/Telephone

Contains information about the telephone numbers for this location.

0...5

CountryCode

string (2 - 3)

Code assigned by telecommunications authorities for international country identifier.

0...1

AreaCityCode

string (1 - 8)

Code assigned for telephones in a specific region, city, or area.

0...1

PhoneNumber*

string (1 - 32)

Location phone number.

1...1

PhoneLocationType

integer (6,7,8)

Indicates location type for location phone number. Possible values: 6 (Home), 7 (Office), 8 (Other).

0...1

PhoneTechType

integer (3, 5)

Indicates type of technology associated with this telephone number. Possible values: 5 (Mobile), 3 (Fax).

0...1

LocationDetails/Description

string

Contains location description.

0...1