Car Service XML Interface Specification

developer’s guide

v1.0.0
June 08

Hotelbeds Accommodation & Destination Services

Camí de Son Fangós, 100 - Torre A, 5ª Planta
07007 - Palma de Mallorca
Spain

Copyright © 2008 – Hotelbeds Accommodation & Destination Services

No Part of this document may be reproduced in any way without the prior agreement and written
permission of the Hotelbeds ADS
 HotelBeds XML Interface Specification
v1.0.0 - June 08

I. Document Control ........................................................... 3

II. Operations ..................................................................... 4

II.1 CarCountryList................................................................................................ 4
II.1.1 Request business rules .......................................................................................... 4
II.1.2 Request Observations ........................................................................................... 4
II.1.3 Request Acceptance Test ....................................................................................... 4
II.1.4 Response business rules ........................................................................................ 4
II.1.5 Response Observations ......................................................................................... 5
II.2 CarInfoSet ..................................................................................................... 5
II.2.1 Request business rules .......................................................................................... 5
II.2.2 Request Observations ........................................................................................... 5
II.2.3 Request Acceptance Test ....................................................................................... 5
II.2.4 Response business rules ........................................................................................ 5
II.2.5 Response Observations ......................................................................................... 5
II.3 CarValuedAvail ............................................................................................... 6
II.3.1 Request business rules .......................................................................................... 6
II.3.2 Request Observations ........................................................................................... 6
II.3.3 Request Acceptance Test ....................................................................................... 6
II.3.4 Response business rules ........................................................................................ 7
II.3.5 Response Observations ......................................................................................... 7

III. Particularities of common operations.................................. 8

III.1 ServiceAdd..................................................................................................... 8
III.1.1 Request Business Rules ......................................................................................... 8
III.1.2 Request Acceptance Test ....................................................................................... 8
III.1.3 Response Business Rules ....................................................................................... 8
III.2 ServiceRemove............................................................................................... 9
III.2.1 Response Business Rules ....................................................................................... 9
III.3 PurchaseConfirm............................................................................................. 9
III.3.1 Request Important Notices..................................................................................... 9
III.3.2 Request Acceptance Test ....................................................................................... 9
III.3.3 Response Business Rules ....................................................................................... 9
III.4 PurchaseDetail.............................................................................................. 10
III.4.1 Response Business Rules ..................................................................................... 10
III.5 PurchaseList................................................................................................. 10
III.5.1 Response Business Rules ..................................................................................... 10
III.6 PurchaseCancel ............................................................................................ 10
III.6.1 Response Business Rules ..................................................................................... 10
III.7 CancelProtectionAdd...................................................................................... 11
III.7.1 Response Business Rules ..................................................................................... 11
III.8 CancelProtectionRemove ................................................................................ 11
III.8.1 Response Business Rules ..................................................................................... 11

copyright © 2008 HotelBeds ADS 2 Car Service XML Interface Specification

 HotelBeds XML Interface Specification
v1.0.0 - June 08

I. Document Control

Version Issue Description Operations

1.0.0 14/04/08 New documentation file 3

copyright © 2008 HotelBeds ADS 3 Car Service XML Interface Specification

 HotelBeds XML Interface Specification
v1.0.0 - June 08

II. Operations
II.1 CarCountryList
Get a list of available countries for car services containing their destinations and zones.

CarCountryList
Request Response
Details: xsddocs/CarCountryListRQ.html xsddocs/CarCountryListRS.html
Schema: xml/CarCountryListRQ.xsd xml/CarCountryListRS.xsd
Example: xml/CarCountryListRQ.xml xml/CarCountryListRS.xml

II.1.1 REQUEST BUSINESS RULES

Element/attribute Rule
Language Mandatory
Destination/@type Must have the SIMPLE value

II.1.2 REQUEST OBSERVATIONS

CarCountryListRQ/Destination element is used to filter the response by destination.
CarCountryListRQ/CountryCode element is used to filter the response by country code.

If none of CarCountryListRQ/Destination or CarCountryListRQ/CountryCode elements are

provided, all countries for car services are returned in the response.

If CarCountryListRQ/CountryCode is provided, only this country with all its destinations will
be returned.
If CarCountryListRQ/Destination is provided, all zones for this destination are returned.

II.1.3 REQUEST ACCEPTANCE TEST

