xtour

A specific action to add fixations to the current plan. If at least one of the fixations references the ID of a nonexistent object, an exception is thrown and none of the fixations is added. If one of the fixations is already existing in the current plan, no exception is thrown but the fixation is just ignored.

A specific action to create a single trip of specified orders for a specified vehicle instance. The trip can be created for an unplanned vehicle or within a tour of an already planned vehicle. For an AddTripAction at a specified position a trip of at least one order is created even if the resulting tour becomes invalid but remains structurally valid.

A specific action to add trip start intervals to the current plan. If at least one of the trip start intervals references the trip ID of a nonexistent trip or if a trip start interval is added again for the same trip ID, an exception is thrown and none of the trip start intervals is added.

A break interval is a time interval together with the required duration of the break that shall be scheduled within the interval. Such a break may be scheduled en route between stops. Due to the fact that service time is never split, the driver may have to wait at a stop for the beginning of the next break interval and only begin with the service after the break.

The abstract base type for all specified actions to change tours.

A ChangeToursProposal contains a ChangeToursAction with information about the resulting ToursResponse if the change would be applied to the tour plan.

Options for the propose ChangeToursAction operation.

The abstract base type for all specified actions to propose ChangeToursActions.

Contains the result of a FindChangeToursProposalsRequest.

The request object for the service method changeTours. For further information please have a look at the technical concept Change Tours.

A specific action to change the vehicle of a tour. Either an unused vehicle can be assigned to a tour or a vehicle swap between two tours can be executed with this action. The assignment of drivers to vehicles remains unchanged, i. e. the driver changes together with the vehicle.

The compartment access restriction is needed if the corresponding vehicle has two special compartments, called compartments A and B in the following, and one compartment can only be accessed through the other compartment. It is specified for each maximum quantity scenario of the corresponding vehicle whether compartment A can only be accessed through compartment B or the other way around. In order to access the separate compartment (whether A or B) for picking up goods or delivering them, the load in the walk-through compartment (whether B or A) in relation to its capacity must not exceed a certain load threshold. If this restriction is used, the compartment quantity indices must also be set. The restriction is complied with if a feasible sequence of the pickup and delivery operations exists at every stop (first unloading the walk-through compartment, then unloading the separate compartment, then loading the separate compartment, then loading the walk-through compartment). However, the tasks of a stop do not get sorted accordingly. See the technical concept page for details on the compartment access restriction.

A vehicle can have two special compartments, called compartments A and B in the following, where one compartment can only be accessed through the other compartment. Depending on the compartment setup of a maximum quantity scenario of the vehicle, compartment A can only be accessed through compartment B or the other way around. Each compartment is specified by an index that refers to the quantities of the maximum quantity scenarios and the transport orders. Specifying the compartment quantity indices is mandatory if a compartment access restriction is defined for a vehicle. See the technical concept page for details on the compartment access restriction.

Cost related information describing tours or trips. The cost report contains accumulated values describing its parent object, which is either a tour response, a tour report or a trip report.

A specific site representing a customer location.

A specific site representing a depot. Depots act as trip delimiters. See Tours and Trips.

A driver is always assigned to a specific vehicle instance and may not always be available to operate it. To be precise, a driver can only operate the corresponding vehicle instance within given time intervals. In addition, it may be specified how long the driver has already worked.

If not all route locations are part of the existing distance matrix, this distance mode can be used to indicate reference locations for each location. The distance matrix has to contain every reference location that is necessary for tour planning, otherwise an exception is thrown. For example, the distance matrix can be calculated by a createDistanceMatrix request.

The current state of a tour in execution. The work logbook summary specified at the driver of the given vehicle is overridden.

Use an existing distance matrix per vehicle, for example from a createDistanceMatrix request. For distance mode ExistingDistanceMatrixPerVehicle, each vehicle has to have its own distance matrix ID set. If a vehicle does not have any distance matrix ID, an exception is thrown.

The request object for the service method proposeChangeToursActions.

Different kinds of fixations that are considered during planning as additional restrictions.

A fleet consisting of vehicles that are available to transport goods or perform visits.

A list of tours that serves the algorithm as start solution (e.g. tours of previous responses). All tours of an input plan have to be structurally valid. See Tours and Trips for a description of valid tour structures. The input tours can generally be changed or dissolved except when they are fixed. Violated input tours cannot be changed and appear unchanged in the response with their tour events containing tour violations.

This type defines the insertion position of a task, stop or trip after a specified position.

This type defines the insertion position of a task, stop or trip at the best position. If no valid position can be found, the IDs of the respective orders are added to orderIdsNotPlanned after performing the ChangeToursAction.

This type defines the insertion position of a task, stop or trip before a specified position.

This type defines the insertion position of a trip into an empty tour. It can be used in a MoveTripsAction to move a trip to an empty vehicle or by a AddTripAction to create a trip for an empty vehicle.

The abstract base type to define the insertion position of a task, stop or trip.

