API Documentation

PTV xServer comes with an API documentation which covers all operations of each provided service.

API Versioning

PTV xServer offers the possibility to use the API in a certain version. It provides different APIs on different URLs. That means that the availability of older versions is useful for backward compatibility. More information is available in the chapter Versioned API and hosting previous versions. The section API Changes shows all API changes between releases.

Experimental Features

Elements tagged as experimental are still under development and can change in later versions. For more details see the description of Experimental and Deprecated Features.

Deprecated Features

Elements tagged as deprecated should not be used anymore and might be removed in later versions. For more details see the description of Experimental and Deprecated Features.

Services

xCluster

Use case “Territory Planning and Clustering”

JUMP INTO THE API DOCUMENTATION

xData

Use case “Handle Map Specific Data”

JUMP INTO THE API DOCUMENTATION

xDima

Use case “Distance Matrix Calculation”

JUMP INTO THE API DOCUMENTATION

xLoad

Use case "Loading Space Optimization“

JUMP INTO THE API DOCUMENTATION

xLocate

Use case “Geocoding”

JUMP INTO THE API DOCUMENTATION

xMap

Use case “Rendering”

JUMP INTO THE API DOCUMENTATION

xMatch

Use case “Matching positions to a map”

JUMP INTO THE API DOCUMENTATION

xRoute

Use case “RoutingClosed A route corresponds to a path of a vehicle through the underlying transport network. The main attributes of a route are the distance and the time that the vehicle travels along the path. and Scheduling”

JUMP INTO THE API DOCUMENTATION

xTour

Use case “Solving Multiple VehicleClosed The term vehicle describes what is being routed or planned for. Vehicles are used in route calculation, distance matrix calculation and effectively also in tour planning. In route calculation, vehicle properties like overall size, weight and speed are in focus. In tour planning, it is vehicle properties like capacity and availability. Commonly a vehicle is motorized, like a truck - including its trailer or a car. However also a bike or even a pedestrian are included in this definition. Routing Problem”

JUMP INTO THE API DOCUMENTATION