home > support > API > Marketplace API > API: tour_tier_list
List a tour tiers
Lists a tour tiers.
Notes
For Tour Operator usage only (not accessible by Marketplace Agents).
REST info
| Endpoint | /api/tours/tour_tiers/tour_tier_list |
| Formats | XML |
| Example | /api/tours/tour_tiers/tour_tier_list |
| Verb | POST |
Code samples
PHP examples use the PHP Client Library with the return type set to SimpleXML
Description
object list_tiers(SimpleXmlElement $tier, int $channel)
Parameters
- $tier
- SimpleXmlElement containing the tiers data.
- $channel
- ID number for the channel this tours which tiers belongs to.
Example
// Create a new SimpleXMLElement with tier details.
$tier = new SimpleXMLElement('<tier />');
$tier->addChild('tier_type', 'tour_tier');
$tier->addChild('tour_id', 307);
$tier->addChild('active', 5);
// Define the channel ID the tour belongs to.
$channel = 3930;
// Call TourCMS API, listing all the tour tier.
$result = $tourcms->get_tier($tier, $channel);
if ($result->error == "OK") {
print "Tour Tiers found";
} else {
print $result->error;
}
Tour Tiers ListLooking for sample code in a different language? TourCMS and community provided API libraries
Try it
Enter your TourCMS API credentials below to call the List Tour Tiers endpoint.
Take care, submitting this form will modify live data!
Querystring parameters
There are no querystring parameters.
Post fields
The following fields can be posted as XML when calling the API method. All are required fields for their specific tier types.
| XML NODE | Notes | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| tier |
Tour Level tier node contains:
Rate Level tier node contains:
Departure Level tier node contains:
|
Response fields
| XML Node | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| request | Confirmation of the request that you sent | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| error | Any error message returned, if there is no error this will just contain the text OK | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| errors |
Optional field. Only if there are errors. Array of childs error. With the field is not valid and a description of the error. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tiers |
Tiers node contains all the tour tiers:
|