Upon successful execution, the service returns the best route and travel directions between the incident and the chosen facility and the status indicating if the analysis was successful using the following output parameters:
output_facilities and output_closest_facilities
Provides access to the output facilities from a closest facility analysis.
output_closest_facilities parameter includes only those facilities from the set of input facilities that were closest to at least one incident. On the other hand, output_facilities data type includes all the facilities from the analysis including the facilities that cannot be reached from any of the incidents. You can use the Status field from the output_facilities data type, to determine why a facility was not used in the analysis.
The following table lists the fields that are returned for output facilities:
Field | Description |
---|---|
Name | The name of the facility. The values for this field are copied from the Name field on input facilities. |
SourceID | The numeric identifier of the source feature class containing the source feature that the network location is located on. |
SourceOID | The numeric identifier of the source feature in the source feature class. |
PosAlong | The position along the digitized direction of the source line feature. This value is stored as a ratio. For example a value of 0.47 indicates that the point is positioned 47 percent from the start of the source line feature. |
SideOfEdge | The side of the edge in relation to the digitized direction of the line feature. The field can have two possible values. A value of 1 indicates the point is on the right side of the line feature and a value of 0 indicates the point is on the left side of the line feature. |
CurbApproach | The direction a vehicle may arrive at and depart from the facility. The values for this field are copied from the CurbApproach field on input facilities. |
Status | Indicates how the facility was evaluated in the analysis. The possible values are the following:
|
SnapX | The x-coordinate value for the computed network location. |
SnapY | The y-coordinate value for the computed network location. |
SnapZ | The z-coordinate value for the computed network location. The field has a non-zero value only when the input network dataset supports connectivity based on z-coordinate values of the network sources. |
DistanceToNetworkInMeters | The distance, in meters, between the location of the point feature and its computed network location. |
AdditionalTime | The amount of time added to the total route time when this facility is visited. The values for this field are copied from the AdditionalTime field on input facilities. |
AdditionalDistance | The amount of distance added to the total route distance when this facility is visited. The values for this field are copied from the AdditionalDistance field on input facilities. |
AdditionalCost | The cost added to the total route cost when this facility is visited. The values for this field are copied from the AdditionalCost field on input facilities. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time-based or distance-based. |
Cutoff | The impedance value at which the analysis stopped searching for the facilities from a given incident. The values for this field are copied from the Cutoff field on the input facilities. |
ID | A unique identifier for the facility. The values for this field are copied from the ID field on input facilities. |
ORIG_FID FacilityOID | The ObjectID value of the input facility. This field is often used to join information from the input facilities. OutputFacilities data type include the ORIG_FID field and Facilities data type include the FacilityOID field. |
Bearing | The values for this field are copied from the Bearing field on the input facilities. |
BearingTol | The values for this field are copied from the BearingTol field on the input facilities. |
NavLatency | The values for this field are copied from the NavLatency field on the input facilities. |
output_routes
Provides access to the resulting route or routes between the facilities and the incidents.
The route_shape and route_line_simplification_tolerance parameters influence the shape of the output routes.
The following table lists the fields that are returned for output routes:
Field | Description |
---|---|
Name | The name of the closest facility route is based on the names of the associated facility and incident. The facility name is first if the value for the travel_direction parameter is set to Facility to Incident. For example, Facility 5 - Incident 3 indicates the route travels from Facility 5 to Incident 3. If Incident to Facility is specified as the value for the travel_direction parameter, the incident name is first; for instance, Incident 3 — Facility 5. |
FacilityRank | The rank of the facility among all facilities found for the associated incident; the closest facility has a rank of 1. |
FacilityID | The unique ID of the facility the route visits. The values for this field are copied from the ID field on input facilities. |
FacilityOID | The ObjectID value of the input facility used to generate the route. This field is often used to join information from facilities to routes. |
IncidentID | The unique ID of the incident the route visits. The values for this field are copied from the ID field on input incidents . |
IncidentOID | The ObjectID value of the input incident used to generate the route. This field is often used to join information from incidents to routes. |
FacilityCurbApproach | Describes the side of the vehicle the facility is on when arriving at or departing from the facility. A value of 1 means the right side of vehicle; 2 indicates the left side. |
IncidentCurbApproach | Describes the side of the vehicle the incident is on when arriving at or departing from the incident. A value of 1 means the right side of the vehicle; a value of 2 indicates the left side. |
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 of the route between the facility and the incident. This includes any AdditionalTime if specified for the visited facility and incident. |
Total_Miles | The cumulative travel distance in miles of the route between the facility and the incident. This includes any AdditionalDistance if specified for the visited facility and incident. |
Total_Kilometers | This is field is similar to Total_Miles field except the field values are in kilometers. |
Total_Other | The cumulative travel cost in unknown units of the route between the facility and the incident. This includes any AdditionalCost if specified for the visited facility and incident. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time-based or distance-based. |
output_incidents
Provides access to the locations used as starting or ending points in a closest facility analysis.
The following table lists the fields that are returned for output incidents:
Field | Description |
---|---|
Name | The name of the incident. The values for this field are copied from the Name field on input incidents. |
TargetFacilityCount | The number of facilities that need to be found for the given incident. The values for this field are copied from the TargetFacilityCount field on input incidents. |
SourceID | The numeric identifier of the source feature class containing the source feature that the network location is located on. |
SourceOID | The numeric identifier of the source feature in the source feature class. |
PosAlong | The position along the digitized direction of the source line feature. This value is stored as a ratio. For example a value of 0.47 indicates that the point is positioned 47 percent from the start of the source line feature. |
SideOfEdge | The side of the edge in relation to the digitized direction of the line feature. The field can have two possible values. A value of 1 indicates the point is on the right side of the line feature and a value of 0 indicates the point is on the left side of the line feature. |
CurbApproach | The direction a vehicle may arrive at and depart from the incident. The values for this field are copied from the CurbApproach field on input incidents. |
Status | Indicates how the incident was evaluated in the analysis. The possible values are the following:
|
SnapX | The x-coordinate value for the computed network location. |
SnapY | The y-coordinate value for the computed network location. |
SnapZ | The z-coordinate value for the computed network location. The field has a non-zero value only when the input network dataset supports connectivity based on z-coordinate values of the network sources. |
DistanceToNetworkInMeters | The distance, in meters, between the location of the point feature and its computed network location. |
AdditonalTime | The amount of time added to the total route time when this incident is visited. The values for this field are copied from the AdditionalTime field on input incident. |
AdditionalDistance | The amount of distance added to the total route distance when this incident is visited. The values for this field are copied from the AdditionalDistance field on input incidents. |
AdditionalCost | The cost added to the total route cost when this incident is visited. The values for this field are copied from the AdditionalCost field on input incidents. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time-based or distance-based. |
Cutoff | The impedance value at which the analysis stopped searching for the incidents from a given facility. The values for this field are copied from the Cutoff field on the input incidents. |
IncidentOID | The ObjectID value of the input incident. This field is often used to join information from the input facilities. |
Bearing | The values for this field are copied from the Bearing field on the input facilities. |
BearingTol | The values for this field are copied from the BearingTol field on the input facilities. |
NavLatency | The values for this field are copied from the NavLatency field on the input facilities. |
output_directions
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, you need to check the value of the SubItemType field. Type can be used, for example, to assign an icon for a 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 table listed 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. |
solve_succeeded
Use this parameter to determine if the analysis was successful.
output_route_data
Use this parameter to access a zip file that contains a file geodatabase holding 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 in a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the value for the Output Route Data parameter 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_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 applications like ArcMap or ArcGIS Pro do not know how to draw the contents of the result file. Instead, the result file is downloaded in a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the value for the Output Result File parameter 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_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 in a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the value for the Output Network Analysis Layer parameter 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.