A query to propose insertion positions for unplanned orders. Only structurally valid positions are proposed, for details please have a look at tour structures. The proposed change tours actions are either add trip actions or move orders actions. If violated insertion positions shall be part of the proposals, set returnViolatedTours to true. The resulting tour is contained in the Tours and TourReports. This query may be used to analyze unscheduled orders, see the corresponding integration sample.

Contains information for the route between two successive sites of a tour. A leg is either between two stops of a trip, between two trips, between the vehicle start location and the first stop of the tour or between the last stop of a tour and the vehicle end location. For further information please have a look at the technical concept Tours and Trips.

The abstract base type for all kinds of locations. See Orders, Locations, and Stops.

A scenario for the maximum quantities of goods of different kind.

There may be some orders that shall not be mixed with some other orders on one trip. For instance, it may be prohibited to load certain dangerous goods together on the same trip, such as flammable solids on the one hand and explosive substances on the other hand. A mixed loading prohibition is a pair of two conflicting categories that prohibits orders of these categories to be mixed on the same trip. The category can be specified for every order. For a vehicle, there is a flag that lets the vehicle ignore this restriction.

Specifies options for calculating monetary costs for a vehicle. Cost totals are output in the cost reports of the response.

Contains the costs calculated on the basis of the monetary cost options of the vehicle(s). The implicit currency unit of the cost values is the same as for the monetary cost options of the vehicles. A monetary costs report may refer to a trip, a tour or the whole plan.

A specific action to move orders from unplanned orders or existing trips to an existing trip. Currently, a MoveOrdersAction cannot both contain visit and transport orders. If multiple orders of a stop shall be moved, use a MoveStopsAction. All specified insertion positions refer to the trip before performing this MoveOrdersAction.

The following conditions must be fulfilled or an exception will be thrown:

• If any order referenced by orderIds is a visit order, visitInsertionPosition must be set.
• If any order referenced by orderIds is a transport order, pickupInsertionPosition and deliveryInsertionPosition must be set.
• Unless the task's insertion position is of type insertion at best position, every task must have the same site unless the site is
  • equal to the site of the stop directly before the insertion position, or
  • equal to the site of the stop directly after the insertion position.

In case of moving an order of type OrderWithAlternativePickupDepots or OrderWithAlternativeDeliveryDepots the depot of the order can change if it is better to serve the order at a different depot.

A specific action to move consecutive stops from an existing trip to another existing trip. The stops may be moved within their original trip or to another trip. If the stops are moved to another trip, all partner tasks of tasks of the moved stops will be moved too. The insertion positions of the partner tasks in the target tour are implicitly defined. They are inserted at the closest existing stop at the according location or a new start/end depot is created. A new start/end depot may only be created if it is unambiguous, i.e. there is no other start/end depot already. For all other partner tasks, it is necessary that all their locations are already in the target trip. If the insertion position of the partner task is ambiguous, an AmbiguousInsertionPositionFault is thrown. If the stops are moved within their original trip, the partner tasks stay at their old position.

In case of moving stops that contain orders of type OrderWithAlternativePickupDepots or OrderWithAlternativeDeliveryDepots the depot of the order can change if it is better to serve the order at a different depot.

A specific action to move a trip to a specified position in an existing tour or to an empty vehicle. The trip may be moved within its original tour or to another tour. For certain special tour structures moving a trip could cause adjacent trips to become one trip. Such MoveTripsActions are currently not supported and throw an exception.

In case of moving a trip that contains orders of type OrderWithAlternativePickupDepots or OrderWithAlternativeDeliveryDepots the depot of the order can change if it is better to serve the order at a different depot.

This result limitation indicates that a request could not be properly moved for the objects listed in objectIds because no valid position was found.

A specific action to optimize the stop sequence of trips. Keep in mind that the optimization goal is to minimize the travel and driving time of the overall tour.

Base type for orders that should be carried out in the tours. See Orders, Locations, and Stops.

Defines strong preferences concerning order groups. They are considered in automatic planning. If these preferences are not met for an input plan or for a change tours action, they are not reported as a violation. For further information please have a look at the technical concept Order Groups. Currently, oneTripPerGroup can only be activated if oneGroupPerTrip is also activated, otherwise an exception is thrown.

A specific transport order that allows the goods to be delivered to alternative depot sites.

A specific transport order that allows the goods to be picked up at alternative depot sites.

A specific transport order that allows the goods to be picked up at one location and be delivered to a different location.

Contains global planning settings.

The request object for the service method planTours.

Driver and his vehicle are at a stop of the tour. If the trip with the given id starts at the given stop and the driver has arrived at the stop, then the corresponding TRIP_START event is returned in the tour events. If the trip with the given id ends at the given stop and the driver has completed his service, then the corresponding TRIP_END event is not returned and no trip report is created for this trip.

Position of the driver and his vehicle is still at the start of the tour.

