CityProvider Service

An API to interact with cities, airports and train stations.

Namespace
http://airportal.service.cbtweb.cbt.com/
WSDL
airportal.wsdl
Path
/CityProviderService

getAirportByCode Operation

Get an airport using its IATA code.

Input Parameters
name type description
code string The IATA code for the airport.
Return Value
type description
city The City that the airport resides in.

getAirportByCityName Operation

Get an airport using the name of the city it is in.

Input Parameters
name type description
cityName string The name of the city that the airport resides.
Return Value
type description
city The city that the airport resides in.

getAirportByCityNameAndState Operation

Input Parameters
name type description
cityName string  
state string  
Return Value
type description
city  

getTrainStationByCode Operation

Get a train station using its IATA code.

Input Parameters
name type description
code string The IATA code for the train station.
Return Value
type description
trainStation The TrainStation that the code identifies.

getTrainStationById Operation

Get a train station using its ID.

Input Parameters
name type description
id long The id of the train station.
Return Value
type description
trainStation The TrainStation that the id identifies.

getTrainStationByAirportCode Operation

Get a list of train stations by their nearest airport code.

Input Parameters
name type description
code string The airport code nearest to the train station.
Return Value
type description
list of trainStation The train station closes to the airport.

updateAirport Operation

Update a city.

Input Parameters
name type description
city city The city to update.
Return Value
type description
city The updated city.

updateTrainStation Operation

Update a train station.

Input Parameters
name type description
station trainStation The station to update.
Return Value
type description
trainStation The updated train station.

searchAirports Operation

Search for airports using the provided query.

Input Parameters
name type description
search searchList The query to search for airports with.
Return Value
type description
list of city The airports found using the query.

countAirports Operation

Count the airports using the provided query.

Input Parameters
name type description
search searchList The query to count airports with.
Return Value
type description
long A long number of the total airports returned by the query.

searchTrainStations Operation

Search for train stations using the provided query.

Input Parameters
name type description
search searchList The query to search for train stations with.
Return Value
type description
list of trainStation The train stations found using the query.

countTrainStations Operation

Count the train stations using the provided query.

Input Parameters
name type description
search searchList The query to count stations with.
Return Value
type description
long A long number of the total stations returned.

getHotelLocationByNameAndAddress Operation

Get a hotel location using it's property name and address.

Input Parameters
name type description
propertyName string The name of the property
address1 string The address of the hotel location
Return Value
type description
hotelLocation The Hotel Location

getHotelLocationByCode Operation

Get a hotel location using it's property code.

Input Parameters
name type description
code string The unique code for the property.
gds long The GDS that the code is for.
Return Value
type description
hotelLocation The property that the code belongs to.

getHotelLocationByAddressAndPhone Operation

Get a hotel location using it's phone number.

Input Parameters
name type description
address string The address of the hotel location.
phone string The phone number to search by.
Return Value
type description
hotelLocation The hotel location with this matching phone number.

getAirportById Operation

Get an airport by its ID.

Input Parameters
name type description
id long The ID of the city/airport.
Return Value
type description
city The city/airport identified by the given ID.

getCountries Operation

Get all countries.

Return Value
type description
list of country All countries.

getAllRegions Operation

Return Value
type description
list of region  

getAirportRegion Operation

Input Parameters
name type description
code string  
Return Value
type description
region  

getAirportCountry Operation

Input Parameters
name type description
code string  
Return Value
type description
country  

getAllTimeZones Operation

Get a list of all time zones in the world.

Return Value
type description
list of timeZone A list of all time zones in the world.

getTimeZoneByName Operation

Get a time zone by its name.

Input Parameters
name type description
name string  
Return Value
type description
timeZone The time zone with the given name.

getCityByCityId Operation

Get a city by its id.

Input Parameters
name type description
id long The ID of the city.
Return Value
type description
city The city identified by the given ID.

getAlternativeAirports Operation

Get alternative airports for a particular airport.

Input Parameters
name type description
id long The id of the airport to get alternatives for.
Return Value
type description
list of city A list of cities that are alternatives for the provided airport.

updateAlternativeAirports Operation

Add/Remove alternative airports for a particular airport.

Input Parameters
name type description
id long The id of the airport to add or remove alternatives for.
cities list of city A list of cities that are alternatives for the provided airport.
Return Value
type description
list of city The list of cities that were added as alternatives for the provided airport.