[XTRAVELSYSTEM WEB SERVICE. COMMONS]

1

XTravelSystem Web Service. Commons

CONTENTS

XTravelSystem Web Service. Commons ...................................................................................................................1

Chapter 0. Commons Handler WS Specification. ........................................................................................................... 2

Web Service: commonsHandlerService ........................................................................................................................ 2

Test Environment Access: .............................................................................................................................................. 2

METHODS ............................................................................................................................. ..........................................2

getAirports ...................................................................................................................................... ................2

getAirportTypes ..............................................................................................................................................3

getAreasV22...................................................................................................................................................... ......4

getCitiesByAreaV22 ............................................................................................................................ ...................5

getCitiesV22 ............................................................................................ ........................................................6

getCitiesWithAvailabilityV22 ................................................................................................................................8

getCountriesV22 .....................................................................................................................................................9

getDistrictsV22 ............................................................................ ........................................................................10

getGeographicalMapV22 .................................................................................................................... ..................11

getVehiclesTypes ............................................................................................................................. ....................12

getErrataTypesV22 ...............................................................................................................................................13

pingV21 .......................................................................................................................................... .......................14

getRatesV22 ...............................................................................................................................................15

IT PROJECT MANAGEMENT,

ANALYSIS AND QUALITY

ASSURANCE DEPARTMENT

CLIENT SPECIFICATION

XTRAVELSYSTEM WEB

SERVICE. COMMONS

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

IT Project management, analysis and quality assurance Department | XTravelSystem Web 2 Service. Commons

Chapter 0. Commons Handler WS Specification.

In the file MAN_xts_WSClientSpec_20200725_en_base you will find a group of tips and recommendations for the

correct use of our API that must be reviewed before carrying out any development.

Specification of available public web services

XTS implements different handler web services according to their functional use.

CommonsHandlerService and BasketHandlerService contain WS usable by all services (hotel, car, transfer and

excursion), the rest being service specific.

Required parameters are colour marked and text specified: “(required)”.

All methods require the following parameterss:

- agencyCode: Agency code. Unique code for each customer. We provide it.

- brandCode: Brand code. Same code for all methods. We provide it.

- pointOfSaleId: Point of Sale. Same code for all methods. We provide it.

Most methods have a language parameter. This is a required parameter and specifies the language sent in the

responses. Possible values are:

- “en”: English

- “es”: Spanish

- “de”: German

- “fr”: French

- “it”: Italian

- “pt”: Portuguese

Web Service: commonsHandlerService

WS description: WS to handle common methods for all WS: geographical structure and other auxiliary data

Test Environment Access:

WSDL: https://test.xtravelsystem.com/public/v1_0rc1/commonsHandler?WSDL (Also http) Endpoint:

https://test.xtravelsystem.com/public/v1_0rc1/commonsHandler (Also http)

METHODS

getAirports

It returns airports from a country. More information on geographical structure can be found in Appendix D.

getAirports Request

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

3

agencyCode (required) Agency code. Unique code for each customer.

brandCode (required) Brand code. Same code for all methods.

pointOfSaleId (required) Point of Sale. Same code for all methods.

language (required) Language sent in the response.

countryCode (required)

Country code.

See geographic structure related methods in CommonsHandler service. Also

see xls files at http://doc.xtravelsystem.com to fully understand the geographic

structure.

getAirports Response

[airports]

airports item composed of code, name and type

code Airport code.

iataCode Iata codification.

name Airport name.

type

Airport type. Values:

- AIRPORT

- SEAPORT

- RAILWAY STATION - BUS STATION

- DOMESTIC AIRPORT

getAirportTypes

It returns airports types values

getAirportTypes Request

agencyCode (required) Agency code. Unique code for each customer.

brandCode (required) Brand code. Same code for all methods.

pointOfSaleId (required) Point of Sale. Same code for all methods.

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

IT Project management, analysis and quality assurance Department | XTravelSystem Web 4 Service. Commons

getAirportTypes Response

type

Airport type. Values:

- AIRPORT

- SEAPORT

- RAILWAY STATION - BUS STATION

- DOMESTIC AIRPORT

getAreasV22

It returns geographical operational structure used by XTS. Area codes are used as input parameter in the availability

methods from the hotelBookingHandler. More information on geographical structure can be found in Appendix D.

This version adds Extended Login.

getAreasV22 Request

agencyCode (required) Agency code. Unique code for each customer.

brandCode (required) Brand code. Same code for all methods.

pointOfSaleId (required) Point of Sale. Same code for all methods.

