Upon successful execution of FindRoutes, the service returns the best routes between the stops, and the status indicating whether the analysis was successful, using the output parameters described below.
output_routes
This provides access to the resulting routes.
The following table lists the fields returned for output routes:
| Field | Description |
|---|---|
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. |
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). |
Total_Minutes | 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 for the visited stops if specified. Note:An additional field, Total_[TimeUnits], is included if measurement_units is time based and its value is not set to Minutes. The field values are in the units specified by the measurement_units parameter. Note:Additional fields, Total_[AccumulateAttributeName]_[TimeUnits], are included for each time-based cost attribute that is accumulated during the analysis. |
Total_Miles | 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 for the visited stops if specified. Note:An additional field, Total_[DistanceUnits], is included if the measurement_units parameter is distance based and its value is not Miles or Kilometers. The field values are in the units specified by the measurement_units parameter. Note:Additional fields, Total_[AccumulateAttributeName]_[DistanceUnits], are included for each distance-based cost attribute that is accumulated during the analysis. |
Total_Kilometers | 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 for the visited stops if specified. |
Total_Other | 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 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. Note:Additional fields, Total_[AccumulateAttributeName]_Other, are included for each cost attribute that is neither time based nor distance based and accumulated during the analysis. |
TotalWait_Minutes | 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. Note:An additional field, TotalWait_[TimeUnits], is included if the measurement_units parameter is not set to Minutes. The field values are in the units specified by the measurement_units parameter. Note:Additional fields, TotalWait_[AccumulateAttributeName]_[TimeUnits], are included for each time-based cost attribute that is accumulated during the analysis. |
TotalViolation_Minutes | 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. The field has a null value if time windows are not used in the analysis. Note:An additional field, TotalViolation_[TimeUnits], is included if the timeUnits property of the analysis object is not set to TimeUnits.Minutes. The field values are in the units specified by the timeUnits property. Additional fields, TotalViolation_[AccumulateAttributeName]_[TimeUnits], are included for each time-based cost attribute that is accumulated during the analysis. |
FirstStopOID | The ObjectID value of the first stop on the route. This field is often used to join information from input stops to routes. |
LastStopOID | The ObjectID value of the last stop on the route. This field is often used to join information from input stops to routes. |
output_directions
This provides access to the turn-by-turn directions for each resulting route.
The shape for the directions feature is determined from the underlying streets included in the route.
The Directions Language, Directions Distance Units, and Directions Style Name parameters influence the travel directions. The parameter returns empty features if the Populate Directions parameter is False.
The following table lists the fields that are returned for output directions:
| Field | Description |
|---|---|
RouteName | The name of the route to which the driving action applies. This value is the same as the Name field of the output routes. |
ArriveTime | The time of day to initiate the given driving action. If the route spans multiple days, the date and time of day are displayed. |
Type | 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, check the value of the SubItemType field. 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 your application. The Type value is an integer from the Maneuver Types or Directions String Types lists below. Maneuver Types
Directions String Types
|
SubItemType | Specifies whether the Type field refers to an integer from the Directions String Types table or the Maneuver Types table.
|
Text | A text description of the travel directions. |
ElaspsedTime | 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. |
DriveDistance | 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 is 0 for the directions text at the start of the route. |
output_direction_points
Specifies the output turn-by-turn directions for the routes calculated in the analysis, represented as point locations along the routes where specific directions events or maneuvers occur.
| Field name | Description |
|---|---|
RouteID | The ObjectID of the output output_routes feature with which this direction point is associated. |
Sequence | The sequence of the direction points for the route, starting with 1. |
DirectionPointType | The type of directions event or maneuver described by the point, designated by one of the values below.
|
StopID | 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. |
DisplayText | The directions text to display in the consuming application. |
ArrivalTime | The time when the directions event happens in coordinated universal time (UTC). |
ArrivalUTCOffset | The difference in minutes between the local time at the maneuver location and UTC time shown in the ArrivalTime field, in minutes. |
Name | The name of the directions point. |
ExitName | The highway exit name that appears in the directions instruction. |
AlternateName | Alternate source name that appears in the directions instruction. |
IntersectingName | The name of the intersecting or cross street that appears in the directions instruction. |
BranchName | The signpost branch name that appears in the directions instruction. |
TowardName | The signpost toward destination name that appears in the directions instruction. |
Level | The building level at which this directions event occurs. This value corresponds to the Level property defined in the network dataset used for the analysis. Learn more about the directions configuration of a network dataset |
ShortVoiceInstruction | Short text to use as voice guidance text in the consuming application. |
VoiceInstruction | Fill text, including expanded abbreviations and plurals, to use as voice guidance text in the consuming application. |
Azimuth | The bearing in degrees of the vehicle departing this point. Zero indicates north. |
output_direction_lines
Specifies the output route lines calculated in the analysis sliced to represent each route segment between DirectionPoints event or maneuver locations.
| Field name | Description |
|---|---|
DirectionPointID | The ObjectID of the feature in the output_direction_points table with which this line is associated. |
RouteID | The ObjectID of the output output_routes feature with which this direction line is associated. |
DirectionLineType | The type of directions situation described by this line, designated by one of the values below.
|
Meters | The length of the line segment measured in meters. |
Minutes | The travel time along the line segment in minutes. |
FromLevel | The building level at which this directions event begins. This value corresponds to the Level property defined in the network dataset used for the analysis. Learn more about the directions configuration of a network dataset |
ToLevel | The building level at which this directions event ends. This value corresponds to the Level property defined in the network dataset used for the analysis. |
output_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.
The following table list the fields returned for output stops. In addition to these fields, the parameter also includes all the fields from the input feature class used as stops for the analysis.
Field | Description |
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 at the stop. The time zone for this time-of-day value is taken from the network element on which the stop is located. |
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:
|
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. |
AdditionalTime | 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. |
AdditionalDistance | 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. |
AdditionalCost | 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_Minutes | 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. Note:An additional field, Cumul_[TimeUnits], is included if the measurement_units parameter is time based and its value is not set to Minutes. The field values are in the units specified by the measurement_units parameter. Note:Additional fields, Cumul_[AccumulateAttributeName]_[TimeUnits], are included for each time-based cost attribute that is accumulated during the analysis. |
Cumul_Miles | 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. Note:An additional field, Cumul_[DistanceUnits], is included if the measurement_units parameter is distance based and its value is not Miles or Kilometers. The field values are in the units specified by the measurement_units parameter. Note:Additional fields, Cumul_[AccumulateAttributeName]_[DistanceUnits], are included for each distance-based cost attribute that is accumulated during the analysis. |
Cumul_Kilometers | 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_Cost | 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. Note:Additional fields, Cumul_[AccumulateAttributeName]_Other, are included for each cost attribute that is neither time based nor distance based and accumulated during the analysis. |
Wait_Minutes | 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. Note:An additional field, Wait_[TimeUnits], is included if the measurement_units parameter is time based and its value is not set to Minutes. The field values are in the units specified by the measurement_units parameter. Note:Additional fields, Wait_[AccumulateAttributeName]_[TimeUnits], are included for each time-based cost attribute that is accumulated during the analysis. |
CumulWait_Minutes | 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. Note:An additional field, CumulWait_[TimeUnits], is included if the measurement_units parameter is time based and its value is not set to Minutes. The field values are in the units specified by the measurement_units parameter. Note:Additional fields, CumulWait_[AccumulateAttributeName]_[TimeUnits], are included for each time-based cost attribute that is accumulated during the analysis. |
Violation_Minutes | 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. Note:An additional field, Violation_[TimeUnits], is included if the measurement_units parameter is time based and its value is not set to Minutes. The field values are in the units specified by the measurement_units parameter. Additional fields Violation_[AccumulateAttributeName]_[TimeUnits] are included for each time-based cost attribute that is accumulated during the analysis. |
CumulViolation_Minutes | 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. Note:An additional field, CumulViolation_[TimeUnits], is included if the measurement_units parameter is time based and its value is not set to Minutes. The field values are in the units specified by the measurement_units parameter. Note:An additional field CumulViolation_[TimeUnits] is included if the timeUnits property of the analysis object is not set to TimeUnits.Minutes. The field values are in the units specified by the timeUnits property. Additional fields CumulViolation_[AccumulateAttributeName]_[TimeUnits] are included for each time-based cost attribute that is accumulated during the analysis. |
ORIG_FID | The ObjectID 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. |
Bearing | The values for this field are copied from the Bearing field on the input stops. |
BearingTol | The values for this field are copied from the BearingTol field on the input stops. |
NavLatency | The values for this field are copied from the NavLatency field on the input stops. |
output_route_edges
This provides access to the individual network edges along which the routes travel.
This parameter has value only when the populate_route_edges parameter is set to True.
The following table lists the fields supported by the output route edges:
| Field | Description |
|---|---|
SourceName | The name of the edge source feature class from which the line was generated. |
SourceOID | The ObjectID 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. |
RouteEdgeID | 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. |
FromPosition | Specifies where the output RouteEdges feature begins in reference to the digitized direction of the underlying street feature.
|
ToPosition | Specifies where the output RouteEdges feature ends in reference to the digitized direction of the underlying street feature.
|
RouteID | Uniquely identifies the route that traversed the edge. The RouteID value corresponds to an ObjectID value from the output routes. |
Attr_Minutes | The travel time in minutes of the traversed portion of the underlying street feature. Note:An additional field, Attr_[TimeUnits], is included if the measurement_units parameter is time based and its value is not set to Minutes. The field values are in the units specified by the measurement_units parameter. |
Attr_Miles | The length in miles of the traversed portion of the underlying street feature. Note:An additional field, Attr_[DistanceUnits], is included if the measurement_units parameter is distance based and its value is not Miles or Kilometers. The field values are in the units specified by the measurement_units parameter. |
Attr_Kilometers | The length in kilometers of the traversed portion of the underlying street feature. |
Attr_Other | 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. Note:Additional fields, Attr_[AccumulateAttributeName], are included for each cost attribute that is neither time based nor distance based and accumulated during the analysis. |
Cumul_Minutes | The travel time in minutes of the route from its origin to the end of the traversed portion of this underlying street feature. Note:An additional field, Cumul_[TimeUnits], is included if the measurement_units parameter is time based and its value is not set to Minutes. The field values are in the units specified by the measurement_units parameter. Note:Additional fields, Cumul_[AccumulateAttributeName], are included for each time-based cost attribute that is accumulated during the analysis. The values are in the time units used for the analysis. |
Cumul_Miles | The length in miles of the route from its origin to the end of the traversed portion of this underlying street feature. Note:An additional field, Cumul_[DistanceUnits], is included if the measurement_units parameter is distance based and its value is not Miles or Kilometers. The field values are in the units specified by the measurement_units parameter. Note:Additional fields, Cumul_[AccumulateAttributeName], are included for each distance-based cost attribute that is accumulated during the analysis. The values are in the distance units used for the analysis. |
Cumul_Kilometers | The length in kilometers of the route from its origin to the end of the traversed portion of this underlying street feature. |
Cumul_Other | 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. Note:Additional fields, Cumul_[AccumulateAttributeName], are included for each cost attribute that is neither time based nor distance based and accumulated during the analysis. |
Attr_[Soft Restriction Attribute Name] | Specifies whether the traversed edge used the soft restriction attribute referred to in this field's name.
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. |
solve_succeeded
Use this parameter to determine if the analysis was successful.
output_result_file
Use this parameter to access the results from the analysis as a .zip file containing one or more files for each output. The format of the individual file is specified by the Output Format parameter. The parameter value is not populated when the Output Format parameter is set to Feature Set.
When a file-based output format—such as JSON File or GeoJSON File—is specified, no outputs are added to the display, since the application (such as ArcMap or ArcGIS Pro) does not draw the contents of the result file. Instead, the result file is downloaded to a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the Output Result File parameter value in the entry corresponding to the tool execution in the geoprocessing history of your project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu on the Output Result File parameter in the entry corresponding to the tool execution in the Geoprocessing Results window.
output_route_data
Use this parameter to access a .zip file that contains a file geodatabase containing the inputs and outputs of the analysis in a format that can be used to share route layers with ArcGIS Online or Portal for ArcGIS. The parameter value is populated only when the Save Route Data parameter is set to True.
The file is downloaded to a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the Output Route Data parameter value in the entry corresponding to the tool execution in the geoprocessing history of your project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu on the Output Route Data parameter in the entry corresponding to the tool execution in the Geoprocessing Results window.
output_network_analysis_layer
Use this parameter to access the network analysis layer file that stores the analysis settings and the inputs and outputs used for the analysis. The parameter value is populated only when the Save Output Network Analysis Layer parameter is set to True.
The file is downloaded to a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the Output Network Analysis Layer parameter value in the entry corresponding to the tool execution in the geoprocessing history of your project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu on the Output Network Analysis Layer parameter in the entry corresponding to the tool execution in the Geoprocessing Results window.
Note:
You cannot work directly with this file even when you open the file in an ArcGIS Desktop application such as ArcMap since its data source will not be valid. The file is meant to be sent to Esri Technical Support to diagnose the quality of results returned from the tool.