home > support > API > Marketplace API > API: show_tours_pickup_routes
Show Tour Pickup Routes
Show pickup routes and pickup points of tour.
Notes
For Tour Operator and Marketplace Partners accounts usage.
REST info
| Endpoint | /api/tours/pickup/routes/show |
| Formats | XML |
| Example | /api/tours/pickup/routes/show |
| Verb | GET |
Code samples
PHP examples use the PHP Client Library with the return type set to SimpleXML
Description
show_tours_pickup_routes($tour, $channel)
Parameters
- $tour
- ID number for the tour.
- $channel
- ID number for the channel the pickup routes belongs to.
Example
// Define the ID of the tour
$tour = 1;
// Define the channel ID the pickup routes belongs to.
$channel = 3930;
// Call TourCMS API, getting the pickup routes and their pickup points.
$result = $tourcms->show_tours_pickup_routes($tour, $channel);
foreach ($response->pickup_routes->pickup_route as $pickup_route) {
print 'ROUTE CODE: '.(string) $pickup_route->route_code.', TIME RANGE START: '.(string) $pickup_route->time_range_start.PHP_EOL;
}
ROUTE CODE: 123, TIME RANGE START: 00:55
ROUTE CODE: 456, TIME RANGE START: 01:10
ROUTE CODE: 789, TIME RANGE START: 01:00
Looking for sample code in a different language? TourCMS and community provided API libraries
Try it
Enter your TourCMS API credentials below to call the Show Tour Pickup Routes endpoint.
Querystring parameters
PHP examples use the PHP Client Library with the return type set to SimpleXML
Description
show_tours_pickup_routes($tour, $channel)
Parameters
- $tour
- ID number for the tour.
- $channel
- ID number for the channel the pickup routes belongs to.
Example
// Define the ID of the tour
$tour = 1;
// Define the channel ID the pickup routes belongs to.
$channel = 3930;
// Call TourCMS API, getting the pickup routes and their pickup points.
$result = $tourcms->show_tours_pickup_routes($tour, $channel);
foreach ($response->pickup_routes->pickup_route as $pickup_route) {
print 'ROUTE CODE: '.(string) $pickup_route->route_code.', TIME RANGE START: '.(string) $pickup_route->time_range_start.PHP_EOL;
}ROUTE CODE: 123, TIME RANGE START: 00:55
ROUTE CODE: 456, TIME RANGE START: 01:10
ROUTE CODE: 789, TIME RANGE START: 01:00Looking for sample code in a different language? TourCMS and community provided API libraries
Try it
Enter your TourCMS API credentials below to call the Show Tour Pickup Routes endpoint.
| Parameter | Notes |
|---|---|
| id | Tour ID. If using a wrapper library this will be passed as a separate argument. |
The Channel ID is also passed via the request header, this is required as Tour IDs are unique within a particular channel (supplier) rather than being unique system wide.
Response fields
| XML Node | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| request | Confirmation of the request that you sent | ||||||||||||||||||||||||||||||||||||||||||||||||
| error | Error status OK/NOTOK | ||||||||||||||||||||||||||||||||||||||||||||||||
| error_message | Any error message returned. Will only be returned if error is NOTOK | ||||||||||||||||||||||||||||||||||||||||||||||||
| tour_id | Tour ID | ||||||||||||||||||||||||||||||||||||||||||||||||
| channel_id | Channel ID | ||||||||||||||||||||||||||||||||||||||||||||||||
| pickup_routes |
Pickup route node contains:
|