Driver and his vehicle are currently en route between stops or between the vehicle start location and the first stop of the first trip. PositionEnRouteToStop may not be used before the first stop of the first trip if the tour does not start before this stop. An exception is thrown otherwise.

Driver and his vehicle are currently en route between the last stop of the tour and the vehicle end location. PositionEnRouteToVehicleEndLocation may not be used after the last stop of the last trip if the tour ends at this stop. An exception is thrown otherwise.

A mapping of a location that is part of the request to a route location. The route location is used as a reference, e.g. for distance calculation.

A specific action to remove fixations from the current plan. If at least one of the fixations references the ID of a nonexistent object, an exception is thrown and none of the fixations are removed. If one of the fixations is not in the current plan, no exception is thrown but the fixation is just ignored. If one of the fixations exists in the current plan multiple times, all occurences will be removed. However we do not distinguish between one or multiple occurences of a fixation.

A specific action to remove orders from the current plan. If removing the orders leads to an empty trip with a trip start interval, the trip start interval is also removed from the input plan.

A specific action to remove tours from the current plan. For each removed tour that contained a trip with a trip start interval, the trip start interval is also removed from the input plan.

A specific action to remove trip start intervals from the current plan. If at least one of the trip IDs references the ID of a nonexistent trip, an exception is thrown and none of the trip start intervals are removed. If for one of the trip ids no trip start interval is specified in the current plan, no exception is thrown but the trip ID is just ignored.

A specific action to remove trips from the current plan. For each removed trip with a specified trip start interval, the trip start interval is also removed from the input plan.

A specific location where goods can be picked up or delivered. This location is either a depot or a customer location. It is highly recommended to avoid multiple sites with the same members to improve performance and solution quality!

A stop groups subsequent tasks of a tour that are carried out at the same site. If there is more than one task at the same customer site, tasks are grouped to one stop and scheduled in order of their type: DELIVERY tasks before VISIT tasks before PICKUP tasks. If there is more than one task at the same depot site, all DELIVERY tasks are grouped to one stop and all PICKUP tasks are grouped to another one. See Orders, Locations, and Stops.

Identifies a stop by a trip ID and a position.

Each task of an order is carried out at a stop of a tour.

As an operation schedule for a single vehicle, a tour provides the information which tasks are carried out in which order by the specified vehicle respectively its driver. There is at most one tour per vehicle. A tour contains a sequence of trips. See Tours and Trips.

Different kinds of events that can happen during execution of a tour.

The base type for any progress that is returned from the tour planning algorithm. Currently we do not provide any kind of progress for that.

More detailed information about a tour, containing reports for each trip, an accumulated cost report and a list of events that occur along the tour.

Restrictions that can be set for a tour.

Violation related information describing tours. The tour violation report contains violation summaries of its parent object, which is a tour report.

The request object for the service method evaluateTours.

Contains the result of a PlanToursRequest, ChangeToursRequest or ToursInExecutionRequest. For the planTours case, all members refer to the complete plan. For the changeTours case, all members refer to the changed part of the plan. For the evaluateToursInExecution case, only the evaluated tours and their updated tour events are returned.

Order to transport goods from one depot site or customer site to another.

An operation schedule for a single trip. A trip contains the sequence of stops that are served. At the beginning and end of each trip the vehicle does not carry any load. A trip starts at the vehicle start location or at a depot, and ends at the vehicle end location or at a depot. See Tours and Trips.

More detailed information about a trip, containing an accumulated cost report.

Trip start interval in which the trip must start.

Violation related information describing trips. The trip violation report contains violation summaries of its parent object, which is a trip report.

Describes special tweaks to the objective of the algorithm.

A vehicle that is used to transport goods or perform visits. In transport use cases, vehicles are mostly trucks, for customer visits, also cars may be used. Several IDs can be specified to simplify the use of multiple vehicles that are of the same type.

A location representing a vehicle location. This location may be the start or end location of a vehicle in a tour.

Position of the driver and his vehicle in a tour in execution.

A query to propose other vehicles for a trip, that means moving a trip to a specified position in an existing tour or to an empty vehicle. Only structurally valid positions are proposed, for details please have a look at tour structures. If violated insertion positions shall be part of the proposals, set returnViolatedTours to true. The source tour of the trip to be moved (if not empty after the move) plus the resulting tour are contained in the TourReports.

Violation related information describing tours or trips. The violation report contains violation summaries of its parent object, which is either a tour report or a trip report.

Order to visit a customer without transporting any goods.

Enumeration to define the calculation behaviour of the algorithm, i.e. if the focus of calculation is on performance, quality or both.

The compartment setup tells whether compartment A can only be accessed through compartment B or the other way around. Compartments A and B are defined by the compartment quantity indices. See the technical concept page for details on the compartment access restriction.

Different kinds of fixations.

Type of a specified position of a stop at a customer site within its trip.

Position at which a quantity scenario of a vehicle may be changed.

A type of task that can be carried out at a stop.