If true, the start time of the tour is fixed during the tour optimization. In case of a fixation this point in time must be specified by startTimeEarliest.

Additional field to describe the tour point (optional); not relevant for tour planning.

Type of the tour point.

The distance between the first and the last tour point of the tour [in meter]. In contrast to tourDistance, this value does not comprise the distance from the depot/ vehicle location to the first tour point and from the last tour point to the depot/ vehicle location.

The maximum distance between two consecutive tour points of the tour [in meter].

If true, a co-driver will be required for this tour.

The period needed for uploading at the depot.

The period needed for unloading at the depot.

The earliest time the goods of all orders are available at the start depot ([sec] from a reference point in time on). This is the maximum of all earliest availability times of all transport orders of this tour. Consequently, the tour cannot be started earlier because deliverable goods are not available, yet.

The latest time the goods of all orders have to be delivered to the end depot ([sec] from a reference point in time on). This is the minimum of all latest delivery times of all transport orders of this tour. Consequently, the tour cannot be finished later because deliverable goods have to be at the depot at this time. If this attribute is missing, the goods can be delivered to the end depot at any time.

If true, this tour has been changed from the input plan or is newly created.

The priority of the order. 0 is the lowest priority, 9 the highest. Omitting this attribute means lowest priority. The priorities will be used to execute planning hierarchically, that means first all orders with the highest priority are planned, then all orders with the second highest priority and so on.

The unique key to identify the transported product (> 0, optional). Used only to handle product incompatibilities.

This attribute must be specified in order to calculate overnight stays. For this use case operatingIntervals is equal to the driver's operating intervals. See also the attribute overnightStayPattern in the class OvernightParams.

If true, the algorithm can change vehicles on existing routes. The default is false.

The maximum distance in meter that an additional order may cause. By default there is no restriction.

The unique key to identify the tour.

The unique key to identify the truck.

The unique key to identify the trailer.

The unique key to identify the train.

The position of the tour within the chain.

The instructions for inserting the vehicle.

If true, the vehicle was scheduled.

If true, a start depot was inserted.

The unique key to identify the start depot (-1, if there is no start depot).

If true, an end depot was inserted.

The unique key to identify the end depot (-1, if there is no end depot).

Additional costs for assigning the vehicle.

Additional distance for assigning the vehicle.

Additional tour period for assigning the vehicle.

Additional driving period for assigning the vehicle.

Start time of the tour.

This attribute specifies an internal method. Adjust this value in collaboration with PTV's support only.

The unique key to identify the distance matrix used with this vehicle (see DistanceMatrixCalculation). If the direct velocity is used, this parameter can be left empty.

If true, the servicePeriod that is specified for a TransportPoint is ignored. The default is false.

The status of the co-driver.

If set to true, tours must fit into a single operating interval. This attribute is ignored for the method planOvernightTours because this use case must consider several operating intervals.

The individual driver regulation settings. If this attribute is set to null, xTour will assume that there are no rules for rests, breaks and working periods.

If set to true, the algorithm ignores product incompatibilities for this vehicle. The default is false.

Product incompatibilities have to be specified in the PlanningParams otherwise this attribute has no effect.

If multi-compartment constraints are considered, this is the minimal percentage of the vehicle's capacity that has to be available regarding the blocking quantity. If the remaining capacity is less than this threshold, no orders of the blocked quantity can be loaded or unloaded at the current stop.

The break-period that has to be taken within the break-intervals given below.

Intervals within which the break has to be taken.

Uninterrupted period of time a driver is allowed to drive without a break.

Remark: According to EU regulation : 4h 30min (16200s)

Minimum period of time required for the first break.

Remark: According to EU regulation : 15min (900s)

Minimum period of time required for the second break.

Remark: According to EU regulation : 30min (1800s)

The capacities of the vehicle.

The tours performed by this vehicle. The sequence of the tours in the list correspond to the chronology of the tours. The number of elements in the list should not exceed the maximum number of consecutive tours limited by the vehicle.

Result of the planned tour chain. This attribute is not relevant for the import of an existing tour chain, but it appears in the export case to provide additional information.

Additional field to describe the vehicle (optional).

The chain costs of this chain. These are only the costs per chain defined with the vehicle. They do not comprise distance or time dependent costs.

The tour events of the tour chain in chronological order to get an overview of the time profile without gaps.

The end time of the chain ([sec] from the reference point).

If a startLocation of the vehicle is specified in the request, this value contains the driving period from the startLocation to the first tour point ([sec]). Otherwise it is 0.

