RouteResponseCode Enumeration

Note

Bing Maps Web Control SDK retirement

Bing Maps Web Control SDK is deprecated and will be retired. Free (Basic) account customers can continue to use Bing Maps Web Control SDK until June 30th, 2025. Enterprise account customers can continue to use Bing Maps Web Control SDK until June 30th, 2028. To avoid service disruptions, all implementations using Bing Maps Web Control SDK will need to be updated to use Azure Maps Web SDK by the retirement date that applies to your Bing Maps for Enterprise account type. For detailed migration guidance, see Migrate from Bing Maps Web Control SDK and Migrate Bing Maps Enterprise applications to Azure Maps with GitHub Copilot.

Azure Maps is Microsoft's next-generation maps and geospatial services for developers. Azure Maps has many of the same features as Bing Maps for Enterprise, and more. To get started with Azure Maps, create a free Azure subscription and an Azure Maps account. For more information about azure Maps, see Azure Maps Documentation. For migration guidance, see Bing Maps Migration Overview.

Contains response codes for a route calculation request.

Response Code Name Description
0 success The route was successfully calculated.
1 unknownError An unknown error has occurred.
2 cannotFindNearbyRoad A nearby road cannot be found for one or more of the route waypoints.
3 tooFar The distance between two route waypoints, or the total length of the route exceeds the limit of the route mode. Modify the waypoint locations so that they are closer together.
4 noSolution A route cannot be calculated for the specified waypoints. For example, this code is returned when a route between “Seattle, WA” and “Honolulu, HI” is requested.
5 dataSourceNotFound There is no route data for the specified waypoints.
7 noAvailableTransitTrip There are no transit options available for the specified time.
8 transitStopsTooClose The transit stops are so close that walking is always a better option.
9 walkingBestAlternative The transit stops are so close that walking is a better option.
10 outOfTransitBounds There is no transit data available for the route or for one or more of the specified waypoints, or the waypoints are in different transit areas that do not overlap.
11 timeout The directions calculation request has timed out.
12 waypointDisambiguation One or more waypoints need to be disambiguated. This error does not occur if the autoDisplayDisambiguation directions render option is set to true.
13 hasEmptyWaypoint One or more waypoints do not have an address or location specified.
14 exceedMaxWaypointLimit The maximum number of waypoints, which is 25, has been exceeded.
15 atleastTwoWaypointRequired At least two waypoints are required to calculate a route.
16 firstOrLastStoppointIsVia The first or last waypoint is a via point, which is not allowed.
17 searchServiceFailed The search service failed to return results.
18 invalidCredentials The credentials passed to the Directions module are invalid.