/FindRoutes

Attributes for stops

• Namestring (length: 500)nullable

  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.

• IDinteger (non-negative)nullable

  A unique identifier for the stop. The identifier is included in the output routes (as the StopID field) and can help join additional information from the output routes, such as the total travel time or total distance, to attributes from your incidents or vice versa. If the ID isn't specified, the service automatically generates a unique identifier for each stop.

• RouteNamestring (length: 1024)nullable

  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.

• Sequenceintegernullable

  If the reorder_stops_to_find_optimal_routes 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.

• AdditionalTimenumber (non-negative)default:0

  The amount of time spent at the stop, which is added to the total time of the route.

  The units for this attribute value are specified by the measurement_units parameter. The attribute value is included in the analysis only when the measurement units are time based.

  You can account for the extra time it takes at the stop to complete a task, such as to repair an appliance, deliver a package, or inspect the premises.

• AdditionalDistancenumber (non-negative)default:0

  The extra distance traveled at the stops, which is added to the total distance of the route.

  The units for this attribute value are specified by the measurement_units parameter. The attribute value is included in the analysis only when the measurement units are distance based.

  Generally, the location of a stop, such as a home, isn't exactly on the street; it is set back somewhat from the road. This attribute value can be used to model the distance between the actual stop location and its location on the street if it is important to include that distance in the total travel distance.

• AdditionalCostnumber (non-negative)default:0

  The extra cost spent at the stop, which is added to the total cost of the route.

  This attribute value should be used when the travel mode for the analysis uses an impedance attribute that is neither time based nor distance based. The units for the attribute values are interpreted to be in unknown units.

• TimeWindowStartdatetimenullable

  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 should visit the stop. When the impedance attribute of this analysis, either specified by impedance parameter or the impedance of the travel mode, is time based, by specifying time-window values the analysis will find a solution that minimizes overall travel and reaches the stop within the prescribed time window.

  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 given for the use_time_windows parameter.

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

• TimeWindowEnddatetimenullable

  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 impedance parameter or the impedance of the travel mode, is time based, specifying time-window values will cause the analysis to find a solution that minimizes overall travel and reaches the stop within the prescribed time window.

  Together, the TimeWindowStart and TimeWindowEnd attributes make up 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 use_time_windows 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.

• CurbApproachint enumdefault:0

  Allowed values: 0, 1, 2, 3

  Specify the direction a vehicle can arrive at and depart from the stop. The options are as following:

  • 0: Either side of vehicle. The vehicle can approach and depart the stop in either direction. U-turns are allowed. You should choose this setting if your vehicle can make a U-turn at the order or if it can pull into a driveway or parking lot and turn around.
  • 1: Right side of vehicle. When the vehicle approaches and departs the stop, the curb must be on the right side of the vehicle. A U-turn is prohibited.
  • 2: Left side of vehicle. When the vehicle approaches and departs the stop, the curb must be on the left side of the vehicle. A U-turn is prohibited.
  • 3: No U-turn. When the vehicle approaches the stop, the curb can be on either side of the vehicle; however, the vehicle must depart without turning around. Learn more about U-turn policies
  Show illustration

  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 a 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 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.

  

  

• Bearingnumber (non-negative)nullable

  The direction in which a point is moving. The units are degrees and are measured clockwise from true north.

  This attribute is used in conjunction with the BearingTol attribute. 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 attribute 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 solver determine the side of the street that the point is on.

  Learn more about bearing and bearing tolerance

• BearingTolnumber (range: 0 - 180)default:30nullable

  The bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing attribute.

  If the Bearing attribute 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. 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

• NavLatencynumber (non-negative)nullable

  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.

  This attribute is only used in the solve process if the Bearing and BearingTol fields also have values; however, providing a NavLatency attribute value is optional, even when values are present in the Bearing and BearingTol.

Example for locate_settings

Example 1: Specify locate settings using a JSON structure

This example shows how to specify locate settings so inputs are only located within 500 meters of the specified location. A small search tolerance like this can be helpful if you are solving using a walking travel mode and don't want inputs to be located farther than 500 meters from the original point location.

