home > support > API > Marketplace API > update_tours_pickup_routes
Update a pickup route of a tour.
For Tour Operator usage only (not accessible by Marketplace Agents).
Endpoint | /api/tours/pickup/routes/update |
Formats | XML |
Example | /api/tours/pickup/routes/update.xml |
Verb | POST |
PHP examples use the PHP Client Library with the return type set to SimpleXML
update_tours_pickup_routes($data, $channel)
// Create a new SimpleXMLElement to hold the route details
$data = new SimpleXMLElement('<route/>');
$data->addChild('tour_id', 70);
$data->addChild('route_id', 2);
$data->addChild('route_code', 'TEST');
// Define the channel ID the pickup route belongs to.
$channel = 3930;
// Call TourCMS API, getting the pickup routes and their pickup points.
$result = $tourcms->update_tours_pickup_routes($data, $channel);
// Check the result, will be "OK" if a route was updated
switch ($result->error) {
case "OK":
// Print a success message
print "Thanks, your route details have been updated.";
break;
case "NOTOK":
// Some other problem (could check error to see what)
print $result->error_message;
break;
}
Thanks, your route details have been updated.
Looking for sample code in a different language? TourCMS and community provided API libraries
There are no querystring parameters.
The following fields can be posted as XML when calling the API, the tour_id and route_id are the only required fields.
Any fields not present in the XML will not be updated, to clear a field you will need to add it to the XML but leave it's contents blank.
XML Node | Notes | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
route |
The root XML element, can contain any of the following child nodes.
|
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.
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_route |
Each pickup route node contains the following child nodes.
|