If a startLocation of the vehicle is specified in the request, this value contains the driving distance from the startLocation to the first tour point ([m]). Otherwise it is 0.

If an endLocation of the vehicle is specified in the request, this value contains the driving period from the last tour point to the end location ([sec]). Otherwise it is 0.

If an endLocation of the vehicle is specified in the request, this value contains the driving distance from the last tour point to the end location ([m]). Otherwise it is 0.

The costs per hour if the vehicle has a driver only, but not a co-driver ([MU]).

The costs per hour if the vehicle has a co-driver ([MU]). Only one of these two values will be used in calculating the costs depending on whether the vehicle in question has a co-driver or not.

Regular daily rest period.

First period of a split regular daily rest period.

Second period of a split regular daily rest period.

Reduced daily rest period.

Number of allowed reduced rest periods between any two weekly rest periods.

Regular daily driving period.

Extended daily driving period.

Maximum number of extended driving periods per week. The maximum allowed value is 2, larger values are not accepted.

Within each of this period after the end of the previous daily rest period a driver shall have taken a new daily rest period.

The distance matrix profile to be used for calculating the distances. This profile contains vehicle and speed parameters and overwrites the property distanceCalculation.profile from the main profile set in the caller context. This profile name represents a file (without its extension) from the conf directory.

Reference time for time-dependent feature layers. Each route in the distance matrix contains this time as start time.

Enforces the usage of a high-performance routing network. If there is no matching network available, an exception will be thrown.

The periods and frequencies needed to obey the weekly rest rules of the European Union.

Parameters needed to obey the working rules of Germany.

Parameters needed for breaks and break intervals.

The unique key to identify the used driver regulation. Must be greater than 0.

If true, the break rule is active.

If true, the daily rest rule is active.

If true, the weekly rest rule is active.

If true, the rule for working hours is active.

Encoded remaining periods of a driver's previous tour.

restrictions for the tour period that depend on individual drivers. These settings allow to restrict tour periods taking into account regular commuting times for drivers who can start and end their tour at home.

Defines the maximum distance in meter that an additional order may cause. By default there is no restriction.

If true, the algorithm can change vehicles on existing routes. The default is false.

If true, the algorithm can change vehicles on existing routes.

The maximum distance in meter that an additional order may cause. By default there is no restriction.

If true, the algorithm can create new tours. The default is false.

The cost factor for creating new tours.

If true, the algorithm can insert depots at the start of a tour or at the end of a tour. This is possible if a tour has no start depot or end depot. The default is false.

If true, the algorithm can use scheduled vehicles. The default is false.

If true, the algorithm can insert depots at the start of a tour or at the end of a tour. That is possibe if a tour has no start depot or end depot. The default is false.

The list of vehicles.

The list of trailers.

The list of trains.

The ranking for the vehicle count.

The ranking for the tour count.

The ranking for the overall chain period.

The ranking for the tour period.

The ranking for the tour driving period.

The ranking for the tour distance.

The ranking for unplanned orders.

The unique key to identify the order.

The unique key to identify the tour.

Position number within the tour for TransportDepot orders and for the TransportPoint A of TransportAB orders.

Position number within the tour for TransportPoint B of a TransportAB order.

This element is not set for TransportDepot orders.

The unique key to identify the vehicle.

The unique key to identify the trailer.

The unique key to identify the train.

The position of the tour within the chain.

The instructions for inserting the order.

If true, a vehicle was changed in an existing tour. Otherwise it is a new tour.

If true, the chain position was changed in an existing tour. Otherwise it is a new tour.

The cost for inserting the order.

The additional distance [m] for inserting the order.

The additional tour period [sec].

The additional driving period [sec].

The start of service [sec].

The end of service [sec].

The arrival time at the stop of the order.

The departure time at the stop of the order.

A length restriction of a load. If the attribute is omitted or set to zero, it will not be considered.

A width restriction of a load. If the attribute is omitted or set to zero, it will not be considered.

A height restriction of a load. If the attribute is omitted or set to zero, it will not be considered.

A weight restriction of a load. If the attribute is omitted or set to zero, it will not be considered.

The quantity-independent amount of loading period for a set of tour points that share the same site ID. ([sec], >= 0, optional).

The exponent for non-linear loading functions (optional, >= 0, <= 2).

The maximum period for this loading function ([sec], >=0, optional).

An additional field to describe the logistic point (optional); not relevant for tour planning.

The unique key to identify the transport points belonging together in a logical way. For example all logistic points in one premises get the same ID (> 0, optional). These logistic points do not need the same location, but usually they are nearby. This ID is relevant for the service period calculation.

