Update Booking

PHP examples use the PHP Client Library with SimpleXML

Description

object update_booking ( SimpleXmlElement $booking_data, int $channel )

Parameters

$booking_data

SimpleXmlElement containing the booking data (must include booking ID)

$channel

ID number for the channel the booking belongs to

Example

// Set the channel ID
$channel = 3;

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

// Must set the Booking ID on the XML, so TourCMS knows which to update
$booking->addChild('booking_id', '12345');

// Provide their special request information
$booking->addChild('customer_special_request', 'Please can we have a ground floor room');

// Call TourCMS API, updating the booking
$result = $tourcms->update_booking($booking, $channel);

// Check the result, will be "OK" if a booking was updated
switch ($result->error) {
    case "OK":
		// Print a success message
	    print "Thanks, your booking details have been updated.";
	    break;
	case "NO DATA CHANGED":
		// Nothing was changed, old data matched new data
	    print "Thanks, it looks like we have your request already!";
	    break;
	default:
		// Some other problem (could check error to see what)
	    print "Sorry, unable to update your booking details at this time.";
	    break;
}

Thanks, your booking details have been updated.

C# examples use the .Net Client Library

Overload list

XmlDocument UpdateBooking ( XmlDocument bookingData, int channelId )

Parameters

bookingData

XmlDocument containing the booking data (must include booking ID). See "Post fields" table below for full list.

channelId

ID number for the channel the booking belongs to

Example

// Set the ID for the channel this booking is made with
int channelId = 3;

 // Create an XMLDocument to hold the booking details
XmlDocument bookingData = new XmlDocument();

// Create the XML Declaration, append it to XML document
XmlDeclaration dec = bookingData.CreateXmlDeclaration("1.0", null, null);
bookingData.AppendChild(dec);

// Create the root element, append it to the XML document
XmlElement root = bookingData.CreateElement("booking");
bookingData.AppendChild(root);

// Must set the Booking ID so TourCMS knows which booking to update
XmlElement bookingId = bookingData.CreateElement("booking_id");
bookingId.InnerText = "12345";
root.AppendChild(bookingId);

// Now set any details that need updating
// Here we'll update the "Special request"
XmlElement req = bookingData.CreateElement("customer_special_request");
req.InnerText = "Please can we have a ground floor room";
root.AppendChild(req);

// Send the data to the TourCMS API, updating the Booking
XmlDocument doc = myTourCMS.UpdateBooking(bookingData, channelId);

// Check the status
// Will be "OK" if the booking was updated
// "NO DATA CHANGED" if the new data matched the old, etc
string status = doc.SelectSingleNode("//error").InnerText;

Console.WriteLine(status);

OK

VB examples use the .Net Client Library

Overload list

XmlDocument UpdateBooking ( XmlDocument bookingData, Integer channelId )

Parameters

bookingData

XmlDocument containing the booking data (must include booking ID). See "Post fields" table below for full list.

channelId

ID number for the channel the booking belongs to

Example

' Set the ID for the channel this booking is made with
Dim channelId As Integer = 3

' Create an XMLDocument to hold the booking details
Dim bookingData As XmlDocument = new XmlDocument()

' Create the XML Declaration, append it to XML document
Dim dec As XmlDeclaration = bookingData.CreateXmlDeclaration("1.0", null, null)
bookingData.AppendChild(dec)

' Create the root element, append it to the XML document
Dim root As XmlElement = bookingData.CreateElement("booking")
bookingData.AppendChild(root)

' Must set the Booking ID so TourCMS knows which booking to update
Dim bookingId As XmlElement = bookingData.CreateElement("booking_id")
bookingId.InnerText = "12345"
root.AppendChild(bookingId)

' Now set any details that need updating
' Here we'll update the "Special request"
Dim req As XmlElement = bookingData.CreateElement("customer_special_request")
req.InnerText = "Please can we have a ground floor room"
root.AppendChild(req)

' Send the data to the TourCMS API, updating the Booking
Dim doc As XmlDocument = myTourCMS.UpdateBooking(bookingData, channelId)

' Check the status
' Will be "OK" if the booking was updated
' "NO DATA CHANGED" if the new data matched the old, etc
Dim status As String = doc.SelectSingleNode("//error").InnerText

Console.WriteLine(status)

OK

NodeJS examples use the NodeJS Wrapper

Example

// This example sets the Customer Special Request field on the booking
TourCMS.updateBooking({
  channelId: 3930,
  booking: {
    booking_id: 1234,
    customer_special_request: "Please can we have a ground floor room"
  },
  callback: function(response) {
    console.log(response.error);
  }
});

OK

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

Implementing yourself? Check the REST info for this endpoint.