language (required) Language sent in the response.

areasTreeCode (required)

Area Tree Code. Values:

- Always: “1”.

extendedLogin

If known, you can inform the connection source country, the paxes country of

residence and the distribution channel (B2B or B2C)

loginCountry Country code. ISO alfa-2: ES, DE, GB, US,...

To be filled always with source country, country from where the connection is

made.

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

5

getCitiesByAreaV22

mainNationality Country code. ISO alfa-2: ES, DE, GB, US,...

To inform the pax country of residence, if it is known. If it is unknown, fill with the

same value than loginCountry.

It will be used to choose the market distribution treated with a higher priority than

loginCountry. It means that if the mainNationality has a different value than

loginCountry, mainNationality will be the country used to select the credentials

which client will connect to XTS.

channel Values: B2B or B2C

getAreasV22Response

[areas]

List item composed of code and name (Level1 areas)

code

Level1 area code

name

Level1 area name

[areas]

List item composed of code and name (Level2 areas)

code

Level2 area code

name

Level2 area name

[areas]

list item composed of code and name (Level3 areas)

code Level3 area code

name Level3 area name

pricingAgencyCode

For Jumbo use only.

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

IT Project management, analysis and quality assurance Department | XTravelSystem Web 6 Service. Commons

It returns cities from an area and its child áreas, with their codes included within an área, this version adds Extended

Login.

getCitiesByAreaV22 Request

agencyCode (required) Agency code. Unique code for each customer.

brandCode (required) Brand code. Same code for all methods.

pointOfSaleId (required) Point of Sale. Same code for all methods.

language (required) Language sent in the response.

areaCode (required)

Area Code. Values:

extendedLogin

If known, you can inform the connection source country, the paxes country of

residence and the distribution channel (B2B or B2C)

loginCountry Country code. ISO alfa-2: ES, DE, GB, US,...

To be filled always with source country, country from where the connection is

made.

mainNationality Country code. ISO alfa-2: ES, DE, GB, US,...

To inform the pax country of residence, if it is known. If it is unknown, fill

with the same value than loginCountry.

It will be used to choose the market distribution treated with a higher priority

than loginCountry. It means that if the mainNationality has a different value

than loginCountry, mainNationality will be the country used to select the

credentials which client will connect to XTS.

channel Values: B2B or B2C

getCitiesByAreaV22 Response

[list] List item composed of code and name

code City code

name City name

pricingAgencyCode

For Jumbo use only.

getCitiesV22

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

7

It returns cities from a country with their codes included within

this version adds Extended Login.

getCitiesV22 Request

agencyCode (required) Agency code. Unique code for each customer.

brandCode (required) Brand code. Same code for all methods.

pointOfSaleId (required) Point of Sale. Same code for all methods.

language (required) Language sent in the response.

countryCode (required)

Geographical area code.

See geographic structure related methods in CommonsHandler service. Also

see xls files at http://doc.xtravelsystem.com to fully understand the geographic

structure.

extendedLogin

If known, you can inform the connection source country, the paxes country of

residence and the distribution channel (B2B or B2C)

loginCountry Country code. ISO alfa-2: ES, DE, GB, US,...

To be filled always with source country, country from where the connection is

made.

mainNationality Country code. ISO alfa-2: ES, DE, GB, US,...

To inform the pax country of residence, if it is known. If it is unknown, fill

with the same value than loginCountry.

It will be used to choose the market distribution treated with a higher priority

than loginCountry. It means that if the mainNationality has a different value

than loginCountry, mainNationality will be the country used to select the

credentials which client will connect to XTS.

channel Values: B2B or B2C

getCitiesV22 Response

[list] Lists items composed of code and name

code City code

name City name

pricingAgencyCode

For Jumbo use only.

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

IT Project management, analysis and quality assurance Department | XTravelSystem Web 8 Service. Commons

getCitiesWithAvailabilityV22

It returns Number of Available Hotels by City from a Country. This

version adds Extended Login.

getCitiesWithavailabilityV22 Request

agencyCode (required) Agency code. Unique code for each customer.

brandCode (required) Brand code. Same code for all methods.

pointOfSaleId (required) Point of Sale. Same code for all methods.

countryCode (required)

Country code (ISO-2)

See geographic structure related methods in CommonsHandler service. Also

see xls files at http://doc.xtravelsystem.com to fully understand the geographic

structure.

extendedLogin

If known, you can inform the connection source country, the paxes country of

residence and the distribution channel (B2B or B2C)

