home > support > API > Marketplace API > tours_pickup_routes_pickup_delete
Delete Pickup in Tour Pickup Route
Delete a pickup in a pickup route of a tour.
Notes
For Tour Operator usage only (not accessible by Marketplace Agents).
REST info
| Endpoint | /api/tours/pickup/routes/pickup_delete |
| Formats | XML |
| Example | /api/tours/pickup/routes/pickup_delete.xml |
| Verb | POST |
Code samples
PHP examples use the PHP Client Library with the return type set to SimpleXML
Description
tours_pickup_routes_delete_pickup($data, $channel)
Parameters
- $data
- SimpleXmlElement containing the pickup and route data (must include tour ID, route ID, pickup ID and unique ID)
- $channel
- ID number for the channel the pickup route belongs to.
Example
// Create a new SimpleXMLElement to hold the pickup details
$data = new SimpleXMLElement('<pickup/>');
$data->addChild('tour_id', 70);
$data->addChild('route_id', 2);
$data->addChild('unique_id', 111);
// Define the channel ID the pickup route belongs to.
$channel = 3930;
// Call TourCMS API, getting the pickup routes and their pickup points.
$result = $tourcms->tours_pickup_routes_delete_pickup($data, $channel);
// Check the result, will be "OK" if a route was deleted
switch ($result->error) {
case "OK":
// Print a success message
print "Thanks, your pickup has been removed from the tour pickup route.";
break;
case "NOTOK":
// Some other problem (could check error to see what)
print $result->error_message;
break;
}
Thanks, your pickup has been deleted.
Looking for sample code in a different language? TourCMS and community provided API libraries
Querystring parameters
PHP examples use the PHP Client Library with the return type set to SimpleXML
Description
tours_pickup_routes_delete_pickup($data, $channel)
Parameters
- $data
- SimpleXmlElement containing the pickup and route data (must include tour ID, route ID, pickup ID and unique ID)
- $channel
- ID number for the channel the pickup route belongs to.
Example
// Create a new SimpleXMLElement to hold the pickup details
$data = new SimpleXMLElement('<pickup/>');
$data->addChild('tour_id', 70);
$data->addChild('route_id', 2);
$data->addChild('unique_id', 111);
// Define the channel ID the pickup route belongs to.
$channel = 3930;
// Call TourCMS API, getting the pickup routes and their pickup points.
$result = $tourcms->tours_pickup_routes_delete_pickup($data, $channel);
// Check the result, will be "OK" if a route was deleted
switch ($result->error) {
case "OK":
// Print a success message
print "Thanks, your pickup has been removed from the tour pickup route.";
break;
case "NOTOK":
// Some other problem (could check error to see what)
print $result->error_message;
break;
}Thanks, your pickup has been deleted.Looking for sample code in a different language? TourCMS and community provided API libraries
There are no querystring parameters.
Post fields
The following fields can be posted as XML when calling the API, all fields are required fields.
Any fields not present in the XML will not be deleted, to clear a field you will need to delete 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.
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 |