The following elements and attributes are useless:
ƒ CarCountryListRQ/ExtraParamList
ƒ CarCountryListRQ/Destination/Name
ƒ CarCountryListRQ/Destination/ZoneList

II.1.4 RESPONSE BUSINESS RULES

If CarCountryListRS/Country element is present the following elements and attributes must
be always present:
ƒ CarCountryListRS/Country/Name

If CarCountryListRS/Country/DestinationList element is present the following elements

and attributes must be always present:
ƒ CarCountryListRS/Country/DestinationList/Destination/Name

If CarCountryListRS/Country/DestinationList/Destination/ZoneList element is present

the following elements and attributes must be always present:
ƒ CarCountryListRS/Country/DestinationList/Destination/ZoneList/Zone

copyright © 2008 HotelBeds ADS 4 Car Service XML Interface Specification

 HotelBeds XML Interface Specification
v1.0.0 - June 08

II.1.5 RESPONSE OBSERVATIONS

If one or more CarCountryListRS/Country elements are present
CarCountryListRS/@totalItems attribute contains the total number of countries returned in
the response.

If no CarCountryListRS/Country element is present and CarCountryListRS/@totalItems

attribute is 0, no countries were found that match the search criteria.

II.2 CarInfoSet
Get the car offices, car groups and car special equipment available at a specific destination.

CarInfoSet
Request Response
Details: xsddocs/CarInfoSetRQ.html xsddocs/CarInfoSetRS.html
Schema: xml/CarInfoSetRQ.xsd xml/CarInfoSetRS.xsd
Example: xml/CarInfoSetRQ.xml xml/CarInfoSetRS.xml

II.2.1 REQUEST BUSINESS RULES

Element/attribute Rule
Language Mandatory
Destination/ZoneList/Zone At least an element

II.2.2 REQUEST OBSERVATIONS

If more than one CarInfoSetRQ/Destination/ZoneList/Zone element is provided, only the
first one will be taken as request parameter, the other elements in the list will be ignored.

II.2.3 REQUEST ACCEPTANCE TEST

The following elements and attributes are useless:
ƒ CarInfoSetRQ/ExtraParamList
ƒ CarInfoSetRQ/Destination/Name
ƒ CarInfoSetRQ/Destination/ZoneList/Content

Furthemore:
ƒ Only first CarInfoSetRQ/Destination/ZoneList/Zone is taken in consideration.

II.2.4 RESPONSE BUSINESS RULES

If CarInfoSetRS/CarOfficeList element is present the following elements and attributes
must be always present:
ƒ CarInfoSetRS/CarOfficeList/Code
ƒ CarInfoSetRS/CarOfficeList/Name
ƒ CarInfoSetRS/CarOfficeList/Destination/Name
ƒ CarInfoSetRS/CarOfficeList/Destination/ZoneList/Zone

II.2.5 RESPONSE OBSERVATIONS

If no CarInfoSetRS/ErrorList or CarInfoSetRS/CarOfficeList or
CarInfoSetRS/CarGroupList elements are present no car info is available for the provided
destination.
copyright © 2008 HotelBeds ADS 5 Car Service XML Interface Specification
 HotelBeds XML Interface Specification
v1.0.0 - June 08

II.3 CarValuedAvail
Get a list of available car services according to the requested parameters. The returned prices
are final prices.

CarValuedAvail
Request Response
Details: xsddocs/CarValuedAvailRQ.html xsddocs/CarValuedAvailRS.html
Schema: xml/CarValuedAvailRQ.xsd xml/CarValuedAvailRS.xsd
Example: xml/CarValuedAvailRQ.xml xml/CarValuedAvailRS.xml

II.3.1 REQUEST BUSINESS RULES

Element/attribute Rule
Language Mandatory
RentalDate/@date At least today
RentalDate/@time Mandatory
RentalDate/@date Earlier than ReturnDate/@date
ReturnDate/@time Mandatory
RentalDestination/ZoneList/Zone Mandatory
ReturnDestination/ZoneList/Zone Mandatory
CarCategory Mandatory

II.3.2 REQUEST OBSERVATIONS

If more than one CarValuedAvailRQ/RentalDestination/ZoneList/Zone or
CarValuedAvailRQ/ReturnDestination/ZoneList/Zone element is provided, only the first
one will be taken as request parameter, the other elements in the list will be ignored.

To get a list of available rental and return destinations use CarCountryList operation (see
CarCountryList).

To get a list of available car categories or special equipment use CarInfoSet operation (see
CarInfoSet).

