Route service with synchronous execution

• URL:https://<nalayer-url>/solve
  
• Version Introduced:9.3.1

Description

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.

The solve operation is performed on a network layer resource. The solve operation is supported on a network layer with a layerType value of esriNAServerRouteLayer. You can provide arguments to the solve operation as query parameters defined in the parameters table below. See the Get a route and directions tutorial to learn more about how to get directions and calculate an optimal route between two or more places using synchronous mode.

Updates at 10.9.1

• Use returnTraversedEdges, returnTraversedJunctions, and returnTraversedTurns to specify whether the service should return the elements traversed during the solve.
• Use geometryPrecision, geometryPrecisionZ, and geometryPrecisionM to specify the output geometry precision for X, Y, and Z coordinates and the value of M.

Updates at 10.8.1

When the authoring application for services is ArcGIS Pro, you can specify the now value in the startTime parameter to set your analysis to begin at the current time.

Updates at 10.8

Use the preserveObjectID parameter to specify whether the object IDs from the input locations will be preserved when the input locations are returned as output.

Updates at 10.5

Use the overrides parameter to specify additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems.

Updates at 10.4

Pass in a complete JSON representation of a travel mode through travelMode and automatically set override values for various other parameters to quickly and consistently model cars, trucks, a type of truck, and so on.

Updates at 10.3

Use the travelMode parameter to automatically set override values for various other parameters to quickly and consistently model cars, trucks, a type of truck, and so on.

Updates at 10.2.1

Use the startTimeIsUTC parameter to specify whether the startTime parameter value is in UTC or the time zone of the first stop. Using startTimeIsUTC, you can start all the routes at the same time regardless of the time zone where the stops are located.

Updates at 10.1

• M-values—The outputLines parameter supports a new value: esriNAOutputLineTrueShapeWithMeasure. If specified, returned routes, compressed geometry, and service area lines will contain m-values on each vertex.
• Z-values—The route solver supports the new returnZ parameter. If returnZ=true and the route solver is using a z-aware network dataset, returned routes and compressed geometry will contain z-values on each vertex. Input point and line locations can have z-values on them.

  Routes, directions, stops, and barriers in the response include the hasZ and hasM properties that indicate whether the geometry includes z-values or m-values, respectively.

• CompressedGeometry—CompressedGeometry can contain m- and z-values and indicates how to decompress m- and z-values.
• Use the optional url property to specify input stops, barriers, polylineBarriers, or polygonBarriers values. The url value contains a REST Query request to a feature, map, or geoprocessing service returning a JSON feature set. The advantage of using this property is that locations can be passed directly from a service endpoint as input to the network analysis operation, bypassing the client as intermediate storage.

Request parameters

Parameter	Description
stops (Required)	Specify two or more locations between which the route is to be found. Syntax: As longitude, latitude values As a collection of features As a feature service URL As a layer in the map service
token (Required)	Provide the identity of a user who has permissions to access the service.
f (Optional)	Specify the response format. The default value is html. Values: html | json | pjson
travelMode (Optional)	Specify the mode of transportation for the analysis. Value: JSON object
startTime (Optional)	Specify the time at which travel begins from the input stops. You can also use the now value to set the start time to the current time.
startTimeIsUTC (Optional)	Specify the time zone or zones of the startTime parameter. Values: true | false
timeWindowsAreUTC (Optional)	Specify whether the TimeWindowStart and TimeWindowEnd attribute values for stops are specified in coordinated universal time (UTC) or geographically local time. Values: true | false
findBestSequence (Optional)	Specify whether the service will reorder stops to find the optimized route. Values: true | false
preserveFirstStop (Optional)	Specify whether the service will keep the first stop fixed when reordering the stops. This parameter is required only if the findBestSequence parameter value is set to true. Values: true | false
preserveLastStop (Optional)	Specify whether the service will keep the last stop fixed when reordering the stops. This parameter is required only if the findBestSequence parameter value is set to true. Values: true | false
useTimeWindows (Optional)	Specify whether the service will use time windows specified on the stops when finding the best route. The default value is false. Values: true | false
restrictUTurns (Optional)	Restrict or permit the route to make U-turns at junctions. Values: esriNFSBAtDeadEndsAndIntersections | esriNFSBAllowBacktrack | esriNFSBAtDeadEndsOnly | esriNFSBNoBacktrack
useHierarchy (Optional)	Specify whether hierarchy will be used when finding the shortest paths. Values: true | false
impedanceAttributeName (Optional)	Specify the impedance. Values: TravelTime | TruckTravelTime | WalkTime | Miles | Kilometers Note: These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.
accumulateAttributeNames (Optional)	Specify whether the service will accumulate values other than the value specified for impedanceAttributeName. Specify the parameter value as a comma-separated list of names. The parameter values are the same as the impedanceAttributeName parameter. The values can be specified as in the example below: accumulateAttributeName=Miles,Kilometers Values: Miles | Kilometers | WalkTime | TravelTime | TruckTravelTime Note: These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.
restrictionAttributeNames (Optional)	Specify the restrictions that will be honored by the service. The values can be specified as in the example below: restrictionAttributeNames=Avoid Carpool Roads, Avoid Express Lanes, Avoid Gates, Avoid Private Roads, Avoid Unpaved Roads, Driving an Automobile, Roads Under Construction Prohibited, Through Traffic Prohibited For a complete list of values, see the restrictionAttributeNames section below. Note: These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.
attributeParameterValues (Optional)	Specify additional values required by an attribute or restriction. For more information on accepted values, see the attributeParameterValues section below. Syntax
barriers (Optional)	Specify one or more points to act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. Syntax: As longitude, latitude values As a collection of features As a feature service URL As a layer in the map service
polylineBarriers (Optional)	Specify one or more lines that prohibit travel anywhere the lines intersect the streets. Syntax: As a collection of features As a feature service URL As a layer in the map service
polygonBarriers (Optional)	Specify polygons that either prohibit travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons. Syntax: As a collection of features As a feature service URL As a layer in the map service
returnDirections (Optional)	Specify whether the service will generate driving directions for each route. The default value is true. Values: true | false
directionsLanguage (Optional)	Specify the language that will be used when generating driving directions. This parameter is required only when the returnDirections parameter is set to true. For a full list of accepted values, see the directionsLanguage section below.
directionsOutputType (Optional)	Define the content and verbosity of the driving directions. This parameter is required only when the returnDirections parameter is set to true. The default value is esriDOTStandard. Values: esriDOTStandard | esriDOTComplete | esriDOTCompleteNoEvents | esriDOTInstructionsOnly | esriDOTStandard | esriDOTSummaryOnly | esriDOTFeatureSets
directionsStyleName (Optional)	Specify the name of the formatting style for the directions. This parameter is required only when the returnDirections parameter is set to true. The default value is NA Desktop. Values: NA Desktop | NA Navigation
directionsLengthUnits (Optional)	Specify the units for displaying travel distance in the driving directions. This parameter is required only when the returnDirections parameter is set to true. Values: esriNAUMiles | esriNAUCentimeters | esriNAUDecimalDegrees | esriNAUDecimeters | esriNAUFeet | esriNAUInches | esriNAUKilometers | esriNAUMeters | esriNAUMillimeters | esriNAUNauticalMiles | esriNAUPoints | esriNAUYards
directionsTimeAttributeName (Optional)	Specify a time-based impedance attribute to display the duration of a maneuver. Values: TravelTime | TruckTravelTime | WalkTime Note: These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.
returnRoutes (Optional)	Specify whether routes will be returned by the service. The default value is true. Values: true | false
outputLines (Optional)	Specify the type of route features that will be output by the service. Values: esriNAOutputLineTrueShape | esriNAOutputLineTrueShapeWithMeasure | esriNAOutputLineStraight | esriNAOutputLineNone
returnStops (Optional)	Specify whether stops will be returned by the service. The default value is false. Values: true | false
returnBarriers (Optional)	Specify whether barriers will be returned by the service. The default value is false. Values: true | false
returnPolylineBarriers (Optional)	Specify whether polyline barriers will be returned by the service. The default value is false. Values: true | false
returnPolygonBarriers (Optional)	Specify whether polygon barriers will be returned by the service. The default value is false. Values: true | false
returnTraversedEdges	Specify whether traversed edges will be returned by the service. The default value is false. Values: true | false When this parameter is set to true, the traversed edges are available in the traversedEdges property of the JSON response.
returnTraversedJunctions	Specify whether traversed junctions will be returned by the service. The default value is false. Values: true | false When this parameter is set to true, the traversed junctions are available in the traversedJunctions property of the JSON response.
returnTraversedTurns	Specify whether traversed turns will be returned by the service. The default value is false. Values: true | false When this parameter is set to true, the traversed turns are available in the traversedTurns property of the JSON response.
ignoreInvalidLocations (Optional)	Specify whether invalid input locations will be ignored when finding the best solution. The default value is true. Values: true | false
outSR (Optional)	Specify the spatial reference of the geometries.
outputGeometryPrecision (Optional)	Specify how the route geometry will be simplified. The units for this parameter are set using the outputGeometryPrecisionUnits parameter.
outputGeometryPrecisionUnits (Optional)	Specify the units for the outputGeometryPrecision parameter value. Values: esriMeters | esriCentimeters | esriDecimalDegrees | esriDecimeters | esriFeet | esriInches | esriKilometers | esriMiles | esriMillimeters | esriNauticalMiles | esriPoints | esriYards
geometryPrecision	Specify the number of decimal places in the response geometries returned by solve operation. This applies to X- and Y-values only (not M- or Z-values). geometryPrecision = 3
geometryPrecisionZ	Specify the number of decimal places in the response geometries returned by solve operation. This applies to Z-value only (not X-,Y- or M-values). geometryPrecisionZ = 3
geometryPrecisionM	Specify the number of decimal places in the response geometries returned by solve operation. This applies to M-value only (not X-,Y- or Z-values). geometryPrecisionM = 3
overrides (Optional)	Specify additional settings that can influence the behavior of the solver.
preserveObjectID (Optional)	Specify whether the object IDs from the input locations will be preserved when the input locations are returned as output. The default value is false. Values: true | false

Note:

The default value for each parameter is based on the layer setting when map service is published with the network analysis capabilities. Open the service description page to see the default values for the parameters.

Required parameters

stops

Specifies the locations the output route or routes will visit.

You can use a simple comma- and semicolon-based syntax if you are passing the input locations using their longitude and latitude values in the WGS84 coordinate system and don't need to pass additional fields for each location.

Simple syntax for stops

stops=x1,y1; x2, y2; ...; xn, yn

Example using simple syntax

stops=-117.1957,34.0564; -117.184,34.0546

The stops parameter can be specified using a JSON structure that references a set of point features. The property is optional however, the JSON structure must specify either the features, url, or layer property:

• url—Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set.

  The JSON structure can include the following property:

  • doNotLocateOnRestrictedElements (optional)—Specify whether the restricted network elements should be considered when finding network locations. The default is true.

• features—Specify an array of features.

  Each feature in the features array represents a stop and contains the following properties:

  • geometry—Specify the input point geometry containing x and y properties along with a spatialReference property. If the spatialReference property is defined for the entire JSON, there isn't a need to define this property for each geometry. Doing so reduces the size of the input JSON if the input has many features, and improves performance. This property is not required if the coordinates are in the default spatial reference, WGS84. If the coordinates are in a different spatial reference, you must specify the spatial reference's well-known ID (WKID). See Using spatial references to look up WKID values.
    Tip:

    As a best practice, it is recommended to explicitly specify the spatialReference, and specify it for the entire JSON instead of each individual geometry.

  • attributes—Specify each attribute as a key-value pair where the key is the name of a given field, and the value is the attribute value for the corresponding field.

  The JSON structure can include the following property:

  • doNotLocateOnRestrictedElements (optional)—Specify whether the restricted network elements should be considered when finding network locations. The default is true.

• layer—Specify a feature layer in the map service. Attribute and spatial filters can also be applied on the layer. The JSON structure can include the following properties:
  • type—The type should be set to layer to indicate that the user is specifying the stops by referencing a layer.
  • layerName—The name or ID of the data layer in the map service that is being referenced.
  • where (optional)—A WHERE clause for the query filter. Any legal SQL WHERE clause operating on the fields in the layer is allowed.
  • geometry (optional)—The geometry to apply as the spatial filter. The structure of the geometry is the same as the structure of the JSON geometry objects returned by the ArcGIS REST API.

    The geometry type is specified using the geometryType property.

  • geometryType (optional)—The type of geometry specified by the geometry property. The supported geometry types are envelope, point, line, or polygon. The default geometry type is esriGeometryEnvelope.

    Values: esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope

  • spatialRel (optional)—The spatial relationship to be applied on the input geometry. The supported spatial relationships include intersects, contains, envelope intersects, within, and so on. The default spatial relationship is intersects esriSpatialRelIntersects.

    Values: esriSpatialRelIntersects | esriSpatialRelContains | esriSpatialRelCrosses | esriSpatialRelEnvelopeIntersects | esriSpatialRelIndexIntersects | esriSpatialRelOverlaps | esriSpatialRelTouches | esriSpatialRelWithin

  • doNotLocateOnRestrictedElements (optional)—Specify whether the restricted network elements should be considered when finding network locations. The default is true.

Attributes for stops

When specifying the stops using a JSON structure, you can specify additional properties for stops, such as their names, using attributes. The stops parameter can be specified with the following attributes:

• Name

  The name of the stop. The name is used in the driving directions. If the name is not specified, a unique name prefixed with Location is automatically generated in the output stops, routes, and directions.

• ObjectID

  The ObjectID of the stop. The ObjectID is a unique identifier for the stop. If you want to maintain relationship between input and output, set preserveObjectID to true, and the ObjectID of the input stop is included in the output routes (as the StopID field). The ObjectID is also included in the output stops (as the ObjectID field) and can be used to join additional information from the analysis outputs to the attribute of your stops. If the ObjectID is not specified, a unique ID is automatically generated in the output.

• SourceID

  The numeric identifier of the network dataset source feature class on which the input point is located.

• SourceOID

  The ObjectID of the feature in the source on which the input point is located.