loginCountry Country code. ISO alfa-2: ES, DE, GB, US,...

To be filled always with source country, country from where the connection is

made.

mainNationality Country code. ISO alfa-2: ES, DE, GB, US,...

To inform the pax country of residence, if it is known. If it is unknown, fill

with the same value than loginCountry.

It will be used to choose the market distribution treated with a higher priority

than loginCountry. It means that if the mainNationality has a different value

than loginCountry, mainNationality will be the country used to select the

credentials which client will connect to XTS.

channel Values: B2B or B2C

getCitiesWithAvailabilityV22 Response

[list] Lists items composed of code and name

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

9

availableHotels Number of Available Hotels by City.

cityCode City code

cityDescription City name

pricingAgencyCode

For Jumbo use only.

getCountriesV22

It returns all countries. This is a complete list of countries and many of them will not include cities or product. Use

getCitiesWithAvailability to locate cities with available hotels.

This version adds Extended Login.

getCountriesV22 Request

agencyCode (required) Agency code. Unique code for each customer.

brandCode (required) Brand code. Same code for all methods.

pointOfSaleId (required) Point of Sale. Same code for all methods.

language (required) Language sent in the response.

extendedLogin

If known, you can inform the connection source country, the paxes country of

residence and the distribution channel (B2B or B2C)

loginCountry Country code. ISO alfa-2: ES, DE, GB, US,...

To be filled always with source country, country from where the connection is

made.

mainNationality Country code. ISO alfa-2: ES, DE, GB, US,...

To inform the pax country of residence, if it is known. If it is unknown, fill with

the same value than loginCountry.

It will be used to choose the market distribution treated with a higher priority

than loginCountry. It means that if the mainNationality has a different value than

loginCountry, mainNationality will be the country used to select the credentials

which client will connect to XTS.

channel Values: B2B or B2C

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

IT Project management, analysis and quality assurance Department | XTravelSystem Web 10 Service. Commons

getCountriesV22 Response

[list

] Lists items composed of code and name

code Country code

name Country name

pricingAgencyCode

For Jumbo use only.

getDistrictsV22

It returns a list of districts from a country, state or city, with their codes included within an área, this version adds

Extended Login.

getDistrictsV22 Request

agencyCode (required) Agency code. Unique code for each customer.

brandCode (required) Brand code. Same code for all methods.

pointOfSaleId (required) Point of Sale. Same code for all methods.

countryCode (required)

Country code (ISO-2)

See geographic structure related methods in CommonsHandler service. Also

see xls files at http://doc.xtravelsystem.com to fully understand the geographic

structure.

extendedLogin

If known, you can inform the connection source country, the paxes country of

residence and the distribution channel (B2B or B2C)

loginCountry Country code. ISO alfa-2: ES, DE, GB, US,...

To be filled always with source country, country from where the connection is

made.

mainNationality Country code. ISO alfa-2: ES, DE, GB, US,...

To inform the pax country of residence, if it is known. If it is unknown, fill

with the same value than loginCountry.

It will be used to choose the market distribution treated with a higher priority

than loginCountry. It means that if the mainNationality has a different value

than loginCountry, mainNationality will be the country used to select the

credentials which client will connect to XTS.

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

11

channel Values: B2B or B2C

getDistrictsV22 Response

[list

] Lists items composed of code and name

code District code

name District name

pricingAgencyCode

For Jumbo use only.

getGeographicalMapV22

It returns administrative geographical structure: Countries, states, cities. City codes are used as input parameters in the

availableHotelsByMultiQuery method from the hotelBookingHandler. Countries and states are not used in hotel

availability requests. More information on geographical structures can be found in Appendix D.

This version adds Extended Login.

getGeographicalMapV22 Request

agencyCode (required) Agency code. Unique code for each customer.

brandCode (required) Brand code. Same code for all methods.

pointOfSaleId (required) Point of Sale. Same code for all methods.

language (required) Language sent in the response.

extendedLogin

If known, you can inform the connection source country, the paxes country of

residence and the distribution channel (B2B or B2C)

loginCountry Country code. ISO alfa-2: ES, DE, GB, US,...

To be filled always with source country, country from where the connection is

made.

mainNationality Country code. ISO alfa-2: ES, DE, GB, US,...

To inform the pax country of residence, if it is known. If it is unknown, fill

with the same value than loginCountry.

It will be used to choose the market distribution treated with a higher priority

than loginCountry. It means that if the mainNationality has a different value

than loginCountry, mainNationality will be the country used to select the

