Transient Options

This set of preferences allows you to set transient updates for each request. For instance, you can request that the server attempt to avoid all of the major road types. Each request can contain one or more updates.

Note: The transient update functionality is only available through the SOAP API, and is not available through the Management Console or Enterprise Designer.

Table 1. Transient Update Options
Parameter	Description
PointUpdate	Point updates are changes applied to a corresponding point (Latitude, Longitude). For a particular point, you can: exclude the point, set the speed of the point or change (increase or decrease) the speed of the point by a value or percentage. You must specify a Point which consists of a Latitude and Longitude, then specify one of the following: Velocity This is a speed update where you define the new speed of the point 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 point 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 point 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). Exclude This is a string value to exclude the specified point from the route calculation. To exclude a point you need to specify the point and include the Exclude parameter defined as Y. Valid values are Y (yes) and N (no).
SegmentUpdate	Segment updates are changes applied to a corresponding segment ID (Latitude, Longitude). 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 valid RoutingSegmentID, then specify one of the following: 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). 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 Exclude This is a string value to exclude the specified segment from the route calculation. 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).
RoadTypeUpdate	Road type updates are changes applied to a corresponding road type. For a particular road type, you can: set the speed of the roadtype, or change (increase or decrease) the speed of the road type by a value or percentage. You must specify a RoadType to update (see the above road types in the segment update), then specify one of the following: 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).