Side of Street Routing
Contents
The sideOfStreetAdherence parameter is used in multiple APIs to set the extent to which our routing algorithm will try to route to the side of the street where a stop is located. It can be set for the entire trip as part of the
Route Options, or for individual stops within a trip, as part of the Stop Location object in
POST method requests.
Below are the enum values for sideOfStreetAdherence.
| Value | Description |
|---|---|
Off | Will not re-route according to side of the street. This is the default value, except for school buses. |
Minimal | Will increase the route by up to a maximum of 1⁄4 mile to avoid ending up on the wrong side of the street. |
Moderate | Will increase the route by up to a maximum of 1/2 mile to avoid ending up on the wrong side of the street. |
Average | Will increase the route by up to a maximum of 1 mile to avoid ending up on the wrong side of the street. |
Strict | Will increase the route by up to a maximum of 5 miles to avoid ending up on the wrong side of the street. |
Adhere | Will increase the route by up to a maximum of 10 miles to avoid ending up on the wrong side of the street. |
StronglyAdhere | Will route the driver by any possible means to reach the correct side of the street. |
School Bus Routing Profiles
(Available in North America only. Requires license for school bus routing.)
If the
Vehicle Routing Profile is set to Small School Bus or Conventional School Bus, the sideOfStreetAdherence defaults to Average. This reduces the number of stops that require children to cross the road to board the bus.