credentials which client will connect to XTS.

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

IT Project management, analysis and quality assurance Department | XTravelSystem Web 12 Service. Commons

channel Values: B2B or B2C

getGeographicalMapV22 Response

[continents] Continents item composed of code and name

Code Continent code

name Continen name

[countries] Countries item composed of code and name

Code Country code

name Country name

[states] List item composed of code and name

code State province or region code

name State province or region name

[cities] Cities item composed of code and name

code City code

name City name

pricingAgencyCode

For Jumbo use only.

getVehiclesTypes

It returns Vehicles Types. getVehiclesTypes Request

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

13

getVehiclesTypes Request

agencyCode (required) Agency code. Unique code for each customer.

brandCode (required) Brand code. Same code for all methods.

pointOfSaleId (required) Point of Sale. Same code for all methods.

language (required) Language sent in the response.

getVehiclesTypes Response

[vehiclesTypes]

Vehicles Types item

carName Name of Vehicle.

description Escription of Vehicle.

id Id of Vehicle.

imageUrl Link to a Image of Vehicle.

numPassenger Max. Number of Passengers for this Vehicle.

getErrataTypesV22

It returns the Errata Types by language.

This version adds Extended Login.

getErrataTypesV22 Request

agencyCode (required) Agency code. Unique code for each customer.

brandCode (required) Brand code. Same code for all methods.

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

IT Project management, analysis and quality assurance Department | XTravelSystem Web 14 Service. Commons

pointOfSaleId (required) Point of Sale. Same code for all methods.

Code Code of the Errata Type to be found.

language (required) Language sent in the response.

Title Part of the Errata Type Title to be found.

extendedLogin

If known, you can inform the connection source country, the paxes country of

residence and the distribution channel (B2B or B2C)

loginCountry Country code. ISO alfa-2: ES, DE, GB, US,...

To be filled always with source country, country from where the connection is

made.

mainNationality Country code. ISO alfa-2: ES, DE, GB, US,...

To inform the pax country of residence, if it is known. If it is unknown, fill

with the same value than loginCountry.

It will be used to choose the market distribution treated with a higher priority

than loginCountry. It means that if the mainNationality has a different value

than loginCountry, mainNationality will be the country used to select the

credentials which client will connect to XTS.

channel Values: B2B or B2C

getErrataTypesV22 Response

[errataTypes]

Errata Type item composed of category, description, establishmentId, imageUrl

and name.

Code Code of the Errata Type

description Long description of the Errata Type.

title Title of the Errata Type.

pricingAgencyCode

For Jumbo use only.

pingV21

Checks an XTS agency’s connectivity. A method you can use to ensure you can connect

to our ws, send a request and get a response. You must fill the 3 tags in login1 or at least

client and country in login2. If you fill any tag in login1, login2 will be ignored.

agencyCode Agency code. Unique code for each customer.

To be filled always with brandCode and pointOfSaleId

brandCode Brand code. Same code for all methods.

To be filled always with agencyCode and pointOfSaleId.

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

15

pointOfSaleId Point of Sale. Same code for all methods.

To be filled always with agencyCode and brandCode.

getRatesV22

With this call you can retrieve all the available rates and conditions with the call getRatesV22, it is very important

that the current rates are periodically reviewed with this call and in case you are not interested in receiving any of

them contact with the commercial staff, so they can be blocked.

getRatesV22 Request

agencyCode (required) Agency code. Unique code for each customer.

brandCode (required) Brand code. Same code for all methods.

pointOfSaleId (required) Point of Sale. Same code for all methods.

language (required) Language sent in the response.

extendedLogin

If known, you can inform the connection source country, the paxes country of

residence and the distribution channel (B2B or B2C)

loginCountry Country code. ISO alfa-2: ES, DE, GB, US,...

To be filled always with source country, country from where the connection is

made.

mainNationality Country code. ISO alfa-2: ES, DE, GB, US,...

To inform the pax country of residence, if it is known. If it is unknown, fill

with the same value than loginCountry.

It will be used to choose the market distribution treated with a higher priority

than loginCountry. It means that if the mainNationality has a different value

than loginCountry, mainNationality will be the country used to select the

credentials which client will connect to XTS.

[XTRAVELSYSTEM WEB SERVICE. COMMONS]

IT Project management, analysis and quality assurance Department | XTravelSystem Web 16 Service. Commons

channel Values: B2B or B2C

getRatesV22 Response

[rates]

code Code of the Rate

description Description of the Rate

pricingAgencyCode

For Jumbo use only.