• PosAlong

  The position along the digitized direction of the source line feature. This value is stored as a ratio. This field is null if the network location references a junction.

• SideOfEdge

  The side of the edge in relation to the digitized direction of the line feature. This field is limited to a domain of two values: Right Side (1) and Left Side (2).

  Note:

  SourceID, SourceOID, PosAlong, and SideOfEdge are location fields. If these fields are present on input, the analysis will locate input based on these fields else, the analysis will calculate the location of input based on the geometry of the input. However, these fields are not required.

• TimeWindowStart

  The earliest time the stop can be visited. By specifying a start and end time for a stop's time window, you are defining when a route will visit the stop. When the impedance attribute of this analysis—either specified by the impedanceAttributeName parameter value or the impedanceAttributeName parameter value of the travel mode—is time based, the analysis will find a solution that minimizes overall travel and reaches the stop within the prescribed time window when you specify time-window values.

  The value is specified as an integer that represents the number of milliseconds since epoch (January 1, 1970).

  This value can be specified either in UTC or local time, depending on the value of the timeWindowsAreUTC parameter.

  If you specify this attribute, you also need to specify the TimeWindowEnd attribute.

• TimeWindowEnd

  The latest time the stop can be visited. By specifying a start and end time for a stop's time window, you are defining when a route will visit the stop. When the impedance attribute of this analysis—either specified by impedanceAttributeName parameter value or the impedanceAttributeName parameter value of the travel mode—is time based, the analysis will find a solution that minimizes overall travel and reaches the stop within the prescribed time window when you specify time-window values.

  Together, the TimeWindowStart and TimeWindowEnd attributes compose the time window within which a route can visit the stop. As with TimeWindowStart, the TimeWindowEnd value is specified as an integer that represents the number of milliseconds since epoch (January 1, 1970) and is interpreted as UTC or local time, depending on the value specified for the timeWindowsAreUTC parameter.

  The time window specified using the TimeWindowStart and TimeWindowEnd attributes is not considered a hard constraint by the service. That is, the service doesn't fail if the stop cannot be visited during the time window. Instead, the service tries to find a route that visits the stop during its time window, but if time-window violations are inevitable, the service tries to find a solution that minimizes the time-window violation time for all stops in the problem.

  If a route has to arrive early at the stop, a wait time is added to the total travel time of the route. Similarly, if the route arrives late at the stop, a violation time is added to the total travel time of the route. For example, if the time window on the stop is set as 10:00 AM to 11:00 AM and the earliest a route can reach the stop is 11:25 AM, a violation of 25 minutes is added to the total travel time.

• RouteName

  The name of the route to which the stop is assigned. Assigning the same route name to different stops causes those stops to be grouped together and visited by the same route. You can generate many routes in a single solve by assigning unique route names to different groups of stops.

  For example, to find two distinct routes—a route with four stops and another with six stops—set RouteName to Route1 for each of the four stops and Route2 for each of the six stops. The service will produce two distinct routes and driving directions for each group of stops in a single request.

  If RouteName is not specified for any stops, all stops belong to the same route. If RouteName is not specified for some stops, those stops are treated as unassigned and are not included in any route.

  Note:

  The grouping is based entirely on the provided input and no attempt is made by the service to group stops in any optimal manner. To determine the optimal grouping of stops into routes, use the vehicle routing problem service instead.

• Sequence

  If the findBestSequence parameter is set to false, the output routes will visit the stops in the order you specify with this attribute. In a group of stops that have the same RouteName value, the sequence number should be greater than 0 but not greater than the total number of stops. Also, the sequence number should not be duplicated.

• CurbApproach

  Specify the direction a vehicle can arrive at and depart from the stop.

  One of the integers listed in the Coded value column in the following table must be specified as a value of this attribute. The values in the Setting column are the descriptive names for CurbApproach attribute values that you may have seen when using the ArcGIS Network Analyst extension software.

  Setting	Coded value	Description
  Either side of vehicle	0	The vehicle can approach and depart the stop in either direction, so a U-turn is allowed at the stop. This is the default value. This setting can be chosen if it is possible and desirable for your vehicle to turn around at the stop. This decision may depend on the width of the road and the amount of traffic or whether the stop has a parking lot where vehicles can pull in and turn around. All arrival and departure combinations are allowed with the Either side of vehicle curb approach.
  Right side of vehicle	1	When the vehicle approaches and departs the stop, the stop must be on the right side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must arrive with the bus stop on the right side. The allowed arrival and departure combination for the Right side of vehicle curb approach is shown.
  Left side of vehicle	2	When the vehicle approaches and departs the stop, the stop must be on the left side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must arrive with the bus stop on the left side. The allowed arrival and departure combination for the Left side of vehicle curb approach is shown.
  No U-Turn	3	When the vehicle approaches the stop, the stop can be on either side of the vehicle; however, when it departs, the vehicle must continue in the same direction in which it arrived. A U-turn is prohibited. The allowed arrival and departure combinations for the No U-Turn curb approach are shown.

  The CurbApproach attribute is designed to work with both types of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider an incident on the left side of a vehicle. It is always on the left side regardless of whether the vehicle travels on the left or right half of the road. What may change with national driving standards is your decision to approach an incident from one of two directions, that is, so it ends up on the right or left side of the vehicle. For example, if you want to arrive at an incident and not have a lane of traffic between the vehicle and the incident, choose 1 (Right side of vehicle) in the United States and 2 (Left side of vehicle) in the United Kingdom.

  With right-hand traffic, the curb approach that leaves the vehicle closest to the stop is Right side of vehicle.

  With left-hand traffic, the curb approach that leaves the vehicle closest to the stop is Left side of vehicle.

• Attr_[Cost]

  This field specifies how much additional time spent or distance traveled should occur at the stop. The value for this attribute is included in the total travel time or distance for the route and is also displayed in driving directions as service time.

  To determine the units of the field, refer to the units of the network cost attribute specified in the field name. For instance, if there is a TravelTime cost attribute that has a unit of minutes, Attr_TravelTime would be in minutes.

  A zero or null value indicates the stop requires no service time or extra distance traveled. The default value is 0.

  You may want to add additional time on a stop to represent how long it takes to make a delivery, install equipment, or perform some other task at the stop. Similarly, adding extra distance may be useful to account for a long driveway or other road that isn't represented by your network dataset.

  If you have multiple network cost attributes, you'll see multiple Attr_[Cost] fields. Consequently, you may have more than one time- or distance-based Attr_[Cost] field. The field values you provide are only referenced if the cost attribute referred to in the field name is used in the analysis, for instance, to minimize or accumulate time or distance.

• LocationType

  Specifies the stop type. The field value is specified as one of the following integers (use the numeric code, not the name in the parentheses):

  • 0 (Stop)—A location that the route will visit. This is the default.
  • 1 (Waypoint)—A location that the route will travel through without making a stop. Waypoints can be used to force the route to take a specific path (to go through the waypoint) without being considered an actual stop. Waypoints do not appear in directions.
  • 2 (Break)—A location where the route stops for the driver to take a break.

• Bearing

  The direction in which a point is moving. The units are degrees and are measured clockwise from true north. This field is used in conjunction with the BearingTol field.

  Bearing data is usually sent automatically from a mobile device equipped with a GPS receiver. Try to include bearing data if you are loading an input location that is moving, such as a pedestrian or a vehicle.

  Using this field tends to prevent adding locations to the wrong edges, which can occur when a vehicle is near an intersection or an overpass, for example. Bearing also helps the tool determine on which side of the street the point is.

  Learn more about bearing and bearing tolerance

• BearingTol

  The bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing field. If the Bearing field value is within the range of acceptable values that are generated from the bearing tolerance on an edge, the point can be added as a network location there; otherwise, the closest point on the next-nearest edge is evaluated.

  The units are in degrees, and the default value is 30. Values must be greater than 0 and less than 180. A value of 30 means that when Network Analyst attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge.

  Learn more about bearing and bearing tolerance

• NavLatency

  This field is only used in the solve process if the Bearing and BearingTol fields also have values; however, entering a NavLatency field value is optional, even when values are present in Bearing and BearingTol. NavLatency indicates how much cost is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device.

  The units of NavLatency are the same as the units of the impedance attribute.

Syntax examples for stops

Syntax for specifying stops using a JSON structure for features

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>
  },
  "features": [
    {
      "geometry": {
        "x": <x>,
        "y": <y>,
      },
      "attributes": {
        "<field1>": <value11>,
        "<field2>": <value12>
      }
    },
    {
      "geometry": {
        "x": <x>,
        "y": <y>,
      },
      "attributes": {
        "<field1>": <value21>,
        "<field2>": <value22>
      }
    }
  ],
  "doNotLocateOnRestrictedElements": true | false
}

Syntax for specifying stops using a URL returning a JSON response

{
  "url": "<url>"
  "doNotLocateOnRestrictedElements": true | false
}

Syntax for specifying stops using a layer

{ 
  "type" : "layer",
  "layerName" : "<layerName>",
  "where" : "<whereClause>",
  "geometry" : {<geometry>},
  "geometryType" : "<geometryType>",
  "spatialRel" : "<spatialRel>",
  "doNotLocateOnRestrictedElements" : true | false
}

Examples for stops

Example one: Specifying stop geometries and attributes using a JSON structure

This example shows how to specify the Name attribute for each stop and group four stops into two routes, Route A and Route B, using the RouteName attribute.

{ 
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "geometry": {
        "x": -122.4079,
        "y": 37.78356
      },
      "attributes": {
        "Name": "From",
        "RouteName": "Route A"
      }
    },
    {
      "geometry": {
        "x": -122.404,
        "y": 37.782
      },
      "attributes": {
        "Name": "To",
        "RouteName": "Route A"
      }
    },
    {
      "geometry": {
        "x": -122.4095,
        "y": 37.78379
      },
      "attributes": {
        "Name": "From",
        "RouteName": "Route B"
      }
    },
    {
      "geometry": {
        "x": -122.480,
        "y": 37.734
      },
      "attributes": {
        "Name": "To",
        "RouteName": "Route B"
      }
    }
  ]
}

Example two: Specifying stop geometries in the Web Mercator spatial reference using a JSON structure

{
  "spatialReference": {
    "wkid": 102100}
      },
  "features": [
    {
      "geometry": {
        "x": -13635398.9398,
        "y": 4544699.034400001,
        
      },
      "attributes": {"Name": "Home"}
    },
    {
      "geometry": {
        "x": -13632733.3441,
        "y": 4547651.028300002,
        
      },
      "attributes": {"Name": "Office"}
    }
  ]
}

Example three: Specifying stops using a URL

The URL makes a query for a few features from a map service. A URL querying features from a feature service can also be specified.

{
  "url": "https://machine.domain.com/webadaptor/rest/services/Network/USA/MapServer/1/query?where=1%3D1&outFields=Name,RouteName&f=json"
}

Example four: Specifying stops using a layer

{ 
  "type" : "layer",
  "layerName" : "PointsOfInterest",
  "where" : "CITY = 'San Francisco'"
}

token

Use this parameter to specify a token that provides the identity of a user that has the permissions to access the service. The accessing services page provides more information on how such an access token can be obtained.

Example (replace <yourToken> with a valid token):

token=<yourToken>

Optional parameters

f

Use this parameter to specify the response format. The parameter can have html, json or pjson as arguments, for example, f=json. The pjson value is used for printing the JSON response in a pretty format.

travelMode

Choose the mode of transportation for the analysis.

Travel modes are managed in ArcGIS Enterprise, and can be configured by the administrator of your organization to better reflect your organization's workflows.

To learn more about travel modes, see Configure travel modes.

The value for the travelMode parameter is the JSON object containing the settings for a travel mode supported by your organization. To get the supported travel modes, execute the retrieveTravelModes operation.

You can make a request to retrieve travel modes using the following form:

https://machine.domain.com/webadaptor/rest/services/Routing/NetworkAnalysis/NAServer/Route/retrieveTravelModes?f=json&token=<yourToken>

Note:

See Implementing App Login for ArcGIS Online and Acquire ArcGIS tokens for ArcGIS Enterprise to learn how to generate one.

Below is the response as returned by the retrieveTravelModes operation.

Note:

Because the response is quite verbose, the elements in the response are abbreviated for clarity.

{
  "currentVersion": 10.8,
  "defaultTravelMode": "FEgifRtFndKNcJMJ",
  "supportedTravelModes": [
    {
      "attributeParameterValues": [
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Avoid Private Roads",
          "value": "AVOID_MEDIUM"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Walking",
          "value": "PROHIBITED"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Preferred for Pedestrians",
          "value": "PREFER_LOW"
        },
        {
          "parameterName": "Walking Speed (km/h)",
          "attributeName": "WalkTime",
          "value": 5
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Avoid Roads Unsuitable for Pedestrians",
          "value": "AVOID_HIGH"
        }
      ],
      "description": "Follows paths and roads that allow pedestrian traffic and finds
                     solutions that optimize travel time. The walking speed is set to
                     5 kilometers per hour.",
      "impedanceAttributeName": "WalkTime",
      "simplificationToleranceUnits": "esriMeters",
      "uturnAtJunctions": "esriNFSBAllowBacktrack",
      "restrictionAttributeNames": [
        "Avoid Private Roads",
        "Avoid Roads Unsuitable for Pedestrians",
        "Preferred for Pedestrians",
        "Walking"
      ],
      "useHierarchy": false,
      "simplificationTolerance": 2,
      "timeAttributeName": "WalkTime",
      "distanceAttributeName": "Kilometers",
      "type": "WALK",
      "id": "caFAgoThrvUpkFBW",
      "name": "Walking Time"
    },
    {
      "attributeParameterValues": [
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Avoid Unpaved Roads",
          "value": "AVOID_HIGH"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Avoid Private Roads",
          "value": "AVOID_MEDIUM"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Driving an Automobile",
          "value": "PROHIBITED"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Through Traffic Prohibited",
          "value": "AVOID_HIGH"
        },
        {
          "parameterName": "Vehicle Maximum Speed (km/h)",
          "attributeName": "TravelTime",
          "value": 0
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Roads Under Construction Prohibited",
          "value": "PROHIBITED"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Avoid Gates",
          "value": "AVOID_MEDIUM"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Avoid Express Lanes",
          "value": "PROHIBITED"
        },
        {
          "parameterName": "Restriction Usage",
          "attributeName": "Avoid Carpool Roads",
          "value": "PROHIBITED"
        }
      ],
      "description": "Models the movement of cars and other similar small automobiles,
                      such as pickup trucks, and finds solutions that optimize travel
                      time. Travel obeys one-way roads, avoids illegal turns, and
                      follows other rules that are specific to cars. When you specify
                      a start time, dynamic travel speeds based on traffic are used
                      where it is available.",
      "impedanceAttributeName": "TravelTime",
      "simplificationToleranceUnits": "esriMeters",
      "uturnAtJunctions": "esriNFSBAtDeadEndsAndIntersections",
      "restrictionAttributeNames": [
        "Avoid Unpaved Roads",
        "Avoid Private Roads",
        "Driving an Automobile",
        "Through Traffic Prohibited",
        "Roads Under Construction Prohibited",
        "Avoid Gates",
        "Avoid Express Lanes",
        "Avoid Carpool Roads"
      ],
      "useHierarchy": true,
      "simplificationTolerance": 10,
      "timeAttributeName": "TravelTime",
      "distanceAttributeName": "Kilometers",
      "type": "AUTOMOBILE",
      "id": "FEgifRtFndKNcJMJ",
      "name": "Driving Time"
    }
  ]
}