II.3.3 REQUEST ACCEPTANCE TEST

The following elements and attributes are useless:
ƒ CarValuedAvailRQ/ExtraParamList
ƒ CarValuedAvailRQ/Contract
ƒ CarValuedAvailRQ/RentalDestination/Name
ƒ CarValuedAvailRQ/RentalDestination/ZoneList/Zone content
ƒ CarValuedAvailRQ/ReturnDestination/ZoneList/Zone content
ƒ CarValuedAvailRQ/SpecialEquipmentList/ServiceCarSpecialEquip/Name
ƒ CarValuedAvailRQ/SpecialEquipmentList/ServiceCarSpecialEquip/Description

Furthemore:
ƒ Only first CarValuedAvailRQ/RentalDestination/ZoneList/Zone is taken in
consideration.
ƒ Only first CarValuedAvailRQ/ReturnDestination/ZoneList/Zone is taken in
consideration.

copyright © 2008 HotelBeds ADS 6 Car Service XML Interface Specification

 HotelBeds XML Interface Specification
v1.0.0 - June 08

II.3.4 RESPONSE BUSINESS RULES

One of CarValuedAvailRS/Servicecar or CarValuedAvailRS/ErrorList element must be
present in the response unless the @totalItems attribute is 0.

If CarValuedAvailRS/ServiceCar element is present the following elements and attributes

must be always present:
ƒ CarValuedAvailRS/ServiceCar/@availToken
ƒ CarValuedAvailRS/ServiceCar/ContractList
ƒ CarValuedAvailRS/ServiceCar/DateFrom/@time
ƒ CarValuedAvailRS/ServiceCar/DateTo/@time
ƒ CarValuedAvailRS/ServiceCar/Currency
ƒ CarValuedAvailRS/ServiceCar/TotalAmount
ƒ CarValuedAvailRS/ServiceCar/CarGroup
ƒ CarValuedAvailRS/ServiceCar/RentalOffice/Code
ƒ CarValuedAvailRS/ServiceCar/ReturnOffice/Code
ƒ CarValuedAvailRS/ServiceCar/CarInfo/Code
ƒ CarValuedAvailRS/ServiceCar/CarInfo/Name
ƒ CarValuedAvailRS/ServiceCar/CarInfo/Vendor

II.3.5 RESPONSE OBSERVATIONS

If one or more CarValuedAvailRS/ServiceCar elements are present:
ƒ /@totalItems attribute contains the total number of car services returned in the
response.

If no CarValuedAvailRS/ServiceCar element is present and /@totalItems attribute is 0, no

hotel services were found matching the search criteria.

Additional service car rate description information may be provided in

CarValuedAvailRS/ServiceCar/ServiceExtraInfoList/ExtendedData element:
ƒ Type value: EXT_ADDITIONAL_INFO
ƒ Name value: INFO_CAR_RATE_DESCRIPTION

copyright © 2008 HotelBeds ADS 7 Car Service XML Interface Specification

 HotelBeds XML Interface Specification
v1.0.0 - June 08

III. Particularities of common operations

III.1 ServiceAdd
In this section you will see the particularities of this operation for Car service. If you want to
see the general specification for ServiceAdd, please see HotelBeds XML Interface
Specification-v2.4.1.

III.1.1 REQUEST BUSINESS RULES

When you try to add a Car Service:

Element/attribute Rule
Service/DateFrom/@time Mandatory
Service/DateTo Mandatory
Service/DateTo/@time Mandatory
Service/CarInfo/Code Mandatory

III.1.2 REQUEST ACCEPTANCE TEST