Extra service period at the transport point in case of a given SiteId ([sec], >= 0). If there are several consecutive logistic points in a tour referring to logistic points with the same siteId, the extra service period would only be considered at the first logistic point of that row (for example the period for a security check at the gate of the same premises). In case of different extra site periods, the maximum value is relevant for the first logistic point.

The unique key to identify the related uploading function clearly (> 0, optional). This function calculates the uploading period at this point depending on the pickup quantities. Omitting this attribute means that the uploading period at this point is 0. If there are no pickupQuantities defined, the resulting period will be 0. So even the fixed periods will be omitted.

The unique key to identify the related unloading function clearly (> 0, optional). This function calculates the unloading period at this point depending on the delivery quantities. Omitting this attribute means that the unloading period at this point is 0. If there are no deliveryQuantities defined, the resulting period will be 0. So even the fixed periods will be omitted.

The maximum of the total tour period reduced by the maximum allowable tour period.

This value is considered to be seconds and has to be > 0.

The maximum allowable tour period is the maximum part of the tour period that can be considered as non-working period by the employer.

Usually it represents the employee's driving time to and from the company location. If one of the distances to the first customer or from the last customer is shorter than the distance to the company location, the distance to or from the customer will be used.

This value is considered to be seconds and has to be > 0.

Defines which periods are considered as 'night'.

A tour is called a 'night tour' if the length of the intersection of the tour interval with some night interval exceeds this threshold.

The maximum period of a 'night tour'. When an input plan exceeds this value, the TourViolation MAX_PERIOD_PER_NIGHT_TOUR will be returned.

The maximum period of a chain containing a 'night tour'. When an input plan exceeds this value, the TourViolation MAX_PERIOD_PER_NIGHT_TOUR will be returned.

Additional costs for each overnight stay ([MU]).

Additional costs for each unplanned order ([MU]). Higher values decrease the number of unplanned orders.

The maximum number of subsequent overnight stays. Legal values range from 0 to 6.

This boolean array specifies whether the PTV xTour server may plan an overnight stay between two operating intervals. Each array field represents a gap between two operating intervals. If more fields are set than possible gaps exist, the PTV xTour server will ignore superfluous values.

Example: Assume that 4 operating intervals are configured for the given vehicle. The overnightStayPattern [false, true, true] specifies that overnight stays are valid between the operating intervals 2 and 3 and 3 and 4, but not between the intervals 1 and 2. Note that this array can hold a maximum of 6 values, which means that overnight stays for 7 operating intervals can be specified.

The tour chains of the vehicles performing at least one tour (required). There is one element in the list for every used vehicle.

The overview of the planned tours in all tour chains. This attribute is not relevant for the import of the existing tours, but it appears in the export case to provide additional information.

The sum of the costs per chain of all planned chains ([MU]). See VehicleCosts.

The unique key to identify all scheduled transport orders (optional). This attribute does not appear if no transport orders are planned in tours.

The unique key to identify all scheduled vehicles (optional). This attribute does not appear if no vehicles are planned in tours.

This Array of UnscheduledOrderAnalysisResult objects represents analysis results for each unscheduled order. The analysis specifies why an order could not be planned. By default this attribute is NULL. The Analysis must be activated by using UnscheduledOrderAnalysisParams or by setting maximumNumberOfUnscheduledOrdersToBeAnalyzed in StandardParams.

This factor is used if directVelocity is set (optional, >= 0). If set to 0.0, the default value from conf/TourOpt.ini is taken.

Correction factor for loading periods with a co-driver in order to represent a faster loading with a value less than 1, a slower loading with a value greater than 1 or a standard loading with the value 1 (>= 0, optional). Omitting this attribute means that the value 1 for the standard loading is set.

Set this to true if you do not want to mix TransportPoints that require a co-driver with TransportPoints that do not need a co-driver.

This attribute specifies a set of custom driver regulations. A maximum of 200 different regulations is allowed.

An array of product incompatibilities to be considered in the tours.

The consideration of product incompatibilities can be disabled for specific vehicles using the parameter ignoreProductIncompatibilities in the BaseVehicle.

If this parameter is set to true, a fallback mechanism to direct distance is used for distance calculation. That means, if the distance to a location could not be determined on the road, the direct distance multiplied by a constant factor is used instead. This factor is specified as DTF in the conf/TourOpt.ini.

Driving periods are determined accordingly by using the distance and the directVelocity factor which is also specified in conf/TourOpt.ini.

If true, the algorithm avoids early recreations at the beginning of the tour. Early recreations may be inserted by the algorithm to avoid the need of a longer recreation later in the tour. The default is false.

