Segment Options

This set of preferences allows you to set the segment updates for each persistent update. Segment updates are changes applied to a corresponding route segment ID. For a particular segment, you can: exclude the segment, set the speed of the segment, change (increase or decrease) the speed of the segment by a value or percentage, or change the road type of the segment.

You must specify a RoutingSegmentID, then specify the type of segment update. Each request can contain one or more updates.

Table 1. Segment Update Options
Parameter	Description
RoutingSegmentID	The route segment ID to perform the persistent update.
Exclude	This is a string value to exclude the specified segment from all route calculations. To exclude a segment you need to specify the segment ID and include the Exclude parameter defined as Y. Valid values are Y (yes) and N (no).
RoadType	This is a string value to change the value of the road type for the segment for the route calculation. The RoadType can be one of the following: access way back road connector ferry footpath limited access dense urban limited access rural limited access suburban limited access urban local road dense urban local road rural local road suburban local road urban major local road dense urban major local road rural major local road suburban major local road urban major road dense urban major road rural major road suburban major road urban minor local road dense Urban minor local road rural minor local road suburban minor local road urban mormal road dense urban normal road rural normal road rural normal road urban primary highway dense urban primary highway rural primary highway suburban primary highway urban ramp dense urban ramp limited access ramp major road ramp primary highway ramp rural ramp secondary highway ramp urban ramp suburban secondary highway dense urban secondary highway rural secondary highway suburban secondary highway urban
Velocity	This is a speed update where you define the new speed of the segment by specifying the velocity unit and new velocity. For speed updates, the velocity unit can have one of the following values: kph (kilometers per hour), mph (miles per hour), mtps (meters per second), mtpm (meters per minute).
SpeedIncrease	This is a speed update where you define an increase in the speed of the segment by specifying either the velocity (unit and value) or a percentage to increase the speed. For speed updates, the velocity unit can have one of the following values: kph (kilometers per hour), mph (miles per hour), mtps (meters per second), mtpm (meters per minute).
SpeedDecrease	This is a speed update where you define a decrease in the speed of the segment by specifying either the velocity (unit and value) or a percentage to decrease the speed. For speed updates, the velocity unit can have one of the following values: kph (kilometers per hour), mph (miles per hour), mtps (meters per second), mtpm (meters per minute).