The following elements and attributes are useless:
ƒ ServiceAddRQ/Service/CarInfo/Name
ƒ ServiceAddRQ/Service/CarInfo/DescriptionList
ƒ ServiceAddRQ/Service/CarInfo/ImageList
ƒ ServiceAddRQ/Service/CarInfo/Contact
ƒ ServiceAddRQ/Service/CarInfo/TransmissionType
ƒ ServiceAddRQ/Service/CarInfo/AirConditioning
ƒ ServiceAddRQ/Service/CarInfo/Vendor
ƒ ServiceAddRQ/Service/CarInfo/DoorCount
ƒ ServiceAddRQ/Service/CarInfo/Abs
ƒ ServiceAddRQ/Service/CarInfo/Airbag
ƒ ServiceAddRQ/Service/CarInfo/PowerSteering
ƒ ServiceAddRQ/Service/CarInfo/SeatCount
ƒ ServiceAddRQ/Service/CarInfo/Driver/AdditionalInfo
ƒ ServiceAddRQ/Service/CarInfo/Driver/Document/DocIssueAuthority
ƒ ServiceAddRQ/Service/CarInfo/Driver/Document/DocIssueLocation
ƒ ServiceAddRQ/Service/CarInfo/Driver/Document/DocType
ƒ ServiceAddRQ/Service/CarInfo/Driver/Document/EffectiveDate
ƒ ServiceAddRQ/Service/CarInfo/Driver/Document/ExpireDate
ƒ ServiceAddRQ/Service/CarInfo/Driver/Document/DocHolderName
ƒ ServiceAddRQ/Service/CarInfo/Driver/Document/DocLimitations
ƒ ServiceAddRQ/Service/RentalOffice
ƒ ServiceAddRQ/Service/ReturnOffice
ƒ ServiceAddRQ/Service/SpecialEquipmentList

III.1.3 RESPONSE BUSINESS RULES

If ServiceAddRS/Purchase element is present and ServiceAddRS/Purchase/ServiceList/
Service/@type is ServiceCar the following elements and attributes must be provided:
ƒ ServiceAddRS/Purchase/ServiceList/Service/@SPUI
ƒ ServiceAddRS/Purchase/ServiceList/Service/Status
ƒ ServiceAddRS/Purchase/ServiceList/Service/Supplier
ƒ ServiceAddRS/Purchase/ServiceList/Service/DateFrom/@time
ƒ ServiceAddRS/Purchase/ServiceList/Service/DateTo/@time

copyright © 2008 HotelBeds ADS 8 Car Service XML Interface Specification

 HotelBeds XML Interface Specification
v1.0.0 - June 08

III.2 ServiceRemove
In this section you will see the particularities of this operation for Car service. If you want to
see the general specification for ServiceRemove, please see HotelBeds XML Interface
Specification-v2.4.1.

III.2.1 RESPONSE BUSINESS RULES

If ServiceRemoveRS/Purchase element is present and ServiceRemoveRS/Purchase/
ServiceList/Service/@type is ServiceCar the following elements and attributes must be
provided:
ƒ ServiceRemoveRS/Purchase/ServiceList/Service/@SPUI
ƒ ServiceRemoveRS/Purchase/ServiceList/Service/Status
ƒ ServiceRemoveRS/Purchase/ServiceList/Service/Supplier
ƒ ServiceRemoveRS/Purchase/ServiceList/Service/DateFrom/@time
ƒ ServiceRemoveRS/Purchase/ServiceList/Service/DateTo/@time

III.3 PurchaseConfirm
In this section you will see the particularities of this operation for Car service. If you want to
see the general specification for PurchaseCancel, please see HotelBeds XML Interface
Specification-v2.4.1.

III.3.1 REQUEST IMPORTANT NOTICES

Driver is mandatory for car services if it was not specified when the car service was added.

III.3.2 REQUEST ACCEPTANCE TEST

The following elements and attributes are useless:
ƒ PurchaseConfirmRQ/ConfirmationData/Confirmation/ServiceDataList/ServiceDat
a/CommentList

III.3.3 RESPONSE BUSINESS RULES

If PurchaseConfirmRS/Purchase element is present and PurchaseConfirmRS
/Purchase/ServiceList/Service/@type is ServiceCar the following elements and attributes
must be provided:
ƒ PurchaseConfirmRS/Purchase/ServiceList/Service/@SPUI
ƒ PurchaseConfirmRS/Purchase/ServiceList/Service/Status
ƒ PurchaseConfirmRS/Purchase/ServiceList/Service/Supplier
ƒ PurchaseConfirmRS/Purchase/ServiceList/Service/DateFrom/@time
ƒ PurchaseConfirmRS/Purchase/ServiceList/Service/DateTo/@time
ƒ PurchaseConfirmRS/Purchase/ServiceList/Service/Driver/LastName

copyright © 2008 HotelBeds ADS 9 Car Service XML Interface Specification

 HotelBeds XML Interface Specification
v1.0.0 - June 08

III.4 PurchaseDetail
In this section you will see the particularities of this operation for Car service. If you want to
see the general specification for PurchaseDetail, please see HotelBeds XML Interface
Specification-v2.4.1.

III.4.1 RESPONSE BUSINESS RULES