From the above JSON , to pass Walking Time as the travel mode, use the following JSON as the value for the travelMode parameter:

travelMode={"attributeParameterValues": [{"parameterName": "Restriction Usage","attributeName": "Walking","value": "PROHIBITED"},{"parameterName": "Restriction Usage","attributeName": "Preferred for Pedestrians","value": "PREFER_LOW"},{"parameterName": "Walking Speed (km/h)","attributeName": "WalkTime","value": 5}],"description": "Follows paths and roads that allow pedestrian traffic and finds solutions that optimize travel time. The walking speed is set to 5 kilometers per hour.","impedanceAttributeName": "WalkTime","simplificationToleranceUnits": "esriMeters","uturnAtJunctions": "esriNFSBAllowBacktrack","restrictionAttributeNames": ["Preferred for Pedestrians","Walking"],"useHierarchy": false,"simplificationTolerance": 2,"timeAttributeName": "WalkTime","distanceAttributeName": "Miles","type": "WALK","id": "caFAgoThrvUpkFBW","name": "Walking Time"}

Caution:

When the travelMode parameter is set, you are choosing a travel mode configured in your organization, and the service automatically overrides the values of other parameters with values that model the chosen travel mode. The following parameters are overridden: impedanceAttributeName, attributeParameterValues, restrictUturns, useHierarchy, restrictionAttributeNames, outputGeometryPrecision, outputGeometryPrecisionUnits, and directionsTimeAttributeName.

If you don't set the travelMode parameter, the service honors the default or user-defined values for the parameters that would otherwise be overridden, so you can create your own travel mode.

startTime

Indicate the time that travel begins from the input stops. You can also specify the now value to set the depart time to the current time.

Specifying a time of day results in more accurate estimations of travel times because the travel times account for the traffic conditions that are applicable for that date and time.

To use traffic in the analysis, set impedanceAttributeName to TravelTime, and assign a value to startTime.

Note:

TravelTime is a cost attribute in ArcGIS StreetMap Premium data. The TravelTime attribute is set with a traffic evaluator to evaluate the cost based on traffic. If you have your own data, set impedanceAttributeName to a cost attribute with a traffic evaluator, and assign a value to timeOfDay to use traffic in your analysis.

The startTime value represents the target start time of the routes in the analysis. The time is specified as Unix time (milliseconds since midnight, January 1, 1970).

If the now value is used for the startTime parameter, the travel begins at the current time. This causes the startTimeIsUTC parameter value to be true. When startTime is now and startTimeIsUTC is true, the travel will begin at input locations at the current time regardless of the time zone in which the input locations reside.

If a time of day is not passed in, the service uses static road speeds based on average historical speeds or posted speed limits. It uses posted speeds in areas where historical traffic information isn't available.

When the service is using the ArcGIS StreetMap Premium data, it can support two kinds of traffic: live and typical.

If the startTime value specified is within four hours of the current time, live traffic will be used where available. Live traffic retrieves speeds based on phone probe records, sensors, and other data sources and reflects the current travel speeds and predicts speeds for the near future. If the startTime value specified is more than four hours earlier or later than the current time, or the road does not have live traffic, typical traffic speeds will be used. Typical speeds are based on historical traffic patterns. The travel time data is aggregated in 15 minute intervals per day of the week based on multiple years worth of data. Consequently, a road may have a different travel time at Monday at 8 a.m., Monday at 8:15 a.m., or Tuesday at 8 a.m. Since the variance is at the day of week and time of day, the travel time is the same on a road for any Monday at 8 a.m., regardless of the month or year.

If your goal is to model typical travel conditions and avoid large variances from the average due to live traffic, it is recommended to use a date from the past to ensure it doesn't coincide with the 4 hour window from the current time. As an extreme example, you can even use dates from 1990.

The Data Coverage page shows the countries Esri currently provides traffic data for.

Typical traffic

To ensure the task uses typical traffic in locations where it is available, choose a time and day of the week, and then convert the day of the week to one of the following dates from 1990:

• Monday—1/1/1990
• Tuesday—1/2/1990
• Wednesday—1/3/1990
• Thursday—1/4/1990
• Friday—1/5/1990
• Saturday—1/6/1990
• Sunday—1/7/1990

Set the time and date as Unix time in milliseconds. For example, to solve for 1:03 p.m. on Thursdays, set the time and date to 1:03 p.m., January 4, 1990; and convert to milliseconds (631458180000). Although the dates representing days of the week are from 1990, typical traffic is calculated from recent traffic trends—usually over the last two years worth of data.

Live traffic

To use live traffic when and where it is available, choose a time and date and convert to Unix time.

Esri saves live traffic data for 4 hours and references predictive data extending 4 hours into the future. If the time and date you specify for this parameter is outside the 8-hour time window, or the travel time in the analysis continues past the predictive data window, the task falls back to typical traffic speeds.

Examples for startTime

Example 1: 13:03, January 4, 1990. Typical traffic on Thursdays at 1:03 p.m.

"startTime": 631458180000

Example 2: 17:00, January 7, 1990. Typical traffic on Sundays at 5:00 p.m.

"startTime": 631731600000

Example 3: Specify the now value. The analysis will begin at current time and live traffic speeds are referenced in the analysis.

"startTime": now

Example 4: 10:20, March 18, 2015. If the current time is between 6:20 a.m., March 18, 2015, and 14:20 p.m., March 18,2015, live traffic speeds are referenced in the analysis; otherwise, typical traffic speeds are referenced.

"startTime": 1426674000000

startTimeIsUTC

Specify the time zone or zones of the startTime parameter.

False (use geographically local time zones)

The startTime value refers to the time zone in which the first stop of each route is located. The start time uses the time zone that is geographically local to the first stop.

The following image illustrates setting the value to false (geographically local). Setting startTime to 9:00 a.m., January 4, 1990 (631443600000 milliseconds) and startTimeIsUTC to false, and submitting a valid request causes the drive times for points in the eastern time zone to start at 9:00 a.m. (2:00 p.m. UTC).

Input: startTime is 9:00 a.m.,January 4, 1990 (631443600000 milliseconds), and startTimeIsUTC is set to false

True (use UTC)

The startTime value refers to coordinated universal time (UTC). The start times for all points are simultaneous, regardless of time zones.

The following image illustrates setting the value to true (UTC). Setting startTime to 9:00 a.m., January 4, 1990 (631443600000 milliseconds) and startTimeIsUTC to true causes the start time for points in the eastern time zone to be 4:00 a.m. eastern time and 3:00 a.m. central time for those in the central time zone.

Input: startTime is 9:00 a.m., 4 Jan. 1990 (631443600000 milliseconds), and startTimeIsUTC is set to true

timeWindowsAreUTC

Specify whether the TimeWindowStart and TimeWindowEnd attribute values on stops are specified in UTC or geographically local time. There are two options: false and true.

See the startTimeIsUTC section for an explanation of UTC versus local time.

Note:

This parameter is ignored when impedanceAttributeName is set to distance units.

Note:

The service does not allow the combination of timeWindowsAreUTC=true and startTimeIsUTC=false. An error is produced if this combination is given.

findBestSequence

Use this parameter to specify whether the service should reorder stops to find the optimized route. If the parameter value is false, the service returns a route that visits stops in the order you define. If the parameter value is true, the service finds the best order to visit the stops. The service will account for a variety of variables so that the total travel distance or travel time for the route is minimized. You can elect to preserve the origin and the destination stops while allowing the service to reorder intermediary stops by setting the preserveFirstStop and preserveLastStop parameters.

preserveFirstStop

Use this parameter to indicate whether the service should keep the first stop fixed when reordering the stops. The possible parameter values are true or false. This parameter is applicable only if the findBestSequence parameter value is true.

preserveLastStop

Use this parameter to indicate whether the service should keep the last stop fixed when reordering the stops. The possible parameter values are true or false. This parameter is applicable only if the findBestSequence parameter value is true.

useTimeWindows

Use this parameter to indicate whether the service should consider time windows specified on the stops when finding the best route. The possible parameter values are true or false. The time windows are specified on stops using the TimeWindowStart and TimeWindowEnd attributes.

The default value is false.

restrictUTurns

Use this parameter to restrict or permit the route from making U-turns at junctions.

Caution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

In order to understand the available parameter values, consider for a moment that a junction is a point where only two streets intersect each other. If three or more streets intersect at a point, it is called as an intersection. A cul-de-sac is a dead-end. The parameter can have the following values:

Parameter values	Description
esriNFSBAllowBacktrack	U-turns are permitted everywhere. Allowing U-turns implies that the vehicle can turn around at a junction and double back on the same street. U-turns are permitted at junctions with any number of adjacent streets.
esriNFSBAtDeadEndsAndIntersections	U-turns are prohibited at junctions where exactly two adjacent streets meet. U-turns are permitted only at intersections or dead ends.
esriNFSBAtDeadEndsOnly	U-turns are prohibited at all junctions and intersections and are permitted only at dead ends. U-turns are permitted only at dead ends.
esriNFSBNoBacktrack	U-turns are prohibited at all junctions, intersections, and dead-ends. Note that even when this parameter value is chosen, a route can still make U-turns at stops. If you wish to prohibit U-turns at a stop, you can set its CurbApproach property to the appropriate value (3).

useHierarchy

Specify whether hierarchy should be used when finding the shortest paths.

Caution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

• true—Use hierarchy when travelling between stops. When hierarchy is used, the service prefers higher-order streets (such as freeways) to lower-order streets (such as local roads), and can be used to simulate the driver preference of traveling on freeways instead of local roads even if that means a longer trip. This is especially true when finding routes to faraway locations, because drivers on long-distance trips tend to prefer traveling on freeways where stops, intersections, and turns can be avoided. Using hierarchy is computationally faster, especially for long-distance routes, since the service can determine the best route from a relatively smaller subset of streets.

• false—Do not use hierarchy when travelling between stops. If hierarchy is not used, the service considers all the streets and doesn't prefer higher-order streets when finding the route. This is often used when finding short-distance routes within a city.

impedanceAttributeName

Specify the impedance.

Caution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

Impedance is a value that quantifies travel along the transportation network. Travel distance is an example of impedance; it quantifies the length of walkways and road segments. Similarly, drive time—the typical time it takes to drive a car along a road segment—is an example of impedance. Drive times may vary by type of vehicle—for instance, the time it takes for a truck to travel along a path tends to be longer than a car—so there can be many impedance values representing travel times for different vehicle types. Impedance values may also vary with time; live and typical traffic reference dynamic impedance values. Each walkway and road segment stores at least one impedance value. When performing a network analysis, the impedance values are used to calculate the best results, such as finding the shortest route—the route that minimizes impedance—between two points.

The impedanceAttributeName parameter can be specified using the following values:

• TravelTime—Historical and live traffic data is used. This option is good for modeling the time it takes automobiles to travel along roads at a specific time of day using live traffic speed data where available. When using TravelTime, you can optionally set the TravelTime::Vehicle Maximum Speed (km/h) attribute parameter to specify the physical limitation of the speed the vehicle is capable of traveling.
• Minutes—Live traffic data is not used, but historical average speeds for automobiles data is used.
• TruckTravelTime—Historical and live traffic data is used, but the speed is capped at the posted truck speed limit. This is good for modeling the time it takes for the trucks to travel along roads at a specific time. When using TruckTravelTime, you can optionally set the TruckTravelTime::Vehicle Maximum Speed (km/h) attribute parameter to specify the physical limitation of the speed the truck is capable of traveling.
• TruckMinutes—Live traffic data is not used, but the smaller of the historical average speeds for automobiles and the posted speed limits for trucks are used.
• WalkTime—The default is a speed of 5 km/hr on all roads and paths, but this can be configured through the WalkTime::Walking Speed (km/h) attribute parameter.
• Miles—Length measurements along roads are stored in miles and can be used for performing analysis based on shortest distance.
• Kilometers—Length measurements along roads are stored in kilometers and can be used for performing analysis based on shortest distance.
• TimeAt1KPH—The default is a speed of 1 km/hr on all roads and paths. The speed cannot be changed using any attribute parameter.

Note:

These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.

accumulateAttributeNames

Use this parameter to specify whether the service should accumulate values other than the value specified for impedanceAttributeName. For example, if your impedanceAttributeName is set to TravelTime, the total travel time for the route will be calculated by the service. However, if you also want to calculate the total distance of the route in miles, you can specify Miles as the value for the accumulateAttributeNames parameter.

The parameter value should be specified as a comma-separated list of names. The parameter values are the same as the impedanceAttributeName parameter. For example, accumulateAttributeNames=Miles,Kilometers indicates that the total cost of the route should also be calculated in miles and kilometers.

Note:

The values specified for the accumulateAttributeNames parameter are purely for reference. The service always uses impedanceAttributeName to find the best routes.

Note:

These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.

restrictionAttributeNames

Use this parameter to specify which restrictions should be honored by the service. A restriction represents a driving preference or requirement. In most cases, restrictions cause roads or pathways to be prohibited, but they can also cause them to be avoided or preferred. For instance, using an Avoid Toll Roads restriction will result in a route that will include toll roads only when it is absolutely required to travel on toll roads in order to visit a stop. Height Restriction makes it possible to route around any clearances that are lower than the height of your vehicle. If you are carrying corrosive materials on your vehicle, using the Any Hazmat Prohibited restriction prevents hauling the materials along roads where it is marked as illegal to do so.

Caution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

The parameter value is specified as a comma-separated list of restriction names. A value of none indicates that no restrictions should be used when finding shortest paths.

The restrictionAttributeNames parameter can be specified using the following values:

• Any Hazmat Prohibited—The results will not include roads where transporting any kind of hazardous material is prohibited.

• Avoid Carpool Roads—The results will avoid roads that are designated exclusively for car pool (high-occupancy) vehicles.

• Avoid Express Lanes—The results will avoid roads designated as express lanes.

• Avoid Ferries—The results will avoid ferries.

• Avoid Gates—The results will avoid roads where there are gates, such as keyed access or guard-controlled entryways.

• Avoid Limited Access Roads—The results will avoid roads that are limited-access highways.

• Avoid Private Roads—The results will avoid roads that are not publicly owned and maintained.

• Avoid Roads Unsuitable for Pedestrians—The results will avoid roads that are unsuitable for pedestrians.

• Avoid Stairways—The results will avoid all stairways on a pedestrian-suitable route.

• Avoid Toll Roads—The results will avoid all toll roads for automobiles.

• Avoid Toll Roads for Trucks—The results will avoid all toll roads for trucks.

• Avoid Truck Restricted Roads—The results will avoid roads where trucks are not allowed, except when making deliveries.

• Avoid Unpaved Roads—The results will avoid roads that are not paved (for example, dirt, gravel, and so on).

• Axle Count Restriction—The results will not include roads where trucks with the specified number of axles are prohibited. The number of axles can be specified using the Number of Axles restriction parameter.

• Driving a Bus—The results will not include roads where buses are prohibited. Using this restriction will also ensure that the results will honor one-way streets.

• Driving a Taxi—The results will not include roads where taxis are prohibited. Using this restriction will also ensure that the results will honor one-way streets.

• Driving a Truck—The results will not include roads where trucks are prohibited. Using this restriction will also ensure that the results will honor one-way streets.

• Driving an Automobile—The results will not include roads where automobiles are prohibited. Using this restriction will also ensure that the results will honor one-way streets.

• Driving an Emergency Vehicle—The results will not include roads where emergency vehicles are prohibited. Using this restriction will also ensure that the results will honor one-way streets.

• Height Restriction—The results will not include roads where the vehicle height exceeds the maximum allowed height for the road. The vehicle height can be specified using the Vehicle Height (meters) restriction parameter.

• Kingpin to Rear Axle Length Restriction—The results will not include roads where the vehicle length exceeds the maximum allowed kingpin to rear axle for all trucks on the road. The length between the vehicle kingpin and the rear axle can be specified using the Vehicle Kingpin to Rear Axle Length (meters) restriction parameter.

• Length Restriction—The results will not include roads where the vehicle length exceeds the maximum allowed length for the road. The vehicle length can be specified using the Vehicle Length (meters) restriction parameter.

• Preferred for Pedestrians—The results will use preferred routes suitable for pedestrian navigation.

• Riding a Motorcycle—The results will not include roads where motorcycles are prohibited. Using this restriction will also ensure that the results will honor one-way streets.

• Roads Under Construction Prohibited—The results will not include roads that are under construction.

• Semi or Tractor with One or More Trailers Prohibited—The results will not include roads where semis or tractors with one or more trailers are prohibited.

• Single Axle Vehicles Prohibited—The results will not include roads where vehicles with single axles are prohibited.

• Tandem Axle Vehicles Prohibited—The results will not include roads where vehicles with tandem axles are prohibited.

• Through Traffic Prohibited—The results will not include roads where through traffic (non-local) is prohibited.

• Truck with Trailers Restriction—The results will not include roads where trucks with the specified number of trailers on the truck are prohibited. The number of trailers on the truck can be specified using the Number of Trailers on Truck restriction parameter.

• Use Preferred Hazmat Routes—The results will prefer roads that are designated for transporting any kind of hazardous materials.

• Use Preferred Truck Routes—The results will prefer roads that are designated as truck routes, such as the roads that are part of the national network as specified by the National Surface Transportation Assistance Act in the United States, or roads that are designated as truck routes by the state or province, or roads that are preferred by truckers when driving in an area.

• Walking—The results will not include roads where pedestrians are prohibited.

• Weight Restriction—The results will not include roads where the vehicle weight exceeds the maximum allowed weight for the road. The vehicle weight can be specified using the Vehicle Weight (kilograms) restriction parameter.

• Weight per Axle Restriction—The results will not include roads where the vehicle weight per axle exceeds the maximum allowed weight per axle for the road. The vehicle weight per axle can be specified using the Vehicle Weight per Axle (kilograms) restriction parameter.

• Width Restriction—The results will not include roads where the vehicle width exceeds the maximum allowed width for the road. The vehicle width can be specified using the Vehicle Width (meters) restriction parameter.

Note:

These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.

The Driving a Delivery Vehicle restriction attribute is no longer available. The service will ignore this restriction since it is invalid. To achieve similar results, use the Driving a Truck restriction attribute along with the Avoid Truck Restricted Roads restriction attribute.

The restrictionAttributeName parameter value is specified as a list of restriction names. A value of null indicates that no restrictions should be used when finding the best route, but only when travelMode is set to null.

attributeParameterValues

Use this parameter to specify additional values required by an attribute or restriction, such as to specify whether the restriction prohibits, avoids, or prefers travel on restricted roads. If the restriction is meant to avoid or prefer roads, you can further specify the degree to which they are avoided or preferred using this parameter. For example, you can choose to never use toll roads, avoid them as much as possible, or prefer them.

Caution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

The parameter value is specified as an array of objects each having the following properties:

• attributeName—The name of the restriction

• parameterName—The name of the parameter associated with the restriction. A restriction can have one or more parameterName properties.

• value—The value for parameterName.

Most attribute parameters are related to the restriction attributes in restrictionAttributeNames. Each restriction has at least one attribute parameter named Restriction Usage, which specifies whether the restriction prohibits, avoids, or prefers travel on the roads associated with the restriction and the degree to which the roads are avoided or preferred. The Restriction Usage parameter can be assigned any of the following string values, or their equivalent numeric values listed within the parentheses:

• Prohibited (-1)—Travel on the roads that have the restriction is completely prohibited.
• Avoid_High (5)—It is very unlikely for the service to include in the route the roads that are associated with the restriction.
• Avoid_Medium (2)—It is unlikely for the service to include in the route the roads that are associated with the restriction.
• Avoid_Low (1.3)—It is somewhat unlikely for the service to include in the route the roads that are associated with the restriction.
• Prefer_Low (0.8)—It is somewhat likely for the service to include in the route the roads that are associated with the restriction.
• Prefer_Medium(0.5)—It is likely for the service to include in the route the roads that are associated with the restriction.
• Prefer_High (0.2)—It is very likely for the service to include in the route the roads that are associated with the restriction.

Note:

The restrictionAttributeNames parameter is associated with attributeParameterValues. The restriction attribute's parameter value is specified as part of attributeParameterValues. Each restriction has at least one parameter named Restriction Usage, which specifies whether travel on roads that have the restriction is prohibited, should be avoided, or should be preferred. For the latter two options, it also specifies the degree to which the roads are avoided or preferred.

The following table lists the attribute parameter names and the default parameter values.

Tip:

If you want to use the default value for a restriction, attributeName, parameterName and value do not have to be specified as part of the attributeParameterValues parameter.

Restriction Name	Restriction Parameter Name	Restriction Parameter Default Value
Any Hazmat Prohibited	Restriction Usage	Prohibited
Avoid Carpool Roads	Restriction Usage	Prohibited
Avoid Express Lanes	Restriction Usage	Prohibited
Avoid Ferries	Restriction Usage	Avoid_Medium
Avoid Gates	Restriction Usage	Avoid_Medium
Avoid Limited Access Roads	Restriction Usage	Avoid_Medium
Avoid Private Roads	Restriction Usage	Avoid_Medium
Avoid Roads Unsuitable for Pedestrians	Restriction Usage	Avoid_High
Avoid Stairways	Restriction Usage	Avoid_High
Avoid Toll Roads	Restriction Usage	Avoid_Medium
Avoid Toll Roads for Trucks	Restriction Usage	Avoid_Medium
Avoid Truck Restricted Roads	Restriction Usage	Avoid_High
Avoid Unpaved Roads	Restriction Usage	Avoid_High
Axle Count Restriction	Number of Axles	0
	Restriction Usage	Prohibited
Driving a Bus	Restriction Usage	Prohibited
Driving a Taxi	Restriction Usage	Prohibited
Driving a Truck	Restriction Usage	Prohibited
Driving an Automobile	Restriction Usage	Prohibited
Driving an Emergency Vehicle	Restriction Usage	Prohibited
Height Restriction	Restriction Usage	Prohibited
	Vehicle Height (meters)	0
Kingpin to Rear Axle Length Restriction	Restriction Usage	Prohibited
	Vehicle Kingpin to Rear Axle Length (meters)	0
Length Restriction	Restriction Usage	Prohibited
	Vehicle Length (meters)	0
Preferred for Pedestrians	Restriction Usage	Prefer_Low
Riding a Motorcycle	Restriction Usage	Prohibited
Roads Under Construction Prohibited	Restriction Usage	Prohibited
Semi or Tractor with One or More Trailers Prohibited	Restriction Usage	Prohibited
Single Axle Vehicles Prohibited	Restriction Usage	Prohibited
Tandem Axle Vehicles Prohibited	Restriction Usage	Prohibited
Through Traffic Prohibited	Restriction Usage	Avoid_High
Truck with Trailers Restriction	Restriction Usage	Prohibited
	Number of Trailers on Truck	0
Use Preferred Hazmat Routes	Restriction Usage	Prefer_Medium
Use Preferred Truck Routes	Restriction Usage	Prefer_High
Walking	Restriction Usage	Prohibited
WalkTime	Walking Speed (km/h)	5
Weight Restriction	Restriction Usage	Prohibited
	Vehicle Weight (kilograms)	0
Weight per Axle Restriction	Restriction Usage	Prohibited
	Vehicle Weight per Axle (kilograms)	0
Width Restriction	Restriction Usage	Prohibited
	Vehicle Width (meters)	0

Note:

These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.

Syntax example for attributeParameterValues

Syntax for specifying attributeParameterValues

[
    {
        "attributeName": "<attribute1>",
        "parameterName": "<parameter1>",
        "value": "<value1>"
    },
    {
        "attributeName": "<attribute2>",
        "parameterName": "<parameter2>",
        "value": "<value2>"
    }
]

Example for attributeParameterValues

Example: Specifying the vehicle height and weight and a high preference to use designated truck routes

This example shows how to specify the height and weight of the vehicle for use with the height and weight restrictions respectively along with a high preference to include the designated truck routes. This results in a route that does not include any roads where the clearance under overpasses or through tunnels is less than the vehicle height. The route will also not include any roads with load limited bridges or local roads that prohibit heavy vehicles if the vehicle weight exceeds the maximum permissible weight. However, the route will include as many roads as possible that are designated as preferred truck routes.

Note that the Restriction Usage parameter for the Height Restriction and the Weight Restriction are not specified as we want to use the default value of Prohibit for these restriction parameters.

attributeParameterValues=
[
    {
        "attributeName": "Height Restriction",
        "parameterName": "Vehicle Height (meters)",
        "value": 4.12
    },
    {
        "attributeName": "Weight Restriction",
        "parameterName": "Vehicle Weight (kilograms)",
        "value": 36287
    },
    {
        "attributeName": "Use Preferred Truck Routes",
        "parameterName": "Restriction Usage",
        "value": "Prefer_High"
    }
]

barriers

Use this parameter to specify one or more points that will act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. For example, a point barrier can be used to represent a fallen tree along a street or a time delay spent at a railroad crossing.

You can use a simple comma- and semicolon-based syntax if you are passing the point barrier locations using their longitude and latitude values in the WGS84 coordinate system and don't need to pass additional fields for each location.

Simple syntax for barriers

barriers=x1,y1; x2, y2; ...; xn, yn

Example using simple syntax

barriers=-117.1957,34.0564; -117.184,34.0546

You can specify barrier geometries as well as attributes using a more comprehensive JSON structure that references a set of features. The property is optional however, the JSON structure must specify either the url, features, or layer property:

• url—Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set.

  The JSON structure can include the following property:

  • doNotLocateOnRestrictedElements (optional)—Specify whether the restricted network elements should be considered when finding network locations. The default is true.

• features—Specify an array of features.

  Each feature in this array represents a point barrier and contains the following fields:

  • geometry—Specify the input point geometry containing x and y properties along with a spatialReference property. If the spatialReference property is defined for the entire JSON, there isn't a need to define this property for each geometry. Doing so reduces the size of the input JSON if the input has many features, and improves performance. This property is not required if the coordinates are in the default spatial reference, WGS84. If the coordinates are in a different spatial reference, you must specify the spatial reference's well-known ID (WKID). See Using spatial references to look up WKID values.
    Tip:

    As a best practice, it is recommended to explicitly specify the spatialReference, and specify it for the entire JSON instead of each individual geometry.

  • attributes—Specify each attribute as a key-value pair where the key is the name of a given field, and the value is the attribute value for the corresponding field.

  The JSON structure can include the following property:

  • doNotLocateOnRestrictedElements (optional)—Specify whether the restricted network elements should be considered when finding network locations. The default is true.

