Routing services
Caution:For up-to-date information about routing services, see the most recent edition of this topic in the web help.
Routing services allow you to perform analysis on transportation networks, such as finding the best route across a city, finding the closest emergency vehicle or facility, identifying a service area around a location, or servicing a set of orders with a fleet of vehicles. If you have used ArcGIS Pro to perform analysis on a street network, routing services allow you to perform similar analysis using web services running on your ArcGIS Server site.
Dive-in:Routing services are either map services with network analysis capability (also known as Network Analysis services) or geoprocessing services available with ArcGIS Server. If you have previously worked with either map services or geoprocessing services, the REST API for routing services will be familiar to you. For routing services that are map services, the REST API for routing services is distinct from the REST API for map services. However, for routing services that are geoprocessing services, the routing services have the same REST API as any other geoprocessing service. You can think of a routing service as a geoprocessing service designed for performing a particular network analysis.
There are six types of analysis that can be performed using the routing services. Each type is available as a service and can be accessed using a unique REST endpoint for the service.
- Route service
The route service can be used to find the best way to get from one location to another or to visit several locations. The best route can be the quickest route for a given time of day considering the traffic conditions applicable during that time, or it can be the shortest route that minimizes the travel distance. The route service can also find the best route that visits each stop during permitted time windows you specify. If you have more than two stops to visit, the best route can be determined for the fixed order of locations you specify. Such a route is called a simple route. Alternatively, the route service can determine the best sequence in which to visit the locations (the traveling salesman problem). Such a route is called an optimized route.
- Closest Facility service
Finding the closest hospital to an accident, the closest police cars to a crime scene, and the closest store to a customer's address are all examples of problems that can be solved using the closest facility service. When finding the closest facilities, you can specify how many to find and whether the direction of travel is toward or away from them. Once you've found the closest facilities, you can display the best route to or from them and include the travel time, travel distance, and driving directions to each facility. The service can use current traffic conditions when determining the best routes. Additionally, you can specify an impedance cutoff beyond which the service should not search for a facility. For instance, you can set up a closest facility service to search for hospitals within 15 minutes' drive time of the site of an accident. Any hospitals that take longer than 15 minutes to reach will not be included in the results. The hospitals are referred to as facilities, and the accident is referred to as an incident. The service allows you to perform multiple closest facility analyses simultaneously. This means you can have multiple incidents and find the closest facility or facilities to each incident.
- Service Area service
With the service area service, you can find the area that can be reached from the input location within a given travel time or travel distance. A service area is the area that encompasses all streets that can be accessed within a given distance or travel time from one or more locations, referred to as facilities. Service areas are generally used to visualize and measure the accessibility of facilities. For example, a three-minute drive-time polygon around a grocery store can determine which residents are able to reach the store within three minutes and are thus more likely to shop there. The service can also create multiple concentric service areas around one or more facilities that can show how accessibility changes with an increase in travel time or travel distance. It can be used, for example, to determine how many hospitals are within 5, 10, and 15 minute drive times of schools. When creating service areas based on travel times, the service can make use of traffic data, which can influence the area that can be reached during different times of the day.
- Vehicle Routing Problem service
Various organizations service orders with a fleet of vehicles. For example, a large furniture store might use several trucks to deliver furniture to homes. A specialized grease recycling company might route trucks from a facility to pick up used grease from restaurants. A health department might schedule daily inspection visits for each of its health inspectors. The problem that is common to these examples is the vehicle routing problem (VRP). Each organization needs to determine which orders (homes, restaurants, or inspection sites) should be serviced by each route (truck or inspector) and in what sequence the orders should be visited. The primary goal is to best service the orders and minimize the overall operating cost for the fleet of vehicles. The VRP service can be used to determine solutions for such complex fleet management tasks. In addition, the service can solve more specific problems because numerous options are available, such as matching vehicle capacities with order quantities, providing a high level of customer service by honoring any time windows on orders, giving breaks to drivers, and pairing orders so they are serviced by the same route.
Consider an example of delivering goods to grocery stores from a central warehouse location. A fleet of three trucks is available at the warehouse. The warehouse operates only within a certain time window—from 8:00 a.m. to 5:00 p.m.—during which all trucks must return back to the warehouse. Each truck has a capacity of 15,000 pounds, which limits the amount of goods it can carry. Each store has a demand for a specific amount of goods (in pounds) that needs to be delivered, and each store has time windows that confine when deliveries should be made. Furthermore, the driver can work only eight hours per day, requires a break for lunch, and is paid for the amount of time spent on driving and servicing the stores. The service can be used to determine an itinerary for each route such that the deliveries can be made while honoring all the vehicle and order requirements and minimizing the total time spent on a particular route by the driver.
- Location-Allocation service
Location-allocation helps you choose which facilities from a set of facilities to operate based on their potential interaction with demand points. It can help you answer questions like the following:
- Given a set of existing fire stations, which site for a new fire station would provide the best response times for the community?
- If a retail company has to downsize, which stores should it close to maintain the most overall demand?
- Where should a factory be built to minimize the distance to distribution centers?
The objective may be to minimize the overall distance between demand points and facilities, maximize the number of demand points covered within a certain distance of facilities, maximize an apportioned amount of demand that decays with increasing distance from a facility, or maximize the amount of demand captured in an environment of friendly and competing facilities.
- Origin Destination Cost Matrix service
The Origin Destination Cost Matrix service helps you to create an origin-destination (OD) cost matrix from multiple origins to multiple destinations. An OD cost matrix is a table that contains the cost, such as the travel time or travel distance, from each origin to each destination. Additionally, it ranks the destinations that each origin connects to in ascending order based on the minimum cost required to travel from that origin to each destination. When generating an OD cost matrix, you can optionally specify the maximum number of destinations to find for each origin and the maximum time or distance to travel when searching for destinations.
The results from the OD cost matrix service often become input for other spatial analyses where the cost to travel on the street network is more appropriate than straight-line cost. For example, predicting the movement of people in a city is better modeled with costs based on street networks, since people tend to travel on roads and pedestrian paths.
Tip:The closest facility and OD cost matrix services perform very similar analyses; the main difference, however, is in the output and the computation speed. OD cost matrix service generates results more quickly but cannot return the true shapes of routes or their driving directions. It is designed to quickly solve large M x N problems and, as a result, does not internally contain the information required to generate route shapes and driving directions. Alternatively, the closest facility service returns routes and directions but performs the analysis more slowly than the OD cost matrix service. If you need driving directions or true shapes of routes, use the closest facility service; otherwise, use the OD cost matrix service to reduce the computation time.
Execution modes
A routing service can support the synchronous or the asynchronous execution mode. An execution mode defines how the application using the service interacts with the service and gets the result. When using the synchronous execution mode, the application must wait for the request to finish and get the results. This execution mode is well-suited for requests that complete quickly (under 10 seconds). When using the asynchronous execution mode, the client must periodically check whether the service has finished execution and, once completed, get the result. While the service is executing, the application is available to do other things. This execution mode is well-suited for requests that take a long time to complete because it allows you to continue to interact with the application while the results are generated. Another advantage of the asynchronous mode for long running requests is that the application does not need to keep a connection open with the web server in your ArcGIS Server site while the request is being processed. This can prevent web server timeouts that can occur with long-running synchronous requests.
A routing service for an analysis type supports the same functionality regardless of the execution mode. However, the request URL and the parameter names supported by the service are different based on the execution mode. Certain network analysis types are available in both execution modes and some are only available in asynchronous execution mode.
The table below summarizes the execution mode available for each analysis type and links to detailed API reference for the routing services.
Analysis type | Synchronous execution | Asynchronous execution |
|---|---|---|
Route service | Yes | Yes |
Closest Facility service | Yes | Yes |
Service Area service | Yes | Yes |
Vehicle Routing Problem service | Yes Learn more about the synchronous Vehicle Routing Problem service | Yes Learn more about the asynchronous Vehicle Routing Problem service |
Location-Allocation service | No | Yes Learn more about the asynchronous Location-Allocation service |
Origin Destination Cost Matrix service | Yes Learn more about the synchronous Origin Destination Cost Matrix service | Yes Learn more about the asynchronous Origin Destination Cost Matrix service |
Publish routing services
To use the routing services from their REST endpoints, you must first publish the services to an ArcGIS Server site in your ArcGIS Enterprise deployment. The routing services need a network dataset that defines the data model for your transportation network on which the analysis is performed. Once you have a network dataset, you can publish the routing services using the Publish Routing Services utility available with ArcGIS Server.