If PurchaseDetailRS/Purchase element is present and PurchaseDetailRS
/Purchase/ServiceList/Service/@type is ServiceCar the following elements and attributes
must be provided:
ƒ PurchaseDetailRS/Purchase/ServiceList/Service/@SPUI
ƒ PurchaseDetailRS/Purchase/ServiceList/Service/Status
ƒ PurchaseDetailRS/Purchase/ServiceList/Service/Supplier
ƒ PurchaseDetailRS/Purchase/ServiceList/Service/DateFrom/@time
ƒ PurchaseDetailRS/Purchase/ServiceList/Service/DateTo/@time

III.5 PurchaseList
In this section you will see the particularities of this operation for Car service. If you want to
see the general specification for PurchaseList, please see HotelBeds XML Interface
Specification-v2.4.1.

III.5.1 RESPONSE BUSINESS RULES

If PurchaseListRS/Purchase element is present and PurchaseListRS/Purchase/
ServiceList/Service/@type is ServiceCar the following elements and attributes must be
provided:
ƒ PurchaseListRS/Purchase/ServiceList/Service/Status
ƒ PurchaseListRS/Purchase/ServiceList/Service/DateFrom/@time
ƒ PurchaseListRS/Purchase/ServiceList/Service/DateTo/@time
ƒ PurchaseListRS/Purchase/ServiceList/Service/Driver/LastName

III.6 PurchaseCancel
In this section you will see the particularities of this operation for Car service. If you want to
see the general specification for PurchaseCancel, please see HotelBeds XML Interface
Specification-v2.4.1.

III.6.1 RESPONSE BUSINESS RULES

If PurchaseCancelRS/Purchase element is present and
PurchaseCancelRS/Purchase/ServiceList/Service/@type is ServiceCar the following
elements and attributes must be provided:
ƒ PurchaseCancelRS/Purchase/ServiceList/Service/@SPUI
ƒ PurchaseCancelRS/Purchase/ServiceList/Service/Status
ƒ PurchaseCancelRS/Purchase/ServiceList/Service/Supplier
ƒ PurchaseCancelRS/Purchase/ServiceList/Service/DateFrom/@time
ƒ PurchaseCancelRS/Purchase/ServiceList/Service/DateTo/@time
ƒ PurchaseCancelRS/Purchase/ServiceList/Service/Driver/LastName

copyright © 2008 HotelBeds ADS 10 Car Service XML Interface Specification

 HotelBeds XML Interface Specification
v1.0.0 - June 08

III.7 CancelProtectionAdd
In this section you will see the particularities of this operation for Car service. If you want to
see the general specification for CancelProtectionAdd, please see HotelBeds XML Interface
Specification-v2.4.1.

III.7.1 RESPONSE BUSINESS RULES

If CancelProtectionAddRS/Purchase element is present and CancelProtectionAddRS/
Purchase/ServiceList/Service/@type is ServiceCar the following elements and attributes
must be provided:
ƒ CancelProtectionAddRS/Purchase/ServiceList/Service/@SPUI
ƒ CancelProtectionAddRS/Purchase/ServiceList/Service/Status
ƒ CancelProtectionAddRS/Purchase/ServiceList/Service/Supplier
ƒ CancelProtectionAddRS/Purchase/ServiceList/Service/DateFrom/@time
ƒ CancelProtectionAddRS/Purchase/ServiceList/Service/DateTo/@time

III.8 CancelProtectionRemove
In this section you will see the particularities of this operation for Car service. If you want to
see the general specification for CancelProtectionRemove, please see HotelBeds XML
Interface Specification-v2.4.1.

III.8.1 RESPONSE BUSINESS RULES

If CancelProtectionRemoveRS/Purchase element is present and CancelProtectionRemoveRS/
Purchase/ServiceList/Service/@type is ServiceCar the following elements and attributes
must be provided:
ƒ CancelProtectionRemoveRS/Purchase/ServiceList/Service/@SPUI
ƒ CancelProtectionRemoveRS/Purchase/ServiceList/Service/Status
ƒ CancelProtectionRemoveRS/Purchase/ServiceList/Service/Supplier
ƒ CancelProtectionRemoveRS/Purchase/ServiceList/Service/DateFrom/@time
ƒ CancelProtectionRemoveRS/Purchase/ServiceList/Service/DateTo/@time

copyright © 2008 HotelBeds ADS 11 Car Service XML Interface Specification