• layer—Specify a feature layer in the map service. Attribute and spatial filters can also be applied on the layer. The JSON structure can include the following properties:
  • type—The type should be set to layer to indicate that the user is specifying the point barriers by referencing a layer.
  • layerName—The name or ID of the data layer in the map service that is being referenced.
  • where (optional)—A WHERE clause for the query filter. Any legal SQL WHERE clause operating on the fields in the layer is allowed.
  • geometry (optional)—The geometry to apply as the spatial filter. The structure of the geometry is the same as the structure of the JSON geometry objects returned by the ArcGIS REST API.

    The geometry type is specified using the geometryType property.

  • geometryType (optional)—The type of geometry specified by the geometry property. The supported geometry types are envelope, point, line, or polygon. The default geometry type is esriGeometryEnvelope.

    Values: esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope

  • spatialRel (optional)—The spatial relationship to be applied on the input geometry. The supported spatial relationships include intersects, contains, envelope intersects, within, and so on. The default spatial relationship is intersects esriSpatialRelIntersects.

    Values: esriSpatialRelIntersects | esriSpatialRelContains | esriSpatialRelCrosses | esriSpatialRelEnvelopeIntersects | esriSpatialRelIndexIntersects | esriSpatialRelOverlaps | esriSpatialRelTouches | esriSpatialRelWithin

  • doNotLocateOnRestrictedElements (optional)—Specify whether the restricted network elements should be considered when finding network locations. The default is true.

Attributes for barriers

When specifying the barriers parameter using JSON structure, you can specify additional information about barriers, such as the barrier type, using attributes. The barriers parameter can be specified with the following attributes:

Name

The name of the barrier.

ObjectID

The ObjectID of the barrier. The ObjectID is a unique identifier for the barrier. If you want to maintain relationship between input and output, set preserveObjectID to true. The ObjectID of the input barrier is included in the output barrier (as the ObjectID field) and can be used to join additional information from analysis outputs to the attribute of your barriers. If the ObjectID is not specified, a unique ID is automatically generated in the output.

SourceID

The numeric identifier of the network dataset source feature class on which the input point is located.

SourceOID

The ObjectID of the feature in the source on which the input point is located.

PosAlong

The position along the digitized direction of the source line feature. This value is stored as a ratio. This field is null if the network location references a junction.

SideOfEdge

The side of the edge in relation to the digitized direction of the line feature. This field is limited to a domain of two values: Right Side (1) and Left Side (2).

Note:

SourceID, SourceOID, PosAlong, and SideOfEdge are location fields. If these fields are present on input, the analysis will locate input based on these fields else, the analysis will calculate the location of input based on the geometry of the input. However, these fields are not required.

BarrierType

Specifies whether the point barrier restricts travel completely or adds time or distance when it is crossed. The value for this attribute is specified as one of the following integers (use the numeric code, not the name in parentheses):

• 0 (Restriction)—Prohibits travel through the barrier. The barrier is referred to as a restriction point barrier since it acts as a restriction.

  The map on the left shows the shortest path between two stops without any restriction point barriers. The map on the right has a road that is blocked by a fallen tree, so the shortest path between the same points is longer.

• 2 (Added Cost)—Traveling through the barrier increases the travel time or distance by the amount specified in the Attr_[Cost] attributes. This barrier type is referred to as an added cost point barrier.

  The map on the left shows the shortest path between two stops without any added cost point barrier. For the map on the right, the travel time from stop one to stop two would be the same whether going around the north end of the block or the south end; however, since crossing railroad tracks incurs a time penalty (modeled with added cost point barriers), the route with only one railroad crossing is chosen. The cost of crossing the barrier is added to the accumulated travel time of the resulting route.

Note:

There is no point barrier type with a value of 1 for the BarrierType attribute.

FullEdge

Specifies how the restriction point barriers are applied to the edge elements during the analysis. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses):

• 0 (False)—Permits travel on the edge up to the barrier but not through it. This is the default value.
• 1 (True)—Restricts travel anywhere on the associated edge.

Attr_[Cost]

Indicates how the cost (time or distance) is added when the barrier is traversed. This attribute is applicable only for added cost point barriers. The attribute value must be greater than or equal to zero.

Syntax examples for barriers

Syntax for specifying barriers using JSON structure for features

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>
  },
  "features": [
    {
      "geometry": {
        "x": <x>,
        "y": <y>
      },
      "attributes": {
        "<field1>": <value11>,
        "<field2>": <value12>
      }
    },
    {
      "geometry": {
        "x": <x>,
        "y": <y>
      },
      "attributes": {
        "<field1>": <value21>,
        "<field2>": <value22>
      }
    }
  ],
  "doNotLocateOnRestrictedElements": true | false
}

Syntax for specifying barriers using a URL to a JSON response

{
  "url": "<url>"
  "doNotLocateOnRestrictedElements": true | false
}

Syntax for specifying point barriers using a layer

{ 
  "type" : "layer",
  "layerName" : "<layerName>",
  "where" : "<whereClause>",
  "geometry" : {<geometry>},
  "geometryType" : "<geometryType>",
  "spatialRel" : "<spatialRel>"
  "doNotLocateOnRestrictedElements": true | false
}

Examples for barriers

Example one: Specifying an added cost point barrier using JSON structure

This example shows how to use an added cost point barrier to model a five-minute delay at a railroad crossing. The BarrierType attribute is used to specify that the point barrier is of type added cost and the Attr_TravelTime attribute is used to specify the delay in minutes.

{
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "geometry": {
        "x": -122.053461,
        "y": 37.541479
      },
      "attributes": {
        "Name": "Haley St rail road crossing",
        "BarrierType": 2,
        "Attr_TravelTime": 5
      }
    }
  ]
}

Example two: Specifying a restriction point barrier using a URL

The URL makes a query for a few features from a map service. A URL querying features from a feature service can also be specified.

{
  "url": "https://machine.domain.com/webadaptor/rest/services/Network/USA/MapServer/0/query?where=1%3D1&returnGeometry=true&f=json"
}

Example 3: Specifying a point barrier using a layer

{ 
  "type" : "layer",
  "layerName" : "TrafficAccidents",
  "where" : "SEVERITY > 0"
}

polylineBarriers

Use this parameter to specify one or more lines that prohibit travel anywhere the lines intersect the streets. For example, a parade or protest that blocks traffic across several street segments can be modeled with a line barrier. A line barrier can also quickly fence off several roads from being traversed, thereby channeling possible routes away from undesirable parts of the street network.

The map on the left displays the shortest path between two stops. The map on the right shows the shortest path when several streets are blocked by a polyline barrier.

You can specify polyline barrier geometries as well as attributes using a JSON structure that references a set of features. The property is optional however, the JSON structure must specify either the url, features, or layer property:

• url—Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set.

  The JSON structure can include the following property:

  • doNotLocateOnRestrictedElements (optional)—Specify whether the restricted network elements should be considered when finding network locations. The default is true.

• features—Specify an array of features.

  Each feature in this array represents a polyline barrier and contains the following fields:

  • geometry—Specify the input point geometry containing x and y properties along with a spatialReference property. If the spatialReference property is defined for the entire JSON, there isn't a need to define this property for each geometry. Doing so reduces the size of the input JSON if the input has many features, and improves performance. This property is not required if the coordinates are in the default spatial reference, WGS84. If the coordinates are in a different spatial reference, you must specify the spatial reference's well-known ID (WKID). See Using spatial references to look up WKID values.
    Tip:

    As a best practice, it is recommended to explicitly specify the spatialReference, and specify it for the entire JSON instead of each individual geometry.

  • attributes—Specify each attribute as a key-value pair where the key is the name of a given field, and the value is the attribute value for the corresponding field.

  The JSON structure can include the following property:

  • doNotLocateOnRestrictedElements (optional)—Specify whether the restricted network elements should be considered when finding network locations. The default is true.

• layer—Specify a feature layer in the map service. Attribute and spatial filters can also be applied on the layer. The JSON structure can include the following properties:
  • type—The type should be set to layer to indicate that the user is specifying the polyline barriers by referencing a layer.
  • layerName—The name or ID of the data layer in the map service that is being referenced.
  • where (optional)—A WHERE clause for the query filter. Any legal SQL WHERE clause operating on the fields in the layer is allowed.
  • geometry (optional)—The geometry to apply as the spatial filter. The structure of the geometry is the same as the structure of the JSON geometry objects returned by the ArcGIS REST API.

    The geometry type is specified using the geometryType property.

  • geometryType (optional)—The type of geometry specified by the geometry property. The supported geometry types are envelope, point, line, or polygon. The default geometry type is esriGeometryEnvelope.

    Values: esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope

  • spatialRel (optional)—The spatial relationship to be applied on the input geometry. The supported spatial relationships include intersects, contains, envelope intersects, within, and so on. The default spatial relationship is intersects esriSpatialRelIntersects.

    Values: esriSpatialRelIntersects | esriSpatialRelContains | esriSpatialRelCrosses | esriSpatialRelEnvelopeIntersects | esriSpatialRelIndexIntersects | esriSpatialRelOverlaps | esriSpatialRelTouches | esriSpatialRelWithin

  • doNotLocateOnRestrictedElements (optional)—Specify whether the restricted network elements should be considered when finding network locations. The default is true.

Attributes for polylineBarriers

When specifying the polylineBarriers parameter using JSON structure, the parameter can be specified with the following attribute:

Name

The name of the barrier.

ObjectID

The ObjectID of the line barrier. The ObjectID is a unique identifier for the line barrier. If you want to maintain relationship between input and output, set preserveObjectID to true. The ObjectID of the input line barrier is included in the output line barrier (as the ObjectID field) and can be used to join additional information from analysis outputs to the attribute of your line barriers. If the ObjectID is not specified, a unique ID is automatically generated in the output.

SourceID

The numeric identifier of the network dataset source feature class on which the input point is located.

SourceOID

The ObjectID of the feature in the source on which the input point is located.

PosAlong

The position along the digitized direction of the source line feature. This value is stored as a ratio. This field is null if the network location references a junction.

SideOfEdge

The side of the edge in relation to the digitized direction of the line feature. This field is limited to a domain of two values: Right Side (1) and Left Side (2).

Note:

SourceID, SourceOID, PosAlong, and SideOfEdge are location fields. If these fields are present on input, the analysis will locate input based on these fields else, the analysis will calculate the location of input based on the geometry of the input. However, these fields are not required.

BarrierType

Specify if the barrier restricts travel completely or scales time or distance when it is crossed. The value for this attribute is specified as one of the following integers (use the numeric code, not the name in parentheses):

• 0 (Restriction)-Prohibits travel through the barrier. The barrier is referred to as a restriction line barrier since it acts as a restriction.
• 1 (Scaled Cost)-Scales the time or distance required to travel the underlying streets by a factor specified using the Attr_[Cost] attribute.

Attr_[Cost]

This property is specific to scaled-cost barriers. It is the factor by which the cost of edges underlying the barrier are multiplied.

Syntax examples for polylineBarriers

Syntax for specifying polyline barriers using JSON structure for features

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>
  },
  "features": [
    {
      "geometry": {
        "paths": [
          [
            [<x11>,<y11>],
            [<x12>,<y12>]
          ],
          [
            [<x21>,<y21>],
            [<x22>,<y22>]
          ]
        ],
      },
      "attributes": {
        "<field1>": <value11>,
        "<field2>": <value12>
      }
    },
    {
      "geometry": {
        "paths": [
          [
            [<x11>,<y11>],
            [<x12>,<y12>]
          ],
          [
            [<x21>,<y21>],
            [<x22>,<y22>]
          ]
        ]
      },
      "attributes": {
        "<field1>": <value21>,
        "<field2>": <value22>
      }
    }
  ],
  "doNotLocateOnRestrictedElements": true | false
}

Syntax for specifying polyline barriers using a URL returning a JSON response

{
  "url": "<url>"
  "doNotLocateOnRestrictedElements": true | false
}

Syntax for specifying polyline barriers using a layer

{ 
  "type" : "layer",
  "layerName" : "<layerName>",
  "where" : "<whereClause>",
  "geometry" : {<geometry>},
  "geometryType" : "<geometryType>",
  "spatialRel" : "<spatialRel>"
  "doNotLocateOnRestrictedElements": true | false
}

Examples for polylineBarriers

Example one: Specifying polyline barriers using JSON structure

The example shows how to add two lines as polyline barriers to restrict travel on the streets intersected by the lines. Barrier 1 is a single-part line feature made up of two points. Barrier 2 is a two-part line feature. The first part is made up of three points, and the second part is made up of two points.

{
  "spatialReference": {
    "wkid": 102100
  },
  "features": [
    {
      "geometry": {
        "paths": [
          [
            [-10804823.397,3873688.372],
            [-10804811.152,3873025.945]
          ]
        ]
      },
      "attributes": {
        "Name": "Barrier 1"
      }
    },
    {
      "geometry": {
        "paths": [
          [
            [-10804823.397,3873688.372],
            [-10804807.813,3873290.911],
            [-10804811.152,3873025.945]
          ],
          [
            [-10805032.678,3863358.76],
            [-10805001.508,3862829.281]
          ]
        ]
      },
      "attributes": {
        "Name": "Barrier 2"
      }
    }
  ]
}

Example two: Specifying polyline barrier using a URL

The URL makes a query for a few features from a map service. A URL querying features from a feature service can also be specified.

{
  "url": "https://machine.domain.com/webadaptor/rest/services/Network/USA/MapServer/6/query?where=1%3D1&returnGeometry=true&f=json"
}

Example 3:Specifying polyline barrier using a layer

{ 
  "type" : "layer",
  "layerName" : "PolylineBarrier"
}

polygonBarriers

Use this parameter to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.

You can specify polygon barrier geometries as well as attributes using a JSON structure that references a set of features. The property is optional however, the JSON structure must specify either the url, features, or layer property:

• url—Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set.

  The JSON structure can include the following property:

  • doNotLocateOnRestrictedElements (optional)—Specify whether the restricted network elements should be considered when finding network locations. The default is true.

