Helpful Guide For Kumuka's Web Services : Tour Services

Introduction

The Kumuka TourServices Web service has been created in Microsoft ASP.NET (version 2.0) for use by affiliates within their own Web sites or custom applications. The service provides read-only access to our range of Kumuka tours that we offer on our own Web site in an XML format. You can either use SOAP, HTTP-GET, or HTTP-POST to access the service.

Please note that any prices provided by the Web service are currency specific and may vary from time to time, but will always contain the most up to date information held on our systems. Therefore, please do not cache tour information within your site for more than 12 hours. Kumuka also reserves the right to modify any part of a tour including the tour price without informing affiliates directly.

Also note that if a visitor to your site makes a booking with Kumuka, you will receive a commission amount as detailed in the affiliate agreement. To ensure this commission can be traced to you, use the booking url provided in the TourDetail datatype or embed your own affiliate id in any page links to our site as shown on the affiliate link page.

Available Methods
The following table lists the Web service method, a description and its parameters.

Web Method Name Description Parameters *
GetAfricanTours Provides a list of tours for Africa.
The list contains only the basic information for a tour as described in the TourBasic datatype.
GetAllTours Provides a list of all current tours.
The list contains only the basic information for a tour as described in the TourBasic datatype.
GetAsianTours Provides a list of tours for Asia.
The list contains only the basic information for a tour as described in the TourBasic datatype.
GetCentralAmericanTours Provides a list of tours for Central America.
The list contains only the basic information for a tour as described in the TourBasic datatype.
GetEuropeanTours Provides a list of tours for Europe.
The list contains only the basic information for a tour as described in the TourBasic datatype.
GetFamilyTours Provides a list of tours for the whole family.

The list contains only the basic information for a tour as described in the TourBasic datatype.
GetLateDeals Provides a list of tours that currently have late (or last minute) discounts. Returns a separate list for each of the continent areas as described in the LateDeal datatype.
GetMiddleEasternTours Provides a list of tours for the Middle East.
The list contains only the basic information for a tour as described in the TourBasic datatype.
GetNorthAmericanTours Provides a list of tours for North America.
The list contains only the basic information for a tour as described in the TourBasic datatype. 
GetSouthAmericanTours Provides a list of tours for South America.
The list contains only the basic information for a tour as described in the TourBasic datatype. 
GetSpecialOffers Provides a list of discount values for each continent currently on a special offer. Returns a SpecialOffer datatype object.
GetTourDetail

Provides detailed information for a single tour.
The resulting TourDetail datatype contains all of the possible information for a tour.

This return type includes a Booking URL that includes your affiilate id. This will ensure you receive any commission if your customers book via that link if you display the link on your site.

 TourCode - the tour code you want to retrieve.
GetToursForContinent Provides a list of tours for a specified continent.
This is an alternative option to using the other methods because it allows you to pass a continent parameter to the method.

The list contains only the basic information for a tour as described in the TourBasic datatype. 		Continent - the continent you wish to search for:
AF, AS, CA, EU, ME, SA
GetVersionDetails Provides the current version information for this Web service and is only intended to assist you with checking which version of our schema we are currently using.
SearchForToursByKeywords Provides a list of tours for based on keywords such as country names.

The list contains only the basic information for a tour as described in the TourBasic datatype.

Keywords - Possible keywords include a country name or other keyword. Use quotes to perform exact match.

Examples: Vietnam, Thailand, Safari
GetTourPricingDetail Provides detailed pricing for a single tour departure date.

Returns a DeparturePrice datatype which may include discount amounts, adult/child prices, and supplements such as single passenger, or seasonal supplements. 		InstanceId - the tour departure's instance ID pulled from the GetTourDetail method's TourDetail datatype.

TourCode - the tour code to get the pricing for.
GetRegions Provides a list of current regions such as AFRICA etc as an array of strings.
GetRegionsWithContinentKey Same as GetRegions but also returns the continent key for use with the GetToursForContinent method.
GetTourStyles Returns a list of tour styles that Kumuka provide such as OVERLAND TOURS etc as an array of strings.
PerformComplexSearch Lets you search by continent, tour type, minimum/maximum tour length, and search dates. ContinentCode - the two character continent code.

TourType - the value returned from the GetTourStyles method.

MinTourLength - the minimum duration of tours to return.

MaxTourLength - the maximum duration of tours to return.

StartDate - the date to begin the search.

EndDate - the date to end the search.

*Note: All methods expect your unique affiliate code. If you don't have an affiliate id, please join by going to http://www.kumuka.com/JoinAffiliates.aspx

Most methods automatically use your designated currency for pricing however alternative methods that end with "...ForCurrency" allow you to specify any of our supported currencies from this list:

  • AUD
  • CAD
  • EUR
  • GBP
  • NZD
  • USD
  • ZAR

You can view the Web Services Description Language (WSDL) file for the datatype schema at http://www.kumuka.com/services/TourServices.asmx?WSDL

Examples

To view a sample of the XML results retrieved from the Web service, click here for a list of TourBasic items, or here for a single TourDetail response.

To download a C# .NET example of how to use our Web service, click here.

Suggestions

If you have any suggestions about how we can enhance our Web service, please e-mail suggestions to: affiliates@kumuka.com