Enables the consideration of multi-compartment constraints at the vehicle. Furthermore it is required to set both the indexOfBlockingQuantity and the indexOfBlockedQuantity.

Blocked quantities can only be loaded or unloaded at a stop if the amount of the blocking quantity does not exceed a vehicle specific threshold at the same stop.

This feature is not available if the fleet contains trains or trailers.

The 0-based index of the quantity in the array of quantities that is considered as blocking quantity for multi-compartment constraints.

The 0-based index of the quantity in the array of quantities that is considered as blocked quantity for multi-compartment constraints.

The unique key to identify the first product. Must be > 0.

The unique key to identify the second product. Must be > 0.

The incompatibility type.

The single quantities ([QU], >= 0, optional).

Loading period per unit of each quantity ([sec], >= 0).

The unique key to identify this regulations object. Requires values greater than 0. Use this ID in DriverSettings to point to this regulations object.

The parameter mergeTransportPointCountPerSite affects the way how transport points at the same site are counted for this restriction.

Decides if transport points with the same siteID (> 0) are counted as 1 with respect to the maxTransportPointCountPerTour restriction. By default, this parameter is set to false which means that each transport point is counted, without considering its siteID. Transport points at depots are not counted in this case.

If it is set to true, transport points at the same site are counted as single transport point. Furthermore, transport points at depots are also counted as single transport point.

This parameter affects all maxTransportPointCountPerTour restrictions in the request regardless if it is set as global restriction or as a vehicle specific restriction at the fleet (VehicleRestrictions or Train).

The tour-dependent restrictions.

Defines restrictions for night tours, i.e. when another maximum tour period applies to night tours. These restrictions will be considered in addition to the tour restrictions.

The number of transport points AFTER the starting depot that should be kept fixed during calculation. The depot itself is fixed by default. For depot-less tours, this value contains the number of transport points from the start that should be kept fixed. This parameter only considers transport points specified in an input plan.

The number of transport points BEFORE the end depot that should be kept fixed during calculation. The depot itself is fixed by default. For depot-less tours, this value contains the number of transport points from end that should be kept fixed. This parameter only considers transport points specified in an input plan.

Limits the available machine time of the tour optimization ([sec], > 0, optional). It is recommended to provide as much machine time as possible. Omitting this attribute means that the tour optimization is executed without time limits.

This attribute specifies how many unscheduled orders should be analyzed. If set to NULL or 0, no analysis will be done. The maximum is the number of orders.
The result is returned in PlanResult as an array of UnscheduledOrderAnalysisResult

The resulting sequencing tour.

Overview of the planned tour. This attribute is not relevant for the import of the existing tours, but it appears in the export case to provide additional information.

The tour events of the tour chain in chronological order to get an overview of the time profile without gaps.

The remaining periods caused by the planned tour relevant for the calculation of the first shift of the next tour (optional). Use this value as an input parameter for BaseVehicle->driverSettings to calculate subsequent tours.

The unique key to identify all scheduled sequencing transport orders (optional). This attribute does not appear if no sequencing transport orders are planned in tours.

The IDs of all unscheduled sequencing transport orders (optional). This attribute does not appear if all sequencing transport orders are planned in tours.

The results of the unscheduled order analysis.

The list of tour points.

If true the tour reduction step is executed (optional). This step tries to reduce the number of tours. All tour points must remain planned. Depending on the problem, this takes some machine time. Omitting this attribute means that the tour reduction step is executed. The restriction of the usage is documented in the inherited classes.

Limits the available machine time of the tour optimization ([sec], > 0, optional). It is recommended to provide as much machine time as possible. Omitting this attribute means that the tour optimization is executed without time limits.

This attribute specifies how many unscheduled orders should be analyzed. If set to NULL or 0, no analysis will be done. The maximum is the number of orders.
The result is returned in PlanResult as an array of UnscheduledOrderAnalysisResult.

This optional attribute specifies a set of rankings for different optimization goals.

This attribute specifies an internal method. Adjust this value in collaboration with PTV's support only.

This attribute specifies an internal method. Adjust this value in collaboration with PTV's support only.

This attribute specifies an internal method. Adjust this value in collaboration with PTV's support only.

The costs for one hour tour period ([MU/h]).

The total costs of the complete tour ([MU]).

An additional field to describe the tour (optional); not relevant for tour planning.

The unique key to identify the related trailer clearly (> 0). If this attribute is not set, a trailer is not used for this tour. The different tours within a chain can use different trailers, but a specific trailer can occur only within a single chain.

