Search Vouchers

PHP examples use the PHP Client Library with SimpleXML

Description

object search_voucher ( SimpleXmlElement $voucher_data [, int $channel = 0 ] )

Parameters

$voucher_data

XML containing the voucher info to search, currently just the barcode data

$channel

If authenticating as an operator use their Channel ID, Agents skip this / pass 0

Example

// Tour Operators set their channel here
// Marketplace Agents don't need to specify one
// Used for API authentication only, not searching bookings
$channel = 0;

// Create a new SimpleXMLElement to hold the voucher details
$voucher_data = new SimpleXMLElement('<voucher />');

// Include the contents of the barcode
$voucher_data->addChild('barcode_data', '12345');

// Query the TourCMS API
$results = $tourcms->search_voucher($voucher_data, $channel);

// Loop through each booking
foreach($results->booking as $booking) {

  // If the booking is valid
  if($booking->booking_valid == "OK") {

	  // Print out the booking ID
	  print $booking->booking_id

	  // Loop through all the components on the booking
	  foreach($booking->component as $component) {
	  	// Output the tour name and redemption status
	  	print " " . $component->name;
	  	print " (" .  $component->voucher_redemption_status . ")";

	  }
  } else {

      // There is some problem with the booking
      print $booking->booking_id . " " . $booking->booking_valid_reason;

  }
}

123455 - Half day rafting (1)
123456 - Half day rafting (0) Off-road (1)
123457 - BOOKING NOT CONFIRMED
123458 - Half day rafting (1)

C# examples use the .Net Client Library

VB examples use the .Net Client Library

NodeJS examples use the NodeJS Wrapper

Example

// Search for vouchers containing the text VOUCHER_STRING_HERE
// the wideDates param being set to 1 causes TourCMS to include dates other than today in the search
TourCMS.searchVouchers({
  channelId: 3930,
  voucherString: "VOUCHER_STRING_HERE",
  wideDates: 1,
	callback: function(response) {
		console.log("Found " + response.booking.length + " bookings")
	}
});

Found 2 bookings

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