Search Bookings

PHP examples use the PHP Client Library with SimpleXML

Description

object search_bookings ( [ string $params = "" [, int $channel = 0 ]] )

Parameters

$params

Search querystring, see possible values in the table below

$channel

Channel to search, 0/blank for all connected channels

Example

// Tour Operators set their channel here
// Marketplace Partners can optionally set the Channel ID
// Here we set to 0 for all connected channels
$channel = 0;

// Optionally define search parameters
// Here we are just returning active (not cancelled / expired) bookings
$params = "active=1";

// Query the TourCMS API
$result = $tourcms->search_bookings($params, $channel);

// Loop through each booking
foreach($results->booking as $booking) {
  // Print out the booking ID and channel name
  print $booking->booking_id." - ".$booking->channel_name." > ";

  // Print out the booking name and revenue
  print $booking->booking_name." (".$booking->sales_revenue_display.")";
  print "<br />";
}

12345 - Example Tours > Highland Walk (£599.00)
99281 - Adventure Co > Half day rafting (£99.00)

C# examples use the .Net Client Library

Overload list

XmlDocument SearchBookings ()

XmlDocument SearchBookings (string queryString)

XmlDocument SearchBookings (string queryString, int channelId)

Parameters

queryString

Optional, filter by querystring (see table of parameters below)

channelId

Optional, bookings from a single channel

Example

// Optionally set the Channel ID
// Here we set to 0 for all connected channels
int channelId = 0;

// Optionally define search parameters
// Here we are just returning active (not cancelled / expired) bookings
string queryString = "active=1";

// Query the TourCMS API
XmlDocument doc = myTourCMS.SearchBookings(queryString, channelId);

// Display Booking list
XmlNodeList bookingList = doc.GetElementsByTagName("booking");
foreach (XmlNode booking in bookingList)
{
 // Booking ID
 string bId = booking.SelectSingleNode("booking_id").InnerText;
 // Channel Name
 string cName = booking.SelectSingleNode("channel_name").InnerText
 // Booking Name
 string bName = booking.SelectSingleNode("booking_name").InnerText
 // Booking Revenue
 string bRev = booking.SelectSingleNode("sales_revenue_display").InnerText

 Console.WriteLine(bId + " " + cName + " - " + bName + "(" + bRev + ")");
} 

12345 Example Tours - Highland Walk (£599.00)
99281 Adventure Co - Half day rafting (£99.00)

VB examples use the .Net Client Library

Overload list

XmlDocument SearchBookings ()

XmlDocument SearchBookings (String queryString)

XmlDocument SearchBookings (String queryString, Integer channelId)

Parameters

queryString

Optional, filter by querystring (see table of parameters below)

channelId

Optional, bookings from a single channel

Example

' Optionally set the Channel ID
' Here we set to 0 for all connected channels
Dim channelId As Integer = 0

' Optionally define search parameters
' Here we are just returning active (not cancelled / expired) bookings
Dim queryString As String = "active=1"

' Query the TourCMS API
Dim doc As XmlDocument = myTourCMS.SearchBookings(queryString, channelId)

' Display Booking list
Dim bookingList As XmlNodeList = doc.GetElementsByTagName("booking")

For Each booking As XmlNode In bookingList
{
 ' Booking ID
 Dim bId As String = booking.SelectSingleNode("booking_id").InnerText
 ' Channel Name
 Dim cName As String = booking.SelectSingleNode("channel_name").InnerText
 ' Booking Name
 Dim bName As String = booking.SelectSingleNode("booking_name").InnerText
 ' Booking Revenue
 Dim bRev As String = booking.SelectSingleNode("sales_revenue_display").InnerText

 Console.WriteLine(bId & " " & cName & " - " & bName & "(" & bRev & ")")
} 

12345 Example Tours - Highland Walk (£599.00)
99281 Adventure Co - Half day rafting (£99.00)

NodeJS examples use the NodeJS Wrapper

Example

// Search for bookings made in the first two weeks of January 2016.
TourCMS.searchBookings({
	channelId: 3930,
	qs: {
		made_date_start: "2016-01-01",
		made_date_end: "2016-01-14"
	},
	callback: function(response) {
		response.booking.forEach(function(booking) {
			console.log(booking.booking_id)
		})
	}
});

1234
1235

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