Search Enquiries

PHP examples use the PHP Client Library with SimpleXML

Description

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

Parameters

$params

Search query string, see possible values in the table below

$channel

Channel to search, Partners can set to 0/blank for all connected

Example

// Set the channel we want the enquiries from
// For tour operators this will be their channel ID
// For Marketplace Partners this can be set to return just enquiries
// from a particular channel or 0 to search all channels
$channel = 3;

// Optionally define search parameters
// Here we're searching for Enquiries made in April 2011
$params = "made_date_start=2011-04-01&made_date_end=2011-04-30";

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

// Loop through each Enquiry and output the Enquiry ID and Status text
foreach($result->enquiry as $enquiry)
	print $enquiry->enquiry_id . " - ". $enquiry->status_text . "<br />";

12345 - Triage
12344 - Open

C# examples use the .Net Client Library

Overload list

XmlDocument SearchEnquiries ()

XmlDocument SearchEnquiries (string queryString)

XmlDocument SearchEnquiries (string queryString, int channelId)

Parameters

queryString

Search query string, see possible values in the table below

channelId

Channel to search, Partners can set to 0/blank for all connected

Example

// Set the channel we want the enquiries from
// For tour operators this will be their channel ID
// For Marketplace Partners this can be set to return just enquiries
// from a particular channel or 0 to search all channels
int channel = 3;

// Optionally define search parameters
// Here we're searching for Enquiries made since 1st April 2011
string queryString = "made_date_start=2011-04-01";

// Call the API
XmlDocument doc = myTourCMS.SearchEnquiries(queryString, channelId);

// Check the response status
string status = doc.SelectSingleNode("//error").InnerText;
if ( status == "OK" )
{
  // Loop through each Enquiry and output the Enquiry ID and Status text
  XmlNodeList enquiryList = doc.GetElementsByTagName("enquiry");
  foreach ( XmlNode enquiry in enquiryList )
  {
    string enquiryId = enquiry.SelectSingleNode("enquiry_id").InnerText;
    string enquiryStatus = enquiry.SelectSingleNode("status_text").InnerText;
    Console.WriteLine(enquiryId   " - "   enquiryStatus);
  }
} else {
  Console.WriteLine("Error: "   status);
} 

12345 - Triage
12344 - Open

VB examples use the .Net Client Library

Overload list

XmlDocument SearchEnquiries ()

XmlDocument SearchEnquiries (String queryString)

XmlDocument SearchEnquiries (String queryString, Integer channelId)

Parameters

queryString

Search query string, see possible values in the table below

channelId

Channel to search, Partners can set to 0/blank for all connected

Example

' Set the channel we want the enquiries from
' For tour operators this will be their channel ID
' For Marketplace Partners this can be set to return just enquiries
' from a particular channel or 0 to search all channels
Dim channel As Integer = 3

' Optionally define search parameters
' Here we're searching for Enquiries made since 1st April 2011
Dim queryString As String = "made_date_start=2011-04-01"

' Call the API
Dim doc As XmlDocument = myTourCMS.SearchEnquiries(queryString, channelId)

' Check the response status
Dim status As String = doc.SelectSingleNode("//error").InnerText

If status = "OK" Then

  ' Display Some information on each Enquiry
  Dim enquiryList As XmlNodeList = doc.GetElementsByTagName("enquiry")

  For Each enquiry As XmlNode In enquiryList
    Dim enqId As string = enquiry.SelectSingleNode("enquiry_id").InnerText
    Dim enqStat As string = enquiry.SelectSingleNode("status_text").InnerText
    Console.WriteLine(enqId & " - " & enqStat)
  Next

Else

  Console.WriteLine("Error: "   status)

End If

12345 - Triage
12344 - Open

NodeJS examples use the NodeJS Wrapper

Example

// Search for all enquiries made in the first two weeks of Jan 2016
TourCMS.searchEnquiries({
  channelId: 3930,
  qs: {
    made_date_start: "2016-01-01",
    made_date_end: "2016-01-14"
  },
  callback: function(response) {
    console.log("Found " + response.enquiry.length + " enquiries");
  }
});

Found 2 enquiries

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