• features—Specify an array of features.

  Each feature in this array represents a polygon barrier and contains the following fields:

  • geometry—Specify the input point geometry containing x and y properties along with a spatialReference property. If the spatialReference property is defined for the entire JSON, there isn't a need to define this property for each geometry. Doing so reduces the size of the input JSON if the input has many features, and improves performance. This property is not required if the coordinates are in the default spatial reference, WGS84. If the coordinates are in a different spatial reference, you must specify the spatial reference's well-known ID (WKID). See Using spatial references to look up WKID values.
    Tip:

    As a best practice, it is recommended to explicitly specify the spatialReference, and specify it for the entire JSON instead of each individual geometry.

  • attributes—Specify each attribute as a key-value pair where the key is the name of a given field, and the value is the attribute value for the corresponding field.

  The JSON structure can include the following property:

  • doNotLocateOnRestrictedElements (optional)—Specify whether the restricted network elements should be considered when finding network locations. The default is true.

• layer—Specify a feature layer in the map service. Attribute and spatial filters can also be applied on the layer. The JSON structure can include the following properties:
  • type—The type should be set to layer to indicate that the user is specifying the polygon barriers by referencing a layer.
  • layerName—The name or ID of the data layer in the map service that is being referenced.
  • where (optional)—A WHERE clause for the query filter. Any legal SQL WHERE clause operating on the fields in the layer is allowed.
  • geometry (optional)—The geometry to apply as the spatial filter. The structure of the geometry is the same as the structure of the JSON geometry objects returned by the ArcGIS REST API.

    The geometry type is specified using the geometryType property.

  • geometryType (optional)—The type of geometry specified by the geometry property. The supported geometry types are envelope, point, line, or polygon. The default geometry type is esriGeometryEnvelope.

    Values: esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope

  • spatialRel (optional)—The spatial relationship to be applied on the input geometry. The supported spatial relationships include intersects, contains, envelope intersects, within, and so on. The default spatial relationship is intersects esriSpatialRelIntersects.

    Values: esriSpatialRelIntersects | esriSpatialRelContains | esriSpatialRelCrosses | esriSpatialRelEnvelopeIntersects | esriSpatialRelIndexIntersects | esriSpatialRelOverlaps | esriSpatialRelTouches | esriSpatialRelWithin

  • doNotLocateOnRestrictedElements (optional)—Specify whether the restricted network elements should be considered when finding network locations. The default is true.

Attributes for polygonBarriers

When specifying the polygonBarriers parameter using JSON structure, you can specify additional information about barriers, such as the barrier type, using attributes. The polygonBarriers parameter can be specified with the following attributes:

Name

The name of the barrier.

ObjectID

The ObjectID of the polygon barrier. The ObjectID is a unique identifier for the polygon barrier. If you want to maintain relationship between input and output, set preserveObjectID to true. The ObjectID of the input polygon barrier is included in the output polygon barrier (as the ObjectID field) and can be used to join additional information from analysis outputs to the attribute of your polygon barriers. If the ObjectID is not specified, a unique ID is automatically generated in the output.

SourceID

The numeric identifier of the network dataset source feature class on which the input point is located.

SourceOID

The ObjectID of the feature in the source on which the input point is located.

PosAlong

The position along the digitized direction of the source line feature. This value is stored as a ratio. This field is null if the network location references a junction.

SideOfEdge

The side of the edge in relation to the digitized direction of the line feature. This field is limited to a domain of two values: Right Side (1) and Left Side (2).

Note:

SourceID, SourceOID, PosAlong, and SideOfEdge are location fields. If these fields are present on input, the analysis will locate input based on these fields else, the analysis will calculate the location of input based on the geometry of the input. However, these fields are not required.

BarrierType

Use this parameter to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.

• 0 (Restriction)—Prohibits traveling through any part of the barrier. The barrier is referred to as a restriction polygon barrier since it prohibits traveling on streets intersected by the barrier. One use of this type of barrier is to model floods covering areas of the street that make traveling on those streets impossible.

  This is the default value.

  The left side depicts the shortest path between two stops. On the right, a polygon barrier blocks flooded streets, so the shortest path between the same two stops is different.

• 1 (Scaled Cost)—Scales the time or distance required to travel the underlying streets by a factor specified using the Attr_[Cost]. If the streets are partially covered by the barrier, the travel time or distance is apportioned and then scaled. For example, a factor of 0.25 would mean that travel on underlying streets is expected to be four times faster than normal. A factor of 3.0 would mean it is expected to take three times longer than normal to travel on underlying streets. This barrier type is referred to as a scaled cost polygon barrier. It might be used to model storms that reduce travel speeds in specific regions.

  The map on the left shows a route that goes through inclement weather without regard for the effect that poor road conditions have on travel time. On the right, a scaled polygon barrier doubles the travel time of the roads covered by the storm. Notice the route still passes through the southern tip of the storm since it is quicker to spend more time driving slowly through a small part of the storm rather than driving completely around it. The service uses the modified travel time in calculating the best route; furthermore, the modified travel time is reported as the total travel time in the response.

Attr_[Cost]

This is the factor by which the cost of the streets intersected by the barrier is multiplied. This attribute is applicable only for scaled cost barriers. The attribute value must be greater than zero.

Syntax examples for polygonBarriers

Syntax for specifying polygon barriers using JSON structure for features

{
  "spatialReference": {
    "wkid": <wkid>,
    "latestWkid": <wkid>
  },
  "features": [
    {
      "geometry": {
        "rings": [
          [
            [<x11>,<y11>],
            [<x12>,<y12>],
            [<x11>,<y11>]
          ],
          [
            [<x21>,<y21>],
            [<x22>,<y22>],
            [<x21>,<y21>]
          ]
        ]
      },
      "attributes": {
        "<field1>": <value11>,
        "<field2>": <value12>
      }
    },
    {
      "geometry": {
        "rings": [
          [
            [<x11>,<y11>],
            [<x12>,<y12>],
            [<x11>,<y11>]
          ],
          [
            [<x21>,<y21>],
            [<x22>,<y22>],
            [<x21>,<y21>]
          ]
        ]
      },
      "attributes": {
        "<field1>": <value21>,
        "<field2>": <value22>
      }
    }
  ],
  "doNotLocateOnRestrictedElements": true | false
}

Syntax for specifying polygon barriers using a URL returning a JSON response

{
  "url": "<url>"
  "doNotLocateOnRestrictedElements": true | false
}

Syntax for specifying polygon barriers using a layer

{ 
  "type" : "layer",
  "layerName" : "<layerName>",
  "where" : "<whereClause>",
  "geometry" : {<geometry>},
  "geometryType" : "<geometryType>",
  "spatialRel" : "<spatialRel>"
  "doNotLocateOnRestrictedElements": true | false
}

Examples for polygonBarriers

Example one: Specifying polygon barrier using JSON structure

The example shows how to add two polygons as barriers. The first polygon, named Flood zone, is a restriction polygon barrier that prohibits travel on the underlying streets. The polygon is a single-part polygon feature made up of four points. The second polygon, named Severe weather zone, is a scaled-cost polygon barrier that reduces the travel time on underlying streets to one-third of the original value. The polygon is a two-part polygon feature. Both parts are made up of four points.

{
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "geometry": {
        "rings": [
          [
            [-97.0634,32.8442],
            [-97.0554,32.84],
            [-97.0558,32.8327],
            [-97.0638,32.83],
            [-97.0634,32.8442]
          ]
        ]
      },
      "attributes": {
        "Name": "Flood zone",
        "BarrierType": 0
      }
    },
    {
      "geometry": {
        "rings": [
          [
            [-97.0803,32.8235],
            [-97.0776,32.8277],
            [-97.074,32.8254],
            [-97.0767,32.8227],
            [-97.0803,32.8235]
          ],
          [
            [-97.0871,32.8311],
            [-97.0831,32.8292],
            [-97.0853,32.8259],
            [-97.0892,32.8279],
            [-97.0871,32.8311]
          ]
        ]
      },
      "attributes": {
        "Name": "Severe weather zone",
        "BarrierType": 1,
        "Attr_TravelTime": 3
      }
    }
  ]
}

Example two: Specifying a polygon barrier using a URL

The URL makes a query for a few features from a map service. A URL querying features from a feature service can also be specified.

{
  "url": "https://machine.domain.com/webadaptor/rest/services/Network/USA/MapServer/7/query?where=1%3D1&returnGeometry=true&f=json"
}

Example 3:Specifying a polygon barrier using a layer

{ 
  "type" : "layer",
  "layerName" : "PolygonBarrier"
}

returnDirections

Specify whether the service should generate driving directions for each route.

The default value is false.

• true—Generate directions. The directions are configured based on the values for the directionsLanguage, directionsOutputType, directionsStyleName, and directionsLengthUnits parameters. The directions are available in the directions property of the JSON response.

• false—Don't generate directions.

directionsLanguage

The language that will be used when generating travel directions.

This parameter applies only when the returnDirections parameter is set to true. The service supports generating directions in the following languages:

• ar—Arabic
• bs—Bosnian
• ca—Catalan
• cs—Czech
• da—Danish
• de—German
• el—Greek
• en—English
• es—Spanish
• et—Estonian
• fi—Finnish
• fr—French
• he—Hebrew
• hr—Croatian
• hu—Hungarian
• id—Indonesian
• it—Italian
• ja—Japanese
• ko—Korean
• lt—Lithuanian
• lv—Latvian
• nb—Norwegian
• nl—Dutch
• pl—Polish
• pt-BR—Portuguese (Brazil)
• pt-PT—Portuguese (Portugal)
• ro—Romanian
• ru—Russian
• sk—Slovak
• sl—Slovenian
• sr—Serbian
• sv—Swedish
• th—Thai
• tr—Turkish
• uk—Ukrainian
• vi—Vietnamese
• zh-CN—Chinese (China)
• zh-HK—Chinese (Hong Kong)
• zh-TW—Chinese (Taiwan)

The service tries to find an exact match for the specified language including any language localization. If an exact match is not found, it tries to match the language family. If a match is still not found, the service returns the directions using the default language of the server's operating system. For example, if the directions language is specified as es-MX (Mexican Spanish), the service will return the directions in Spanish as it supports es language code and not es-MX.

Caution:

If a language supports localization, such as Brazilian Portuguese (pt-BR) and European Portuguese (pt-PT), you should specify the language family and the localization. If you only specify the language family, the service will not match the language family and instead return directions in the default language of the server's operating system. For example, if the directions language is specified as pt, the service will return the directions in the default language of the server's operating system since it cannot decide if the directions should be returned in pt-BR or pt-PT.

directionsOutputType

Define the content and verbosity of the driving directions. This parameter applies only when the returnDirections parameter is set to true. The parameter can be specified using the following values:

• esriDOTComplete—Directions output that includes all directions properties.
• esriDOTCompleteNoEvents—Directions output that includes all directions properties except events.
• esriDOTInstructionsOnly—Directions output that includes text instructions, time, length and ETA. Does not include geometry.
• esriDOTStandard—Directions output that includes all the text instructions, geometry, time, length, ETA. Does not include events, new types of strings (street names, signposts info), Maneuver type, Bearings and Turn angle.
• esriDOTSummaryOnly—Directions output that contains only summary (time and length). Detailed text instructions and geometry are not provided.
• esriDOTFeatureSets—Directions output that includes two feature sets; direction points and direction lines. Direction points contains a set of point features representing the direction maneuvers such as arriving to or departing from a stop, turning left or right, and other events along your route. This feature set contains the route's turn-by-turn directions. Direction lines contains a set of line features for each segment of the route. This feature set can be used to visualize the turn-by-turn directions on a map.

The default value is esriDOTStandard.

directionsStyleName

Specify the name of the formatting style for the directions. The parameter can be specified using the following values:

• NA Desktop—Generates turn-by-turn directions suitable for printing.
• NA Navigation—Generates turn-by-turn directions designed for an in-vehicle navigation device.
• NA Campus—Generates turn-by-turn walking directions designed for pedestrian routes.

This parameter applies only when the returnDirections parameter is set to true.

directionsLengthUnits

Specify the units for displaying travel distance in the driving directions. This parameter applies only when the returnDirections parameter is set to true. The parameter can be specified using one of the values:

• esriNAUCentimeters
• esriNAUDecimalDegrees
• esriNAUDecimeters
• esriNAUFeet
• esriNAUInches
• esriNAUKilometers
• esriNAUMeters
• esriNAUMiles
• esriNAUMillimeters
• esriNAUNauticalMiles
• esriNAUPoints
• esriNAUYards

The default value is esriNAUMiles.

directionsTimeAttributeName

Set the time-based impedance attribute to display the duration of a maneuver, such as "Go northwest on Alvorado St. for 5 minutes." The units for all the time attributes is minutes.

• TravelTime—Travel times for a car
• TruckTravelTime—Travel times for a truck
• WalkTime—Travel times for a pedestrian
• Minutes—Travel times for a car without using live traffic data
• TruckTime—Travel times for a truck without using live traffic data

Note:

These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.

returnRoutes

Use this parameter to specify if the service should return routes.

The default value is true.

• true—Routes are generated. The routes are available in the routes property of the JSON response. The shape of the routes depends on the value for the outputLines parameter.
• false—Routes are not generated.

Tip:

You may not want to return routes if your application has to display only the driving directions between the stops. It is sufficient in this case to set the returnDirections parameter to trueand returnRoutes parameter to false; returning routes will not provide any additional information and will increase the overall response size.

outputLines

Use this parameter to specify the type of route features that are output by the service. This parameter is applicable only if the returnRoutes parameter is set to true. The outputLines parameter can have one of the following values:

• esriNAOutputLineTrueShape—Return the exact shape of the resulting route that is based on the underlying streets.

• esriNAOutputLineTrueShapeWithMeasure—Return the exact shape of the resulting route that is based on the underlying streets and include route measurements that keep track of the cumulative travel time or travel distance along the route relative to the first stop. When this value is chosen for the outputLines parameter, each point that make up the route shape will include an M value along with X and Y values. The M value, also known as the measure value, indicates the accumulated travel time or travel distance at that point along the route. The M values can be used to determine how far you have traveled from the start of the route or the remaining distance or time left to reach the destination. The M values are in the same units as the impedance attribute.

