TourCMS, a leading online booking and channel management solution is operated by Palisis.

Contact Info

Palisis AG
Florastrasse 18A
8610 Uster
support@palisis.com
+41 44 533 40 40

Follow Us

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
FormatsXML
Example/api/tours/pickup/routes/show
VerbGET

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

Querystring parameters

Querystring parameters
ParameterNotes
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

Response fields
XML NodeNotes
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:

XML NodeNotes
pickup_route

There will be one pickup route node for each result on this page.
Each pickup route node contains the following child nodes.

XML NodeNotes
route_id The pickup route ID
route_code The code of the pickup route
time_range_start Tour starting between time range start. e.g. "11:55". Can be blank if no time selected.
time_range_end Tour starting between time range end. e.g. "13:15". Can be blank if no time selected.
pickup_points

Pickup points node contains:

XML NodeNotes
pickup_point

There will be one pickup point node for each result on this page.
Each pickup point node contains the following child nodes.

If called by partner, only will return pickup points that are staff_only = 0.

XML NodeNotes
unique_id The pickup member ID
pickup_id The pickup point ID
supplier_pickup_code Allows subsystem mapping of pickups
time Pickup time. e.g. "09:45". Can be blank if no time selected.
pickup_name The name of the pickup point
description Any extra information for the client, e.g. "Meet in the reception lounge"
address1 First line of the address
address2 Second line of the address
postcode Postcode
lat Latitude - geographic coordinate
long Longitude - geographic coordinate
geocode Lat,Lng geographic point. Sample - (1.23,4,56)
staff_only Only returned if called as operator

More information