The unique key to identify the related train clearly (> 0). If this attribute is not set, a trailer is not used for this tour and thus neither a train.

If true, the trailer is fixed during the tour optimization. Otherwise the trailer can be changed during the tour optimization.

If true, the intermediate period of the previous tour will be ignored (if in input plan) or has been ignored (if in output plan).

Restrictions of the tour. Contains the same values as the corresponding tour of the input plan. If it is null there, its value will be null. It will also be null if no input plan is given. In output plans these values are informational, only. These values, if present, overwrite those from Restrictions only for this tour.

Tours points of the tour (required). The sequence of the tour points in the list correspond to the chronology of the tour points. Mainly the tour points refer to transport points, only the first and the last tour point refer to a depot. Every transport point should only occur once in the tours.

Result of the planned tour. This attribute is not relevant for the import of an existing tour, but it appears in the export case to provide additional information.

Index of the logistic point at which the event takes place, or -1 if the event takes place on the road.

Start time of this event.

Period of this event.

An array of TourEventDescriptions for this event. See TourEventDescription for details. This enumeration may be extended without further notice. Client applications must ignore unknown values.

An array of TourEventViolations for this TourEvent. See TourEventViolation for details. This enumeration may be extended without further notice. Client applications must ignore unknown values.

Index of the tour within the chain starting with 0. Events between two tours that do not belong to a specific tour have index -1.

The maximum period from the start to the end of a tour ([sec], >= 0, optional). Omitting this attribute means that there is no special restriction for the tour.

The maximum driving period between all tour points of a tour ([sec], >= 0, optional). Omitting this attribute means that there is no special restriction for the tour.

The maximum distance between all tour points of a tour ([m], >= 0, optional). Omitting this attribute means that there is no special restriction for the tour.

The maximum distance between the first tour point and the last tour point of a tour ([m], >= 0, optional). In contrast to maxDistance, this value does not comprise the distance from the depot or vehicle location to the first tour point and from the last tour point to the depot or vehicle location. Omitting this attribute means that there is no special restriction for the tour.

Maximum distance between two consecutive tour points of a tour ([m], >= 0, optional). Omitting this attribute means that there is no special restriction for the tour.

Additional field to describe the train.

Additional field to describe the trailer.

The maximum of all specified maxLoadingAreas of transport orders that are scheduled for the tour.

The minimum of all specified minLoadingAreas of transport orders that are scheduled for the current tour.

An array of violations. See TourViolation for details on single violations. This enumeration may be extended without further notice. Client applications must ignore unknown values.

The unique key to identify the trailer clearly (> 0).

Additional field to describe the trailer (optional). Not relevant for tour planning.

The unique key to identify the train clearly (> 0).

Additional field to describe the train (optional); not relevant for tour planning.

The unique keys to identify the vehicle allowed in this train rule. The list must contain at least one identifier.

The unique keys to identify the trailer allowed in this train rule. The list must contain at least one identifier.

The unique key to identify the distance matrix to be used with this train (see DistanceMatrixCalculation). If the direct velocity is used, this parameter can be left empty.

The minimum size and/or weight of a train load. Omitting this attribute means that there is no lower bound.

The maximum size and/or weight of a train load. Omitting this attribute means that there is no upper bound.

Category of the train (1 <= x <= 255, optional). Categories are a way to group the trains. They are useful to assign transport orders to trains. Omitting this attribute means that the standard category 1 is set.

The correction factor for driving periods in order to represent a faster train with a value less than 1, a slower train with a value greater than 1 or a standard train with the value 1 (>= 0, optional). Omitting this attribute means that the value 1 for the standard train is set.

Available equipment of the train to satisfy transport order requirements (1 <= x <= 512, optional). There are up to 512 different equipment flags possible. Omitting this attribute means that the train has no equipment flags.

The maximum number of transport points in a tour of the train (>= 0, optional). Omitting this attribute means unlimited number transport points.

The parameter mergeTransportPointCountPerSite  affects the way how transport points at the same site are counted for this restriction.

The unique keys to identify the related depots clearly (> 0, optional). With one element in the list, the transport order has a fixed assignment to the depot. With more than one element in the list, the tour optimization can choose one of the depots as the fixed depot. In case of delivery quantities this depot is considered as the fixed start depot. The same applies if no quantities are defined. In case of pickup quantities this depot is considered as the fixed end depot. Omitting this attribute means that the transportation can be done with any depot.

The unique key to identify the related vehicle clearly (> 0, optional). The transport order has a fixed assignment to the vehicle. Omitting this attribute means that the transport order can be executed by any vehicle.

