Check Tour Availability

PHP examples use the PHP Client Library with SimpleXML

Description

object check_tour_availability ( string $params, int $tour, int $channel )

Parameters

$params

Querystring parameters (see table below)

$tour

ID for the Tour to check

$channel

ID for the Channel (supplier) - required as Tour IDs are not unique

Example

// Set the ID number for the Tour we are checking
$tour = 1;

// Set the channel this Tour belongs to
$channel = 3930;

// Add the desired date to the querystring
$qs = "date=2012-10-29";

// If this Tour used Hotel type pricing we'd append a duration
// $qs .= "&hdur=7";

// Append the number of people for each rate
// Rate details obtained via "Show Tour" API
// Numbers of people likely via user input
// Here we just want 2 people on rate "r1"
$qs .= "&r1=2";

// Query the TourCMS API
$result = $tourcms->check_tour_availability($qs, $tour, $channel);

// See how many available components TourCMS has returned
if(isset($result->available_components->component))
  $num_components = count($result->available_components->component);
else
  $num_components = 0;

// If there are components display them, otherwise display "no availability"
if($num_components>0)
{
  // We have some components, loop through them
  foreach ($result->available_components->component as $component)
  {
    print $component->date_code . " ";
    print $component->total_price_display . "<br />";
  }
} else {
  // The components we searched for are not available
  print "Sorry, no availability";
}

09:00-12:30 £100
13:00-16:30 £110

C# examples use the .Net Client Library

Overload list

XmlDocument CheckTourAvailability (String queryString, int tourId, int channelId)

Parameters

queryString

See querystring parameters table below

tourId

Id number for the Tour we want to check availability for

channelId

The channel the Tour belongs to

VB examples use the .Net Client Library

Overload list

XmlDocument CheckTourAvailability (String queryString, Integer tourId, Integer channelId)

Parameters

queryString

See querystring parameters table below

tourId

Id number for the Tour we want to check availability for

channelId

The channel the Tour belongs to

NodeJS examples use the NodeJS Wrapper

Example

// Check availability for 2x Rate 1, 1st Jan 2017 on Tour ID 6
TourCMS.checkTourAvailability({
  channelId: 3930,
  qs: {
    id:1,
    date: '2017-12-21',
    r1:2
  },
  callback: function(response) {

    if (response.available_components.component.length == 0)
      console.log("No availability");
    else{
      //Loop through each component and output its component key
      response.available_components.component.forEach(function(component) {
        console.log("component key: " + component.component_key);
      });
    }
  }
});

Outputs the component key for each result

Looking for sample code in a different language? TourCMS and community provided API libraries

Implementing yourself? Check the REST info for this endpoint.