➑️ route-direct-spec

GET https://{{route-service}}.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/solve

solve is the direct (synchronous) operation that scan be used to find the best way to get from one location to another or to visit several locations.

πŸ“„ API reference: solve operation
πŸ“™ Related guides: Routing

Request Params

KeyDatatypeRequiredDescription
fstring(Required) Specify the response format (json
tokenstring(Required) You need a valid access token. To learn more, read the collection's documentation.
stopsstringSpecify two or more locations between which the route is to be found
travelModestringChoose the mode of transportation for the analysis.
startTimestringIndicate the time at which travel begins from the input stops. You can also specify a value of now, to set the depart time to the current time.
startTimeIsUTCstringSpecify the time zone or zones of the startTime parameter.
timeWindowsAreUTCstringSpecify whether the TimeWindowStart and TimeWindowEnd attribute values on stops are specified in coordinated universal time (UTC) or geographically local time.
findBestSequencestringSpecify whether the service should reorder stops to find the optimized route.
preserveFirstStopstringIndicate whether the service should keep the first stop fixed when reordering the stops. This parameter is required only if the findBestSequence parameter value is set to true.
preserveLastStopstringIndicate whether the service should keep the last stop fixed when reordering the stops. This parameter is required only if the findBestSequence parameter value is set to true.
useTimeWindowsstringIndicate whether the service should consider time windows specified on the stops when finding the best route.
restrictUTurnsstringRestrict or permit the route from making U-turns at junctions.
useHierarchystringSpecify whether hierarchy should be used when finding the shortest paths.
impedanceAttributeNamestringSpecify the impedance. The default value is TravelTime.
accumulateAttributeNamesstringSpecify whether the service should accumulate values other than the value specified for impedanceAttributeName. The parameter value should be specified as a comma-separated list of names. The parameter values are the same as the impedanceAttributeName parameter.
restrictionAttributeNamesstringSpecify the restrictions that should be honored by the service.
attributeParameterValuesstringSpecify additional values required by an attribute or restriction.
barriersstringSpecify one or more points that act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets.
polylineBarriersstringSpecify one or more lines that prohibit travel anywhere the lines intersect the streets.
polygonBarriersstringSpecify polygons that either prohibit travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.
returnDirectionsstringSpecify whether the service should generate driving directions for each route.
directionsLanguagestringSpecify the language to be used when generating driving directions. This parameter is required only when the returnDirections parameter is set to true.
directionsOutputTypestringDefine the content and verbosity of the driving directions. This parameter is required only when the returnDirections parameter is set to true.
directionsStyleNamestringSpecify the name of the formatting style for the directions. This parameter is required only when the returnDirections parameter is set to true.
directionsLengthUnitsstringIndicate the units for displaying travel distance in the driving directions. This parameter is required only when the returnDirections parameter is set to true.
returnRoutesstringSpecify whether the service should return routes.
directionsTimeAttributeNamestringIndicate a time-based impedance attribute to display the duration of a maneuver.
outputLinesstringSpecify the type of route features that are output by the service.
returnStopsstringSpecify whether stops will be returned by the service.
returnBarriersstringSpecify whether barriers will be returned by the service.
returnPolylineBarriersstringSpecify whether polyline barriers will be returned by the service.
returnPolygonBarriersstringSpecify whether polygon barriers will be returned by the service.
ignoreInvalidLocationsstringSpecify whether invalid input locations should be ignored when finding the best solution.
outSRstringSpecify the spatial reference of the geometries.
outputGeometryPrecisionstringSpecify by how much you want to simplify the route geometry.
outputGeometryPrecisionUnitsstringSpecify the units for the value specified for the outputGeometryPrecision parameter.
overridesstringSpecify additional settings that can influence the behavior of the solver.
preserveObjectIDstringSpecify whether the object ids from the input locations should be preserved when the input locations are returned as output.