Valid categories for vehicles driving the transport order (1 <= x <= 255, optional). There are up to 255 different categories possible. They are useful to assign the transport order to a vehicle group. Omitting this attribute means that the transport order can be executed by vehicles of any category.

Requirements of the transport order the vehicle must fulfill with its equipment in case of executing the transport order (1 <= x <= 512, optional). There are up to 512 different requirement flags possible. Omitting this attribute means that the transport order has no requirements.

Exclusions of the transport order the vehicle must not fulfill with its equipment in case of executing the transport order (1 <= x <= 512, optional). There are up to 512 different exclusion flags possible. Omitting this attribute means that the transport order has no exclusions.

Area number of the transport order (> 0, optional). A transport order assigned to an area can only be planned in a tour with transport orders having the same or no area number. Thereby a vehicle with an corresponding area number is necessary. This number is only considered when using AreaParams. Omitting this attribute means that the transport order has no assignment to an area and can be planned in any tour.

The minimum size and/or weight of a transport order. Omitting this attribute means that there is no lower bound.

The maximum size and/or weight of a transport order. Omitting this attribute means that there is no upper bound.

If true, transportation on a trailer is disabled. Default is false.

Area number position of the transport point (> 0, optional). This position is responsible for an ascending order of the transport points in a tour. Thereby several transport points with the same area number could have the same area number position. However a position without an area number is not possible. This position is only considered when using AreaParams. Omitting this attribute means that the transport point has no area number position and can be planned in any position of the tour.

If true, a co-driver is required for this TransportPoint. The default is false.

The orders that should be analyzed. Must be a subset of the input plan's unscheduledOrderIds.

The order that was analyzed.

The analysis status.

The violations for vehicles. Each array element represents the violations for a single vehicle.

The violations for tours. Each array element represents the violations for a single tour.

Additional field to describe the vehicle (optional); not relevant for tour planning.

Minimum required period between two consecutive tours ([sec], >= 0). The earliest start time of the successive tour is the end of the preceding tour plus this changeover period.

If the vehicle is not located at the start depot, its actual start location can be given here. The distance from the start location to the depot will be stated in ChainResult.

If the vehicle will not be located at the end depot, its actual end location can be given here. The distance from the depot to the end location will be stated in ChainResult.

The restrictions of the vehicle regarding tours and chains.

The minimum size and/or weight of a vehicle load. Omitting this attribute means that there is no lower bound.

The maximum size and/or weight of a vehicle load. Omitting this attribute means that there is no upper bound.

If true, the intermediatePeriod before the first tour is ignored.

The costs of each chain ([MU]). These are the costs which arise whenever the vehicle (or the driver, respectively) start a chain. These costs will only be used to reduce the number of vehicles being planned, if possible, but they will not be summed up for the total costs. Instead, they will be listed separately in the response. The costs per chain will not be used with planSequence.

The parameter mergeTransportPointCountPerSite  affects the way how transport points at the same site are counted for this restriction.

The maximum distance [m] between all tour points of a tour for this vehicle. Omitting this attribute means that the tour distance is restricted by  TourRestrictions.maxDistance.

Limits the available machine time of the tour optimization ([sec], > 0, optional). It is recommended to provide as much machine time as possible. Omitting this attribute means that the tour optimization is executed without time limits.

The goal that describes how to schedule the tours.

If true, the best solution is searched. This may take a considerable amount of time.

The unique key to identify the vehicle.

The unique key to identify the trailer.

The unique key to identify the train.

An array of violations. See TourViolation for details on single violations. This enumeration may be extended without further notice. Client applications must ignore unknown values.

Maximum period between the end of a weekly rest period and the beginning of the following weekly rest period.

Cumulative period of time a driver is allowed to drive within a week.

Cumulative period of time a driver is allowed to drive within two weeks.

Minimum period of time of a weekly rest.

Minimum duration of required working break.

Minimum duration of extended break if workingPeriod exceeded.

Maximum duration of uninterrupted working time without having a break.

Maximum duration of uninterrupted working time without having an extended break.

Minimum duration break part if break is split.

Maximum working period after which a daily working rest must be done.

Maximum working period in a week.

Minimum uninterrupted daily rest period after work.

No co-driver.

The co-driver must be present.

The co-driver if needed.

The two products must not be transported on the same tour.

The two products must not be transported at the same time.

The driver is driving a vehicle.

Some service is provided. The driver is either actively working or waiting for the service to be finished.

The driver is waiting. He might be recreating himself at the same time.