• esriNAOutputLineStraight—Return a straight line between the stops.

• esriNAOutputLineNone—Do not return any shapes for the routes. This value can be useful in cases where you are only interested in determining the total travel time or travel distance of the route. For example, if your application has already calculated the route and after some time your application needs to only calculate the estimated time of arrival (ETA) to the destination, you can set the returnRoutes parameter to true and the outputLines parameter to esriNAOutputLineNone. The routes property of the JSON response will only contain the total travel time that can be used to determine the ETA. Since the route shape is not returned when using the esriNAOutputLineNone value, the response size will be considerably smaller.

Tip:

When the outputLines parameter is set to esriNAOutputLineTrueShape or esriNAOutputLineTrueShapeWithMeasure, the generalization of the route shape can be further controlled using the appropriate values for the outputGeometryPrecision and the outputGeometryPrecisionUnits parameters.

Note:

No matter which value you choose for the outputLines parameter, the best route is always determined by minimizing the travel time or the travel distance, never using the Euclidean distance (or as the crow flies distance) between the stops. This means that only the route shapes are different, not the underlying streets that are searched when finding the route.

returnStops

Use this parameter to specify whether stops will be returned by the service. The possible values for this parameter are true or false. A true value indicates that the stops used as input will be returned as part of the stops property in the JSON response. The default value for this parameter is false.

When finding optimized routes, the returnStops property can be set to true to determine the optimal sequence where the route visits a particular stop by checking the Sequence property in the JSON response. If you have specified the stops parameter using a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set, returning stops can allow you to draw the stop locations in your application. You may also want to set the returnStops property to true to determine whether the stops were successfully located on the street network or had other errors by checking the Status property in the JSON response.

returnBarriers

Specify whether barriers will be returned by the service.

• true—The input point barriers are returned as part of the barriers property in the JSON response.
• false (default)—Point barriers are not returned.

Setting this parameter has no effect if you don't also specify a value for the barriers parameter.

If you have specified the barriers parameter using a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set, returning barriers can allow you to draw the point barrier locations in your application. You may also want to set the returnBarriers property to true to see where the barriers were located on the street network or, if they weren't located at all, understand what the problem was by checking the Status property in the JSON response.

returnPolylineBarriers

Specify whether polyline barriers will be returned by the service.

• true—The input polyline barriers are returned as part of the polylineBarriers property in the JSON response.
• false (default)—Polyline barriers are not returned.

Setting this parameter has no effect if you don't also specify a value for the polylineBarriers parameter.

If you have specified the polylineBarriers parameter using a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set, the returnPolylineBarriers parameter can be set to true so that you can draw the polyline barrier locations in your application.

returnPolygonBarriers

Specify whether polygon barriers will be returned by the service.

• true—The input polygon barriers are returned as part of the polygonBarriers property in the JSON response.
• false (default)—Polygon barriers are not returned.

Setting this parameter has no effect if you don't also specify a value for the polygonBarriers parameter.

If you have specified the polygonBarriers parameter using a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set, the returnPolygonBarriers parameter can be set to true so that you can draw the polygon barrier locations in your application.

returnTraversedEdges

Specify whether traversed edges will be returned by the service.

• true—The traversed edges are returned as part of the JSON response.
• false—The traversed edges are not returned.

When this parameter is set to true, the traversed edges are available in the traversedEdges property of the JSON response.

The default value is false

returnTraversedJunctions

Specify whether traversed junctions will be returned by the service.

• true—The traversed junctions are returned as part of the JSON response.
• false—The traversed junctions are not returned.

When this parameter is set to true, the traversed junctions are available in the traversedJunctions property of the JSON response.

The default value is false

returnTraversedTurns

Specify whether traversed turns will be returned by the service.

• true—The traversed turns are returned as part of the JSON response.
• false—The traversed turns are not returned.

When this parameter is set to true, the traversed turns are available in the traversedTurns property of the JSON response.

The default value is false

ignoreInvalidLocations

Specify whether invalid input locations should be ignored when finding the best solution. An input point is deemed invalid by the service if it is not within the maximum snap tolerance of any traversable street.

• true—Invalid points are ignored.
• false—Any invalid point in your request will cause the service to return a failure.

The default value is true.

outSR

Use this parameter to specify the spatial reference of the geometries, such as line or point features, returned by the service.

The parameter value can be specified as a well-known ID (WKID) for the spatial reference. See Using spatial references to look up WKID values.

Many of the basemaps provided by ArcGIS Online are in the Web Mercator spatial reference (WKID 102100). Specifying outSR=102100 returns the geometries in the Web Mercator spatial reference, which can be drawn on top of the basemaps.

outputGeometryPrecision

Use this parameter to specify by how much you want to simplify the route geometry returned by the service.

Caution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

Simplification maintains critical points on a route, such as turns at intersections, to define the essential shape of the route and removes other points. The simplification distance you specify is the maximum allowable offset that the simplified line can deviate from the original line. Simplifying a line reduces the number of vertices that are part of the route geometry. This reduces the overall response size and also improves the performance for drawing the route shapes in the applications.

The units are specified with the outputGeometryPrecisionUnits parameter.

outputGeometryPrecisionUnits

Use this parameter to specify the units for the value specified for the outputGeometryPrecision parameter.

Caution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

The parameter value should be specified as one of the following values:

• esriCentimeters
• esriDecimalDegrees
• esriDecimeters
• esriFeet
• esriInches
• esriKilometers
• esriMeters
• esriMiles
• esriMillimeters
• esriNauticalMiles
• esriPoints
• esriYards

geometryPrecision

Use this parameter to specify the number of decimal places in the response geometries returned by solve operation. This applies to x- and y-values only (not m- or z-values).

geometryPrecision = 3

geometryPrecisionZ

Use this parameter specify the number of decimal places in the response geometries returned by solve operation. This applies to z-value only (not x-,y- or m-values).

geometryPrecisionZ = 3

geometryPrecisionM

Use this parameter to specify the number of decimal places in the response geometries returned by solve operation. This applies to m-value only (not x-,y- or z-values).

geometryPrecisionM = 3

overrides

Specify additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems.

The value for this parameter must be specified in JavaScript Object Notation (JSON). The values can be either a number, a Boolean, or a string.

{
  "overrideSetting1" : "value1", 
  "overrideSetting2" : "value2"
}

The default value for this parameter is no value, which indicates to not override any solver settings.

Overrides are advanced settings that should be used only after careful analysis of the results obtained before and after applying the settings. A list of supported override settings for each solver and their acceptable values can be obtained by contacting Esri Technical Support.

preserveObjectID

Use this parameter to specify if the Object IDs specified for input locations such as stops or barriers should be preserved when the input locations are returned as output. This can be useful if you want to associate additional attributes with the output locations after the solve operation is successful and need a common key field to do the join.

For example, if your input stops are specified as the following JSON representation of a feature set.

{
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "geometry": {
        "x": -122.473948,
        "y": 37.7436
      },
      "attributes": {
        "ObjectID": 40,
        "Name": "Depot"
      }
    },
    {
      "geometry": {
        "x": -122.439613,
        "y": 37.746144
      },
      "attributes": {
        "ObjectID": 20,
        "Name": "Store 1"
      }
    },
    {
      "geometry": {
        "x": -122.488254,
        "y": 37.754092
      },
      "attributes": {
        "ObjectID": 30,
        "Name": "Store 2"
      }
    },
    {
      "geometry": {
        "x": -122.44915,
        "y": 37.731837
      },
      "attributes": {
        "ObjectID": 10,
        "Name": "Store 3"
      }
    }
  ]
}

If you solve a route and specify preserveObjectID=false, the output stops will have object ids, 1, 2, 3, and 4 even though the input stops have object ids 10, 20, 30, and 40. However if preserveObjectID=true, the output stops will have same object ids as inputs 10, 20, 30, and 40.

Caution:

The order in which the output locations are returned varies based on other parameters specified for the solve operation and should not be relied upon to correlate the output locations with input locations. Preserving object ID is the best way to achieve this correlation. If the identifier for your input location can not be passed as ObjectID, for example, the identifier is non-numeric, you can pass the identifier as the Name field and then use the Name field on output locations to correlate the input and output locations.

Caution:

When preserveObjectID=true, the object ID values must be 1 or greater, must be specified for every feature, and must be unique.

Output parameters

Upon successful execution, the service returns the best paths between the stops and the status indicating whether the analysis was successful using the output parameters described below.

routes

This provides access to the resulting routes.

The following table lists the fields returned for output routes:

Field	Description
ObjectID	The system-managed ID field.
Name	The name of the route is based on the RouteName field of the associated stops. If the input RouteName field is null, the name is derived from the Name field of the first and last stops.
FirstStopOID	If you specify preserveObjectID=false, the value for this field will be a system-generated ID. If preserveObjectID=True, the value for this field will be the ObjectID of your associated input.
LastStopOID	If you specify preserveObjectID=false, the value for this field will be a system-generated ID. If preserveObjectID=True, the value for this field will be the ObjectID of your associated input.
StopCount	The number of stops assigned to the route.
StartTime	The start time of the route, reported in the time zone in which the first stop is located.
EndTime	The end time of the route, reported in the time zone in which the last stop is located.
StartTimeUTC	The start time of the route in coordinated universal time (UTC).
EndTimeUTC	The end time of the route in coordinated universal time (UTC).
TotalWait_[Cost] (For example, TotalWait_Minutes, when Minutes is the travel cost for the network)	This field stores the route's overall wait time, which is the time spent at stops waiting for time windows to open. Note: Only TotalWait_[ImpedanceAttributeName] is populated with a value. The field has a null value if time windows are not used in the analysis.
TotalViolation_[Cost] (For example, TotalViolation_Minutes, when Minutes is the travel cost for the network)	This field stores the route's overall violation time at stops. Violation time is added when the route arrives at a stop after the time window has ended; it's the difference between the ArriveTime and TimeWindowEnd fields on inputs stops. Note: Only TotalViolation_[ImpedanceAttributeName] is populated with value. The field has a null value if time windows are not used in the analysis.
Total_[Cost] (For example, Total_Minutes, when Minutes is the travel cost for the network)	The total distance, time, or other travel cost from the beginning of the first stop to the end of the last stop. The total travel cost and the Attr_[Cost] value of the visited stops are included in this value. This field will be populated if the [Cost] part of this field is used as an impedance attribute or accumulated attribute.

stops

This provides access to the attributes of the stops that are visited by the routes as well as stops that cannot be reached by any of the routes.

You can use the attributes from this parameter, such as the Status field, to determine why a stop was not assigned to any routes.

Field	Description
ObjectID	If you specify preserveObjectID=false, the value for this field will be a system-generated ID. If preserveObjectID=True, the value for this field will be the ObjectID of your associated input.
Name	The name of the stop visited by the route. The values for this field are copied from the Name field on the input stops.
RouteName	The name of the route to which the stop is assigned. Input stops that have the same route name at the time the tool runs are grouped together and visited by one route, and the route is assigned that name. When more than one route name is present on the input stops, the tool can output multiple routes—one for each unique route name. If no name is present, all the stops belong to the same route.
Sequence	The order in which the stops are visited by the assigned route, which is listed in the RouteName field.
TimeWindowStart	The earliest time the route can visit the stop. The values for this field are copied from the TimeWindowStart field on the input stops.
TimeWindowEnd	The latest time the route can visit the stop. The values for this field are copied from the TimeWindowEnd field on the input stops.
ArriveCurbApproach	The side of the vehicle the curb is on when arriving at the stop.
DepartCurbApproach	The side of the vehicle the curb is on when departing from the stop.
ArriveTime	The date and time value indicating the arrival time at the stop. The time zone for this time-of-day value is taken from the network element on which the stop is located.
DepartTime	The date and time value indicating the departure time from the stop. The time zone for this time-of-day value is taken from the network element on which the stop is located.
ArriveTimeUTC	The date and time value indicating the arrival time in coordinated universal time (UTC)
DepartTimeUTC	The date and time value indicating the departure time in coordinated universal time (UTC)
LocationType	The stop type. The values for this field are copied from the LocationType field on the input stops.
SourceID	The numeric identifier of the network dataset source feature class on which the input point is located.
SourceOID	The ObjectID of the feature in the source on which the input point is located.
PosAlong	The position along the digitized direction of the source line feature. This value is stored as a ratio. This field is null if the network location references a junction.
SideOfEdge	The side of the edge in relation to the digitized direction of the line feature. This field is limited to a domain of two values: Right Side (1) and Left Side (2).
CurbApproach	The direction a vehicle may arrive at and depart from the stop. The values for this field are copied from the CurbApproach field on the input stops.
Status	Indicates the status of the point with respect to its location on the network and the outcome of the analysis. The possible values are the following: 0 (OK)—The point was successfully located on the network. 1 (Not Located)—The point was not successfully located on the network and consequently was not included in the analysis. 2 (Network element not located)—The network element identified by the point's network location fields can't be found. This can occur when a network element where the point should be was deleted, and the network location was not recalculated. 3 (Element not traversable)—The network element that the point is located on is not traversable. This can occur when the element is restricted by a restriction attribute. 4 (Invalid Field Values)—Field values fall outside a range or coded-value domain. For example, a negative number exists where positive numbers are required. 5 (Not Reached)—The point can't be reached by the solver. The point may be on a separate, disconnected area of the network from the other inputs, or barriers or restrictions prevent travel to or from the point. 6 (Time window violation)—The point could not be reached within the designated time windows. This status only applies to network analysis types that support time windows. 7 (Not located on closest)—The closest network location to the point is not traversable because of a restriction or barrier, so the point has been located on the closest traversable network feature instead.
SnapX	The x-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.
SnapY	The y-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.
SnapZ	The z-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset. The SnapZ field is 0 if the network is two dimensional.
DistanceToNetworkInMeters	The distance in meters between the point's geographic location and the position where it was located on the network.
Attr_[Cost] (For example, Attr_Minutes, when Minutes is the travel cost)	This field specifies how much additional time spent or distance traveled will occur at the stop. A zero or null value indicates the stop requires no service time or extra distance traveled. If you have multiple network cost attributes, you'll see multiple Attr_[Cost] fields. Consequently, you may have more than one time- or distance-based Attr_[Cost] field. The field values you provide are only referenced if the cost attribute referred to in the field name is used in the analysis, for instance, to minimize or accumulate time or distance.
Cumul_[Cost] (for instance, Cumul_Minutes, where Minutes is the cost for the network)	This field is the total time, distance, or other travel cost it takes to reach the stop. This includes the travel cost incurred in traveling to the stop, the cost at the stop, and the costs of all the previous stops. If a route analysis layer determines it takes 10 minutes to visit two stops, and the second stop has an Attr_Minutes value of 5, the Cumul_Minutes value is 15 minutes.
Wait_[Cost] (for instance, Wait_Minutes, where Minutes is the travel cost)	This field stores the time spent waiting for the time window to open (TimeWindowStart) when the route arrives early at the stop.
CumulWait_[Cost] (for instance, CumulWait_Minutes, where Minutes is the travel cost)	This field stores a sum of how much time has been spent waiting for time windows to open (TimeWindowStart). It measures idle time. It includes the wait time from the current stop and all previous stops visited by the route.
Violation_[Cost] (For example, Violation_Minutes, when Minutes is the travel cost)	This field is a measure of how late the route arrived after the time window closed (TimeWindowEnd). Specifically, it stores the amount of time between the end of the time window and when the route arrived at the stop.
CumulViolation_[Cost] (For example, CumulViolation_Minutes, when Minutes is the travel cost)	This field stores the cumulative violation time (Violation_[Cost]) from the current stop and all previous stops visited by the route.

