---
title: "/solve"
uid: route-service-direct
description: "Find directions using the global route service available with ArcGIS Location Services."
context:
requestType: "direct"
---
import Token from "../../../shared/routing/snippets/request-parameters/_Token.mdx"
import RouteServiceDesc from "../../../shared/routing/snippets/_route-service.mdx"
import RouteStops from "../../../shared/routing/snippets/request-parameters/_Route-stops.mdx"
import FindBestSequence from "../../../shared/routing/snippets/request-parameters/_Route-BestSequence-JDR-OnE.mdx"
import DirectionsDistanceUnits from "../../../shared/routing/snippets/request-parameters/_DirectionsDistanceUnits-JDR-OnE.mdx"
import DirectionsStyleName from "../../../shared/routing/snippets/request-parameters/_DirectionsStyleName-JDR-OnE.mdx"
import RestrictUTurns from "../../../shared/routing/snippets/request-parameters/_UTurnAtJunctions.mdx"
import UseHierarchy from "../../../shared/routing/snippets/request-parameters/_UseHierarchy-JDR-OnE.mdx"
import Restrictions from "../../../shared/routing/snippets/request-parameters/_Restrictions-JDR-OnE.mdx"
import UseTimeWindows from "../../../shared/routing/snippets/request-parameters/_UseTimeWindows-JDR-OnE.mdx"
import ImpedanceAttrName from "../../../shared/routing/snippets/request-parameters/_Impedance-JDR-OnE.mdx"
import AttributeParameterValues from "../../../shared/routing/snippets/request-parameters/_AttributeParameterValues-JDR-OnE.mdx"
import AccumulateAttrNames from "../../../shared/routing/snippets/request-parameters/_AccumulateAttributeNames-DR-OnE.mdx"
import RouteShape from "../../../shared/routing/snippets/request-parameters/_RouteShape-JR-OnE.mdx"
import IgnoreInvalidLocations from "../../../shared/routing/snippets/request-parameters/_IgnoreInvalidLocations-JDR-OnE.mdx"
import Overrides from "../../../shared/routing/snippets/request-parameters/_Overrides-JDR-OnE.mdx"
import PopulateDirectionsRoute from "../../../shared/routing/snippets/request-parameters/_PopulateDirections-JDR-OnE.mdx"
import DirectionsLanguage from "../../../shared/routing/snippets/request-parameters/_DirectionsLanguage-JDR-OnE.mdx"
import TravelModes from "../../../shared/routing/snippets/request-parameters/_TravelMode.mdx"
import StartTime from "../../../shared/routing/snippets/request-parameters/_StartTime.mdx"
import StartTimeIsUTC from "../../../shared/routing/snippets/request-parameters/_startTimeIsUTC.mdx"
import TimeWindowsIsUTC from "../../../shared/routing/snippets/request-parameters/_timeWindowsAreUTC.mdx"
import DirectionsTimeAttrName from "../../../shared/routing/snippets/request-parameters/_DirectionsTimeAttrName.mdx"
import ReturnBarriers from "../../../shared/routing/snippets/request-parameters/_returnBarriers.mdx"
import ReturnPolygonBarriers from "../../../shared/routing/snippets/request-parameters/_returnPolygonBarriers.mdx"
import ReturnPolylineBarriers from "../../../shared/routing/snippets/request-parameters/_returnPolylineBarriers.mdx"
import ReturnTraversedEdges from "../../../shared/routing/snippets/request-parameters/_returnTraversedEdges.mdx"
import ReturnTraversedJunctions from "../../../shared/routing/snippets/request-parameters/_returnTraversedJunctions.mdx"
import ReturnTraversedTurns from "../../../shared/routing/snippets/request-parameters/_returnTraversedTurns.mdx"
import ReturnZ from "../../../shared/routing/snippets/request-parameters/_returnZ.mdx"
import Context from "../../../shared/routing/snippets/request-parameters/_Context.mdx"
import OutputGeometryPrecision from "../../../shared/routing/snippets/request-parameters/_RouteLineSimplificationTolerance-JR-OnE.mdx"
import OutputGeometryPrecisionUnits from "../../../shared/routing/snippets/request-parameters/_OutputGeometryPrecisionUnits.mdx"
import GeometryPrecision from "../../../shared/routing/snippets/request-parameters/_GeometryPrecision.mdx"
import GeometryPrecisionM from "../../../shared/routing/snippets/request-parameters/_GeometryPrecisionM.mdx"
import GeometryPrecisionZ from "../../../shared/routing/snippets/request-parameters/_GeometryPrecisionZ.mdx"
import PreserveObjectID from "../../../shared/routing/snippets/request-parameters/_PreserveObjectID.mdx"
import ReturnEmptyResults from "../../../shared/routing/snippets/request-parameters/_ReturnEmptyResults.mdx"
import LocateSettings from "../../../shared/routing/snippets/request-parameters/_LocateSettings.mdx"
import DirectionsOutputType from "../../../shared/routing/snippets/request-parameters/_DirectionsOutputType.mdx"
import LineBarrier from "../../../shared/routing/snippets/request-parameters/_LineBarriers.mdx"
import PolygonBarrier from "../../../shared/routing/snippets/request-parameters/_PolygonBarriers.mdx"
import PointBarrier from "../../../shared/routing/snippets/request-parameters/_PointBarriers.mdx"
import UsageLimit from "../../../shared/routing/snippets/request-parameters/_Route-UsageLimits.mdx"
import ConfigureLimits from "../../../shared/routing/snippets/request-parameters/_configureLimits.mdx"
import OutputRoutes from "../../../shared/routing/snippets/output-parameters/_Route-outputRoutes.mdx"
import OutputStops from "../../../shared/routing/snippets/output-parameters/_Route-outputStops.mdx"
import Directions from "../../../shared/routing/snippets/output-parameters/_outputDirections.mdx"
import ResultFile from "../../../shared/routing/snippets/output-parameters/_resultFile.mdx"
import OutputNetworkAnalysisLayer from "../../../shared/routing/snippets/output-parameters/_outputNetworkAnalysisLayer.mdx"
import OutputRouteData from "../../../shared/routing/snippets/output-parameters/_outRouteData.mdx"
import CostUsage from "../../../shared/routing/snippets/output-parameters/_UsageCost.mdx"
import Direction from "../../../shared/routing/snippets/output-parameters/_outputDirections.mdx"
import DirectionLine from "../../../shared/routing/snippets/output-parameters/_outputDirectionLines.mdx"
import DirectionPoint from "../../../shared/routing/snippets/output-parameters/_outputDirectionPoints.mdx"
import OutputBarriers from "../../../shared/routing/snippets/output-parameters/_barriers.mdx"
import OutputPolylineBarriers from "../../../shared/routing/snippets/output-parameters/_polylineBarriers.mdx"
import OutputPolygonBarriers from "../../../shared/routing/snippets/output-parameters/_polygonBarriers.mdx"
import TraversedEdges from "../../../shared/routing/snippets/output-parameters/_traversedEdges.mdx"
import TraversedJunctions from "../../../shared/routing/snippets/output-parameters/_traversedJunctions.mdx"
import TraversedTurns from "../../../shared/routing/snippets/output-parameters/_traversedTurns.mdx"
import SolveSucceeded from "../../../shared/routing/snippets/output-parameters/_SolveSucceeded.mdx"
import UsageCost from "../../../shared/routing/snippets/output-parameters/_UsageCost.mdx"
import SharedContent from "../../../shared/content/_required-params.mdx"
import ParamMetadata from "../../../shared/components/param-metatdata"
Publish using publish routing services
Publish using ArcGIS Pro
If you publish routing services using [configure routing services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-routing-services.htm) dialog box from ArcGIS Enterprise portal website, or publish using [publish routing services](https://enterprise.arcgis.com/en/server/latest/develop/windows/publishing-routing-services.htm) command line utility, use the following endpoint to access the /solve direct request. The `{{folderName}}` represents the folder in which the services are being published.
{`GET https://{{machineName}}/{{serverWebAdaptorName}}/rest/services/{{folderName}}/NetworkAnalysis/NAServer/Route/solve`}
{`POST https://{{machineName}}/{{serverWebAdaptorName}}/rest/services/{{folderName}}/NetworkAnalysis/NAServer/Route/solve`}
If you publish routing services using [ArcGIS Pro](https://pro.arcgis.com/en/pro-app/latest/help/analysis/networks/publish-standard-routing-services.htm), use the following endpoint to access the /solve direct request. The `{{serviceName}}` represents the name of the routing services published from ArcGIS Pro. The `{{layerName}}` is the route layer's name in the map used to publish the routing service.
{`GET https://{{machineName}}/{{serverWebAdaptorName}}/rest/services/{{serviceName}}/NAServer/{{layerName}}/solve`}
{`POST https://{{machineName}}/{{serverWebAdaptorName}}/rest/services/{{serviceName}}/NAServer/{{layerName}}/solve`}
## Parameters
[f](#f)
string
The request response format, either `json` or `pjson`
[token](#token)
string
An access token with the [required privileges](#token).
[stops](#stops)
locations | feature | layer
Two or more locations between which the route is generated.
[travelMode](#travelmode)
object
The mode of transportation for the analysis provided as a JSON object.
[startTime](#starttime)
datetime | "now"
The time at which travel begins from the input stops.
[startTimeIsUTC](#starttimeisutc)
boolean
`false`
The time zone or zones of the `startTime` parameter.
[timeWindowsAreUTC](#timewindowsareutc)
boolean
`false`
The time, either coordinated universal time (UTC) or geographically local time, for the `TimeWindowStart` and `TimeWindowEnd` attributes.
[findBestSequence](#findbestsequence)
boolean
`false`
Reorders stops to find an optimized route.
[preserveFirstStop](#preservefirststop)
boolean
`true`
Preserves the first stop while reordering others. Used if `findBestSequence` is set to `true`.
[preserveLastStop](#preserveLastStop)
boolean
`true`
Preserves the last stop while reordering others. Used if `findBestSequence` is set to `true`.
[useTimeWindows](#usetimewindows)
boolean
`false`
Sets whether the request will consider time windows specified on stops.
[restrictUTurns](#restrictuturns)
string
`esriNFSBAtDeadEndsAndIntersections`
Restricts or allows a route to make U-turns at junctions.
[useHierarchy](#usehierarchy)
boolean
`true`
Specifies whether hierarchy will be used when finding the shortest path.
[impedanceAttributeName](#impedanceattributename)
string
`TravelTime`
The type of impedance, such as `Minutes` or `Miles`.
[accumulateAttributeNames](#accumulateattributenames)
string
`Miles,Kilometers`
Accumulates values other than the value set in the `impedanceAttributeName` parameter.
[restrictionAttributeNames](#restrictionattributenames)
string
The restrictions that should be honored.
[attributeParameterValues](#attributeparametervalues)
[object]
Additional values required by an attribute or restriction.
[barriers](#barriers)
locations | feature | layer
One or more points that act as temporary restrictions, additional time, or distance.
[polylineBarriers](#polylinebarriers)
feature | layer
One ore more lines that prohibit travel anywhere the lines intersect the streets.
[polygonBarriers](#polygonbarriers)
feature | layer
Polygons that either prohibit travel or proportionately scale the time or distance required to travel on the streets.
[returnDirections](#returndirections)
boolean
`true`
Generates the driving directions for each route.
[directionsLanguage](#directionslanguage)
string
`en`
The language used when generating driving directions.
[directionsOutputType](#directionsoutputtypes)
string
`esriDOTStandard`
The content and length of the driving directions. Used if`returnDirections=true`.
[directionsStyleName](#directionsstylename)
string
`NA Desktop`
The formatting style for the directions. Used if`returnDirections=true`.
[directionsLengthUnits](#directionslengthunits)
string
`esriNAUMiles`
The units to display the travel distance in driving directions. Used if`returnDirections=true`.
[returnRoutes](#returnroutes)
boolean
`true`
Returns routes.
[directionsTimeAttributeName](#directionstimeattributename)
string
`TravelTime`
A time-based impedance attribute to display the duration of a maneuver.
[outputLines](#outputlines)
string
`esriNAOutputLineTrueShape`
The type of route features that are returned.
[returnStops](#returnstops)
boolean
`false`
Returns stops.
[returnBarriers](#returnbarriers)
boolean
`false`
Returns barriers.
[returnPolylineBarriers](#returnpolylinebarriers)
boolean
`false`
Returns polyline barriers.
[returnPolygonBarriers](#returnpolygonbarriers)
boolean
`false`
Returns polygon barriers.
[returnTraversedEdges](#returntraversededges)
boolean
`false`
Returns traversed edges.
[returnTraversedJunctions](#returntraversedjunctions)
boolean
`false`
Returns traversed junctions.
[returnTraversedTurns](#returntraversedturns)
boolean
`false`
Returns traversed turns.
[returnZ](#returnz)
boolean
`false`
Returns z- values for the returned geometries.
[ignoreInvalidLocations](#ignoreinvalidlocations)
boolean
`true`
Ignores invalid input locations.
[outSR](#outsr)
string
The spatial reference of output geometries.
[outputGeometryPrecision](#outputgeometryprecision)
number
`10`
Simplifies route geometry.
[outputGeometryPrecisionUnits](#outputgeometryprecisionunits)
string
`esriMeters`
The units for the value in the `outputGeometryPrecision` parameter.
[geometryPrecision](#geometryprecision)
integer
The number of decimal places in the response geometries. Applies to x and y values only.
[geometryPrecisionM](#geometryprecisionm)
integer
The number of decimal places in the response geometries. Applies to m-values only.
[geometryPrecisionZ](#geometryprecisionz)
integer
The number of decimal places in the response geometries. Applies to z-values only.
[overrides](#overrides)
string
For internal use only.
[preserveObjectID](#preserveobjectid)
boolean
`false`
Preserves the object IDs from input locations when the input locations are returned as output.
[returnEmptyResults](#returnemptyresults)
boolean
`false`
Returns empty results instead of the error property when a request fails.
[locateSettings](#locatesettings)
object
Determines how input data are located.
All the default parameter values mentioned above are assuming that the routing service is published with default settings. If you publish routing services using [ArcGIS Pro](https://pro.arcgis.com/en/pro-app/latest/help/analysis/networks/publish-standard-routing-services.htm#ESRI_SECTION1_61BF401948C74301AF09F7D5D0E6FA35), you can change the default on the network analysis layer before publishing the service. If you publish routing services using [configure routing services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-routing-services.htm) dialog box from ArcGIS Enterprise portal website, or publish using [publish routing services](https://enterprise.arcgis.com/en/server/latest/develop/windows/publishing-routing-services.htm) command line utility, the default values can be changed through the publish routing services [configuration file](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-routing-service-config-file.htm), and you can apply the configuration file while publishing the routing services.
## Required parameters
### f
### token
### stops
## Optional parameters
### travelMode
### startTime
### startTimeIsUTC
### timeWindowsAreUTC
### findBestSequence
### preserveFirstStop
{/* type:booldefault:`true`
*/}
Specify whether the request will keep the first stop fixed when reordering the stops.
- `true`—The request won't reorder the first stop. Choose this option if you are starting from a known location, such as your home, headquarters, or current location.
- `false`—The request will not preserve the first stop and reorder all the stops.
This parameter is applicable only if the [`findBestSequence`](#findbestsequence) parameter value is `true` .
### preserveLastStop
{/* type:booldefault:`true`
*/}
Specify whether the request will keep the last stop fixed when reordering the stops.
- `true`—The request won't reorder the last stop. The output routes may begin at any stop but must end at the predetermined last stop.
- `false`—The request will not preserve the last stop and reorder all the stops.
This parameter is applicable only if the [`findBestSequence`](#findbestsequence) parameter value is `true` .
### useTimeWindows
### restrictUTurns
### useHierarchy
### impedanceAttributeName
### accumulateAttributeNames
### restrictionAttributeNames
### attributeParameterValues
### barriers
### polylineBarriers
### polygonBarriers
### returnDirections
### directionsLanguage
### directionsOutputType
### directionsStyleName
### directionsLengthUnits
### returnRoutes
{/* type:enumdefault:`true`
*/}
Specify whether the request will return routes.
- `true`—Routes are returned. The routes are available in the [`routes`](#routes) property of the JSON response. The shape of the routes depends on the value for the [`outputLines`](#outputlines) parameter.
- `false`—Routes are not returned.
If you don't want to return routes because the application has to display only the driving directions between the stops, you can set the [`returnDirections`](#returndirections) parameter to `true` and the `returnRoutes` parameter to `false`. In this case, returning the routes will not provide any additional information and will increase the overall response size.
### directionsTimeAttributeName
### outputLines
### returnStops
{/* type:enumdefault:`false`
*/}
Specify whether stops will be returned by the request.
- `true`—Stops used as input will be returned as part of the [`stops`](#stops) property in the JSON response.
- `false`—Stops are not returned.
When finding optimized routes, the `returnStops` property can be set to `true` to determine the optimal sequence in which the route visits a particular stop by reviewing the `Sequence` property in the JSON response. If you specified the `stops` parameter value using a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set, you can set the `returnStops` parameter to `true` so you can draw the stop locations in the application. You can also set the `returnStops` property to `true` to determine whether the stops were successfully located on the street network or had other errors by reviewing the `Status` property in the JSON response.
### returnBarriers
### returnPolylineBarriers
### returnPolygonBarriers
### returnTraversedEdges
### returnTraversedJunctions
### returnTraversedTurns
### returnZ
### ignoreInvalidLocations
### context
### outputGeometryPrecision
### outputGeometryPrecisionUnits
### geometryPrecision
### geometryPrecisionM
### geometryPrecisionZ
### overrides
### preserveObjectID
### returnEmptyResults
### locateSettings
## Response objects
The JSON response from the route request is based on the following syntax. The actual properties returned in the response depend on the request parameters. For example, the `stops` property is returned only if the `returnStops` parameter is set to `true` . If a request fails, the JSON response only contains the `error` property.
For a list of error codes and details, go to [Direct request error codes](/naserver-error-codes)
On successful completion, the request returns the best paths between the stops and the status indicating whether the analysis was successful using the output parameters described below.
### stops
### routes
### barriers
### polylineBarriers
### polygonBarriers
### traversedEdges
### traversedJunctions
### traversedTurns
### directions
### directionPoints
### directionLines
## Examples
To build client application [see API reference examples](DEVSITE/documentation/mapping-and-location-services/routing-and-directions/route-and-directions/#direct-find-a-route-and-directions)
Below are examples of the request on how to find best route and driving directions between two locations.
If you copy and paste the request URL from the examples into a web browser, you need to replace `` with a valid token. See [Security and authentication](DEVSITE/documentation/security-and-authentication/) to learn more.
### Find the best route and driving directions between two locations
To find the best route between two stops, you can pass their locations, such as the longitude and latitude values, as the value for the `stops` parameter to the `/solve` request. The request will use default values for all other parameters and return a best route between the two stops.
Request
Response
### Find the optimized route and driving directions to visit a set of locations
In some cases, you know the start and end location for your route but want to visit the intermediate stops in an optimal sequence such that the overall travel time or distance of the route is minimized. Such a route, called an optimized route, can be found by specifying a value of true for the findBestSequence parameter. In this example, since you also want to maintain the sequence of first and last stops, you also need to set a value of true for the preserveFirstStop and preserveLastStop parameters.
In this example, you want to find an optimized route that minimizes travel time. You want the route to start and end at the same location and visit the intermediate five stops in the sequence that minimizes the overall travel time. You need to specify a name for each of the stops and an approximate time in minutes you expect to spend at each stop. Consequently, instead of using only the longitude and latitude values for the stops parameter, you'll use the JSON structure for features. The driving directions as well as the total travel time for the route will include the time you expect to spend at each location. The JSON structure for stops specifies the x and y properties for the geometry property as well as the Name and Attr_TravelTime properties for each stop. The returnStops parameter is also set to true to return the optimized sequence of the stops.
Request
Response
### Find the best route that avoids flooded area
Some areas may be temporarily inaccessible due to flooding or other events. If you want to find a route that avoids these areas, you can pass in the areas as `polygonBarriers`. The request will determine the streets that intersect the specified area and restrict travel on those streets when finding the best route.
In this example, the stops are specified using their longitude and latitude values. The geometry of the flooded area is in the default spatial reference, WGS84. Hence, the `spatialReference` property is not required within the `geometry` property. You want to completely avoid travel on any streets that are within the flooded area, so you'll use a restriction polygon barrier to represent the flooded area by specifying the `BarrierType` as 0. You want to draw the resulting route on a basemap that uses the Web Mercator (WKID 102100) spatial reference. So you'll request the output route geometries in Web Mercator spatial reference by specifying the `outSR` parameter.
Request
Response
### Find a route in countries not covered by the request
If the first stop is in a country not supported by the request, the request fails with an error message.
Request
Response
## Service limits