1
2
3
4
5
6
7
8
9
10
11
12
{
  "default": {
    "tolerance": 500,
    "toleranceUnits": "esriMeters",
    "allowAutoRelocate": true,
    "sources": [
      {
        "name": "Routing_Streets"
      }
    ]
  }
}

This parameter can have the following values:

Parameter Value	Description
Allowed	U-turns are permitted everywhere. Permitting 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.
Allowed only at Intersections and Dead Ends	U-turns are prohibited at junctions where exactly two adjacent streets meet. U-turns are permitted only at intersections or dead ends.
Allowed only at Dead Ends	U-turns are prohibited at all junctions and intersections and are permitted only at dead ends. U-turns are permitted only at dead ends.
Not Allowed	U-turns are prohibited at all junctions, intersections, and dead-ends. Even when this parameter value is chosen, a route can still make U-turns at stops. To prohibit U-turns at a stop, you can set its CurbApproach property to the appropriate value (3).

Attributes for point_barriers

• Namestringnullable

  The name of the barrier.

• CurbApproachint enumdefault:0

  Allowed values: 0, 1, 2

  Specify the direction of traffic that is affected by the barrier. The field value is specified as one of the following integers:

  • 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: 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.

  Because junctions are points and don't have a side, barriers on junctions affect all vehicles regardless of the curb approach.

• BarrierTypeint enumdefault:0

  Allowed values: 0, 2

  Specify 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:

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

    

    The first map shows the shortest path between two stops without any restriction point barriers. The second map 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 Additional_Time, Additional_Distance, or AdditionalCost attribute. 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.

• FullEdgeint enumdefault:0

  Allowed values: 0, 1

  Specify how the restriction point barriers are applied to the edge elements during the analysis

  • 0:False—Permits travel on the edge up to the barrier but not through it.
  • 1:True—Restricts travel anywhere on the associated edge.

• Additional_Timenumber (non-negative)default:0

  The added travel time when the barrier is traversed. This attribute is applicable only for added-cost barriers. The attribute value must be greater than or equal to zero, and its units are the same as those specified in the measurement_units parameter.

• Additional_Distancenumber (non-negative)default:0

  The added distance when the barrier is traversed. This attribute is applicable only for added-cost barriers. The attribute value must be greater than or equal to zero, and its units are the same as those specified in the measurement_units parameter.

• AdditionalCostnumber (non-negative)default:0

  The added cost when the barrier is traversed. This attribute is applicable only for added-cost barriers. The attribute value must be greater than or equal to zero.

• Bearingnumber (non-negative)nullable

  The direction in which a point is moving. The units are degrees and are measured clockwise from true north.

  This attribute is used in conjunction with the BearingTol attribute. 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 attribute 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 solver determine the side of the street that the point is on.

  Learn more about bearing and bearing tolerance

• BearingTolnumber (range: 0 - 180)default:30nullable

  The bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing attribute.

  If the Bearing attribute 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. 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

• NavLatencynumber (non-negative)nullable

  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.

  This attribute is only used in the solve process if the Bearing and BearingTol fields also have values; however, providing a NavLatency attribute value is optional, even when values are present in the Bearing and BearingTol.

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.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "geometry": {
        "x": 37.541479,
        "y": -122.053461
      },
      "attributes": {
        "Name": "Haley St railroad crossing",
        "BarrierType": 2,
        "Additional_Time": 5
      }
    }
  ]
}

Attributes for line_barriers

• Namestring (length: 500)nullable

  The name of the barrier.

