Overview
The Avoids feature allows you to define geographic areas that users should not navigate through when they plan or follow routes in the mobile app. When configuring Avoids, you proactively guide users toward safer, preferred routes .
For example, you can create a temporary Avoid with an expiration window to route users around a weekend construction project on a major highway interchange. Another example would be configuring an indefinite Avoid to prevent users from taking a road that prohibits commercial vehicles.
NOTE: If no
expirationproperty is set, the Avoid remains active indefinitely.
How It Works
Create, manage, retrieve, and delete Avoids through the Avoids API or within App Manager’s Trip Planner Studio.
Avoids are defined at the environment level. This means all route requests from users within the same environment utilize the same set of Avoids.
NOTE: To ensure continuous guidance, the Platform will route through an Avoid area if it is the only available path or if the user is already inside it.
WARNING: The Platform limits each environment to 300 Avoids in total, with a maximum of 150 that remain
activeortestat any given time. The API returns an error if you attempt to create additional Avoids beyond these limits.
Key Components
You must supply specific properties when you define an Avoid object.
code: A unique string identifier for the Avoid.name: A descriptive title for the geographic restriction.type: The type of Avoid shape.NOTE: The system currently supports
rectangleas the only valid type.coordinates: The geographic boundaries of the Avoid area.status: Determines how the system applies the Avoid. Anactivestatus applies to all routes, ateststatus applies only in Trip Planner Studio's Build a New Route for evaluation, and aninactivestatus stores the Avoid without applying it.