barriers

This provides access to points that act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets.

Field name	Description
ObjectID	If you specify preserveObjectID=false, the value for this field will be a system-generated ID. If preserveObjectID=True, the value for this field will be the ObjectID of your associated input.
Name	The name of the barrier.
SourceID	The numeric identifier of the network dataset source feature class on which the input point is located.
SourceOID	The ObjectID of the feature in the source on which the input point is located.
PosAlong	The position along the digitized direction of the source line feature. This value is stored as a ratio. This field is null if the network location references a junction.
SideOfEdge	The side of the edge in relation to the digitized direction of the line feature. This field is limited to a domain of two values: Right Side (1) and Left Side (2).
CurbApproach	The direction of traffic that is affected by the barrier. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses): 0 (Either side of vehicle): The barrier affects travel over the edge in both directions. 1 (Right side of vehicle): Vehicles are only affected if the barrier is on their right side during the approach. Vehicles that traverse the same edge but approach the barrier on their left side are not affected by the barrier. 2 (Left side of vehicle): Vehicles are only affected if the barrier is on their left side during the approach. Vehicles that traverse the same edge but approach the barrier on their right side are not affected by the barrier.
Status	Indicates the status of the point with respect to its location on the network and the outcome of the analysis. The possible values are the following: 0 (OK)—The point was successfully located on the network. 1 (Not Located)—The point was not successfully located on the network and consequently was not included in the analysis. 2 (Network element not located)—The network element identified by the point's network location fields can't be found. This can occur when a network element where the point should be was deleted, and the network location was not recalculated. 3 (Element not traversable)—The network element that the point is located on is not traversable. This can occur when the element is restricted by a restriction attribute. 4 (Invalid Field Values)—Field values fall outside a range or coded-value domain. For example, a negative number exists where positive numbers are required. 5 (Not Reached)—The point can't be reached by the solver. The point may be on a separate, disconnected area of the network from the other inputs, or barriers or restrictions prevent travel to or from the point. 6 (Time window violation)—The point could not be reached within the designated time windows. This status only applies to network analysis types that support time windows. 7 (Not located on closest)—The closest network location to the point is not traversable because of a restriction or barrier, so the point has been located on the closest traversable network feature instead.
FullEdge	Point barriers are applied to the edge elements during the analysis. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses): 0 (False): Permits travel on the edge up to the barrier, but not through it. This is the default value. 1 (True): Restricts travel anywhere on the associated edge.
BarrierType	Specify if the point barrier restricts travel completely or adds time or distance when it is crossed. The value for this attribute is specified as one of the following integers (use the numeric code, not the name in parentheses): 0 (Restriction)-Prohibits travel through the barrier. The barrier is referred to as a restriction point barrier since it acts as a restriction. 2 (Added Cost)- Traveling through the barrier increases the travel time or distance by the amount specified in the Attr_[Cost] property value
Attr_[Cost] (for instance Attr_TravelTime, where TravelTime is the travel cost)	This property is specific to added-cost barriers and is limited to values that are greater than or equal to zero. It indicates how much cost is added when the barrier is traversed.

polylineBarriers

This provides access to one or more lines that prohibit travel anywhere the lines intersect the streets.

Field name	Description
ObjectID	If you specify preserveObjectID=false, the value for this field will be a system-generated ID. If preserveObjectID=True, the value for this field will be the ObjectID of your associated input.
Name	The name of the barrier.
BarrierType	Specify if the barrier restricts travel completely or scales time or distance when it is crossed. The value for this attribute is specified as one of the following integers (use the numeric code, not the name in parentheses): 0 (Restriction)-Prohibits travel through the barrier. The barrier is referred to as a restriction line barrier since it acts as a restriction. 1 (Scaled Cost)-Scales the time or distance required to travel the underlying streets by a factor specified using the Attr_[Cost] attribute.
Attr_[Cost] (for instance Attr_TraveTime, where TravelTime is the travel cost)	This property is specific to scaled-cost barriers. It is the factor by which the cost of edges underlying the barrier are multiplied.

polygonBarriers

This provides access to polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.

Field name	Description
ObjectID	If you specify preserveObjectID=false, the value for this field will be a system-generated ID. If preserveObjectID=True, the value for this field will be the ObjectID of your associated input.
Name	The name of the barrier.
BarrierType	Specify if the barrier restricts travel completely or scales time or distance when it is crossed. The value for this attribute is specified as one of the following integers (use the numeric code, not the name in parentheses): 0 (Restriction)— Prohibits traveling through any part of the barrier. The barrier is referred to as restriction polygon barrier since it prohibits traveling on streets intersected by the barrier. 1 (Scaled Cost)—Scales the time or distance required to travel the underlying streets by a factor specified using the Attr_[Cost] attribute.
Attr_[Cost] (for instance Attr_TravelTime, where TravelTime is the travel cost)	This property is specific to scaled-cost barriers. It is the factor by which the cost of edges underlying the barrier are multiplied.

traversedEdges

This provides access to the edges that are traversed while solving a network analysis layer.

Field name	Description
ObjectID	The system-managed ID field.
SourceID	The numeric identifier of the feature class the traversal element is referencing.
SourceOID	The object ID of the traversed source feature.
EID	This field indicates the element ID (EID) of the traversed network edge. An EID uniquely describes a network element. The EID of a network element is independent of the ObjectID of the feature. One feature may be stored as many different elements in the network.
FromPosition	Specifies where the output line feature begins in reference to the digitized direction of the underlying source feature. A value of 0 (zero) indicates the line begins at the from-point of the underlying source feature. A value of 1 indicates the line begins at the to-point of the source feature. A value between 0 and 1 indicates the line begins at a point along the underlying source feature; for example, a value of 0.25 means the line begins 25 percent along the digitized direction of the underlying source feature.
ToPosition	Specifies where the output line feature ends in reference to the digitized direction of the underlying source feature. A value of 0 (zero) indicates the line ends at the from-point of the underlying source feature. A value of 1 indicates the line ends at the to-point of the source feature. A value between 0 and 1 indicates the line ends at a point along the underlying source feature; for example, a value of 0.25 means the line ends 25 percent along the digitized direction of the underlying source feature.
FromJunctionID	It is the reference to the object ID of the junctions in the traversedJunctions recordset.
ToJunctionID	It is the reference to the object ID of the junctions in the traversedJunctions recordset.
RouteID	The ObjectID of the route in the output routes recordset.
Attr_[Cost] (for instance Attr_TravelTime, where TravelTime is the travel cost)	The cost of the underlying edge. The units of this field are the same as the units of the cost attribute referred to in the field name. This field will be populated if the [Cost] part of this field is used as an impedance attribute or accumulated attributes.
Cumul_[Cost]	The cumulative cost of the underlying network elements from the beginning of the route to the end of the edge represented by the line feature. The units of this field are the same as the units of the cost attribute referred to in the field name. This field will be populated if the [Cost] part of this field is used as an impedance attribute or accumulated attributes.
Attr_[Restriction]	Specifies whether the traversed edge used the restriction attribute referred to in this field's name. 0—The traversed edge didn't use the restriction. 1—The traversed edge used the restriction. Note: Elements that use prohibit-restrictions are never traversed; however, those that use prefer- or avoid-restrictions can be traversed.

traversedJunctions

This provides access to the junctions that are traversed while solving a network analysis layer.

Field name	Description
ObjectID	The system-managed ID field.
SourceID	The numeric identifier of the feature class the traversal element is referencing.
SourceOID	The object ID of the traversed source feature.
EID	This field indicates the element ID (EID) of the traversed network element. An EID uniquely describes a network element. The EID of a network element is independent of the ObjectID of the feature. One feature may be stored as many different elements in the network.
RouteID	The ObjectID of the route in the output routes recordset.
Attr_[Cost] (for instance Attr_TravelTime, where TravelTime is the travel cost)	The cost of the underlying junction. The units of this field are the same as the units of the cost attribute referred to in the field name. This field will be populated if the [Cost] part of this field is used as an impedance attribute or accumulated attributes.
Cumul_[Cost]	The cumulative cost of the underlying network elements from the beginning of the route through the location of the current point feature. The units of this field are the same as the units of the cost attribute referred to in the field name. This field will be populated if the [Cost] part of this field is used as an impedance attribute or accumulated attributes.
Attr_[Restriction]	Specifies whether the traversed junction used the restriction attribute referred to in this field's name. 0—The traversed junction didn't use the restriction. 1—The traversed junction used the restriction. Note: Elements that use prohibit-restrictions are never traversed; however, those that use prefer- or avoid-restrictions can be traversed.

traversedTurns

This provides access to the turns that are traversed while solving a network analysis layer.

Field name	Description
ObjectID	The system-managed ID field.
SourceID	The numeric identifier of the feature class the traversal element is referencing.
SourceOID	The object ID of the traversed source feature.
EID	This field indicates the element ID (EID) of the traversed network element. An EID uniquely describes a network element. The EID of a network element is independent of the ObjectID of the feature. One feature may be stored as many different elements in the network.
FromEdgeID	The ObjectID in the traversedEdges recordset.
FromEdgeID	The ObjectID in the traversedEdges recordset.
RouteID	The ObjectID of the route in the output routes recordset.
Attr_[Cost] (for instance Attr_TravelTime, where TravelTime is the travel cost)	The cost of the underlying turn. The units of this field are the same as the units of the cost attribute referred to in the field name. This field will be populated if the [Cost] part of this field is used as an impedance attribute or accumulated attributes.
Cumul_[Cost]	The cumulative cost of the underlying network elements from the beginning of the route through the location of the current turn. The units of this field are the same as the units of the cost attribute referred to in the field name. This field will be populated if the [Cost] part of this field is used as an impedance attribute or accumulated attributes.
Attr_[Restriction]	Specifies whether the traversed turn used the restriction attribute referred to in this field's name. 0—The traversed turn didn't use the restriction. 1—The traversed turn used the restriction. Note: Elements that use prohibit-restrictions are never traversed; however, those that use prefer- or avoid-restrictions can be traversed.

JSON Response syntax

The JSON response from the route service 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. The examples in the subsequent section illustrate the response returned with specific request parameters.

JSON Response syntax for a successful request

{
  "directions": [
    {
      "routeId": <routeId>,
      "routeName": "<routeName>",
      "summary": {
        "totalLength": <totalLength>,
        "totalTime": <totalTime>,
        "totalDriveTime": <totalDriveTime>,
        "envelope": {<envelope>}
      },
      "hasZ": <true|false>,
      "hasM": <true|false>,
      "features": [
        {
          "attributes": {
            "length": <length1>,
            "time": <time1>,
            "text": "<text1>",
            "ETA": <ETA>,
            "maneuverType": "<maneuverType1>"
          },
          "compressedGeometry": "<compressedGeometry1>"
        },
        {
          "attributes": {
            "length": <length2>,
            "time": <time2>,
            "text": "<text2>",
            "maneuverType": "<maneuverType2>"
          },
          "compressedGeometry": "<compressedGeometry2>"
        }
      ]
    }
  ],
  "routes": {
    "spatialReference": {<spatialReference>},
    "hasZ": <true|false>,
    "hasM": <true|false>,
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {<polyline1>}
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {<polyline2>}
      }
    ]
  },
  "stops": {
    "spatialReference": {<spatialReference>},
    "hasZ": <true|false>,
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {<point1>}
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {<point2>}
      }
    ]
  },
  "barriers": {
    "spatialReference": {<spatialReference>},
    "hasZ": <true|false>,
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {<point1>}
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {<point2>}
      }
    ]
  },  
  "traversedEdges": {
    "spatialReference": {<spatialReference>},
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {<polyline1>}
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {<polyline2>}
      }
    ]
  },
  "traversedJunctions": {
    "spatialReference": {<spatialReference>},
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        },
        "geometry": {<point1>}
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        },
        "geometry": {<point2>}
      }
    ]
  },
  "traversedTurns": {
    "spatialReference": {<spatialReference>},
    "features": [
      {
        "attributes": {
          "<field1>": <value11>,
          "<field2>": <value12>
        }
      },
      {
        "attributes": {
          "<field1>": <value21>,
          "<field2>": <value22>
        }
      }
    ]
  },
  "messages": [
    {
      "type": <type1>,
      "description": "<description1>"
    },
    {
      "type": <type2>,
      "description": "<description2>"
    }
  ]
}

Note:

If hasZ or hasM is not present in the response, treat it as false, and the geometry won't include z-values or m-values, respectively.

JSON Response syntax for a failed request

{
  "error": {
    "code": <code>,
    "message": "<message>",
    "details": [
      "<details>"
    ]
  }
}