OTA2012B Documentation
OTA2012B Documentation
OTA2012B Documentation
Hire
with a
smile
MicronNexus
GmbH
Alipiev, Emil
(MicronNexus
GmbH)
1 Index
1
INDEX....................................................................................................................................................... 2
INTRODUCTION........................................................................................................................................ 6
QUOTE ................................................................................................................................................... 26
7.1
REQUEST................................................................................................................................................. 27
7.2
RESPONSE ............................................................................................................................................... 28
7.3
SAMPLE REQUESTS .................................................................................................................................... 31
7.3.1 By Airport ID or City ID: ................................................................................................................... 31
7.3.2 By IATA code: ................................................................................................................................... 31
7.3.3 Using VehPrefs Filter ....................................................................................................................... 31
CarHire-Solutions - Interface
Page 2
RATERULES ............................................................................................................................................ 36
8.1
8.2
RESERVATION ........................................................................................................................................ 39
9.1
REQUEST................................................................................................................................................. 39
9.1.1 Payment .......................................................................................................................................... 40
9.1.2 Equipment ....................................................................................................................................... 41
9.2
RESPONSE ............................................................................................................................................... 41
9.3
SAMPLE REQUEST ..................................................................................................................................... 42
9.4
SAMPLE RESPONSE .................................................................................................................................... 43
10
CANCELLATION ...................................................................................................................................... 46
10.1
10.2
10.3
11
12
REQUEST................................................................................................................................................. 49
RESPONSE ............................................................................................................................................... 49
SAMPLE-REQUEST .................................................................................................................................... 49
SAMPLE-RESPONSE ................................................................................................................................... 50
MODIFY ................................................................................................................................................. 52
12.1
12.2
12.3
12.4
13
RESPONSE ............................................................................................................................................... 47
SAMPLE REQUEST ..................................................................................................................................... 47
SAMPLE RESPONSE .................................................................................................................................... 48
REQUEST................................................................................................................................................. 54
RESPONSE ............................................................................................................................................... 54
SAMPLE REQUEST ..................................................................................................................................... 54
SAMPLE RESPONSE .................................................................................................................................... 55
LOCATION .............................................................................................................................................. 56
13.1
LIST OF LOCATIONS ................................................................................................................................... 56
13.1.1
Request ....................................................................................................................................... 56
13.1.2
Response ..................................................................................................................................... 57
13.1.3
Sample-Request .......................................................................................................................... 57
13.1.4
Sample-Response ........................................................................................................................ 58
13.2
LOCATION DETAILS ................................................................................................................................... 58
13.2.1
Request ....................................................................................................................................... 58
13.2.2
Response ..................................................................................................................................... 59
13.2.3
Sample request ........................................................................................................................... 59
13.2.4
Sample response ......................................................................................................................... 60
14
APPENDIX .............................................................................................................................................. 61
14.1
14.2
14.3
CarHire-Solutions - Interface
Page 3
14.4
14.5
14.6
14.7
14.8
14.9
14.10
14.11
14.12
14.13
14.14
14.15
15
CONTENT-INDEX .................................................................................................................................... 74
15.1
ILLUSTRATIONS ......................................................................................................................................... 74
CarHire-Solutions - Interface
Page 4
2 History of document
Version
1.0
1.0
Date
25.09.2013
22.05.2014
CarHire-Solutions - Interface
Author
Emil Alipiev
Emil Alipiev
Changes
First Release
Revised
Page 5
3 Introduction
This document displays and supports with advisable information of web-based reservation interface
(OTA2012B.carhire-solutions.com) of the MicronNexus car hire platform and designed affiliates using
extensible mark-up language (xml) as well as using this platform as Computerized Reservation System
(CRS) also known as Global Distribution System (GDS).
All mentioned terms, abbreviations, etc. in this document are based on the Open Travel Alliance
2007A Specifications. Please find all information regarding the OTA specifications under
www.opentravel.org.
One may download to recent version of this documentation from http://www.carhiresolutions.com/OTA2012b_documentation.pdf.
The intent of this document is to supply CarHire-Solutions affiliates with information for the
customers demand that support:
Availability of vehicles
Reservation of vehicles
Requesting and reserving equipment and options
Locations
Opening hours
Retrieve a reservation request
Cancel reservation
Amendment (changing a reservation)
CarHire-Solutions - Interface
Page 6
SOAP
SOAP, originally defined as Simple Object Access Protocol, is a protocol specification for exchanging
structured information in the implementation of Web Services in computer networks. It relies on
Extensible Markup Language (XML) as its message format, and usually relies on other Application
Layer protocols (most notably Remote Procedure Call (RPC) and HTTP) for message negotiation and
transmission. SOAP can form the foundation layer of a web services protocol stack, providing a basic
messaging framework upon which web services can be built.
Supplier
A supplier is someone whose business is to supply a particular service or commodity, in this
particular case the car rental service.
Broker
A broker is a party that mediates between the car rental companys and customers.
CarHire-Solutions - Interface
Page 7
Brokers are getting their fleet from several car rental companies and selling under their own
brand, e.g. holidayautos. Brokers havent got their own fleet or locations.
Car Rental Company
A car rental company offers its own fleet at its own locations. Car rental companies are
getting their fleet from the car manufacturer directly and selling under their own brand, e.g.
Hertz.
Affiliate
An affiliate is a partner hosting any kind of website, either B2B (business to business) or B2C
(business 2 customer), for providing rental car offers. This can be a travel web portal, a touristic
service provider or any kind of tour operator.
Tour Operator
A tour operator typically combines tour and travel components to create a holiday. The most
common example of a tour operator's product would be a flight on a charter airline, a transfer from
the airport to a hotel, services to offer car rentals and the services of a local representative, e.g. TUI.
Travel Agency
A travel agency (or travel shop) is the retail unit of a tour operator where customers can book their
holidays and car hire, together with an agency agent (or shop agent).
Net Price
Net price is the defined purchase price given from the car hire supplier to the tour operator. The tour
operator creates a markup on top of the net price in order to end up with a final selling price. This
markup can also be done on behalf of MicronNexus in their database.
Gross Price
Gross price is the predefined selling price by the car hire supplier. The tour operator receives a fixed
percentage of commission.
Prepaid
CarHire-Solutions - Interface
Page 8
Prepaid to Tour-Operator
Prepaid to Supplier
Prepaid to CarHire-Solutions
Postpaid
Postpaid can be referred as to use and pay (pay at time of pick up at counter), in this case:
Postpaid to Supplier
Commission
Commission is a form of payment by supplier to the tour operator. Commission can also be paid by
supplier to MicronNexus. In this case MicronNexus pays a subcommission (its amount is negotiated
between the tour operator and MicronNexus) to the tour operator. The amount is calculated by a
certain percentage to the selling price and will be applicable only in the gross price section.
Margin
The margin defines the result of purchase price less selling price and will be applicable only in the net
price section.
Samples of payment
Postpaid to supplier using gross rates
When pick-up the car at the rental station the customer does pay the price defined by the
supplier.
CarHire-Solutions - Interface
Page 9
Supplier
Provision
Defined price by
Supplier
Affiliate
Customer
Net-price
Defined price by
Affiliate
Affiliate
Customer
Provision
Affiliate
Offered price by
Supplier
Customer
CarHire-Solutions - Interface
Page 10
Airport Coding
By IATA Code
IATA airport codes are trigram letter designations for airports.
By Airport-ID
Airport-ID is defined by MicronNexus.
Sample
IATA
LHR
CDG
MUC
Airport_ID
974
2640
1407
Name
London Heathrow Airport
Paris Charles De Gaulle Airport
Munich Franz Josef Strauss Airport
Please find a selection of IATA airport codes and airport-ID in appendix (Ch. 14).
City-Coding
By IATA-Code
IATA city codes are trigram letter designations for cities.
By City_ID
City ID is defined by MicronNexus, as well as airport ID.
Sample
IATA
SHA
MLB
DXB
City_ID
4411
1026
2453
Name
Shanghai
Melbourne
Dubai
Find a selection of IATA city codes and city ID in the appendix (Ch. 14).
Location coding
Supplier GDS code+ location code
The location code is a supplier specific code defining its location.
Supplier GDS code is the unique two digit code of the supplier.
CarHire-Solutions - Interface
Page 11
Sample
Location_Code
X6Y
TRST71
Supplier_Code
Hertz
Alamo
162464
Autocandia
Name
Calais Downtown
TRIESTE - RONCHI
DE'LEGIONARI APT
Athen Office
CarHire-Solutions - Interface
Page 12
Location(s)
CONTINENTS
COUNTRIES
REGIONS
CITIES
AIRPORTS
Multiple
location
Single
location
LOCATION(S)
Figure 4 Location
CarHire-Solutions - Interface
Page 13
5 System information
The main function of the car platform is to provide all necessary and/or required information within
a short limited time period.
Location is always unique to a single supplier and therefore a search will not return offers from
multiple suppliers.
To request for a specific location of a supplier it is always recommended to request with GDS Code
+ location code!
Page 14
CarHire Solutions provides capabilities to refer to a particular offer or an offer list at any
MicronNexus supplied website using deep linking. A VehAvailRate response contains a deep link URL
which can be used to invoke the MicronNexus website for continuing the booking process after a
vehicle offer (or a list of offers) has been generated.
There are two modes of using deep links:
Please note: using deep linking is only an optional feature for OTA2012B interface users which only
supports offer requests. OTA2012B on the other hand provides the entire spectrum of OTA specific
booking operations. If you plan to use all or at least most of them you may skip this subchapter and
use the operations directly.
<Reference
URL="http://www.carhiremarket.com/upsell_parameter.aspx?reference_number=00519926283730596537A
984476228&live=true" Type="16" ID_Context="005199262812739844762281344"/>
</VehAvail>
</VehAvails>
</VehVendorAvail>
</VehVendorAvails>
Please refer to Ch. 7.4 for more details concerning the response of a quotation.
An alternative approach is to generate a custom URL using the reference number which is
transmitted in the XML attribute ID_Context.
The destination website (in the example above: www.carhiremarket.com) may be agreed with
MicronNexus. The language to be chosen at the destination website is identical to the language
specified at quotation.
Using the reference number, the availability of the offer is checked when navigating to the deep
linked site. If the offer is not available, then alternative offers are returned.
CarHire-Solutions - Interface
Page 15
CarHire-Solutions - Interface
Page 16
http://www.carhiremarket.com/Parameters.aspx?PCITY=51&DCITY=51I&PDAY=03&PMONTHYEAR=0
3.2010&PTIME=13:00&DDAY=10&DMONTHYEAR=03.2010&DTIME=13:00&CAT=9&LANGUAGE=2&Af
filiate_ID=212&Agentcode=dealchecker
Info FTP URL:
See http://www.carhire-solutions.com/export/export_cities.csv for a complete list of city IDs.
The full parameter list is shown in the attached document.
Note that the URL must be built on your own. The destination web site needs to be agreed with
MicronNexus.
CarHire-Solutions - Interface
Page 17
SOAP-Webservice: Staging
https://ota2012b.micronnexus-staging.com/carhireservice.svc
Poduction https://ota2012b.carhire-solutions.com/carhireservice.svc
WDSL Location:
Staging https://ota2012b.micronnexus-staging.com/CarhireService.svc?wsdl
Poduction https://ota2012b.micronnexus-staging.com/CarhireService.svc?wsdl
targetNamespace:
http://www.opentravel.org/OTA/2003/05
Availability
http://tempuri.org/IOta2012BService/getVehReservation
Reservation
http://tempuri.org/IOta2012BService/getVehRetReservation
Retrive Reservation
http://tempuri.org/IOta2012BService/getVehCancelReservation
Cancel Reservation
http://tempuri.org/IOta2012BService/getVehRateRule
Rate info
http://tempuri.org/IOta2012BService/getVehModify
Modify reservation
CarHire-Solutions - Interface
Page 18
5.4.1 Endpoints
Micronnexus web service supports 3 different endpoints.
1) Basic Http Endpoint: Represents a binding that a Windows Communication Foundation
(WCF) service can use to configure and expose endpoints that are able to communicate with
ASMX-based Web services and clients and other services that conform to the WS-I Basic
Profile 1.1.
CarHire-Solutions - Interface
Page 19
3) Soap1.2 endpoint: It is the custom end point based on soap1.2 standard accepting requests
CarHire-Solutions - Interface
Page 20
5.4.2 Which endpoint should we use? What are the exact differences?
Below is the comparison table between basic http and wshttp endpoints. Soap1.2 is the
custom binding uses also soap1.2 standard as wshttp binding but doesnt require ws
addressing.
Criteria
BasicHttpBinding
WsHttpBinding
Security
support
Compatibility
SOAP version
SOAP 1.1
Reliable
messaging
Default
security
options
None
Windows default authentication
Basic
Certificate
None
Transport
Message
Transport with message credentials
Security
options
CarHire-Solutions - Interface
Page 21
SOAP Client
The SOAP client is a web tool for testing SOAP compliancy and can be found at
http://www.soapclient.com/ and http://www.soapclient.com/soaptest.html, respectively.
II. Option B
Call getCountries
Call getRegions with selected Country_ID
Call getAirport or getCity with selected Region_ID
CarHire-Solutions - Interface
Page 22
III. Option C
Call getCountries
Call getAirport or getCity with selected Country_ID
5.7.1 GetAirports
Description
Diplays an array of Airports. One Optional parameter has to be selected
Parameters:
Region_ID (optional)
Language_Code
City_ID (optional)
Country_ID (optional)
5.7.2 GetCities
Description
Diplays an array of Cities. One Optional parameter has to be selected
Parameters:
Region_ID (optional)
Country_ID (optional)
CountryISO (optional)
Language_Code
5.7.3 GetCountries
Description
Diplays an array of Countries.
Parameters:
Language_Code
5.7.4 GetRegions
Description
Diplays an array of Regions.
Parameters:
Language_Code
CountryISO (optional)
CarHire-Solutions - Interface
Page 23
Destinationtype_ID: (2, 3, 4, 5)
Displayname: Hamburg Airport (HAM) or Hamburg Downtown
Destination_ID: Is the Country_ID, Region_ID, City_ID or Airport_ID
CarHire-Solutions - Interface
Page 24
6 Testing Tool
6.1 Overview
Micronnexus Soap Interface can be simply tested with SoapUI and Fiddler. You can simply see the
requirements and sample requests and responses especially using SoapUI.
6.2 Description
6.2.1 Get Available Vehicle To check on the offers request and response
To search and see what cars and options are available based on the input and selection of
parameters.
6.2.4 Reservation Retrieval To retrieve bookings and to see the details of the
reservation
After making a successful booking, you will get a reference number that can be checked here. This
will display the information of your reservation.
CarHire-Solutions - Interface
Page 25
7 Quote
All information provided in this chapter is specified in OTA2012B as the Vehicle Available Rate
Request and Response
VehAvailRateRQ
VehAvailRateRS
The following section gives an overview of how partner can accomplish the search. The search is
carried out by all suppliers supporting the platform.
VehAvailRateRQ has two different ways of working:
1) Live Search
Multi Supplier live search by providing neither City or Airport information nor NO Supplier Code.
It is recommended to fulfill price verification (vehRateRuleRQ) and offer the customer alternative
locations for city pickup.
2) Direct Supplier Connection Live Prices using a single Supplier
This method is suitable if there is a specific supplier chosen and if it is the aim to receive just this
suppliers prices at a specific location. The price verification is not necessary for this booking path.
Querying for a single location can be done by using the parameters listed below.
CarHire-Solutions - Interface
Page 26
7.1 Request
The following table lists the parameter, their types and a short description for the request function.
Parameter
Type
MaxResponses
Integer
ReqRespVersion
String
EchoToken
PrimaryLangID
ISOCountry
ISOCurrency
RequestorID Type
RequestorID ID_Context
String
String
String
String
String
String
PickUpLocation /
ReturnLocation
Integer
CodeContext
VehRentalCore
PickUpDateTime
VehRentalCore
ReturnDateTime
Integer
Integer
PickUpLocation LocationCode
Integer
ReturnLocation LocationCode
Integer
Description
Defines the maximum number of offers to be
returned for each ACRISS-Code category
Requested version of the response message
large: return vehicles including information about
extras. (it causes response time to be increased)
medium: return vehicles without information
about bookable extras.
small: only availability and prices for rates are
returned
Additional message identification
Defines the language of the response
Defines the source market (of the affiliate)
Defines the currency of the response (not in Use)
Defines the username (affiliate name)
Defines the password
Defines the rate query parameter type
cityid: Micronnexus City ID
aipid: Micronnexus Airport ID
loccode: Supplier location
code + Supplier GDS code (s: 14.7 supplier table)
cityiata: IATA code
aipiata : IATA code
Defines date and time the customer will pick up his
car
Defines date and time the customer will drop off
his car
Defines the location the customer will pick up his
car (can be IATA code, location Code dependent on
CodeContext)
Defines the location the customer will return his
car (can be IATA code , location Code dependent
on CodeContext)
Please note: the currency of the vehicle prices cannot be configured dynamically using the request
message. The currency to be returned need to be agreed with MicronNexus when setting up the
affiliate.
CarHire-Solutions - Interface
Page 27
7.2 Response
Parameter
AdvanceBooking
/RulesApplyInd
ID_Context
Type
Description
Boolean
String
VehAvailCore/ Status
Vehicle /AirConditionInd
String
Boolean
Vehicle /TransmissionType
Vehicle /FuelType
Vehicle /DriveType
Vehicle /PassengerQuantity
Vehicle /BaggageQuantity
Vehicle /VendorCarType
Vehicle Code
Vehicle /VehicleType
/VehicleCategory
String
String
String
Integer
Integer
String
String
Integer
Vehicle VehicleType/DoorCount
Vehicle Size
Integer
Integer
Vehicle /VehMakeModel/
Name
Vehicle /VehMakeModel/Code
RentalRate RateDistance
Unlimited
RentalRate /RateDistance
DistUnitName
RentalRate /VehicleCharge
CurrencyCode
RentalRate /VehicleCharge
/Amount
RentalRate/ VehicleCharge
/TaxInclusive
RentalRate /VehicleCharge
/Purpose
String
RentalRate /VehicleCharge
/RatecodeIndicator
TotalCharge
EstimatedTotalAmount
RateQualifier RateCategory/
RateQualifier/ RatePeriod/
Boolean
CarHire-Solutions - Interface
String
Boolean
String
String
Decimal
Boolean
String
Decimal
VendorRateID
RateQualifier /RateComment
PricedEquips
PricedEquip /Equipment
/EquipType
Integer
PricedEquip/ Charge
PricedEquip /Charge
/IncludedInEstTotalInd
Decimal
Boolean
PricedEquip /Charge/
Calculation / UnitCharge
PricedEquip /Charge/
Calculation / UnitName
PricedEquip /Charge/
Calculation / Quantity
Fees
Fee /IncludedInRate
Boolean
Fee /IncludedInEstTotalInd
Boolean
PricedCoverage
PaymentRule
String
PaymentType
Integer
Vendorlocation/dropofflocation String
value
CarHire-Solutions - Interface
LocationCode
String
CodeContext
String
String
Name
String
VehicleCharge/ Purpose
String
VehicleCharge/RateConvertInd
String
TPA_Extensions
TermsConditions url
Warning Code
Warning
String
ExtendedLocaitoncode:
CarHire-Solutions - Interface
Integer
String
Page 30
CarHire-Solutions - Interface
Page 31
<VehAvailRQCore>
<VehRentalCore PickUpDateTime="2013-10-20T12:00:00" ReturnDateTime="2013-10-27T12:00:00">
<PickUpLocation LocationCode="1931" CodeContext="aipid" />
<ReturnLocation LocationCode="1931" CodeContext="aipid" />
</VehRentalCore>
<VehPrefs>
<VehPref>
<VehType />
<VehClass Size="3" />
</VehPref>
</VehPrefs>
</VehAvailRQCore>
<VehAvailRQInfo PassengerQty="4" />
</OTA_VehAvailRateRQ>
CarHire-Solutions - Interface
Page 32
<VehicleCharges>
<VehicleCharge Amount="62.84" CurrencyCode="EUR" TaxInclusive="true"
Purpose="original" />
<VehicleCharge Amount="62.84" CurrencyCode="EUR" TaxInclusive="true"
RateConvertInd="true" Purpose="preferred" />
</VehicleCharges>
<RateQualifier VendorRateID="Centauro">
<RateComments>
<RateComment Name="BronzePackage" />
</RateComments>
</RateQualifier>
<RateRestrictions MinimumAge="25" MaximumAge="80" />
</RentalRate>
<TotalCharge CurrencyCode="EUR" EstimatedTotalAmount="62.84" RateConvertInd="false" />
<Fees>
<Fee Amount="0.00" CurrencyCode="EUR" TaxInclusive="true" Description="Location service
charge(LSC)" IncludedInRate="true" IncludedInEstTotalInd="true" />
<Fee Amount="0.00" CurrencyCode="EUR" TaxInclusive="true" Description="VAT(TAX)"
IncludedInRate="true" IncludedInEstTotalInd="true" />
</Fees>
<Reference
URL="http://www.carhiremarket.com/upsell_parameter.aspx?reference_number=05712228956631596135A116572486
7&live=true" Type="16" ID_Context="0571222895764811657248676570" />
<Vendor TravelSector="Car Rental" Code="CE" CodeContext="59">Centauro</Vendor>
<VendorLocation LocationCode="PMIT081" CodeContext="10" ExtendedLocationCode="1931-CE10"
CounterLocation="14" Name="Palma de Majorca">Palma de Majorca</VendorLocation>
<DropOffLocation LocationCode="PMIT081" CodeContext="10" ExtendedLocationCode="1931-CE10"
CounterLocation="14" Name="Palma de Majorca" />
</VehAvailCore>
<VehAvailInfo>
<PricedCoverages>
<PricedCoverage>
<Coverage CoverageType="Location service charge" Code="LSC">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="EUR" TaxInclusive="true" Description="An
additional service charge applies at some airports, railway stations and ports- In this offer it is
included." GuaranteedInd="true" IncludedInRate="true" IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="Collision damage waiver" Code="CDW">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="EUR" TaxInclusive="true" Description="Maximum
excess of 400 EUR to be paid in the case of damage. Please note that comprehensive insurance does not
cover damage to wheels, tires, mirrors and underbody" GuaranteedInd="true" IncludedInRate="true"
IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage Code="SLI">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="EUR" TaxInclusive="true" Description="Legally
required, insurance for damages on the adversarial vehicle, persons and objects- In this offer it is
included." GuaranteedInd="true" IncludedInRate="true" IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="Personal accident insurance" Code="PAI">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="EUR" TaxInclusive="true" Description="Increases
the liability amount of cover at damages for persons." GuaranteedInd="true" IncludedInRate="true"
IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="Theft protection" Code="TP">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="EUR" TaxInclusive="true" Description="In case of
theft, there is an excess of 400 EUR. Please note: this does not cover loss of personal items."
GuaranteedInd="true" IncludedInRate="true" IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
CarHire-Solutions - Interface
Page 33
CarHire-Solutions - Interface
Page 34
</VehAvailRSCore>
</VehAvailRateRS>
First of all, the Vendorlocation element of VehAvailRateRS does not contain the location
name then but is set to Multiple in this particular case.
The offer reference number which is returned using the XML element ID_Context can then
be used to request further locations of the destination using VehLocSearch.
For a different location, one has to select one of the returned location ID and to query
vehicles again (VehAvailRate) for that location using the RateQueryParameterType 1.
CarHire-Solutions - Interface
Page 35
8 RateRules
The Raterules Request permits to retrieve further information of a particular car offer. The most
important are rental terms as well as terms and conditions which are transmitted either as text or as
an URL.
The following parameters can be requested in a Raterule Request/Response:
Parameter
ID_Context
Type
String
Integer
Description
Unique number (offer reference) to be used for
identifying a particular offer for the raterule
request, as obtained from the offer list (response,
VehAvailRateRS).
Text or URL of the rental terms or terms and
conditions.
Always 2 (indicates description)
VendorMessage Subsection
Paragraph Text
VendorMessage InfoType
Age
Minimum Age
Maximum Age
TotalCharge CurrencyCode
PaymentRules
PaymentRule PaymentType
String
Integer
Integer
Integer
Equipment
Equipment EquipType
Charge CurrencyCode
Integer
String
IncludedInEstTotalInd
String
Calculation UnitCharge
String
PricedCoverages
Coverage CoverageType
String
Charge Amount
IncludedInRate
String
Boolean
ChargeCurrencyCode
String
Tax Inclusive
GuaranteedInd
Location Details
LcoationDetails AtAirport
LocationDetails AtCity
Name
Code Context
Extended Location Code
Address Type
Address Line
Boolean
Boolean
CarHire-Solutions - Interface
String
String
Integer
String
String
String
CityName
PostalCode
CountryName Code
Additional Info
ParkLocation Location
String
String
String
String
String
Operation Time
String
Please refer to AvailrateRS for the description of the XML elements not mentioned above.
VehRateRuleRS and VehAvailRateRS shares most of the response elements.
Samples bellows are pure Ota requests for soap body. Please refer to 5.4.1 for soap header and soap
body samples for different endpoints.
CarHire-Solutions - Interface
Page 37
<Equipment EquipType="7">
<Description>Infant Child Seat</Description>
</Equipment>
<Charge CurrencyCode="EUR" Amount="60.00" Description="BookingCurrencyPrice"
IncludedInEstTotalInd="false">
<Calculation UnitCharge="60.00" UnitName="2-per Rental" Quantity="1" />
</Charge>
</PricedEquip>
<PricedEquip>
<Equipment EquipType="8">
<Description>Child toddler seat</Description>
</Equipment>
<Charge CurrencyCode="EUR" Amount="60.00" Description="BookingCurrencyPrice"
IncludedInEstTotalInd="false">
<Calculation UnitCharge="60.00" UnitName="2-per Rental" Quantity="1" />
</Charge>
</PricedEquip>
<!-- probably some more priced equips same as in VehAvailrateRS -->
</PricedEquips>
<Fees>
<Fee CurrencyCode="EUR" Amount="0.00" TaxInclusive="true" Description="Location service
charge(LSC)" IncludedInRate="true" IncludedInEstTotalInd="true" />
<Fee CurrencyCode="EUR" Amount="0.00" TaxInclusive="true" Description="Vehicle Licence Fee
/ Road fund license(VLF)" IncludedInRate="true" IncludedInEstTotalInd="true" />
<Fee CurrencyCode="EUR" Amount="0.00" TaxInclusive="true" Description="TAX(TAX)"
IncludedInRate="true" IncludedInEstTotalInd="true" />
</Fees>
<PricedCoverages>
<PricedCoverage>
<Coverage CoverageType="Collision damage waiver" Code="CDW">
<Details>
<Charge Amount="0.00" IncludedInRate="true" />
</Details>
</Coverage>
<Charge CurrencyCode="EUR" Amount="0.00" TaxInclusive="true" GuaranteedInd="true"
IncludedInRate="true" IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="Excess" Code="Excessprice">
<Details>
<Charge />
</Details>
</Coverage>
<Charge Description="With excess" />
</PricedCoverage>
<!-- probably some priced coverages -->
</PricedCoverages>
<LocationDetails AtAirport="true" Code="28593" Name="PALMA DE MALLORCA AP" CodeContext="PMI"
ExtendedLocationCode="1931-ZEPMI">
<Address Type="3">
<StreetNmbr>PALMA DE MALLORCA AP</StreetNmbr>
<AddressLine />
<CityName>51-PALMA DE MALL (BL)</CityName>
<PostalCode>07611</PostalCode>
<CountryName Code="ES">Spain</CountryName>
</Address>
<Telephone PhoneTechType="1" PhoneNumber="971 789670" />
<Telephone PhoneTechType="2" PhoneNumber="0034971789671" />
<AdditionalInfo>
<OperationSchedules>
<OperationSchedule>
<OperationTimes />
</OperationSchedule>
</OperationSchedules>
</AdditionalInfo>
</LocationDetails>
<LocationDetails AtAirport="true" Code="28593" Name="PALMA DE MALLORCA AP" CodeContext="PMI"
ExtendedLocationCode="1931-ZEPMI">
<Address Type="3">
<StreetNmbr>PALMA DE MALLORCA AP</StreetNmbr>
<AddressLine />
CarHire-Solutions - Interface
Page 38
9 Reservation
All the information given here is specified in OTA2012B as the Vehicle Reservation
Request/Response.
VehResRQ
VehResRS
9.1 Request
The following table displays the parameter, types and a short description of these functions.
Parameter
ISOCountry
Source-RequestorID-Type
Source-RequestorIDID_Context
Customer- Primary- Gender
Customer- Primary- BirthDate
Customer- Primary- Language
Customer- PrimaryCarHire-Solutions - Interface
Type
String
String
String
Enumeration
Date
Integer
String
Description
Defines the source market (of the affiliate)
Username
User password
Male or Female
Customers birthday. It is important to verify
driver age allowance
Customers preferred language in order to get
an appropriate voucher
2:Dr.
Page 39
PersonName - NameTitle
Customer- PrimaryPersonName- GivenName
Customer- PrimaryPersonName- Surname
Customer- PrimaryTelephone- PhoneTechType
Customer- PrimaryTelephone- PhoneNumber
Customer- Primary- Email
Customer- Primary- AddressStreetNmbr
Customer- Primary- Address AddressLine
Customer- Primary- Address CityName
Customer- Primary- Address PostalCode
Customer- Primary- Address
StateProv-StateCode
Customer- PrimaryCitizenCountryName- Code
Customer- Additional BirthDate
Customer- Additional PersonName- GivenName
Customer- Additional PersonName- Surname
VehPref - Code
SpecialEquipPref EquipType
SpecialEquipPref Quantity
RentalPaymentPref PaymentCard- CardType
String
String
String
String
String
Integer
String
String
String
String
String
String
String
String
String
Integer
Integer
String
3:Prof.
4: Prof. Dr.
Customers first name
Customers surname
1: phone(required) 2:fax(optional)
Customers phone number or fax number
(country phone code incl.)
Customers email, must be correct in order to
get voucher
Customers address street number
Extra or second address
Customers address city
Customers address zip code
Customers address state- only used for USA
and Canada. Example: FL (Florida), CA
(California)
Customers country code (DE, FR, UK, DK, etc.)
Second drivers birthday. It is necessary to verify
driver age allowance
Second drivers first name
Second drivers surname
Code which is returned after price verification.
(value of ID_Context of VehAvailRateRS)
Equipment type ID as returned in
VehAvailRateRS
Number of equipment of this type to book
VI: Visa
MC: Master
AX: American Express
9.1.1 Payment
If the price of the reservation is prepaid (refer to 4: terms and definitions) then payment
details must be provided by VehResRQ.
CarHire-Solutions - Interface
Page 40
9.1.2 Equipment
Extra equipments can be booked by providing equipment code (refer to OTA2012B equipment table)
and equipment quantity as shown below.
<SpecialEquipPrefs>
<SpecialEquipPref EquipType="7" Quantity="1" />
</SpecialEquipPrefs>
9.2 Response
Parameter
Type
OTA_VehResRS/ Success
VehResRSCore/
VehReservation / Customer
String
VehResRSCore/
VehReservation /
VehSegmentCore / ConfID/
Type
Integer
VehResRSCore/
VehReservation /
VehSegmentCore / ConfID/ ID
VehResRSCore/
VehReservation /
VehSegmentCore /
ArrivalDetails/
TransportationCode
VehResRSCore/
VehReservation /
VehSegmentCore /
ArrivalDetails/ Number
ArrivalDetails
OperationCompany Code
VehResRSCore/
VehReservation /
VehSegmentCore / RentalRate
/ RateQualifier/ RateCategory
VehResRSCore/
VehReservation /
VehSegmentCore / RentalRate
/ RateQualifier/ RateQualifier
VehResRSCore/
VehReservation /
VehSegmentCore / RentalRate
RateQualifier/ ArriveByFlight
Warnings
CarHire-Solutions - Interface
String
Description
Returned only when response is successful (no
error)
Primary and Additional Customer information
which were given in the OTA_VehResRQ
Defines the reference number information. It is
expected to have 8 (car rental companys
reference), 16 (Affiliates reference if it is present
in the VehResRQ), 43 (Micronnexus reference
number)
Value for the reference numbers which are
denoted by Type attribute
Integer
Integer
Flight number
String
String
String
Boolean
Array
CarHire-Solutions - Interface
Page 42
<Surname>Test</Surname>
</PersonName>
<Telephone PhoneTechType="1" PhoneNumber="5613210" />
<Email>test@email.com</Email>
<Address>
<StreetNmbr>afsa</StreetNmbr>
<AddressLine>sada</AddressLine>
<CityName>afsf</CityName>
<PostalCode>4567</PostalCode>
</Address>
<CitizenCountryName Code="DE" />
</Primary>
<Additional BirthDate="1980-10-10">
<PersonName>
<GivenName>NameAD</GivenName>
<Surname>SurnameAD</Surname>
</PersonName>
</Additional>
</Customer>
<VehPref Code="0573553457286011816238477681" />
<SpecialEquipPrefs>
<SpecialEquipPref EquipType="7" Quantity="1" />
<SpecialEquipPref EquipType="8" Quantity="1" />
</SpecialEquipPrefs>
</VehResRQCore>
<VehResRQInfo>
<ArrivalDetails TransportationCode="14" Number="LH4711">
<OperatingCompany Code="LH" />
</ArrivalDetails>
</VehResRQInfo>
</OTA_VehResRQ>
CarHire-Solutions - Interface
Page 43
</Additional>
</Customer>
<VehSegmentCore>
<ConfID Type="8" ID_Context=" 123456789" />
<ConfID Type="43" ID_Context="MN1111111111111" />
<ConfID Type="16" ID_Context="6789010" />
<Vendor CompanyShortName="Avis" TravelSector="Car Rental" Code="ZI">48631651GB5</Vendor>
<VehRentalCore PickUpDateTime="2013-10-24T12:00:00" ReturnDateTime="2013-10-31T12:00:00">
<PickUpLocation LocationCode="1069174" CodeContext="PMI" ExtendedLocationCode="1931ZIPMI">Palma De Majorca Airport (PMI), Aeropuerto De Palma </PickUpLocation>
<ReturnLocation LocationCode="1069174" CodeContext="PMI" ExtendedLocationCode="1931ZIPMI">Palma De Majorca Airport (PMI), Aeropuerto De Palma </ReturnLocation>
</VehRentalCore>
<Vehicle AirConditionInd="true" TransmissionType="Manual" FuelType="Petrol"
DriveType="Unspecified" PassengerQuantity="7" BaggageQuantity="1" VendorCarType="ICMR"
CodeContext="Immediate 2/4 Door Car">
<VehType VehicleCategory="C" DoorCount="2" />
<VehClass Size="6" />
<VehMakeModel Name="Volkswagen Touran" Code="ICMR" />
<PictureURL>http://ota2012b.carhiresolutions.com/images/car/Avis/small/ES0_icmr.jpg</PictureURL>
</Vehicle>
<RentalRate>
<RateDistance Unlimited="true" DistUnitName="Km" VehiclePeriodUnitName="RentalPeriod" />
<VehicleCharges>
<VehicleCharge Amount="247.72" CurrencyCode="GBP" TaxInclusive="true" Purpose="original" />
<VehicleCharge Amount="293.89" CurrencyCode="EUR" TaxInclusive="true" RateConvertInd="true"
Purpose="preferred" />
</VehicleCharges>
<RateQualifier RateCategory="M972601" RateQualifier="F8__GB" ArriveByFlight="false" />
</RentalRate>
<PricedEquips>
<PricedEquip>
<Equipment EquipType="222" Quantity="1">
<Description> Additional Driver</Description>
</Equipment>
<Charge Amount="7.08" CurrencyCode="EUR" Description="BookingCurrencyPrice"
IncludedInRate="true" IncludedInEstTotalInd="true">
<Calculation UnitCharge="70.80" UnitName="BookingCurrencyMaxPrice" Quantity="1" />
</Charge>
</PricedEquip>
<PricedEquip>
<Equipment EquipType="222" Quantity="1">
<Description> Additional Driver</Description>
</Equipment>
<Charge Amount="7.08" CurrencyCode="EUR" Description="BookingCurrencyPrice"
IncludedInRate="true" IncludedInEstTotalInd="true">
<Calculation UnitCharge="70.80" UnitName="BookingCurrencyMaxPrice" Quantity="1" />
</Charge>
</PricedEquip>
</PricedEquips>
<Fees>
<Fee Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="VAT(TAX)"
IncludedInRate="true" IncludedInEstTotalInd="true" />
</Fees>
<TotalCharge CurrencyCode="GBP" EstimatedTotalAmount="247.72" />
</VehSegmentCore>
<VehSegmentInfo>
<PaymentRules>
<PaymentRule PaymentType="32">Full payment will be deducted from your credit card by the car
rental supplier at time of pickup. Please note that for local pick up of your car a credit card is
required and that the card holder and driver must be the same person. Prepaid or debit cards, such as
Maestro or Visa electron, are not accepted for pick-up.</PaymentRule>
</PaymentRules>
<PricedCoverages>
<PricedCoverage>
<Coverage CoverageType="Collision damage waiver" Code="CDW">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="Maximum excess of
658 EUR to be paid in the case of damage. Please note that comprehensive insurance does not cover
damage to wheels, tires, mirrors and underbody" GuaranteedInd="true" IncludedInRate="true"
IncludedInEstTotalInd="true" />
CarHire-Solutions - Interface
Page 44
</PricedCoverage>
<PricedCoverage>
<Coverage Code="SLI">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="Legally required,
insurance for damages on the adversarial vehicle, persons and objects- In this offer it is included."
GuaranteedInd="true" IncludedInRate="true" IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="Theft protection" Code="TP">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="In case of theft,
there is an excess of 658 EUR. Please note: this does not cover loss of personal items."
GuaranteedInd="true" IncludedInRate="true" IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="Unlimited Mileage" Code="UNL">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="No further costs
apply for extra miles driven" GuaranteedInd="true" IncludedInRate="true" IncludedInEstTotalInd="true"
/>
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="Airport Service Charge" Code="ASC">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="Some airports
charge a service fee- In this offer it is included." GuaranteedInd="true" IncludedInRate="true"
IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="One way rental" Code="Oneway">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="possible with
additional charges" GuaranteedInd="true" IncludedInRate="true" IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="PetrolOption" Code="F2F">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="Full to full tank
" GuaranteedInd="true" IncludedInRate="false" IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="Cancellation" Code="Cancellation">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="Cancellation fees
may apply. Please refer to the Rental Terms. " GuaranteedInd="true" IncludedInRate="false"
IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="Excess" Code="Excessprice">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" Description="With excess" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="VAT" Code="TAX">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="The rate
corresponds with the VAT-rate of the particular country." GuaranteedInd="true" IncludedInRate="true"
IncludedInEstTotalInd="true" />
</PricedCoverage>
</PricedCoverages>
</VehSegmentInfo>
</VehReservation>
</VehResRSCore>
CarHire-Solutions - Interface
Page 45
<VehResRSInfo>
<TPA_Extensions>
<TermsConditions url="http://www.carhire-solutions.com/terms/1069174.pdf" xmlns="" />
</TPA_Extensions>
</VehResRSInfo>
</VehResRS>
10 Cancellation
All the information given here is specified in OTA2012B as the Vehicle Cancellation
Request/Response.
VehCancelRQ
VehCancelRS
CarHire-Solutions - Interface
Page 46
Cancellation
Customer
Confirmation
with
Cancellation Fee
Confirmation
without
Cancellation Fee
Abort by
Customer
Cancel the
Reservation
CarHire
Platform
Supplier concerned
Figure 7 Cancellation
Request:
In order to cancel an existing reservation, the reference number which is returned by VehResRS
must be used (ID_Context) in combination with the customers surname which can also be
obtained from VehResRS.
10.1 Response
A cancellation status (refer to 14.5: reservation status table) is responded by vehCancelRS that
identifies either cancellation is successful or not (might be pending, rejected, etc.)
CarHire-Solutions - Interface
Page 47
<VehCancelResRQ xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
xmlns:xsd=http://www.w3.org/2001/XMLSchema EchoToken= Version=15
xmlns=http://www.opentravel.org/OTA/2003/05>
<POS>
<Source ISOCountry=ES>
<RequestorID Type=xxxxx ID_Context=yyyyy />
</Source>
</POS>
<VehCancelRQCore CancelType=Book>
<UniqueID ID_Context=MNxxxxxx />
<PersonName>
<Surname>xxxxx</Surname>
</PersonName>
</VehCancelRQCore>
</VehCancelResRQ>
11 Retrieve Reservation
All the information given here is specified in OTA2012B as the Vehicle Retrieve Reservation Request.
VehRetResRQ
VehRetResRQ
One of the main purposes of retrieving reservation is to check a reservation which has been set to
status pending or on request whether the reservation status has changed or not. This is because
sometimes it is necessary for the supplier to process a reservation manually (offline) for some reason
(car of the category not available, etc.), then a periodical job may check the reservation status of all
reservations which are recorded as pending on request.
A retrieve can only be performed using the reference number and the customer last name (must be
same as in the original reservation request).
CarHire-Solutions - Interface
Page 48
Retrieve
Customer
Vehicle Reservation
Summary
Retrieve
CarHire
Platform
Supplier concerned
11.1 Request
In order to retrieve reservation details, the reference number returned within VehResRS must be
used in combination with the customers surname that is also given in the VehResRS.
11.2 Response
By VehRetResRS, customers are able to see the latest status of reservation and a full overview.
11.3 Sample-Request
Samples bellows are pure Ota requests for soap body. Please refer to 5.4.1 for soap header and soap
body samples for different endpoints.
?xml version="1.0" encoding="utf-8"?>
<OTA_VehRetResRQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" EchoToken="1.0" Version="0"
xmlns="http://www.opentravel.org/OTA/2003/05/common">
<POS>
<Source>
<RequestorID Type="username" ID_Context="password" />
</Source>
CarHire-Solutions - Interface
Page 49
</POS>
<VehRetResRQCore>
<UniqueID ID_Context="MN11111111111" />
<PersonName>
<Surname>Surname</Surname>
</PersonName>
</VehRetResRQCore>
</OTA_VehRetResRQ>
11.4 Sample-Response
<?xml version="1.0" encoding="utf-8"?>
<VehRetResRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" EchoToken="1.0" TimeStamp="2013-10-08T15:31:33"
Target="Production" Version="3" xmlns="http://www.opentravel.org/OTA/2003/05/common">
<VehRetResRSCore>
<VehReservation ReservationStatus="In process">
<Customer>
<Primary Gender="Male" BirthDate="1980-10-10">
<PersonName>
<GivenName>Test</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone PhoneTechType="1" PhoneNumber="5613210" />
<Email>test@email.com</Email>
<Address>
<StreetNmbr>buseriussStrasse 2</StreetNmbr>
<AddressLine></AddressLine>
<CityName>Hamburg</CityName>
<PostalCode>4567</PostalCode>
</Address>
<CitizenCountryName Code="DE" />
</Primary>
</Customer>
<VehSegmentCore>
<ConfID Type="8" ID_Context=" 123456789" />
<ConfID Type="43" ID_Context="MN1111111111111" />
<ConfID Type="16" ID_Context="6789010" />
<Vendor CompanyShortName="Avis" TravelSector="Car Rental" Code="ZI">on request</Vendor>
<VehRentalCore PickUpDateTime="2013-10-28T12:00:00" ReturnDateTime="2013-11-04T12:00:00">
<PickUpLocation LocationCode="1069174" CodeContext="PMI" ExtendedLocationCode="1931ZIPMI">Palma De Majorca Airport (PMI), Aeropuerto De Palma </PickUpLocation>
<ReturnLocation LocationCode="1069174" CodeContext="PMI" ExtendedLocationCode="1931ZIPMI">Palma De Majorca Airport (PMI), Aeropuerto De Palma </ReturnLocation>
</VehRentalCore>
<Vehicle AirConditionInd="true" TransmissionType="Manual" FuelType="Petrol"
DriveType="Unspecified" PassengerQuantity="5" BaggageQuantity="1" VendorCarType="CCMR"
CodeContext="Compact 2/4 Door Car">
<VehType VehicleCategory="C" DoorCount="2" />
<VehClass Size="4" />
<VehMakeModel Name="Seat Leon" Code="CCMR" />
<PictureURL>http://ota2012b.carhiresolutions.com/images/car/Avis/small/ES0_ccmr.jpg</PictureURL>
</Vehicle>
<RentalRate>
<RateDistance Unlimited="true" DistUnitName="Km" VehiclePeriodUnitName="RentalPeriod" />
<VehicleCharges>
<VehicleCharge Amount="128.91" CurrencyCode="GBP" TaxInclusive="true" Purpose="original" />
<VehicleCharge Amount="152.79" CurrencyCode="EUR" TaxInclusive="true" RateConvertInd="true"
Purpose="preferred" />
</VehicleCharges>
<RateQualifier RateCategory="M972601" RateQualifier="F8__GB" ArriveByFlight="true" />
</RentalRate>
<Fees>
<Fee Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="VAT(TAX)"
IncludedInRate="true" IncludedInEstTotalInd="true" />
</Fees>
<TotalCharge CurrencyCode="GBP" EstimatedTotalAmount="128.91" />
</VehSegmentCore>
<VehSegmentInfo>
<PaymentRules>
CarHire-Solutions - Interface
Page 50
<PaymentRule PaymentType="32">Full payment will be deducted from your credit card by the car
rental supplier at time of pickup. Please note that for local pick up of your car a credit card is
required and that the card holder and driver must be the same person. Prepaid or debit cards, such as
Maestro or Visa electron, are not accepted for pick-up.</PaymentRule>
</PaymentRules>
<PricedCoverages>
<PricedCoverage>
<Coverage CoverageType="Collision damage waiver" Code="CDW">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="Maximum excess of
658 EUR to be paid in the case of damage. Please note that comprehensive insurance does not cover
damage to wheels, tires, mirrors and underbody" GuaranteedInd="true" IncludedInRate="true"
IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage Code="SLI">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="Legally required,
insurance for damages on the adversarial vehicle, persons and objects- In this offer it is included."
GuaranteedInd="true" IncludedInRate="true" IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="Theft protection" Code="TP">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="In case of theft,
there is an excess of 658 EUR. Please note: this does not cover loss of personal items."
GuaranteedInd="true" IncludedInRate="true" IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="Unlimited Mileage" Code="UNL">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="No further costs
apply for extra miles driven" GuaranteedInd="true" IncludedInRate="true" IncludedInEstTotalInd="true"
/>
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="Airport Service Charge" Code="ASC">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="Some airports
charge a service fee- In this offer it is included." GuaranteedInd="true" IncludedInRate="true"
IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="One way rental" Code="Oneway">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="possible with
additional charges" GuaranteedInd="true" IncludedInRate="true" IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="PetrolOption" Code="F2F">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="Full to full tank
" GuaranteedInd="true" IncludedInRate="false" IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="Cancellation" Code="Cancellation">
<Details CoverageTextType="Supplement" />
</Coverage>
<Charge Amount="0.00" CurrencyCode="GBP" TaxInclusive="true" Description="Cancellation fees
may apply. Please refer to the Rental Terms. " GuaranteedInd="true" IncludedInRate="false"
IncludedInEstTotalInd="true" />
</PricedCoverage>
<PricedCoverage>
<Coverage CoverageType="Excess" Code="Excessprice">
<Details CoverageTextType="Supplement" />
</Coverage>
CarHire-Solutions - Interface
Page 51
12 Modify
All the information given here is specified in OTA2012B as the Vehicle Modify Request VehModRQ.
Modifications (or amendments) can only be performed via Customer-Login by using the
reservation reference number and the customers last name (must be same as original reservation
request customer name).
There are several kinds of modifications the customer can do. Some of the modification might cause
a new reference number and/or extra fee, see the chart below for details.
CarHire-Solutions - Interface
Page 52
Modify
Customer
Modification
CUSTOMER INFO
EQUIPMENT
SEARCH DETAILS
FLEET DETAILS
- Address
- Telephone-Number
- Mobilphone-Number
- Zip-Code
- Add Equipment
- Remove Equipment
- Pick-up/Drop-off Time
- Pick-up/Drop-off Location
- First Name
- Last Name
Modification of these
two items are not
possible with all
suppliers!
CarHire
Platform
Supplier concerned
Figure 9 Amendment
CarHire-Solutions - Interface
Page 53
12.1 Request
The request for modifications is identical to VehResRQ, but an attribute named ModifyType
inside of VehModifyRQCore must be provided, as well as the previously returned reservation
reference number.
12.2 Response
Identical with VehResRS, with the only difference of having the attribute ModifyStatus
which is returned rather than ReservationStatus.
New reservation reference number might be applied with an additional modification fee.
CarHire-Solutions - Interface
Page 54
CarHire-Solutions - Interface
Page 55
13 Location
13.1 List of Locations
All the information given here is specified in OTA2012B as the Vehicle Location Request/Response.
VehLocRQ
VehLocRS
It is possible to query the locations based on the following geographical filters (s. Ch. 14 for more on
codes and IDs)
The following table illustrates the parameter combinations permitted for location requests.
Query-Level
City
Airport
Offer
ISO-Code
Yes
Yes
No
Region-ID
No
No
No
RefPointType
Yes
Yes
Yes
CityName
Yes
Yes
Yes
It is possible to reduce the returned results for a single supplier by defining the Vendor attribute.
Note that any information given by an ID can be encoded using the tables in 14 (appendix).
13.1.1 Request
Parameter
RefPoint CountryCode
RefPoint StateProv
RefPoint RefPointType
Type
String
Integer
Integer
Req
Y
N
N
RefPoint CityName
Vendor
String
String
N
N
CarHire-Solutions - Interface
Description
ISO code of the country
ID of the region
Defines the query type:
1. City_ID
2. City_IATA
3. City_Name
4. Airport_ID
5. Airport_IATA
6. ReferenceNumber (pickup)
7. ReferenceNumber (dropoff)
Defines the source market
Defines the supplier leave it empty to return all
Page 56
13.1.2 Response
Parameter
LocationDetail AtAirport
LocationDetail Code
LocationDetail Name
Type
Boolean
String
String
LocationDetail CodeContext
String
LocationDetail Extended
Location Code
String
Description
Flag indication if location is an airport location
Code used to identify the location
Full name of the location
Specifier of the list the location code has been obtained
from (e.g. IATA, OAG, international company code)
Extended OAG code
13.1.3 Sample-Request
Using CityName all suppliers:
<VehLocationSearchRQ>
<POS xmlns="http://www.opentravel.org/OTA/2003/05">
<Source ISOCountry="DE">
<RequestorID Type="username" ID_Context="password" />
</Source>
</POS>
<VehLocSearchCriterion xmlns="http://www.opentravel.org/OTA/2003/05">
<RefPoint CountryCode="DE" RefPointType="3" CityName="Hamburg">Hamburg</RefPoint>
<CodeRef LocationCode="Hamburg" />
<Radius Distance="0" DistanceMeasure="km" DistanceMax="50" />
</VehLocSearchCriterion>
</VehLocationSearchRQ>
CarHire-Solutions - Interface
Page 57
13.1.4 Sample-Response
<?xml version="1.0" encoding="utf-16"?>
<VehLocationSearchRS TimeStamp="2011-04-20T14:51:12" Version="3">
<VehMatchedLocs xmlns="http://www.opentravel.org/OTA/2003/05">
<VehMatchedLoc>
<LocationDetail AtAirport="false" Code="776401" Name="AHRENSBURGER STR 138 148"
CodeContext="25392" ExtendedLocationCode="47-AE25392">
<Address>
<StreetNmbr />
<AddressLine />
<CityName>47-HAMBURG</CityName>
<PostalCode>22045</PostalCode>
<CountryName Code="DE">Deutschland</CountryName>
</Address>
<Telephone RPH="" />
</LocationDetail>
<VehLocSearchCriterion>
<Position Latitude="0" Longitude="0" />
</VehLocSearchCriterion>
</VehMatchedLoc>
</VehMatchedLocs>
</VehLocationSearchRS>
VehLocDetailRQ
VehLocDetailRS
Main purpose of VehLocDetailRQ is to obtain address data and opening hours of a particular location.
13.2.1 Request
Parameter
Type
Location CodeContext
Integer
Location LocationCode
Location Text
Vendor
Integer
String
String
CarHire-Solutions - Interface
Req
Y
N
N
N
Description
Defines the query type
1. Location_ID
2. GDSCode+LocationCode
3. LocationName
ID of Region
Defines the source market
Defines the Supplier leave empty to return all
Page 58
13.2.2 Response
Parameter
OperationTime Mon, Tue, Wed,
Thu, Fri, Sat, Sun
OperationTime Start
OperationTime End
Type
Boolean
Time
Time
Description
Flag indicating if the location is opened on Mondays,
Tuesdays,
Time when location opens
Time when location closes
Note that each weekday might appear up to three times. Note too that displaying 12 oclock PM has
an exceptional value: 23:59.
CarHire-Solutions - Interface
Page 59
</OperationTimes>
</OperationSchedule>
</OperationSchedules>
</AdditionalInfo>
</LocationDetail>
</VehLocDetailRS>
CarHire-Solutions - Interface
Page 60
14 Appendix
The appendix contains some example tables of possible values of OTA parameters. For a complete
overview to the parameter values see the export files inside of http://www.carhiresolutions.com/export/. This folder contains several files with comma separated values (CSV) which
are updated in regular intervals.
CarHire-Solutions - Interface
Language_Code
DE
EN
FR
IT
HU
PL
SK
CZ
ES
RU
CN
SE
BG
NL
TR
DK
FI
RO
NO
FL
HE
PT
TH
MY
JP
KR
AR
HI
Language_Code2
de-DE
en-GB
fr-FR
it-IT
hu-HU
pl-PL
sk-SK
cs-CZ
es-ES
ru-RU
zh-CN
sv-SE
bg-BG
nl-NL
tr-TR
da-DK
fi-FI
ro-RO
nb-NO
nl-BE
he-IL
pt-PT
th-TH
ms-MY
ja-JP
ko-KR
ar-AE
hi-IN
Language_Description
German
English
French
Italian
Hungarian
Polish
Slovakian
Czech
Spanish
Russian
Chinese
Swedish
Bulgarian
Dutch
Turkish
Danish
Finnish
Rumanian
Norwegian
Flemish
Hebrew
Portuguese
Thai
Malay
Japanese
Korean
Arabian
Hindi
Page 61
Country_Name_EN
Germany
Switzerland
Spain
Austria
France
United States of America
Greece
Turkey
Denmark
Italy
Portugal
Country_ISO
DE
CH
ES
AT
FR
US
GR
TR
DK
IT
PT
Country_ISO2
DEU
CHE
ESP
AUT
FRA
USA
GCE
TUR
DNK
ITL
PRT
Country_ISO3
276
756
724
40
250
840
300
792
208
380
620
Airport_IATA
AAL
AAR
ABE
ABI
ABQ
ABR
ABX
ABY
ABZ
ACA
ACC
ACE
ACK
ACT
ACV
ACY
CarHire-Solutions - Interface
Airport_Name_EN
Aalborg Airport
Aarhus Airport
Allentown Lehigh Valley International Airport
Abilene Municipal Airport
Albuquerque International Airport
Aberdeen Municipal Airport
Albury Airport
Albany Dougherty County Airport
Aberdeen Dyce Airport
Acapulco General Juan N. Alvarez International Airport
Accra Kotoka Airport
Arrecife Lanzarote Airport
Nantucket, Nantucket Memorial Airport
Waco Municipal Airport
Arcata Airport
Atlantic City International Airport
Page 62
City_ID
389
59
12239
9547
390
60
1278
2182
2183
8648
11235
391
11209
14075
City_Name_EN
Aabenraa
Aachen
Aakirkeby
Aal
Aalborg
Aalen
Aalesund
Aalst
Aandalsnes
Aarau
Aardalstangen
Aarhus
Aarup
Aas
City_IATA
AAH
AAL
AES
AAR
AAP
Reservation Status
on request
confirmed
cancelled by customer
open
cancelled by supplier
confirmed - Voucher in process
cancellation pending
cancellation ignored
Amend pending
No Show
Amended - No valid reservation
! Attention: Not booked
Rebooked
Failed - not Rebooked
Test Reservation
Waiting for feedback from client
Shop - failed closed
Reservation ignored
CarHire-Solutions - Interface
Page 63
30
31
32
35
36
37
38
43
44
45
46
47
Reminder
Double Booking
Cancelled by Shop
Car was picked up
Ignored
Ended Current
Ended Previous
Cancelled-free of charge (goodwill)
Supplier confirmation goes to affiliate
Cancellation from Affiliate to Supplier
Confirmed Supplier payment rule changed
Fake Booking
LocationType_Name
Location
Train station
Airport
Airport/Train station
Ferry/Seaport
Delivery Only
City/Downtown
Railway/Bus Station
Garage/Hotel
Unmanned
Chauffeur
Supplier_DisplayName
Hertz
Avis
Sixt
holidayautos
Sunnycars
Sol Mar
Europcar
AutoEurope
Goldcar rental
Alamo
Supplier_GDSCode
ZE
ZI
SX
HA
SC
SM
EP
ZU
GR
AL
Page 64
37
38
40
41
44
46
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
76
77
78
80
81
82
83
84
85
86
87
88
CarHire-Solutions - Interface
Fox Autorent
Sixt holidayCars
Unirent
driveFTI
CarDelMar
Hawk rent a car
m-broker
Klees
Dollar Germany
eMietwagen
Special Offer
Record rent a car
Locauto
AurigaCrown
Budget
easycar
Centauro
Autocandia
Enterprise
National
Hiper Rent a Car
Dollar
Auto Rent
Hertz Bulgaria
Top Rent a Car
Avis Spain
SAY Rent a Car
Bravacar
Guerin
Hertz Canaries
Thrifty Car Rental
Helle Hollis Car Rental
Niza Cars
Europcar France
Europcar Kanaren
First Car Rental South Africa
holiday-autos
296 Rent-a-car
Special Deal
Hertz Balearics
Sixt Italy
Budget Israel
BerElek
GetYourCar
FR
SH
UN
DF
CM
HW
MB
KL
DG
TR
SO
RC
LA
AG
ZD
EC
CE
AU
ET
ZL
HP
ZR
AR
HB
IC
RR
SR
BC
GN
HC
ZT
HH
NC
EF
SZ
FS
HU
AZ
SD
HD
SF
BS
BR
GY
Page 65
89
90
92
93
94
95
96
99
100
101
102
103
104
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
136
137
138
139
140
141
142
CarHire-Solutions - Interface
Thrifty Australia
Buchbinder
Cicar
Auto Jardim
Pops Car
TUI Cars
TUI Portugal rent a car
Thai Cars
ATESA National Renting
AVIA CAR
Sixt Cyprus
Special Deal
Sixt Greece
Hertz Greece
Jumbo Car Runion
Jumbo Car Guadeloupe
Avis Marocco
Pop's Car Martinique
TargaRent
Budget New Zealand
Avis Corsica
Avis Malta
Avis Slovenia
Avis Malaysia
Avis Italy ex Si Sa
Avis France
Gozo
Avis Croatia
Z&X Cyprus
Sixt Croatia
Thrifty India
353 car rental
SamiCar
First-Car
Locationauto
Thrifty Libanon
Dollar Rentacar
Thrifty Niederlande
Thrifty New Zealand
Thrifty Griechenland
Thrifty Sdafrika/Namibia
Thrifty UK
Thrifty Morocco
Thrifty Karibik & Lateinamerika
TA
BO
CX
AJ
PC
TC
TP
HX
AT
AV
SY
LO
SG
HG
HN
HO
AM
PM
BI
BZ
AK
AA
AP
AY
AI
AF
GO
AC
ZX
SA
DI
CR
SI
FC
LC
TL
DA
TN
HZ
TG
DZ
TU
TM
TK
Page 66
143
144
145
146
147
148
149
150
151
161
162
163
164
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
196
197
198
CarHire-Solutions - Interface
Thrifty gypten
Thrifty Oman
Thrifty VAE
Thrifty Jordanien
Thrifty Kuwait
Thrifty Lybien
Thrifty Qatar
Thrifty Trkei
Thrifty Irland
Thrifty
Croatia/Slovenia/Bosnia/Serbien
Thrifty Zypern
Thrifty Bulgarien
Sixt Serbien
SR Rent a Car
Victoria Rent a Car
Budget Romania
Amigos do Auto
Thrifty Italy by Car
Sixt Malta
touRent Crete
Traffic
National Greece
Season Cars
Thrifty Malta
First Car Mauritius
Sixt Montenegro
Thrifty Tschechien
BalatonCar
Prima Rent
Alamo_
Thrifty Russia
Sixt Mauritius
Europcar Corsica
Extraspecial
DerTour
Atlasoption
AutoEscape
mietwagen.com
Woodford
Limo Cyprus Car Hire
SurPrice Car Rentals
Firefly Car Rental
PepeCar
TE
TO
TV
TJ
TW
YL
TQ
TT
TI
TH
TZ
TB
SS
SE
VI
BA
AQ
IB
XM
CT
TF
NG
CS
TY
MA
XN
YT
BL
PR
AL_
RT
SJ
CO
ES
DE
AO
AE
MW
WO
LI
SU
FF
PE
Page 67
200
203
204
206
207
208
209
211
212
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
230
229
231
236
234
237
238
239
STARCAR
EuroRent
Indian Ocean
Hertz Romania
Fox Rent-a-car
Express S.A.
Procar Rental
addCar rental
Easirent
Autos Valls
Caro Autovermietung
Lagorent Rent-a-Car
Bravo Rent a Car
AirCar
Sicily By Car
Hertz Portugal
Orlando Rent A Car
Budget VAE
Budget Rhodos
Payless Car
Sicily Rent a Car
BK Rent a Car
Unidas
movida rent a car
Foco aluguel de carros
E-Z Rent-A-Car
Thrifty Seychelles
Ideal Car Hire
Fleet Rent a car
ACO Rent a Car
Thrifty Mexico
Drive On Holidays
ST
ER
IO
EO
FX
EE
PO
AH
EI
VA
CA
LR
BV
AN
SBC
HEP
ORL
BUA
BD
PAC
SL
BKR
UI
MV
EZ
TS
FT
AO
CarHire-Solutions - Interface
Page 68
ErrorType_Name_EN
A general error has occurred
The interface of the supplier is not responding
The interface of the supplier has produced a general error
The chosen rental period contains a logical error
The pickup station is closed in the chosen period
The drop off station is closed in the chosen period
No vehicles are available for the chosen period and
criteria. Please change your parameters.
The latest booking period for this offer has expired
Unknown Rental Station
Unknown access
Credit card couldnt be verified
Credit card seems to be invalid
No location found to start query
Session has expired
The desired car type is not available
Login Failure
The reservation has already been transferred
The offer for the desired vehicle is not active anymore.
Please make a new search.
Please check your entered data
The chosen equipment is unavailable
The Pickup specified could not be found in the system
The Dropoff specified could not be found in the system
Unfortunately this oneway rental is not permitted
The rental station is not open this day
Invalid Pickup Station
Incorrect XML-Request
Travel between these stations is not permitted
Reservation already cancelled
The reservation couldn't be found in the system of the
supplier.
Invalid Parameters
Reference is missing for offer
Customer Information is missing
Name on credit card must match client name.
Reservation price lower than agency price
Stop Sale
Booking of an allocated vehicle
Planning Problems, booking cannot be done
Internal error of cancellation of booking. Please try again
Internal error of amendment of booking. Please try again
Customer can only cancel by phone
Location ID incorrect
Over or Underpayment on CC
CarHire-Solutions - Interface
ErrorType_OTA_Code
197, 448
723
724
145
227
214
221
425
190
242
242
425
302
297
308
229
233
224
227
229
224
95
97
113
322
193
210
290
Page 69
ErrorType_ID
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
66
67
68
69
70
71
72
73
74
77
78
79
80
81
82
83
84
85
86
87
88
90
91
ErrorType_Name_EN
Account / contract not setup for invoicing
Driver age incorrect
Equipment quantity too high
Flightnumber missing and been needed
Longtime car hire, under request
The hire is too close to pickup / too far in the future
Weekend must be included
ABTA number is missing
Query type is missing
Pickup time is invalid
Drop off is invalid
Supplier parameter missing
Location couldn't be found in the system
Requested vehicle is not supported
Reference for Reservation is missing
Rental duration cannot exceed 360 days
After hours service is not available at this time
Please contact the location for a multi-month reservation
No delivery possible at selected location
Rate Not Found
The reservation data is inconsistent
Pickup supplier and Dropoff supplier are not the same
The flight information is incorrect.
The additional driver information is not consistent.
Ota location search - RefPoint is missing
Ota location search - Position is missing
Ota location search - Radius/Ranking is missing
Unfortunately, your requested offer is not available
anymore. Please change the selected conditions.
Invalid Supplier Account
Unfortunately, your requested offer is not available
anymore. Please change the selected conditions.
Cancellation is not possible at the moment. Please try
again later.
Rentalterms aren't available at the moment. Please try
again later.
connection is currently unavailable, please try again later
or select another supplier.
Reservation was already cancelled
State/Province is required in Address
No Location found for given parameters
Payment Gateway Error
The selected station - for example pick-up or drop-off
stations opening hours are outside your selected time
period
that function is no longer supported.
Membder ID not recognised.
Voucher: duration exceeds limit.
CarHire-Solutions - Interface
ErrorType_OTA_Code
535
236
312
243
253
229
234
315
211
1
233
309
Page 70
ErrorType_ID
92
93
94
95
96
97
98
99
100
ErrorType_Name_EN
Voucher: Amount not correct.
Voucher: rental duration is not correct.
Voucher failure
Reservation already exists
Vehicle will be chauffeur driven.
An equipment is not rated.
Additional fees may apply.
Invalid phone number
Language is missing
ErrorType_OTA_Code
Period Name
per day
per Rental
per week
per km
per mile
per person
per hour
Category Name
Mini
Economy
Compact
Intermediate
Page 71
5
6
7
8
9
10
Full-Size
Premium / Luxury
Van / Minivan
Convertible
all
Special
Category Name
Continent
Country
Region
City
Airport
Location
Hotel Delivery
Supplier
14.14 PricedCoverageTypes
PricedCoverageType
AD
CDW
LDW
TP
CFC
CPP
GPS
LSC
ASC
CSS
ALI
FPO
F2F
E2E
F2E
SLI
UNL
UMP
YDS
WPI
PEP
Oneway
TAX
CarHire-Solutions - Interface
PricedCoverageType_Name
Additional Driver
Collision Damage Waiver
Loss Damage Waiver
Theft Protection
Customer Facility Charge
Canellation Protection Insurance
Global Positioning System
Location Service Charge
Airport Service Charge
Child Safety Seat
Additional Liability Insurance
Fuel Petrol Option
Full to full
Empty to empty
Full to empty
Supplementary Liability Insurance / Extended
Protection
Unlimited Mileage
Uninsured ;Motorist Protection)
Young Driver Surcharge
Winterpackage
Personel Effects Protection / Coverage
Oneway fee
tax
Page 72
CarHire-Solutions - Interface
Page 73
15 Content-Index
15.1 Illustrations
FIGURE 1 PORTPAID TO SUPPLIER .................................................................................................................................. 10
FIGURE 2 PREPAID TO AFFILIATE NET RATE .................................................................................................................. 10
FIGURE 3 PREPAID TO SUPPLIER GROSS RATE ............................................................................................................... 10
FIGURE 4 LOCATION ................................................................................................................................................... 13
FIGURE 5 SOAP-OTA MESSAGE FORMAT ...................................................................................................................... 18
FIGURE 6 DIAGRAM OF THE SEARCH PROCESS.................................................................................................................. 26
FIGURE 7 CANCELLATION ............................................................................................................................................. 47
FIGURE 8 RETRIEVE RESERVATION ................................................................................................................................. 49
FIGURE 9 AMENDMENT............................................................................................................................................... 53
CarHire-Solutions - Interface
Page 74