home > support > API > Marketplace API > API: Tours Search Criteria
Tours Search Criteria
Return the tour tags selected for the tours of a channel, as well as its locations
Notes
Can be used by both Tour Operators and Marketplace Agents
REST info
| Call | /api/tours/search_criteria/get |
| Formats | XML |
| Example | /api/tours/search_criteria/get.xml |
| Verb | GET |
Code
PHP examples use the PHP Client Library with SimpleXML
Description
object tours_search_criteria ( int $channel )
Parameters
- $channel
- ID for the Channel - required
Example
// Channel ID of the Tour
$channel = 6;
// Request the criteria for one channel
$result = $tourcms->tours_search_criteria($channel);
// Go straight to the main node
$availableCriteria = $result->tour_search_criteria;
// Print out the labels for different criteria
foreach ($availableCriteria->criteria as $criteria) {
print 'Criteria Name - '.$criteria->name;
}Criteria Name - Location
Criteria Name - Tour Tags
Try it
Enter your TourCMS API credentials below to call the Search Tours Criteria endpoint.
Querystring parameters
There are no querystring parameters.
Response fields
| 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 | ||||||||||||||||||||
| error_message | User friendly message with a more detailed explanation | tour_search_criteria |
The tour_search_criteria node contains the following child nodes.
|