Rate limit status

PHP examples use the PHP Client Library with the return type set to SimpleXML

Description

object api_rate_limit_status ( [ int $channel = 0 ] )

Parameters

$channel
	Suppliers use your Channel ID. Partners leave blank / zero

Example

// Set the Channel ID 
// For Suppliers this can be found in the API settings page 
// For Partners this will be 0 
$channel_id = 0; 

// Query the TourCMS API
$result = $tc->api_rate_limit_status($channel_id);

// Print out the remaining hits 
print  'Remaining hits: '.$result->remaining_hits;

Remaining hits: 500

C# examples use the .Net Client Library

Overload list

XmlDocument ApiRateLimitStatus ()

XmlDocument ApiRateLimitStatus (int channelId)

Parameters

channelId
	Suppliers use your Channel ID. Partners leave blank / zero

Example

// Set the Channel ID
// For Suppliers this can be found in the API settings page
// For Partners this will be 0
int channelId = 0;
 
// Query the TourCMS API
XmlDocument doc = myTourCMS.ApiRateLimitStatus(channelId);
 
// Print out the remaining hits
string lim = doc.GetElementsByTagName("remaining_hits")[0].innerText;
Console.WriteLine("Remaining hits: " + lim);

Remaining hits: 500

VB examples use the .Net Client Library

Overload list

XmlDocument ApiRateLimitStatus ()

XmlDocument ApiRateLimitStatus (int channelId)

Parameters

channelId
	Suppliers use your Channel ID. Partners leave blank / zero

Example

' Set the Channel ID
' For Suppliers this can be found in the API settings page
' For Partners this will be 0
Dim channelId As Integer = 0
  
' Query the TourCMS API
Dim doc As XmlDocument = myTourCMS.ApiRateLimitStatus(channelId)
  
' Print out the remaining hits
Dim lim As String = doc.GetElementsByTagName("remaining_hits")(0).InnerText
Console.WriteLine("Remaining hits: " & lim)

Remaining hits: 500