API 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.
Agents leave blank / zero or pass a specific channel to check your remaining limit for that channel.

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 for GET and POST requests
print  'GET remaining hits: ' . $result->remaining_hits;
print  'POST remaining hits: ' . $result->remaining_hits_post;

GET remaining hits: 500 
POST remaining hits: 1900

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 for GET and POST requests
string limGET = doc.GetElementsByTagName("remaining_hits")[0].innerText;
string limPOST = doc.GetElementsByTagName("remaining_hits_post")[0].innerText;
Console.WriteLine("GET remaining hits: " + limGET);
Console.WriteLine("POST remaining hits: " + limPOST);

GET remaining hits: 500 
POST remaining hits: 1900

VB examples use the .Net Client Library

Overload list

XmlDocument ApiRateLimitStatus ()

XmlDocument ApiRateLimitStatus (Integer ChannelId)

Parameters

channelId

Operators use your Channel ID. Agents 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 for GET requests
Dim limGET As String = doc.GetElementsByTagName("remaining_hits")(0).InnerText
Dim limPOST As String = doc.GetElementsByTagName("remaining_hits_post")(0).InnerText
Console.WriteLine("GET remaining hits: " & limGET)
Console.WriteLine("POST remaining hits: " & limPOST)

GET remaining hits: 500 
POST remaining hits: 1900

NodeJS examples use the NodeJS Wrapper

Example

// Set the Channel ID

// For Operators this can be found in the API settings page

// For Marketplace Agents this can be 0 for general API calls
// or set to a ChannelID to see how many calls remain on that Channel

var channelId = 0;

// Query the TourCMS API
TourCMS.apiRateLimitStatus({
	channelId: channelId,
	callback: function(response) {
		console.log("GET remaining hits: " + response.remaining_hits);
		console.log("POST remaining hits: " + response.remaining_hits_post);
	}
})

GET remaining hits: 500 
POST remaining hits: 1900

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

Implementing yourself? Check the REST info for this endpoint.