Output from FindRoutes

Upon successful execution, the service returns the best routes between the stops and the status indicating if the analysis was successful using the following output parameters:

output_routes

Use this parameter to access the resulting route or routes between the stops.

The following provides a description of fields that are returned for each route:

Field name	Description
OID	A unique identifier for the route. This identifier is automatically generated by the service.
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 stop.
StopCount	The number of stops assigned to the route.
Total_Minutes	The cumulative travel time in minutes of the route between the stops.
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.
Total_Kilometers	The cumulative travel distance in kilometers of the route between the stops.
Total_Miles	The cumulative travel distance in miles of the route between the stops.
Shape_Length	The length of the route in the units of the spatial reference specified for the route geometry. By default, the length is reported in decimal degrees if the env:outSR parameter is not specified.

Note:

An additional field with the name Total_[MeasurementUnits] is included if the measurement_units parameter is not equal to Miles, Kilometers, or Minutes. For example, if the measurement_units parameter is specified as Meters, the output_routes parameter will include Total_Meters, Total_Miles, Total_Kilometers, and Total_Minutes fields.

output_directions

Use this parameter to access the turn-by-turn driving directions for each resulting route between the stops. The parameter includes the driving directions as well as the geometry for the directions feature corresponding to the text. The shape for the directions feature is determined from the underlying streets included in the route. The feature geometries are returned in the spatial reference specified as the env:outSR parameter. The features are empty if the populate_directions parameter is false. The directions_language, directions_distance_units, and directions_style_name parameters highly influence the driving directions.

The following provides a description of fields that are returned for directions features:

Field name	Description
ObjectID	A unique identifier for the directions feature. This identifier is automatically generated by the service.
RouteName	The name of the route to which the driving action applies. This value is the same as the Name attribute from the output_routes parameter.
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	Indicates 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, you need to check the value of the SubItemType field. Type can be used, for example, to assign a different icon for a direction text based on the maneuver type, or use a special 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 table listed below. Maneuver Types Value Description 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 Directions String Types Value Description 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
SubItemType	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 refers to the values from the Maneuver Types table. If the SubItemType value is 2, the Type refers to the values from the Directions String Types table.
Text	A text description of the driving 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 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.
Shape_Length	The length of the directions feature in the units of the spatial reference specified for the routes. By default, the length is reported in decimal degrees if the env:outSR parameter is not specified.

output_stops

Use this parameter to access the attributes of the stop or stops visited by the route as well as stops that could not be reached by any of the routes. For those that could be reached, the attribute table lists the route name assigned to the stops, the stop sequence, arrival time, and other information. For those that couldn't be reached, the attribute table provides information on the source of the problem.

The following provides a description of attributes that are returned for each stop:

Field name	Description
OID	A unique identifier for the stop. This identifier is automatically generated by the service.
Name	The name of the stop visited by the route.
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 that the route can visit the stop. The values for this field are copied from the TimeWindowStart field on input stops.
TimeWindowEnd	The latest time that the route can visit the stop. The values for this field are copied from the TimeWindowEnd field on input stops.
ArriveCurbApproach	Indicates which side of the vehicle the curb is on when arriving at the stop.
DepartCurbApproach	Indicates which side of the vehicle the curb is on when departing from the stop.
LocationType	Indicates the stop type. The values for this field are copied from the LocationType field on input stops.
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 input stops.
Status	Indicates how the stop was evaluated in the analysis. The field can be used to determine which stops were not assigned to any routes. The possible values are the following: 0 (OK)—The stop was successfully located on the transportation network and analyzed. 1 (Not Located)—A traversable road wasn't within 12.42 miles (20 kilometers) of the stop and therefore was excluded from the analysis. 4 (Not Reached)—The stop couldn't be reached due to constraints; for example, a curb approach is set so that a vehicle must travel in the wrong direction on a one-way street to reach the stop. 6 (Time window violation)—Time windows on the route cannot be reached on time; the route arrives early or late.
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 input stops. This field in included only if the value for the Measurement Units parameter is time based.
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 input stops. This field in included only if the value for the Measurement Units parameter is 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.
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.
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_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 with the name Cumul_[MeasurementUnits] is included if the measurement_units parameter is not equal to Miles, Kilometers, or Minutes. For example, if the measurement_units parameter is specified as Meters, the output_stops parameter will include Cumul_Meters, Cumul_Miles, Cumul_Kilometers, and Cumul_Minutes fields.

output_route_edges

Use this parameter to access the individual road segments that the routes travel along.

The following provides a description of attributes that are returned for each route edge:

Field name	Description
OID	A unique identifier for the route edge. This identifier is automatically generated by the service.
Shape	The geometry field indicating the shape of the lines.
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 makes up 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. A value of 0 (zero) indicates the line begins at the from-point of the underlying street feature. A value of 1 indicates the line begins at the to-point of the street feature. A value between 0 and 1 indicates 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.
ToPosition	Specifies where the output RouteEdges feature ends in reference to the digitized direction of the underlying street feature. A value of 0 (zero) indicates the line ends at the from-point of the underlying street feature. A value of 1 indicates the line ends at the to-point of the street feature. A value between 0 and 1 indicates 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.
RouteID	Uniquely identifies the route that traversed the edge. The RouteID value corresponds to an ObjectID value from the output_routes feature class.
Attr_Minutes	The travel time in minutes of the traversed portion of the underlying street feature.
Attr_Miles	The length in miles of the traversed portion of the underlying street feature.
Attr_Kilometers	The length in kilometers of the traversed portion of the underlying street feature.
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.
Cumul_Miles	The length in miles of the route from its origin to the end of the traversed portion of this underlying street feature.
Cumul_Kilometers	The length in kilometers of the route from its origin to the end of the traversed portion of this underlying street feature.
Attr_[Soft Restriction Attribute Name]	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.
Shape_Length	The length of the route edge in the units of the spatial reference specified for the route geometry.

solve_succeeded

Use this parameter to determine if the service was able to find the routes successfully. The error messages for the failure can be obtained by making a request to get the status of the job.