Set of locations that is to be clustered into territories (required). The locations may be new or already assigned to territories.

Configures the way distances between locations and territory reference points are calculated or approximated (required).

Parameters for the planning algorithm (required).

Configures the planning algorithm (optional).

Set of locations that is to be clustered into territories (required). The locations may be new or already assigned to territories.

Configures the way distances between locations and territory reference points are calculated or approximated (required).

Parameters for the planning algorithm (required).

Configures the planning algorithm (optional).

The amount of activity measure which is projected to the corresponding location (required).

Represents a concrete limit for the total amount of activity within the assigned territory. The value of an AbsoluteActivityLimit must be greater 0.

The unique identifier of the reference matrix (required).

Represents the method that is used to select the nearest reference point in the matrix.

Default value: DIRECT_DISTANCE.

The id of the distance matrix. Use this id to reference the matrix for further use.

Indicates what route calculation algorithm was used for the distances matrix calculation. If a high performance routing network is configured but there is no matching high performance graph for the called profile the routing mode will fall back to conventional routing.

Percentage of used distances calculated by direct distance approximation. Each access to the distance matrix by the algorithm is counted.

The unique identifier of the existing distance matrix (required).

Represents an ID that assigns a Limit to a specified territory. This limit then limits the total amount of activity of the assigned territory. The planTerritories method does not support limits with territory assignments. The changeTerritories method does not support limits that reference candidate territories. However, it is supported that limits carry territory assignments to fixed territories or even carry empty territory assignments.  

The unique identifier of this location (required).

The geographical position of this location (required).

The activity of this location (required).

A set of properties which restrict the assignment to certain territories.

The id of the territory this location is assigned to. This parameter can also be used to provide territories as input, but will be ignored for planTerritories.

Indicates if this location is fixed to the territory represented by the territoryId. Fixed locations may not be moved to other territories in further plannings. Response locations are not fixed by default. This parameter will be ignored for planTerritories.

Unique identifier of a group of locations this location belongs to. Locations that are in the same group will be assigned to the same territory.

A list of territories that are not assignable to this location, represented by their id. PlanTerritories does not support this attribute.

If true, the distance matrix will be deleted after the request has finished. If false, a unique identifier for this matrix will be returned in the DistanceMatrixSummary element. A previously calculated matrix can also be deleted using the method DeleteDistanceMatrix.

Default value: true.

The reference time which is needed for the use of time-dependent feature layers. The time must be specified as a string using the xsd:datetime syntax, for example 2014-08-08T09:10:00+02:00. If this parameter is not set, it is assumed as now, meaning the local time of the PTV xTerritory Server.

The exact number of territories that should be returned by the planning algorithm (required).

Represents the thoroughness of the planning algorithm. A more thorough solution probably requires a larger amount of time. The particular parametrization for each solution quality is located in the TerritoryPlanning profile.

Default value: BASIC.

If true, the imbalanceTolerance parameter will be considered by the planning algorithm. If false, the imbalanceTolerance will be ignored and a probably imbalanced solution is returned.

Default value: true.

Represents the maximum deviation in percent from the average total activity per territory which is tolerated for each territory. The imbalanceTolerance is used as exit criterion for the algorithm: as soon as all territories are sufficiently balanced, the algorithm stops. For BASIC SolutionQuality this value is more a guidance level than a maximal value. Locations may be assigned to a territory after the algorithm stops. Therefore it cannot be quaranteed that the actual imbalance lies within the value set as imbalanceTolerance.

Default value: 10.0.

Territories are always optimized towards compactness and towards minimal driving times from the reference point to each location. Depending on the routing profile used for driving time calculation, territories may be stretched along major roads and it is possible that two territories visually overlap. If avoidOverlappingTerritories is set to true, visually overlapping territories are explicitly avoided by the algorithm, that means the territories are optimized towards round shape. If there is no valid solution that avoids overlapping territory, a valid solution with overlapping territories is returned. Territories are considered as overlapping if there exist intersecting direct links between locations from two different territories and their corresponding reference points. Setting this parameter to true may increase the algorithm runtime because additional steps have to be executed. Furthermore, the overall driving time per territory may increase because the territory is optimized towards round shape and not towards minimal driving time.

Default value: false.

Limits the amount of activities that are assignable for a territory. If set, the number of limits has to correspond with exactNumberOfTerritories in the "planning territories" and "change territories" use case or with the number of territories in the use cases "location assignment".

Return a list of locations, each including the territory it is assigned to.

Default value: false.

Return a list of territories, each including the list of locations assigned to it.

Default value: true.

The service period (in seconds) for this location.

List of locations, each including the territory it is assigned to, if requested in the result set.

List of territories, each including the list of locations assigned to it, if requested in the result set.

Summary of the distance matrix calculation or extension. A summary will only be returned if a distance matrix was calculated and not deleted after its usage, or if a pre-calculated distance matrix was extended.

The unique identifier of this territory (required).

The geographical position of the reference point of the territory (required).

A list of locations assigned to this territory, represented by their id. The location elements can be found in the request or in the list of locations in the TerritoryResponse. As request input location ids are ignored.

A planning summary for this territory.

The total amount of activity of the locations assigned to this territory.

The total number of locations assigned to this territory.

Represents the estimated travel time (in seconds) from the territory center to the territory. It is calculated by averaging the distance from the territory center to its 5 nearest neighbors (locations). This value can be obtained in every use case except in the use case "planning territories" where there is no territory to drive to yet.

Represents a concrete limit for the total tour period (in seconds) within the assigned territory. The value of a TourPeriodLimit must be greater 0.

License is not valid or expired.

Missing a required input parameter.

General error code of the xterritory module.

Engine call returned an error.

A parameter was set to an invalid value.

Invalid profile settings.

Select the reference point with the shortest direct distance from the unknown location.

Select the reference point with the shortest route from the unknown location. Only the n reference points with the shortest direct distance to the location are taken into account as candidates. This method may take a longer time but may lead to better results, especially when locations are situated on both sides of natural obstacles such as rivers.

Indicates that the conventional routing algorithm was used for distance matrix calculation.

Indicates that high performance routing network was used for distance matrix calculation.

The algorithm uses certain approximations to solve the problem in reasonable amount of time.

The algorithm uses a more detailed model of the problem which may lead to increasing calculation time.

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.