This 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 composed of two points. Barrier 2 is a two-part line feature. The first part is composed of three points, and the second part is composed of two points.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  "spatialReference": {
    "wkid": 102100
  },
  "features": [
    {
      "geometry": {
        "paths": [
          [
            [-10804823.397, 3873688.372],
            [-10804811.152, 3873025.945]
          ]
        ]
      },
      "attributes": {
        "Name": "Barrier 1"
      }
    },
    {
      "geometry": {

Attributes for polygon_barriers

• Namestringnullable

  The name of the barrier.

• BarrierTypeint enumdefault:0

  Allowed values: 0, 1

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

  The value for this attribute can be specified as one of the following integers:

  • 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.

    

    The first map depicts the shortest path between two stops. The second map shows a polygon barrier blocking flooded streets, so the shortest path between the same two stops is different.

  • 1: Scaled Cost. Scales the cost (such as travel time or distance) required to travel the underlying streets by a factor specified using the ScaledTimeFactor or ScaledDistanceFactor attribute.

    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 means that travel on underlying streets is expected to be four times faster than normal. A factor of 3.0 means 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 can be used to model storms that reduce travel speeds in specific regions, for example.

  

  The first map shows a route that goes through inclement weather without regard for the effect that poor road conditions have on travel time. The second map shows a scaled polygon barrier that doubles the travel time of the roads covered by the storm. 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, and the modified travel time is reported as the total travel time in the response.

• ScaledTimeFactornumber (non-negative)default:1

  This is the factor by which the travel time of the streets intersected by the barrier is multiplied. The field value must be greater than zero.

  This field is applicable only for scaled-cost barriers and when the measurement_units parameter is time-based.

• ScaledDistanceFactornumber (non-negative)default:1

  This is the factor by which the distance of the streets intersected by the barrier is multiplied. The field value must be greater than zero.

  This field is applicable only for scaled-cost barriers and when the measurement_units parameter is distance-based.

• ScaledCostFactornumber (non-negative)default:1

  The scaled cost when the barrier is traversed. This attribute is applicable only for scaled-cost barriers. The attribute value must be greater than or equal to zero.

  This field is applicable only for scaled-cost barriers when the impedance is neither time-based nor distance-based.

This example shows how to add two polygons as barriers. The first polygon, Flood zone, is a restriction polygon barrier that prohibits travel on the underlying streets. The polygon is a single-part polygon feature composed of four points. The second polygon, 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 composed of four points.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{
  "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

The service supports generating directions in the following languages:

• ar: Arabic
• bg: Bulgarian
• 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)

• Namestring (length: 500)

  The name of the stop visited by the route. The values for this field are copied from the Name field on the input stops.

• RouteNamestring (length: 1024)nullable

  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.

• Sequenceinteger

  The order in which the stops are visited by the assigned route, which is listed in the RouteName field.

• TimeWindowStartdatetimenullable

  The earliest time the route can visit the stop. The values for this field are copied from the TimeWindowStart field on the input stops.

• TimeWindowEnddatetimenullable

  The latest time the route can visit the stop. The values for this field are copied from the TimeWindowEnd field on the input stops.

• ArriveCurbApproachintegernullable

  The side of the vehicle the curb is on when arriving at the stop.

• DepartCurbApproachintegernullable

  The side of the vehicle the curb is on when departing from the stop.

• ArriveTimedatetimenullable

  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.

• DepartTimedatetimenullable

  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.

• ArriveTimeUTCdatetimenullable

  The date and time value indicating the arrival time in coordinated universal time (UTC)

• DepartTimeUTCdatetimenullable

  The date and time value indicating the departure time in coordinated universal time (UTC)

• LocationTypeint enumdefault:0

  The stop type. The values for this field are copied from the LocationType field on the input stops.

• SourceIDinteger (non-negative)nullable

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

• SourceOIDinteger (non-negative)nullable

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

• PosAlongnumber (non-negative)nullable

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

• SideOfEdgeint enum

  Allowed values: 1, 2

  The side of the edge in relation to the digitized direction of the line feature.

  This attribute is limited to a domain of two values:

  • 1: Right Side
  • 2: Left Side

• CurbApproachint enumdefault:0

  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.

• Statusint enum

  Allowed values: 0, 1, 2, 3, 4, 5, 6, 7

  Indicates the status of the point with respect to its location on the network and the outcome of the analysis. The possible values are as following:

  • 0: OK.The point was located on the network.
  • 1: Not Located. The point was not located on the network and was not included in the analysis.
  • 2: Network element not located. The network element identified by the point's network location fields cannot 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 cannot 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. If time windows are used and the route arrives early or late, the value changes to 6 (Time window violation)

• SnapXnumber (non-negative)

  The x-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

• SnapYnumber (non-negative)

  The y-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

• SnapZnumber (non-negative)

  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 attribute is 0 if the network is two-dimensional.

• DistanceToNetworkInMetersnumber (non-negative)

  The distance in meters between the point's geographic location and the position where it was located on the network.

• AdditionalTimenumber (non-negative)nullable

  The amount of time added to the total route time when this stop is visited. The values for this field are copied from the AdditionalTime field on the input stops.

• AdditionalDistancenumber (non-negative)nullable

  The amount of distance added to the total route distance when this stop is visited. The values for this field are copied from the AdditionalDistance field on the input stops.

• AdditionalCostnumber (non-negative)nullable

  The cost added to the total route cost when this stop is visited. The values for this field are copied from the AdditionalCost field on the input stops. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time-based nor distance-based.

• Cumul_Minutesnumber (non-negative)nullable

  The cumulative duration of the route in minutes from the origin to and including the stop. The value reported here is the cumulative route time to the stop, including any additional time at the stop and at any previous stops.

  For example, if a route analysis determines that it takes 10 minutes to visit two stops, and the second stop has an AdditionalTime value of 5, the Cumul_Minutes value will be 15 minutes.

• Cumul_Milesnumber (non-negative)nullable

  The cumulative distance of the route in miles from the origin to and including the stop. The value reported here is the cumulative route distance to the stop, including any additional distance at the stop and at any previous stops.

• Cumul_Kilometersnumber (non-negative)nullable

  The cumulative distance of the route in kilometers from the origin to and including the stop. The value reported here is the cumulative route distance to the stop, including any additional distance at the stop and at any previous stops.

• Cumul_Costnumber (non-negative)nullable

  The cumulative cost of the route from the origin to and including the stop. The value reported here is the cumulative route cost to the stop, including any additional cost at the stop and at any previous stops. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time based nor distance based. The value is in unknown units.

• Wait_Minutesnumber (non-negative)nullable

  This field stores the time spent waiting for the time window to open when the route arrives early at the stop.

  The field has a null value if time windows are not used in the analysis.

• CumulWait_Minutesnumber (non-negative)nullable

  This field stores the sum of how much time has been spent waiting for time windows to open. It measures idle time. It includes the wait time from the current stop and all previous stops visited by the route.

  The field has a null value if time windows are not used in the analysis.

• Violation_Minutesnumber (non-negative)nullable

  This field is a measure of how late the route arrived after the time window closed. Specifically, it stores the amount of time between the end of the time window and when the route arrived at the stop.

  The field has a null value if time windows are not used in the analysis.

• CumulViolation_Minutesnumber (non-negative)nullable

  This field stores the cumulative violation time from the current stop and all previous stops visited by the route.

  The field has a null value if time windows are not used in the analysis.

• ORIG_FIDintegernullable

  The ObjectID value of the input stop. This field can be used to join attributes from the output stops to the input stops or from the input stops to the output stops.

• Bearingnumber (non-negative)nullable

  The values for this field are copied from the Bearing field on the input stops.

• BearingTolnumber (non-negative)nullable

  The values for this field are copied from the BearingTol field on the input stops.

• NavLatencynumber (non-negative)nullable

  The values for this field are copied from the NavLatency field on the input stops.

• SourceNamestring (length: 500)nullable

  The name of the edge source feature class from which the line was generated.

• SourceOIDintegernullable

  The ObjectID value of the traversed street feature. Summarizing the values for this field can provide useful information such as the number of times a particular street feature is included in all the routes.

• RouteEdgeIDintegernullable

  The ID representing the edge that comprises the street feature. Since there can be more than one edge per street feature, the SourceOID field can be used to uniquely identify the traversed street feature, and the RouteEdgeID field can be used to uniquely identify the edge within the traversed street feature.

• FromPositionintegernullable

  Specifies where the output RouteEdges feature begins in reference to the digitized direction of the underlying street feature.

  • 0 (zero) indicates that the line begins at the from point of the underlying street feature.
  • 1 indicates that the line begins at the to point of the street feature.
  • A value between 0 and 1 indicates that the line begins at a point along the underlying street feature; for example, a value of 0.25 means the line begins 25 percent along the digitized direction of the underlying street feature.

• ToPositionintegernullable

  Specifies where the output RouteEdges feature ends in reference to the digitized direction of the underlying street feature.

  • 0 indicates that the line ends at the from point of the underlying street feature.
  • 1 indicates that the line ends at the to point of the street feature.
  • A value between 0 and 1 indicates that the line ends at a point along the underlying street feature; for example, a value of 0.25 means the line ends 25 percent along the digitized direction of the underlying street feature.

• RouteIDintegernullable

  Uniquely identifies the route that traversed the edge.

  The RouteID value corresponds to an ObjectID value from the output routes.

• Attr_Minutesnumber (non-negative)nullable

  The travel time in minutes of the traversed portion of the underlying street feature.

• Attr_Milesnumber (non-negative)nullable

  The length in miles of the traversed portion of the underlying street feature.

• Attr_Kilometersnumber (non-negative)nullable

  The length in kilometers of the traversed portion of the underlying street feature.

• Attr_Othernumber (non-negative)nullable

  The travel cost of the traversed portion of the underlying street feature. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time-based nor distance-based. The value is in unknown units.

• Cumul_Minutesnumber (non-negative)nullable

  The travel time in minutes of the route from its origin to the end of the traversed portion of this underlying street feature.

• Cumul_Milesnumber (non-negative)nullable

  The length in miles of the route from its origin to the end of the traversed portion of this underlying street feature.

• Cumul_Kilometersnumber (non-negative)nullable

  The length in kilometers of the route from its origin to the end of the traversed portion of this underlying street feature.

• Cumul_Othernumber (non-negative)nullable

  The travel cost of the route from its origin to the end of the traversed portion of this underlying street feature. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time-based nor distance-based. The value is in unknown units.

• Attr_[SoftRestrictionsAttributeName]number (non-negative)nullable

  Specifies whether the traversed edge used the soft restriction attribute referred to in this field's name.

  0—The traversed edge didn't use the soft restriction. 1—The traversed edge used the soft restriction.

  For example, if the analysis was performed using the soft restriction called Avoid Toll Roads, a field called Attr_Avoid_Toll_Roads is created for this soft restriction. A value of 1 for this field would represent the toll roads in the route.

• Namestring (length: 1024)

  The name of the route 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.

• StopCountinteger

  The number of stops assigned to the route.

• StartTimedatetimenullable

  The start time of the route, reported in the time zone in which the first stop is located.

• EndTimedatetimenullable

  The end time of the route, reported in the time zone in which the last stop is located.

• StartTimeUTCdatetimenullable

  The start time of the route in coordinated universal time (UTC).

• EndTimeUTCdatetimenullable

  The end time of the route in coordinated universal time (UTC).

• FirstStopIDinteger

  The ObjectID value of the first stop on the route. This field is often used to join information from input stops to routes.

• LastStopIDinteger

  The ObjectID value of the last stop on the route. This field is often used to join information from input stops to routes.

• Total_Minutesnumber (non-negative)nullable

  The cumulative travel time in minutes from the beginning of the first stop to the end of the last stop for a route. This includes any AdditionalTime values for the visited stops if specified.

• Total_Milesnumber (non-negative)nullable

  The cumulative travel distance in miles from the beginning of the first stop to the end of the last stop for a route. This includes any AdditionalDistance values for the visited stops if specified.

• Total_Kilometersnumber (non-negative)nullable

  The cumulative travel distance in kilometers from the beginning of the first stop to the end of the last stop for a route. This includes any AdditionalDistance values for the visited stops if specified.

  Additional fields, Total_[AccumulateAttributeName]_Other, are included for each cost attribute that is neither time based nor distance based and accumulated during the analysis.

• Total_Othernumber (non-negative)nullable

  The cumulative travel cost in unknown units from the beginning of the first stop to the end of the last stop for a route. This includes any AdditionalCost values for the visited stops if specified.

  This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time based nor distance based.

• TotalWait_Minutesnumber (non-negative)nullable

  This field stores the route's overall wait time, which is the time spent at stops waiting for time windows to open.

  The field has a null value if time windows are not used in the analysis.

• TotalViolation_Minutesnumber (non-negative)nullable

  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 field values on inputs stops.

  The field has a null value if time windows are not used in the analysis.

• RouteNamestring (length: 500)nullable

  The name of the route to which the driving action applies. This value is the same as the Name field of the output routes.

• ArriveTimedatetimenullable

  The time of day to initiate the given driving action. If the route spans multiple days, the date and time of day are displayed.

• Typeintegernullable

  The type of maneuver that the directions feature represents or the type of the directions text. To determine whether Type refers to a maneuver type or a directions string type, review the SubItemType field value.

  Type can be used, for example, to assign an icon for direction text based on the maneuver type, or it can use a formatting style based on the directions string type when displaying the driving directions in the application.

  See Maneuver Types

  • 0: Unknown
  • 1: Arrive at Stop
  • 2: Go straight
  • 3: Bear left
  • 4: Bear right
  • 5: Turn left
  • 6: Turn right
  • 7: Make sharp left
  • 8: Make sharp right
  • 9: Make U-turn
  • 10: Take ferry
  • 11: Take roundabout
  • 12: Merge to highway
  • 13: Exit highway
  • 14: Go on another highway
  • 15: At fork keep center
  • 16: At fork keep left
  • 17: At fork keep right
  • 18: Depart stop
  • 19: Trip planning item
  • 20: End of ferry
  • 21: Ramp right
  • 22: Ramp left
  • 23: Turn left and immediately turn right
  • 24: Turn right and immediately turn left
  • 25: Turn right and immediately turn right
  • 26: Turn left and immediately turn left
  • 27: Pedestrian ramp
  • 28: Elevator
  • 29: Escalator
  • 30: Stairs
  • 31: Door passage
  See Directions String Types

  • 0: General directions string type
  • 1: Depart directions string type
  • 2: Arrive directions string type
  • 3: Length directions string type
  • 4: Time directions string type
  • 5: Time summary directions string type
  • 6: Time Window directions string type
  • 7: Violation Time directions string type
  • 8: Wait Time directions string type
  • 9: Service Time directions string type
  • 10: Estimated Arrival Time directions string type
  • 11: Cumulative Length directions string type
  • 12: Street name directions string type
  • 13: Alternate street name directions string type
  • 14: Sign branch information directions string type
  • 15: Sign toward information directions string type
  • 16: Cross street name directions string type
  • 17: Sign exit number directions string type

• SubItemTypeintegernullable

  Specifies whether the Type field refers to an integer from the Directions String Types table or the Maneuver Types table.

  • If the SubItemType value is 1, the Type field refers to the values from the Maneuver Types table.
  • If the SubItemType value is 2, the Type field refers to the values from the Directions String Types table.
  • If the SubItemType value is 3, the Type field refers to the values from the Directions String Types table.

• Textstring (length: 500)nullable

  A text description of the travel directions.

• ElaspsedTimeintegernullable

  The time elapsed in minutes from when the current driving direction starts until the next one starts, or until the route ends for the last driving direction.

• DriveDistanceintegernullable

  The distance from where the current driving direction occurs to where the next one occurs, or to where the route ends for the last driving direction.

  The value is in the units specified by the directions_distance_units parameter.

  This value is zero for driving directions that occur at the same location where the next one begins. For example, the DriveDistance value is 0 for the directions text at the start of the route.

• DirectionPointIDintegernullable

  The ObjectID of the feature in the output_direction_points with which this line is associated.

• RouteIDintegernullable

  The ObjectID of the output output_routes feature with which this direction line is associated.

• DirectionLineTypeintegernullable

  The type of direction situation described by this line, designated by one of the following values:

  Show values

  • Unknown (0)
  • Segment (1)
  • Maneuver Segment (2)
  • Restriction Violation (3)
  • Scaled Cost Barrier (4)
  • Heavy Traffic (5)
  • Slow Traffic (6)
  • Moderate Traffic (7)

• Metersnumber (non-negative)nullable

  The length of the line segment measured in meters.

• Minutesnumber (non-negative)nullable

  The travel time along the line segment in minutes.

• FromLevelintegernullable

  The building level at which this direction event begins. This value corresponds to the Level property defined in the network dataset used for the analysis.

• ToLevelintegernullable

  The building level at which this direction event ends. This value corresponds to the Level property defined in the network dataset used for the analysis.

• RouteIDintegernullable

  The ObjectID of the output output_routes feature with which this direction point is associated.

• Sequenceintegernullable

  The sequence of the direction points for the route, starting with 1.

• DirectionPointTypeintegernullable

  The type of direction event or maneuver described by the point, designated by one of the values below:

  Show values

  • Header (1)
  • Arrive (50)
  • Depart (51)
  • Straight (52)
  • On Ferry (100)
  • Off Ferry (101)
  • Central Fork (102)
  • Roundabout (103)
  • U-Turn (104)
  • Door (150)
  • Stairs (151)
  • Elevator (152)
  • Escalator (153)
  • Pedestrian Ramp (154)
  • Left Fork (200)
  • Left Ramp (201)
  • Clockwise Roundabout (202)
  • Left-handed U-turn (203)
  • Bear left (204)
  • Left Turn (205)
  • Sharp Left (206)
  • Left Turn and immediate Left Turn (207)
  • Left Turn and immediate Right Turn (208)
  • Right Fork (300)
  • Right Ramp (301)
  • Counter-Clockwise Roundabout (302)
  • Right-handed U-turn (303)
  • Bear right (304)
  • Right Turn (305)
  • Sharp Right (306)
  • Right Turn and immediate Left Turn (307)
  • Right Turn and immediate Right Turn (308)
  • Up Elevator (400)
  • Up Escalator (401)
  • Up Stairs (402)
  • Down Elevator (500)
  • Down Escalator (501)
  • Down stairs (502)
  • General Event (1000)
  • Landmark (1001)
  • Time Zone Change (1002)
  • Traffic Event (1003)
  • Scaled Cost Barrier Event (1004)
  • Boundary Crossing (1005)
  • Restriction Violation (1006)
  • Lane (1007)

• StopIDintegernullable

  The ObjectID of the stop with which this direction point is associated, if any. If the point does not represent a visit to a stop, the value is null.

• DisplayTextstring (length: 1024)nullable

  The directions text to display in the consuming application.

• ArrivalTimedatetimenullable

  The time the direction event occurs in coordinated universal time (UTC).

• ArrivalUTCOffsetnumber (non-negative)nullable

  The difference in minutes between the local time at the maneuver location and UTC time shown in the ArrivalTime field.

• Namestring (length: 1024)nullable

  The name of the direction point.

• ExitNamestringnullable

  The highway exit name that appears in the directions instruction.

• AlternateNamestringnullable

  The alternate source name that appears in the directions instruction.

• IntersectingNamestringnullable

  The name of the intersecting or cross street that appears in the directions instruction.

• BranchNamestringnullable

  The signpost branch name that appears in the directions instruction.

• TowardNamestringnullable

  The signpost toward destination name that appears in the directions instruction.

• Levelintegernullable

  The building level at which this direction event occurs. This value corresponds to the Level property defined in the network dataset used for the analysis.

• ShortVoiceInstructionstring (length: 1024)nullable

  The short text to use as voice guidance text in the consuming application.

• VoiceInstructionstring (length: 1024)nullable

  The additional text, including expanded abbreviations and plurals, to use as voice guidance text in the consuming application.

• Azimuthnumber (non-negative)nullable

  The bearing in degrees of the vehicle departing this point. Zero indicates north.