Specifies the location for route calculation, including where the route starts, ends, and intermediate stops (or locations to be passed through).
Parameter |
Description |
Routes |
Routes Matrix |
Isoline |
Optimize Waypoint |
Snap to Road |
|---|---|---|---|---|---|---|
Origin(s) |
Starting position of the route. |
Yes, with options |
Yes, with options |
Yes, with options |
Yes, with options |
No |
Waypoint |
Intermediate positions to be included along the route. |
Yes, with options |
Yes, with options |
Yes, with options |
Yes, with options |
No |
Destination(s) |
Ending position of the route. |
Yes, with options |
Yes, with options |
Yes, with options |
Yes, with options |
No |
Trace points |
GPS trace that includes historical position information emitted by a travel mode. These positions include typical GPS inaccuracies and gaps when the device couldn't emit or record this information. |
No |
No |
No |
No |
Yes, with options |
Configurable options
Provides options to customize routing behavior for waypoints, origins, and destinations.
Waypoints options
Parameter |
Description |
Routes |
Routes Matrix |
Isoline |
Optimize Waypoint |
Snap To Road |
|---|---|---|---|---|---|---|
AvoidActionsForDistance |
Avoids actions for the provided distance. Typically used to ensure drivers have enough time to make decisions near waypoints. |
Yes |
No |
No |
No |
No |
AvoidUTurns |
Specifies whether U-turns are allowed at the waypoint. |
Yes |
No |
No |
No |
No |
Heading |
GPS heading at the waypoint position. |
Yes |
No |
No |
Yes |
No |
Matching |
Options to configure matching the provided position to the road network. |
Yes, with options |
No |
No |
No |
No |
SideOfStreet |
Specifies the side of the street to match the waypoint position. |
Yes, with options |
No |
No |
Yes, with options |
No |
StopDuration |
Duration to stop over at the waypoint position. |
Yes |
No |
No |
No |
No |
Position |
Longitude and Latitude for the waypoint. |
Yes |
No |
No |
Yes |
No |
PassThrough |
Determines if the waypoint should be treated as a stop or passed through. |
Yes |
No |
No |
No |
No |
Id |
Identifier string for the waypoint. |
No |
No |
No |
Yes |
No |
AccessHours |
Specifies access hours for visiting the destination. |
No |
No |
No |
Yes |
No |
AppointmentTime |
Scheduled appointment time at the waypoint. |
No |
No |
No |
Yes |
No |
ServiceDuration |
Service time at the waypoint, such as duration of an appointment. |
No |
No |
No |
Yes |
No |
Before |
Defines which waypoints must be visited after this one. |
No |
No |
No |
Yes |
No |
Origin options
Parameter |
Description |
Routes |
Routes Matrix |
Isoline |
Optimize Waypoint |
Snap To Road |
|---|---|---|---|---|---|---|
AvoidActionsForDistance |
Avoids actions for the provided distance. |
Yes |
Yes |
Yes |
No |
No |
AvoidUTurns |
Specifies if U-turns are permitted at the origin. |
Yes |
No |
No |
No |
No |
Heading |
GPS heading at the origin position. |
Yes |
Yes |
Yes |
No |
No |
Matching |
Options to match the origin position to the road network. |
Yes, with options |
Yes, with options |
Yes, with options |
No |
No |
SideOfStreet |
Specifies the side of the street to match the origin position. |
Yes, with options |
Yes, with options |
Yes, with options |
No |
No |
Id |
Identifier string for the origin. |
No |
No |
Yes |
No |
No |
Destination options
Parameter |
Description |
Routes |
Routes Matrix |
Isoline |
Optimize Waypoint |
Snap To Road |
|---|---|---|---|---|---|---|
AvoidActionsForDistance |
Avoids actions for the provided distance at the destination. |
Yes |
Yes |
Yes |
No |
No |
AvoidUTurns |
Specifies if U-turns are allowed at the destination. |
Yes |
No |
No |
No |
No |
Heading |
GPS heading at the destination position. |
Yes |
Yes |
Yes |
Yes |
No |
Matching |
Options to match the destination position to the road network. |
Yes, with options |
Yes, with options |
Yes, with options |
No |
No |
SideOfStreet |
Specifies the side of the street to match the destination position. |
Yes, with options |
Yes, with options |
Yes, with options |
Yes, with options | No |
StopDuration |
Duration to stop over at the destination. |
Yes |
No |
No |
No |
No |
Id |
Identifier string for the destination. |
No |
No |
Yes |
No |
No |
AccessHours |
Specifies access hours for visiting the destination. |
No |
No |
Yes |
No |
No |
AppointmentTime |
Scheduled appointment time at the destination. |
No |
No |
Yes |
No |
No |
ServiceDuration |
Service time at the destination, such as duration of an appointment. |
No |
No |
Yes |
No |
No |