The event takes place outside of any operating interval. The driver might be recreating himself at the same time.

The driver is taking a break. Break is a kind of recreation.

The driver is taking a daily rest. Daily rest is a kind of recreation.

The driver is taking a weekly rest. Weekly rest is a kind of recreation.

The tour event takes place within a service interval.

The driver is working.

The driver is taking a working break. (WorkingRule)

The driver is taking a daily working rest. (WorkingRule)

The driver is taking a break prescribed by the given break intervals.

Period between two tours in a chain (During intermediate period the driver is not working).

Driving of active service is performed outside of all operating intervals.

Service is performed although the given service intervals do not allow this.

The tour period exceeds the allowed tour period.

Maximum distance of services between two logistic points was exceeded.

Transport point in wrong order for the related TransportAB.

The distance between the first and the last tour point in sum of one tour exceeds the maximum distance.

The distance between two consecutive tour points of one tour exceeds the maximum distance.

Not in use anymore.

The tour violates the restricted availabilities of the goods.

Co-driver is needed but tour point is handled by a vehicle without a co-driver.

The tour requires a co-driver but contains also tourpoints which does not need a co-driver.

The vehicle does not match all loading areas of the tour points.

Tour point fixation prevents operation.

Break and rest rules are violated due to prescribed arrival or departure times.

At least two types of incompatible products are transported in this tour.

More than one tour has to be scheduled in a vehicle operating interval, which is not allowed for this request.

The intermediate period is violated.

Some of the relations that were used to plan this tour did not exist in the distance matrix and thus were interpolated.

The tour period of a 'night tour' exceeds the maximum night tour or the maximum night tour chain period.

The stop is not scheduled in the input plan but it could be scheduled without a violation. The reason why this stop is not scheduled is most likely the fact that the construction step refuses to schedule stops that do not match some general conditions such as the maximum earliness. The improvement stop will schedule the stop then, so please switch on the improvement stop.

The stop was not planned due to the plan. For example there was no suitable tour.

The stop was not planned due to the vehicles. For example there was no suitable vehicle or there are already other stops in the tour.

Minimizing chain count and cost. In case less trucks are scheduled cost of new tour plan is allowed to be higher.

Minimizing costs of the tour plan only.

The left top corner point.

The right bottom corner point.

Specifies how many requests have still to be calculated.

The number of successful calculations so far.

The number of failed computations so far.

The current action being executed. For more information on progress see About Asynchronous Protocol.

The progress of the distance matrix calculation, available only if action equals "DistanceMatrix.Calculation".

The progress of the optimization, available only if action starts with "Optimization.".

The unique key to identify the distance matrix currently being calculated.

The 1-based index of the distance matrix currently being calculated. Depending on the number of different vehicles in the request the number of distance matrices to be calculated can be greater than

The index of the last distance matrix to be calculated, that is the total number of distance matrices.

The progress of the distance matrix currently being processed, available only if action equals "DistanceMatrix.Calculation".

The 1-based index of the current row of the current distance matrix being calculated.

The index of the last row of the current distance matrix to be calculated.

If not null, this attribute contains the well-known binary encoded form of the geometry

If not null, this attribute contains the well-known text encoded form of the geometry

If not null, this attribute contains the well-known text encoded form of the geometry

If not null, this attribute contains the explicit form of the geometry

The available machine time stated in the request in [s]. This value is 0 if available machine time is not set in the request.

The machine time already used in [s].

The index of this iteration. Index 0 denotes the initial plan directly after construction or the input plan.

The number of improvements the algorithm has already achieved. In other words, this is the number of tour plans with a smaller value of costOfObjectiveFunction than the best one at that time.

The key figures characterizing the current tour plan.

The key figures characterizing the currently best tour plan.

The key figures characterizing the initial tour plan. The initial tour plan is the input plan, if available, or the first tour plan after the construction step.

This id references the background job on the server.

The current status of the job.

The current progress of the job. Can be null at the very beginning or very end of the request execution.

Elapsed time since this job has been queued.

The KML string itself.

The placemarks of the KML. If empty, all placemarks will be used. This will result in a GeometryCollection, if more than one exists.

The optimization aims at minimizing the objective function. This value contains its arithmetical cost.

The significance of this value is not the value itself, but rather if and how fast it decreases during the calculation. The faster the value decreases the better the tour plans become according to the GoalImportance which defines what "better" means, at all.

The number of orders already being scheduled.

The number of orders not being scheduled, yet. These orders are feasible and can be scheduled during further improvement iterations.

The number of orders not being scheduled. These orders are infeasible and will not be scheduled during further improvement iterations.

The number of vehicles being scheduled.

The number of all planned tours.

The sum of the tour periods for all planned tours ([sec]).

The sum of the tour driving periods for all planned tours ([sec]).

The sum of the tour waiting periods for all planned tours ([sec]).

The sum of the tour distances for all planned tours ([m]).

The sum of the tour costs for all planned tours ([MU]). The costs per chain will not be included, see attribute totalChainCosts.

The sum of the costs per chain of all planned chains ([MU]). See VehicleCosts.

The sum of the chain periods of all planned chains ([sec]). The chain period is defined as the period between the start of the first tour and the end of the last tour. This period is greater than the sum of the periods of all tours if two subsequent tours do not start right after the other.

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

The index of the current loop being calculated.

The index of the last loop being calculated. The calculation will automatically be finished by the algorithm before reaching this index when no improvement could be reached, anymore. The total number of loops can be set for the improvement step, only (see Params).

The progress in % of the current loop being calculated.

The set of geometries making up the geometry collection.

The set of points defining the line string.

The set of points defining the linear ring.

The set of line strings making up the multi line string.

The set of points making up the multi point.

The set of polygons making up the multi polygon.

The x coordinate

The y coordinate

The z coordinate (optional, only if requested)

The set of linear rings making up the polygon.

The current action being executed. For more information on progress information see About Asynchronous Protocol.

The progress of the distance matrix calculation, available only if action starts with "DistanceMatrix.".

The progress of the improvement step during the tour plan optimization, available only if action equals "Optimization.Improvement".

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

The coordinate format used in the request/response.

The geometry encoding for the response.

The name of the parameter profile to be used.

For internal use only.

If the coordFormat equals to 'OG_SRID', this attribute contains the Spatial Reference Identifier as specified by the Open Geospatial Consortium (OGC), otherwise it is null. All codes of the EPSG Geodetic Parameter Dataset V7.9 maintained by the EPSG.

The current action being executed. For more information on progress with territory planning see the use case documentation.

The progress of the distance matrix calculation, available only if action equals "DistanceMatrix.Calculation".

The progress of the optimization, available only if action starts with "TerritoryOptimization.".

If defined this optional parameter enables additional progress updates with the specified interval. If no new progress update arrives during the specified period, watchJob will wait for and return with the next available progress update. Important updates such as terminal states will always return immediately. The minimum period must be at least 250ms. If no progress waiting period is defined, progress will only be sent as part of status updates.

Specifies the timeout after which watchJob will report the last status even if no further updates are available.If not specified a configured default is used.

The current action being executed.

The progress of the optimization, available only if action starts with "LoadingSpaceOptimization.".

OpenGIS representation of WGS 84 coordinates. Example x=8.2505556, y=48.7627778.

PTV representation of coordinates by degree, minute, and second. Example x=815020, y=4845460.

PTV representation of WGS 84 coordinates. Example x=825056, y=4876278.

PTV representation of conform coordinates. Example x=1672358, y=1620743.

PTV representation of super-conform coordinates. Example x=5072358, y=3320743.

PTV internal coordinate format. Example x=4352286, y=5456405.

This format is set implicitly, if a Spatial Reference Identifier as specified by the Open Geospatial Consortium (OGC) is set in the CallerContext. All codes of the EPSG Geodetic Parameter Dataset V7.9 maintained by the EPSG..
Note: The coordinate format 'OG_GEODECIMAL' and the SRID code 'EPSG:4326' are equivalent.

The specified WKT in the request is invalid. It should a well-known text representation of a geometry from a string (see the OpenGIS simple features specification).

The specified WKB in the request is invalid. It should be a geometry from a byte stream in well-known binary format.

The specified KML in the request is invalid.

Thrown, if requested placemark name is not found in the KML

One or more geometry objects in the request are invalid. There are problems to convert a geometry object to a plain geometry object. Also used for retrieving the plain geometry object from a geometry object.

There are problems to convert a CoordFormat of the request to a coordinate type.

Geometry objects cannot be encoded.

Plain geometry encoding using structured objects and according network presentation.

Geometry should be represented by well-known binaries.

Use well-known texts to encode geometry objects.

Use Keyhole Markup Language to encode geometry objects.

Job has been enqueued.

Job is currently running.

Stop has been requested, the job will terminate its calculation as soon as possible.

Job has completed successfully.

Job has failed with an exception.

The job was deleted by the user.

The job is in an unknown state. For example a given id is unknown or the job has already been fetched and has thus been deleted from the underlying persistent store.