Closest Facility service with asynchronous execution

Finding the closest hospital to an accident, the closest police cars to a crime scene, and the closest store to a customer's address are all examples of problems that can be solved using the closest facility service. When finding the closest facilities, you can specify how many to find and whether the direction of travel is toward or away from them. Once you've found the closest facilities, you can display the best route to or from them and include the travel time, travel distance, and driving directions to each facility. The service can use current traffic conditions when determining the best routes. Additionally, you can specify an impedance cutoff beyond which the service should not search for a facility. For instance, you can set up a closest facility service to search for hospitals within 15 minutes' drive time of the site of an accident. Any hospitals that take longer than 15 minutes to reach will not be included in the results. The hospitals are referred to as facilities, and the accident is referred to as an incident. The service allows you to perform multiple closest facility analyses simultaneously. This means you can have multiple incidents and find the closest facility or facilities to each incident.

Request URL

The Closest Facility service supports synchronous and asynchronous execution modes. Asynchronous and synchronous modes define how the application interacts with the service and gets the results.

While the service supports the same general functionality in both execution modes, the choice of the execution mode depends on the type of request your application has to make as well the size of problem you need to solve using the service. In synchronous mode, the service limits the maximum number of facilities to 100, the maximum number of incidents to 100, and the maximum number of facilities to find from each incident to 10. In asynchronous mode, the service limits the maximum number of facilities to 1,000, the maximum number of incidents to 1,000, and the maximum number of facilities to find from each incident to 100. So, for example, if your application needs to support adding more than 100 facilities in a request, you need to use the asynchronous execution mode. However, if you are finding the closest facilities from a total of 100 or fewer, you can use the synchronous execution mode.

The request URL and the parameter names supported by the service when using synchronous execution are different and described in the Closest Facility Service with Synchronous Execution page.

CautionCaution:

The maximum time an application can use the closest facility service when using the asynchronous execution mode is 1 hour (3,600 seconds). If your request does not complete within this time limit, it will time out and return a failure.

When using the asynchronous execution mode, the request is of the following form:

http://logistics.arcgis.com/arcgis/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities/submitJob?parameters

Dive-inDive-in:

The service works in all of the supported countries as listed in the data coverage page. One or more countries are grouped together to form an analysis region. The service can determine the best region to use based on the location of the inputs; otherwise you can use a parameter to specify a region. The service does not support requests that span more than one region. Consequently, the service will only generate results for inputs that fall within one region.

Request parameters

The closest facility request takes the following parameters. You need to always include values for the required parameters in your requrests. The optional parameters have default values that are used when not specified in the request.

Required parameters

incidents

Use this parameter to specify one or more locations from which the service searches for the nearby locations. These locations are referred to as incidents.

CautionCaution:

The service imposes a maximum limit of 1,000 points that can be passed as incidents. If the value is exceeded, the response returns an error message.

The incidents parameter can be specified using a JSON structure that represents a set of features. The JSON structure can include the following properties:

  • url: Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set. This property is optional. However, either features or url must be specified.
  • spatialReference: Specifies the spatial reference for the geometries of incidents. This property is not required if the coordinate values are in the default spatial reference, WGS84. If the coordinate values are in a different spatial reference, you need to specify the well-known ID (WKID) for the spatial reference. You can find the WKID for your spatial reference depending on whether the coordinates are represented in a geographic coordinate system or a projected coordinate system.
  • features: Specify an array of features. This property is optional. However, either the features or url property must be specified.

Each feature in the features array represents an incident and contains the following properties:

  • geometry: Specifies the incident's geometry as a point containing x and y properties.
  • attributes: Specify each attribute as a key-value pair where the key is the name of a given field, and the value is the attribute value for the corresponding field.

Attributes for incidents

When specifying the incidents, you can specify additional properties for incidents, such as their names or service times, using attributes. The incidents parameter can be specified with the following attributes:

  • Name: The name of the incident. 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 routes and directions.
  • ID: A unique identifier for the incident. The identifier is included in the output routes and can be used to join addtional information from the output routes such as the total travel time or total distance with attributes from your incidents. If the ID is not specified, the service auto-generates a unique identifier for each incident.
  • AdditionalTime: Specifies the amount of time that will added to the total travel time of the route between the incident and the closest facility. The attribute value can be used to model the time spent at the incident. For example, if you are finding the three closest fire stations from a fire incident, the attribute can store the amount of time spent at the fire incident. This could be the time it takes for firefighters to hook up their equipment and begin fighting the fire.

    The unit for this attribute value is specified by the measurement_units parameter. The attribute value is used only if the measurement units are time based. The default value is 0.

  • AdditionalDistance: Specifies the distance that will added to the total distance of the route between the incident and the closest facility. Generally the locations of the incidents are not exactly on the streets but are set back somewhat from the road. This attribute value can be used to model the distance between the actual incident location and its location on the street if it is important to include that distance in the total travel distance.

    The unit for this attribute value is specified by the measurement_units parameter. The attribute value is used only if the measurement units are distance based. The default value is 0.

  • CurbApproach: Specifies the direction a vehicle may arrive at and depart from the incident. One of the integers listed in Coded value column in the following table must be specified as a value of this attribute. The values in the Setting column are the descriptive names for CurbApproach attribute values that you may have seen when using ArcGIS Network Analyst extension software.

    Setting

    Coded value

    Description

    Either side of vehicle

    0

    The vehicle can approach or depart the incident in either direction.

    Right side of vehicle
    Approaching the incident so that it is on the right side of the vehicle is allowed.
    Left side of vehicle
    Approaching the incident so that it is on the left side of the vehicle is allowed.

    Right side of vehicle

    1

    When the vehicle approaches or departs the incident, the incident must be on the right side of the vehicle. This is typically used for vehicles like buses that must arrive with the bus stop on the right hand side.

    Right side of vehicle
    Approaching the incident so that it is on the right side of the vehicle is allowed.

    Left side of vehicle

    2

    When the vehicle approaches or departs the incident, the incident must be on the left side of the vehicle. This is typically used for vehicles like buses that must arrive with the bus stop on the left hand side.

    Left side of vehicle
    Approaching the incident so that it is on the right side of the vehicle is allowed.

    The CurbApproach property was designed to work with both kinds 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, you would choose Right side of vehicle (1) in the United States but Left side of vehicle (2) in the United Kingdom.

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

Syntax for specifying incidents using a JSON structure for features
{
    "spatialReference": {
        "wkid": <wkid>,
        "latestWkid": <wkid>, 
    },
    "features": [
        {
            "geometry": {
                "x": <x1>,
                "y": <y1>,
            },
            "attributes": {
                "<field1>": <value11>,
                "<field2>": <value12>
            }
        },
        {
            "geometry": {
                "x": <x2>,
                "y": <y2>,
            },
            "attributes": {
                "<field1>": <value21>,
                "<field2>": <value22>
            }
        }
    ], 
}
Syntax for specifying incidents using a URL returning a JSON response
{
    "url": "<url>"
}
Example 1: Specifying incidents in the default spatial reference, WGS84, using a JSON structure.

The incident geometries are in the default spatial reference, WGS84. Hence, the spatialReference property is not specified. The example also shows how to specify some attributes for the incidents.

{
    "features": [
        {
            "geometry": {
                "y": 51.5254,
                "x": -0.1891
            },
            "attributes": {
                "Name": "Incident 1",
                "ID": "C100045", 
                "AdditionalTime": 5,
                "CurbApproach": 0
            }
        },
        {
            "geometry": {
                "y": 51.5353,
                "x": -0.1744
            },
            "attributes": {
                "Name": "Incident 2",
                "ID": "F100086",
                "AdditionalTime": 10,
                "CurbApproach": 0
            }
        }
    ]
}
Example 2: Specifying incidents in the Web Mercator spatial reference using a JSON structure.

The incident geometries are in the Web Mercator spatial reference and not in the default WGS84 spatial reference. Hence, the spatialReference property is required.

{
    "spatialReference": {
        "wkid": 102100
    },
    "features": [
        {
            "geometry": {
                "y": -5192521.476,
                "x": -2698533.989
            },
            "attributes": {
                "Name": "123 Main St", 
                "ID": "200156",
                "AdditionalDistance": 300
            }
        },
        {
            "geometry": {
                "y": -5191915.261,
                "x": -2697821.094
            },
            "attributes": {
                "Name": "845 Cypress Ave",
                "ID": "300242",
                "AdditionalDistance": 250
            }
        }
    ]
}
Example 3: Specifying incidents using a URL.

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

{
    "url": "http://sampleserver6.arcgisonline.com/arcgis/rest/services/NetworkAnalysis/SanDiego/MapServer/21/query?where=1%3D1&outFields=Name&f=json"
}

facilities

Use this parameter to specify one or more locations that are searched for when finding the closest location. These locations are referred to as facilities.

CautionCaution:

The service imposes a maximum limit of 1,000 points that can be passed as facilities. If the value is exceeded, the response returns an error message.

The facilities parameter can be specified using a JSON structure that represents a set of features. The JSON structure can include the following properties:

  • url: Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set. This property is optional. However, either features or url must be specified.
  • spatialReference: Specifies the spatial reference for the geometries of facilities. This property is not required if the coordinate values are in the default spatial reference, WGS84. If the coordinate values are in a different spatial reference, you need to specify the well-known ID (WKID) for the spatial reference. You can find the WKID for your spatial reference depending on whether the coordinates are represented in a geographic coordinate system or a projected coordinate system.
  • fields: Lists the fields that are part of the input features representing facilities. This property is optional if you are using the default fields only. However, it is required if your facilities include custom fields.
  • features: Specify an array of features. This property is optional. However, either the features or url property must be specified.

Each feature in the features array represents an incident and contains the following properties:

  • geometry: Specifies the facility's geometry as a point containing x and y properties.
  • attributes: Specify each attribute as a key-value pair where the key is the name of a given field, and the value is the attribute value for the corresponding field.

Attributes for facilities

When specifying the facilities, you can specify additional properties for facilities, such as their names, service times, or custom attributes custom attributes you deem valuable to include in the output closest facilities. The facilities parameter can be specified with the following attributes:

  • Name: The name of the facility. 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 routes, directions, and closest facilities.
  • ID: A unique identifier for the facility. The identifier is included in the output routes and can be used to join addtional information from the output routes such as the total travel time or total distance with attributes from your incidents. If the ID is not specified, the service auto-generates a unique identifier for each facility.
  • AdditionalTime: Specifies the amount of time that will added to the total travel time of the route between the incident and the closest facility. The attribute value can be used to specify the turnout time for the facility. For example, when finding the three closest fire stations from a fire incident, this attribute can be used to store the time it takes a crew to don the appropriate protective equipment and exit the fire station.

    The unit for this attribute value is specified by the measurement_units parameter. The attribute value is used only if the measurement units are time based. The default value is 0.

  • AdditionalDistance: Specifies the distance that will added to the total distance of the route between the incident and the closest facility. Generally, the locations of the facilities are not exactly on the streets but are set back somewhat from the road. This attribute value can be used to model the distance between the actual facility location and its location on the street if it is important to include that distance in the total travel distance.

    The unit for this attribute value is specified by the measurement_units parameter. The attribute value is used only if the measurement units are distance based. The default value is 0.

  • CurbApproach: Specifies the direction a vehicle may arrive at and depart from the facility. One of the integers listed in Coded value column in the following table must be specified as a value of this attribute. The values in the Setting column are the descriptive names for CurbApproach attribute values that you may have seen when using ArcGIS Network Analyst extension software.

    Setting

    Coded value

    Description

    Either side of vehicle

    0

    The vehicle can approach or depart the facility in either direction.

    Right side of vehicle
    Approaching the facility so that it is on the right side of the vehicle is allowed.
    Left side of vehicle
    Approaching the facility so that it is on the left side of the vehicle is allowed.

    Right side of vehicle

    1

    When the vehicle approaches or departs the facility, the facility must be on the right side of the vehicle. This is typically used for vehicles like buses that must arrive with the bus stop on the right hand side.

    Right side of vehicle
    Approaching the facility so that it is on the right side of the vehicle is allowed.

    Left side of vehicle

    2

    When the vehicle approaches or departs the facility, the facility must be on the left side of the vehicle. This is typically used for vehicles like buses that must arrive with the bus stop on the left hand side.

    Left side of vehicle
    Approaching the facility so that it is on the right side of the vehicle is allowed.

    The CurbApproach property was designed to work with both kinds of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider a facility 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 from the right or left side. For example, if you want to arrive at a facility and not have a lane of traffic between the vehicle and the facility, you would choose Right side of vehicle in the United States but Left side of vehicle in the United Kingdom.

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

  • Any custom attributes, or fields, you add to the input facilities are included in the output closest facilities.

Syntax for specifying facilities using a JSON structure for features
{
    "spatialReference": {
        "wkid": <wkid>,
        "latestWkid": <wkid>, 
    },
    "features": [
        {
            "geometry": {
                "x": <x1>,
                "y": <y1>,
            },
            "attributes": {
                "<field1>": <value1_1>,
                "<field2>": <value1_2>
            }
        },
        {
            "geometry": {
                "x": <x2>,
                "y": <y2>,
            },
            "attributes": {
                "<field1>": <value2_1>,
                "<field2>": <value2_2>
            }
        }
    ], 
}
Syntax for specifying facilities with custom attributes using a JSON structure for features
{
    "spatialReference": {
        "wkid": <wkid>,
        "latestWkid": <wkid>, 
    },
    "fields": [
        {
            "name": <name1>,
            "type": <esriFieldType>,
            "alias": <alias1>,
            "length": <length>
        },
        {
            "name": <name2>,
            "type": <esriFieldType>,
            "alias": <alias2>,
            "length": <length>
        }
    ],
    "features": [
        {
            "geometry": {
                "x": <x1>,
                "y": <y1>,
            },
            "attributes": {
                "<field1>": <value1_1>,
                "<field2>": <value1_2>
            }
        },
        {
            "geometry": {
                "x": <x2>,
                "y": <y2>,
            },
            "attributes": {
                "<field1>": <value2_1>,
                "<field2>": <value2_2>
            }
        }
    ], 
}
Syntax for specifying facilities using a URL returning a JSON response
{
    "url": "<url>"
}
Example 1: Specifying facilities in the default spatial reference, WGS84, using JSON structure.

The facility geometries are in the default spatial reference, WGS84. Hence, the spatialReference property is not specified. The example also shows how to specify some attributes for the facilities.

{
    "features": [
        {
            "geometry": {
                "y": 51.5254,
                "x": -0.1891
            },
            "attributes": {
                "Name": "Facility 1",
                "ID": "F100045", 
                "AdditionalTime": 5,
                "CurbApproach": 0
            }
        },
        {
            "geometry": {
                "y": 51.5353,
                "x": -0.1744
            },
            "attributes": {
                "Name": "Facility 2",
                "ID": "F100086",
                "AdditionalTime": 10,
                "CurbApproach": 0
            }
        }
    ]
}
Example 2: Specifying facilities in the Web Mercator spatial reference using a JSON structure.

The facility geometries are in the Web Mercator spatial reference and not in the default WGS84 spatial reference. Hence, the spatialReference property is required.

{
    "spatialReference": {
        "wkid": 102100
    },
    "features": [
        {
            "geometry": {
                "y": -5192521.476,
                "x": -2698533.989
            },
            "attributes": {
                "Name": "123 Main St", 
                "ID": "200156",
                "AdditionalDistance": 300
            }
        },
        {
            "geometry": {
                "y": -5191915.261,
                "x": -2697821.094
            },
            "attributes": {
                "Name": "845 Cypress Ave",
                "ID": "300242",
                "AdditionalDistance": 250
            }
        }
    ]
}
Example 3: Specifying facilities with a custom field using JSON structure.

In this example, the facilities include a custom field, PhoneNumber; therefore, the field schema must be defined in the fields attribute. The schema of default fields must also be defined whenever a custom field is present, so the schema of the Name field is also defined. The values for the fields are specified in the features attribute. The output closest facilities will include the custom field. The facility geometries are in WGS84, the default spatial reference, so the spatialReference attribute isn't required.

{
    "fields": [
        {
            "name": "Name",
            "type": "esriFieldTypeString",
            "alias": "Name",
            "length": 128
        },
        {
            "name": "PhoneNumber",
            "type": "esriFieldTypeString",
            "alias": "PhoneNumber",
            "length": 12
        }
    ],
    "features": [
        {
            "geometry": {
                "x": -122.455962,
                "y": 37.751316
            },
            "attributes": {
                "Name": "Bank 9",
                "PhoneNumber": "999-999-9999"
            }
        },
        {
            "geometry": {
                "x": -122.440825,
                "y": 37.753199
            },
            "attributes": {
                "Name": "Bank 8",
                "PhoneNumber": "888-888-8888"
            }
        },
        {
            "geometry": {
                "x": -122.457844,
                "y": 37.740713
            },
            "attributes": {
                "Name": "Bank 7",
                "PhoneNumber": "777-777-7777"
            }
        }
    ]
}
Example 4: Specifying facilities using a URL.

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

{
    "url": "http://sampleserver6.arcgisonline.com/arcgis/rest/services/NetworkAnalysis/SanDiego/MapServer/21/query?where=1%3D1&outFields=Name&f=json"
}

token

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

f

Use this parameter to specify the response format. Choose either json or pjson, for example, f=json. The pjson value is used for printing the JSON response in a pretty format.

Optional parameters

travel_mode

Choose the mode of transportation for the analysis.

Travel modes are managed in ArcGIS Online and can be configured by the administrator of your organization to better reflect your organization's workflows. You need to specify the JSON object containing the settings for a travel mode supported by your organization. To get a list of supported travel modes, execute the GetTravelModes tool from the Utilities service.

The value for the travel_mode parameter should be a JSON object representing travel mode settings. When you use the GetTravelModes tool from the Utlities service, You get a string representing the travel mode JSON. You need to convert this string to a valid JSON object using your API and then pass the JSON object as the value for the travel_mode parameter.

For example, below is a string representating the Walking Time travel mode as returned by the GetTravelModes tool.

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

The above value should be converted to a valid JSON object and passed as the value for the travel_mode parameter

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

The default value,Custom, allows you to configure your own travel mode. When you pass in Custom, you can set values for the following parameters impedance, uturn_at_junctions, use_hierarchy, route_line_simplification_tolerance, restrictions, and attribute_parameter_values.

The default values of the custom travel mode parameters model travelling by car. You may want to choose Custom and set the custom travel mode parameters listed above to model a pedestrian with a fast walking speed or a truck with a given height, weight, and cargo of certain hazardous materials. You may choose to do this to try out different settings to get desired analysis results. Once you have identified the analysis settings, you should work with your organization's administrator and save these settings as part of new or existing travel mode so that everyone in your organization can rerun the analysis with the same settings.

CautionCaution:

When the travel_mode parameter is not set to Custom, this means you are choosing a travel mode configured by your organization, and the service automatically overrides the values of other parameters with values that model the chosen travel mode. The following parameters are overridden:impedance, uturn_at_junctions, use_hierarchy, route_line_simplification_tolerance, restrictions, and attribute_parameter_values.

If you set travel_mode to Custom, the service honors the default or user-defined values for the related parameters (impedance, uturn_at_junctions, use_hierarchy, route_line_simplification_tolerance, restrictions, and attribute_parameter_values) so you can create your own travel mode.

measurement_units

Use this parameter to specify the units that should be used to report the total travel time or travel distance for the output routes. The service chooses to find the closest facility based on the travel time or the travel distance along the streets depending on whether the units you specify as the value for this parameter are time or distance based. The parameter can be specified using the following values:

  • Minutes
  • Seconds
  • Hours
  • Days
  • Miles
  • Kilometers
  • Meters
  • Feet
  • Yards
  • Nautical Miles

The default value is Minutes.

number_of_facilities_to_find

The service can be used to find multiple closest facilities from an incident. Use this parameter to specify the number of closest facilities to find per incident. This is useful in situations, such as a fire, where multiple fire engines may be required from different fire stations. The service can find, for example, the three nearest fire stations to a fire.

The default value for this parameter is 1.

CautionCaution:

The service imposes a maximum limit of 100 facilities to find from each incident.

cutoff

Use this parameter to specify the travel time or travel distance value at which to stop searching for facilities for a given incident. For instance, while finding the closest hospitals from the site of an accident, a cutoff value of 15 minutes would mean that the service would search for the closest hospital within 15 minutes from the incident. If the closest hospital is 17 minutes away, no routes will be returned in the output routes. A cutoff value is especially useful when searching for multiple facilities.

The units for this parameter is specified by the measurement_units parameter. The default value for this parameter is null, which indicates not to use any cutoff.

travel_direction

Use this parameter to specify whether you want to search for the closest facility as measured from the incident to the facility or from the facility to the incident. The parameter can be specified using the following values:

  • Facility to Incident: Direction of travel is from facilities to incidents.
  • Incident to Facility: Direction of travel is from incidents to facilities.

Using one of the parameter value can find different facilities because the travel time along some streets may vary based on traffic and oneway restrictions. For instance, a facility may be a 10-minute drive from the incident while traveling from the incident to the facility, but while traveling from the facility to the incident, it may be a 15-minute journey because traffic is slower in that direction. If you are setting a value for time_of_day, traffic may also cause the Facility to Incident and Incident to Facility options to return different results.

Fire departments commonly use the Facility to Incident value for the parameter since they are concerned with the time it takes to travel from the fire station (facility) to the location of the emergency (incident). A retail store (facility) is more concerned with the time it takes the shoppers (incidents) to reach the store; therefore, stores commonly use the Incident to Facility parameter value.

The default value for this parameter is Incident to Facility.

use_hierarchy

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

CautionCaution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when travel_mode is set to any other value than Custom. The default value for travel_mode is Driving, so unless you set travel_mode to a different value, this parameter value will be overridden.

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

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

CautionCaution:

The service automatically reverts to using hierarchy if the straight-line distance between the stops is greater than 50 miles (80.46 kilometers), even if you have specified to find the route without using hierarchy.

time_of_day

Specify whether travel times should consider traffic conditions. To include traffic in the analysis, choose a time-based unit for measurement_units and assign a value to time_of_day.

The time_of_day value indicates the target start time of the routes in the analysis. If time_of_day_usage is set to End Time, the value represents when the routes should arrive at their nearby locations. The time is specified as Unix time (milliseconds since midnight, January 1 1970).

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

NoteNote:

Traffic is supported only with the driving time impedance or travel mode. It's not supported with trucking.

The service supports two kinds of traffic: typical and live. Typical traffic references travel speeds that are made up of historical averages for each five-minute interval spanning a week. Live traffic retrieves speeds from a traffic feed that processes phone probe records, sensors, and other data sources to record actual travel speeds and predict speeds for the near future.

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

Typical Traffic:

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

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

Set the time and date as Unix time in milliseconds.

For example, to solve for 1:03 p.m. on Thursdays, set the time and date to 1:03 p.m., 4 January 1990; and convert to milliseconds (631458180000).

NoteNote:
  • The default value is null, which means the effect of changing traffic isn't included in the analysis.
  • Although the dates representing days of the week are from 1990, typical traffic is calculated from recent traffic trends—usually over the last several months.
  • This parameter is ignored when measurement_units is set to a distance-based unit.
  • The time zone for time_of_day can be UTC or the time zone or zones in which the points in facilities or incidents are located. Specify time zones with the time_zone_for_time_of_day parameter.
  • All incidents must be in the same time zone when

    • Specifying a start time and traveling from incident to facility
    • Specifying an end time and traveling from facility to incident

  • All facilities must be in the same time zone when

    • Specifying a start time and traveling from facility to incident
    • Specifying an end time and traveling from incident to facility

Examples:

  • "time_of_day": 631458180000 // 13:03, 4 January 1990. Typical traffic on Thursdays at 1:03 p.m.
  • "time_of_day": 631731600000 // 17:00, 7 January 1990. Typical traffic on Sundays at 5:00 p.m.
  • "time_of_day": 1413964800000 // 8:00, 22 October 2014. If the current time is between 8:00 p.m., 21 Oct. 2014 and 8:00 p.m., 22 Oct. 2014, live traffic speeds are referenced in the analysis; otherwise, typical traffic speeds are referenced.
  • "time_of_day": 1426674000000 // 10:20, 18 March 2015. If the current time is between 10:20 p.m., 17 Mar. 2015 and 10:20 p.m., 18 Mar. 2015, live traffic speeds are referenced in the analysis; otherwise, typical traffic speeds are referenced.

time_zone_for_time_of_day

Specify the time zone or zones of the time_of_day parameter. There are two options: Geographically Local (default) and UTC.

Geographically Local:

The time_of_day value refers to the time zone in which the input facilities or incidents are located. If the travel_direction and time_of_day_usage parameters indicate a departure or arrival time at the facilities, time_of_day refers to the time zone of the facilities. Likewise, if the two parameters indicate a departure or arrival time at the incidents, time_of_day refers to the time zone of incidents.

Geographically Local Illustration: Setting time_of_day to 9:00 a.m., 4 January 1990 (631443600000 milliseconds); time_zone_for_time_of_day to Geographically Local; and submitting a valid request causes the drive times for points in the Eastern Time Zone to start at 9:00 a.m. (2:00 p.m. UTC).

UTC:

The time_of_day value refers to Coordinated Universal Time (UTC).

UTC Illustration: Setting time_of_day to 9:00 a.m., 4 January 1990 (631443600000 milliseconds) and time_zone_for_time_of_day to UTC, the start time for points in the Eastern Time Zone is 4:00 a.m. Eastern Time (9:00 a.m. UTC).

NoteNote:
  • This parameter is ignored when measurement_units is set to a distance-based unit.
  • All incidents must be in the same time zone when

    • Specifying a start time and traveling from incident to facility
    • Specifying an end time and traveling from facility to incident

  • All facilities must be in the same time zone when

    • Specifying a start time and traveling from facility to incident
    • Specifying an end time and traveling from incident to facility

time_of_day_usage

Use this parameter to specify whether the time_of_day parameter value represents the arrival or departure time for the routes. The parameter can be specified using the following values:

  • Start Time: When this value is specified, the service finds the best route considering the time_of_day parameter value as the departure time from the facility or incident.
  • End Time: When this value is specified, the service considers the time_of_day parameter value as the arrival time at the facility or incident. This value is useful if you want to know what time to depart from a location so that you arrive at the destination at the time specified in time_of_day.

The default value for this parameter is Start Time. The parameter value is ignored if the time_of_day parameter has a null value.

uturn_at_junctions

Use this parameter to restrict or allow the analysis to make U-turns at junctions.

CautionCaution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when travel_mode is set to any other value than Custom. The default value for travel_mode is Driving, so unless you set travel_mode to a different value, this parameter value will be overridden.

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

Parameter Value

Description

Allowed

U-turns are permitted everywhere. Allowing U-turns implies that the vehicle can turn around at a junction or intersection and double back on the same street.

U-turns are allowed
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 allowed only at intersections and dead-ends
U-turns are permitted only at intersections or dead ends.

Allowed only at Dead Ends

U-turns are prohibited at all junctions and interesections and are permitted only at dead ends.

U-turns allowed 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. Note that even when this parameter value is chosen, a route can still make U-turns at stops. If you wish to prohibit U-turns at a stop, you can set its CurbApproach property to the appropriate value (3).

The default value for this parameter is Allowed.

point_barriers

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

CautionCaution:

The service imposes a maximum limit of 250 point barriers. If the value is exceeded, the response returns an error message.

The point_barriers parameter can be specified using a JSON structure that represents a set of features. The JSON structure can include the following properties:

  • url: Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set. This property is optional. However, either features or url must be specified.
  • spatialReference: Specifies the spatial reference for the geometries of point barriers. This property is not required if the coordinate values are in the default spatial reference, WGS84. If the coordinate values are in a different spatial reference, you need to specify the well-known ID (WKID) for the spatial reference. See Geographic coordinate systems and Projected coordinate systems to look up WKID values.
  • features: Specify an array of features. This property is optional. However, either the features or url property must be specified.

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

  • geometry: Specifies the barrier's geometry as a point containing x and y properties.
  • attributes: Specify each attribute as a key-value pair where the key is the name of a given field, and the value is the attribute value for the corresponding field.

Attributes for point_barriers

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

  • Name: The name of the barrier.
  • BarrierType: Specifies whether the point barrier restricts travel completely or adds time or distance when it is crossed. The value for this attribute is specified as one of the following integers:
    • 0 - Prohibits traversing through the barrier. The barrier is referred to as restriction point barrier since it acts as a restriction. This is the default value.
      Two maps demonstrate how a restriction point barrier affects finding the best route.
      The map on the left shows the shortest path between two stops without any restriction point barriers. The map on the right has a road that is blocked by a fallen tree, so the shortest path between the same points is longer.
    • 2 - Traveling through the barrier increases the travel time or distance by the amount specified as the value for Additional_Time or Additional_Distance attributes. This barrier type is referred to as an added cost point barrier.
      Two maps demonstrate how added cost barriers affect finding the best route.
      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.
      NoteNote:

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

  • Additional_Time: Indicates how much travel time is added when the barrier is traversed. This attribute is applicable only for added-cost barriers and only if the measurement units are time based. The attribute value must be greater than or equal to zero and is specified in the measurement units.
  • Additional_Distance: Indicates how much distance is added when the barrier is traversed. This attribute is applicable only for added-cost barriers and only if the measurement units are distance based. The attribute value must be greater than or equal to zero and is specified in the measurement units.

Syntax for specifying point_barriers using a JSON structure for features
{
    "spatialReference": {
        "wkid": <wkid>,
        "latestWkid": <wkid>, 
    },
    "features": [
        {
            "geometry": {
                "x": <x1>,
                "y": <y1>,
            },
            "attributes": {
                "<field1>": <value11>,
                "<field2>": <value12>
            }
        },
        {
            "geometry": {
                "x": <x2>,
                "y": <y2>,
            },
            "attributes": {
                "<field1>": <value21>,
                "<field2>": <value22>
            }
        }
    ], 
}
Syntax for specifying point_barriers using a URL returning a JSON response
{
    "url": "<url>"
}
Example 1: Specifying an added cost point barrier in the default spatial reference, WGS84, using JSON structure.

This example shows how to use an added cost point barrier to model a 5-minute delay at a railroad crossing. The BarrierType attribute is used to specify the point barrier is of type added cost and the Additional_Time attribute is used to specify the added delay in minutes. The barrier geometries are in the default spatial reference, WGS84. Hence, the spatialReference property is not specified.

{
    "features": [
        {
            "geometry": {
                "x": 37.541479,
                "y": -122.053461
            },
            "attributes": {
                "Name": "Haley St railroad crossing",
                "BarrrierType": 2,
                "Additional_Time": 5
            }
        }
    ]
}
Example 2: Specifying restriction point barriers in the Web Mercator spatial reference using a JSON structure.

This example shows how to use a restriction point barrier to model a road that is blocked by a fallen tree.The barrier's geometry is in the Web Mercator spatial reference and not in the default WGS84 spatial reference. Hence, the spatialReference property is required.

{
    "spatialReference": {
        "wkid": 102100
    },
    "features": [
        {
            "geometry": {
                "y": -13635398.9398,
                "x": 4544699.034400001
            },
            "attributes": {
                "Name": "Fallen tree at 123 Main St", 
                "BarrierType": 0
            }
        }
    ]
}
Example 3: Specifying point barriers using a URL.

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

{
    "url": "http://sampleserver6.arcgisonline.com/arcgis/rest/services/NetworkAnalysis/SanDiego/MapServer/21/query?where=1%3D1&outFields=Name&f=json"
}

line_barriers

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

Two maps demonstrate how a line barrier affects finding a route between two stops.
The map on the left displays the shortest path between two stops. The map on the right shows the shortest path when several streets are blocked by a line barrier.

CautionCaution:

The service imposes a limit on the number of streets you can restrict using the line_barriers parameter. While there is no limit on number of lines you can specify as line barriers, the combined number of streets intersected by all the lines cannot exceed 500. If the value is exceeded, the response returns an error message.

The line_barriers parameter can be specified using a JSON structure that represents a set of features. The JSON structure can include the following properties:

  • url: Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set. This property is optional. However, either features or url must be specified.
  • spatialReference: Specifies the spatial reference for the geometries of the barriers. This property is not required if the coordinate values are in the default spatial reference, WGS84. If the coordinate values are in a different spatial reference, you need to specify the well-known ID (WKID) for the spatial reference. See Geographic coordinate systems and Projected coordinate systems to look up WKID values.
  • features: Specify an array of features. This property is optional. However, either the features or url property must be specified.

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

  • geometry: Specifies the barrier's geometry. The structure is based on ArcGIS REST polyline object. A polyline contains an array of paths. Each path is represented as an array of points, and each point in the path is represented as an array of numbers containing X and Y coordinate values at index 0 and 1 respectively.
  • attributes: Specify each attribute as a key-value pair where the key is the name of a given field, and the value is the attribute value for the corresponding field.

Attributes for line_barriers

The line_barriers parameter can be specified with the following attributes:

  • Name: The name of the line barrier.

Syntax for specifying line barriers using a JSON structure for features
{
    "spatialReference": {
        "wkid": <wkid>,
        "latestWkid": <wkid>, 
    },
    "features": [
        {
            "geometry": {
                "paths": [
                    [
                        [
                            <x11>,
                            <y11>
                        ],
                        [
                            <x12>,
                            <y12>
                        ]
                    ],
                    [
                        [
                            <x21>,
                            <y21>
                        ],
                        [
                            <x22>,
                            <y22>
                        ]
                    ]
                ]
            },
            "attributes": {
                "<field1>": <value11>,
                "<field2>": <value12>
            }
        },
		{
            "geometry": {
                "paths": [
                    [
                        [
                            <x11>,
                            <y11>
                        ],
                        [
                            <x12>,
                            <y12>
                        ]
                    ],
                    [
                        [
                            <x21>,
                            <y21>
                        ],
                        [
                            <x22>,
                            <y22>
                        ]
                    ]
                ]
            },
            "attributes": {
                "<field1>": <value21>,
                "<field2>": <value22>
            }
        }
    ], 
}
Syntax for specifying line barriers using a URL returning a JSON response
{
    "url": "<url>"
}
Example 1: Specifying line barriers using a JSON structure in Web Mercator spatial reference.

The example shows how to add two lines as line barriers to restrict travel on the streets intersected by the lines. Barrier 1 is a single-part line feature made up of two points. Barrier 2 is a two-part line feature whose first part is made up of three points and whose second part is made up of two points. The barrier geometries are in the Web Mercator spatial reference and not in the default WGS84 spatial reference. Hence, the spatialReference property is required.

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

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

{
    "url": "http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Network/USA/MapServer/6/query?where=1%3D1&returnGeometry=true&f=json"
}

polygon_barriers

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

CautionCaution:

The service imposes a limit on the number of streets you can restrict using the polygon_barriers parameter. While there is no limit on number of polygons you can specify as the polygon barriers, the combined number of streets intersected by all the polygons cannot exceed 2,000. If the value is exceeded, the response returns an error message.

The polygon_barriers parameter can be specified using a JSON structure that represents a set of features. The JSON structure can include the following properties:

  • url: Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set. This property is optional. However, either features or url must be specified.
  • spatialReference: Specifies the spatial reference for the geometries of barriers. This property is not required if the coordinate values are in the default spatial reference, WGS84. If the coordinate values are in a different spatial reference, you need to specify the well-known ID (WKID) for the spatial reference. See Geographic coordinate systems and Projected coordinate systems to look up WKID values.
  • features: Specify an array of features. This property is optional. However, either the features or url property must be specified.

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

  • geometry: Specifies the barrier's geometry. The structure is based on ArcGIS REST polygon object. A polygon contains an array of rings. The first point of each ring is always the same as the last point. Each point in the ring is represented as an array of numbers containing X and Y coordinate values at index 0 and 1 respectively.
  • attributes: Specify each attribute as a key-value pair where the key is the name of a given field, and the value is the attribute value for the corresponding field.

Attributes for polygon_barriers

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

  • Name: The name of the barrier.
  • BarrierType: Specifies whether the barrier restricts travel completely or scales the time or distance for traveling through it. The value for this attribute is specified as one of the following integers:
    • 0 - Prohibits traveling through any part of the barrier. The barrier is referred to as restriction polygon barrier since it prohibits traveling on streets intersected by the barrier. One use of this type of barrier is to model floods that make traveling on flooded streets impossible. This is the default value.
      Two maps demonstrate how a restriction polygon barrier affects finding a route between two stops.
      The left side depicts the shortest path between two stops. On the right, a polygon barrier blocks flooded streets, so the shortest path between the same two stops is different.
    • 1 - Scales the time or distance required to travel the underlying streets by a factor specified using the ScaledTimeFactor or ScaledDistanceFactor attributes. If the streets are partially covered by the barrier, the travel time or distance is apportioned and then scaled. For example, a factor 0.25 would mean that travel on underlying streets is expected to be four times faster than normal. A factor of 3.0 would mean it is expected to take three times longer than normal to travel on underlying streets. This barrier type is referred to as scaled cost polygon barrier. It might be used to model storms that reduce travel speeds in specific regions.
      Two maps demonstrate how a scaled cost polygon barrier affects finding a route between two stops.
      The map on the left shows a route that goes through inclement weather without regard for the effect poor road conditions have on travel time. On the right, a scaled polygon barrier doubles the travel time of the roads covered by the storm. Notice the route still passes through the southern tip of the storm since it is quicker to spend more time driving slowly through a small part of the storm rather than driving completely around it. The service uses the modified travel time in calculating the best route; furthermore, the modified travel time is reported as the total travel time in the response.
  • ScaledTimeFactor: This is the factor by which the travel time of the streets intersected by the barrier is multiplied. This attribute is applicable only to scaled-cost barriers whose measurement units are time based. The attribute value must be greater than zero. The default value is 1.
  • ScaledDistanceFactor: This is the factor by which the distance of the streets intersected by the barrier is multiplied. This attribute is applicable only to scaled-cost barriers whose measurement units are distance based. The attribute value must be greater than zero. The default value is 1.

Syntax for specifying polygon barriers using a JSON structure for features
{
    "spatialReference": {
        "wkid": <wkid>,
        "latestWkid": <wkid>    
    }
    "features": [
        {
            "geometry": {
                "rings": [
                    [
                        [
                            <x11>,
                            <y11>
                        ],
                        [
                            <x12>,
                            <y12>
                        ],
                        ...,
                        [
                            <x11>,
                            <y11>
                        ]
                    ],
                    [
                        [
                            <x21>,
                            <y21>
                        ],
                        [
                            <x22>,
                            <y22>
                        ],
                        ...,
                        [
                            <x21>,
                            <y21>
                        ]
                    ]
                ]
            },
            "attributes": {
                "<field1>": <value11>,
                "<field2>": <value12>
            }
        },
        {
            "geometry": {
                "rings": [
                    [
                        [
                            <x11>,
                            <y11>
                        ],
                        [
                            <x12>,
                            <y12>
                        ],
                        ...,
                        [
                            <x11>,
                            <y11>
                        ]
                    ],
                    [
                        [
                            <x21>,
                            <y21>
                        ],
                        [
                            <x22>,
                            <y22>
                        ],
                        ...,
                        [
                            <x21>,
                            <y21>
                        ]
                    ]
                ]
            },
            "attributes": {
                "<field1>": <value21>,
                "<field2>": <value22>
            }
        }
    ]
}
Syntax for specifying polygon barriers using a URL returning a JSON response
{
    "url": "<url>"
}
Example 1: Specifying polygon barriers using a JSON structure.

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

The barrier geometries are in the default spatial reference, WGS84. Hence, the spatialReference property is not required.

{
    "features": [
        {
            "geometry": {
                "rings": [
                    [
                        [
                            -97.0634,
                            32.8442
                        ],
                        [
                            -97.0554,
                            32.84
                        ],
                        [
                            -97.0558,
                            32.8327
                        ],
                        [
                            -97.0638,
                            32.83
                        ],
                        [
                            -97.0634,
                            32.8442
                        ]
                    ]
                ]
            },
            "attributes": {
                "Name": "Flood zone",
                "BarrierType": 0
            }
        },
        {
            "geometry": {
                "rings": [
                    [
                        [
                            -97.0803,
                            32.8235
                        ],
                        [
                            -97.0776,
                            32.8277
                        ],
                        [
                            -97.074,
                            32.8254
                        ],
                        [
                            -97.0767,
                            32.8227
                        ],
                        [
                            -97.0803,
                            32.8235
                        ]
                    ],
                    [
                        [
                            -97.0871,
                            32.8311
                        ],
                        [
                            -97.0831,
                            32.8292
                        ],
                        [
                            -97.0853,
                            32.8259
                        ],
                        [
                            -97.0892,
                            32.8279
                        ],
                        [
                            -97.0871,
                            32.8311
                        ]
                    ]
                ]
            },
            "attributes": {
                "Name": "Severe weather zone",
                "BarrierType": 1,
                "ScaledTimeFactor": 3
            }
        }
    ]
}
Example 2: Specifying a polygon barrier using a URL.

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

{
    "url": "http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Network/USA/MapServer/7/query?where=1%3D1&returnGeometry=true&f=json"
}

restrictions

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

CautionCaution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when travel_mode is set to any other value than Custom. The default value for travel_mode is Driving, so unless you set travel_mode to a different value, this parameter value will be overridden.

The service supports the restriction names listed in the following table:

NoteNote:

Some restrictions are supported only in certain countries as indicated by the Availability column in the table. A restriction is supported in a country if the Logistics Attribute column has a value of Yes in the list of supported countries. If you specify restriction names that are not available in the country where your input points are located, the service ignores the invalid restrictions and returns warning messages indicating the names for the restrictions that were not considered when making measurements.

NoteNote:

Sometimes you need to specify an additional value, the restriction attribute parameter, on a restriction to get the intended results. This value needs to be associated with the restriction name and a restriction parameter using attribute_parameter_values.

Restriction Name

Description

Availability

Any Hazmat Prohibited

The route will exclude roads where transporting any kind of hazardous material is prohibited.

Select countries in North America and Europe

Avoid Carpool Roads

The route will avoid roads designated exclusively for carpool (high-occupancy) vehicles.

All countries

Avoid Express Lanes

The route will avoid roads designated as express lanes.

All countries

Avoid Ferries

The route will avoid ferries.

All countries

Avoid Gates

The route will avoid roads where there are gates, such as keyed-access or guard-controlled entryways.

All countries

Avoid Limited Access Roads

The route will avoid roads designated as limited-access highways.

All countries

Avoid Private Roads

The route will avoid roads that are not publicly owned and maintained.

All countries

Avoid Toll Roads

The route will avoid toll roads.

All countries

Avoid Unpaved Roads

The route will avoid roads that are not paved (for example, dirt, gravel, etc.).

All countries

Avoid Truck Restricted Roads

The route will avoid roads where trucks are not allowed except when making deliveries.

All countries

Axle Count Restriction

The route will not include roads where trucks with the specified number of axles are prohibited. The number of axles can be specified using the Number of Axles restriction parameter.

Select countries in North America and Europe

Driving a Bus

The route will exclude roads where buses are prohibited. Using this restriction also ensures the route will honor one-way streets.

All countries

Driving a Delivery Vehicle

The route will exclude roads where delivery vehicles are prohibited. Using this restriction also ensures the route will honor one-way streets.

All countries

Driving a Taxi

The route will exclude roads where taxis are prohibited. Using this restriction also ensures the route will honor one-way streets.

All countries

Driving a Truck

The route will exclude roads where trucks are prohibited. Using this restriction also ensures the route will honor one-way streets.

All countries

Driving an Automobile

The route will exclude roads where automobiles are prohibited. Using this restriction also ensures the route will honor one-way streets.

All countries

Driving an Emergency Vehicle

The route will exclude roads where emergency vehicles are prohibited. Using this restriction also ensures the route will honor one-way streets.

All countries

Height Restriction

The route will exclude roads where the vehicle height exceeds the maximum allowed height for the road. The vehicle height can be specified using the Vehicle Height (meters) restriction parameter.

Select countries in North America and Europe

Kingpin to Rear Axle Length Restriction

The route will exclude roads where the vehicle kingpin-to-rear-axle length exceeds the maximum allowed for the road. The vehicle's length between the vehicle kingpin and the rear axle can be specified using the Vehicle Kingpin to Rear Axle Length (meters) restriction parameter.

Select countries in North America and Europe

Length Restriction

The route will exclude roads where the vehicle length exceeds the maximum allowed length for the road. The vehicle length can be specified using the Vehicle Length (meters) restriction parameter.

Select countries in North America and Europe

Preferred for Pedestrians

The route prefers paths designated for pedestrians.

All countries

Riding a Motorcycle

The route will exclude roads where motorcycles are prohibited. Using this restriction also ensures the route will honor one-way streets.

All countries

Roads Under Construction Prohibited

The route will exclude roads that are under construction.

All countries

Semi or Tractor with One or More Trailers Prohibited

The route will exclude roads where semis or tractors with one or more trailers are prohibited.

Select countries in North America and Europe

Single Axle Vehicles Prohibited

The route will exclude roads where vehicles with single axles are prohibited.

Select countries in North America and Europe

Tandem Axle Vehicles Prohibited

The route will exclude roads where vehicles with tandem axles are prohibited.

Select countries in North America and Europe

Through Traffic Prohibited

The route will exclude roads where through traffic (non-local) is prohibited.

All countries

Truck with Trailers Restriction

The route will exclude roads where trucks with the specified number of trailers on the truck are prohibited. The number of trailers on the truck can be specified using the Number of Trailers on Truck restriction parameter.

Select countries in North America and Europe

Use Preferred Hazmat Routes

The route will prefer roads designated for transporting any kind of hazardous materials.

Select countries in North America and Europe

Use Preferred Truck Routes

The route will prefer roads designated as truck routes, such as the roads that are part of the national network as specified by the National Surface Transportation Assistance Act in the United States, or roads that are designated as truck routes by the state or province, or or roads in an area that are generally more suitable for trucks.

Select countries in North America and Europe

Walking

The route will exclude roads where pedestrians are prohibited.

All countries

Weight Restriction

The route will exclude roads where the vehicle weight exceeds the maximum allowed weight for the road. The vehicle weight can be specified using the Vehicle Weight (kilograms) restriction parameter.

Select countries in North America and Europe

Weight per Axle Restriction

The route will exclude roads where the vehicle's weight per axle exceeds the maximum allowed for the road. The vehicle's weight per axle can be specified using the Vehicle Weight per Axle (kilograms) restriction parameter.

Select countries in North America and Europe

Width Restriction

The route will roads where the vehicle width exceeds the maximum allowed for the road. The vehicle width can be specified using the Vehicle Width(meters) restriction parameter.

Select countries in North America and Europe

LegacyLegacy:

Driving a Delivery Vehicle restriction attribute is deprecated and will be unavailable in future releases. To achieve similar results, use Driving a Truck restriction attribute along with Avoid Truck Restricted Roads restriction attribute.

The restrictions parameter value is specified as an array of restriction names. The default value for this parameter is restrictions=[Avoid Carpool Roads, Avoid Express Lanes, Avoid Gates, Avoid Private Roads, Avoid Unpaved Roads, Driving an Truck, Use Preferred Truck Routes, Roads Under Construction Prohibited, Through Traffic Prohibited]. A value of null indicates that no restrictions should be used when finding the best route, but only when travel_mode is set to Custom.

Example: restrictions=[Driving an Emergency Vehicle,Height Restriction,Length Restriction]

attribute_parameter_values

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

CautionCaution:

The value of this parameter, regardless of whether you rely on its default or explicitly set a value, is overridden when travel_mode is set to any other value than Custom. The default value for travel_mode is Custom.

The attributes_parameter_values parameter can be specified using a JSON structure that represents a set of features. The JSON structure can include the following properties:

  • url: Specify a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set. This property is optional. However, either features or url must be specified.
  • features: Specify an array of features. This property is optional. However, either the features or url property must be specified.

Each feature in the features array represents an attribute parameter and contains the following properties:

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

The JSON structure for the attribute_parameter_values parameter does not have a geometry property.

Attributes for attribute_parameter_values

The attribute_parameter_values parameter can be specified with the following attributes:

  • AttributeName: Lists the name of the restriction.
  • ParameterName: Lists the name of the parameter associated with the restriction. A restriction can have one or more ParameterName values based on its intended use, which implies you may need multiple attribute_parameter_values parameters for a single attribute name.
  • ParameterValue: The value for the ParameterName that is used by the service when evaluating the restriction.

NoteNote:

In most cases, the attribute_parameter_values parameter is dependent on the restrictions parameter. The ParameterValue specified as part of attribute_parameter_values is applicable only if the restriction name is specified as the value for the restrictions parameter.

When specifying the attribute_parameter_values parameter, each restriction (listed as AttributeName) has a ParameterName value, Restriction Usage, that specifies whether the restriction prohibits, avoids, or prefers travel on the roads associated with the restriction and the degree to which the roads are avoided or preferred.

The Restriction Usage ParameterName can be assigned any of the following string values or their equivalent numeric values listed within the parentheses:

  • PROHIBITED (-1)—Travel on the roads using the restriction is completely prohibited.
  • AVOID_HIGH (5)—It is very unlikely for the service to include, in the results, roads that are associated with the restriction.
  • AVOID_MEDIUM (2)—It is unlikely for the service to include, in the results, roads that are associated with the restriction.
  • AVOID_LOW (1.3)—It is somewhat unlikely for the service to include, in the results, roads that are associated with the restriction.
  • PREFER_LOW (0.8)—It is somewhat likely for the service to include, in the results, results roads that are associated with the restriction.
  • PREFER_MEDIUM(0.5)—It is likely for the service to include, in the results, roads that are associated with the restriction.
  • PREFER_HIGH (0.2)—It is very likely for the service to include, in the results, roads that are associated with the restriction.

In most cases, you can use the default value, PROHIBITED, for Restriction Usage if the restriction is dependent on a physical vehicle characteristic, such as vehicle height. However, in some cases, the value for Restriction Usage depends on your travel preferences. For example, the Avoid Toll Roads restriction has the default value of AVOID_MEDIUM for the Restriction Usage parameter. This means that when the restriction is used, the service will try to route around toll roads when it can. AVOID_MEDIUM also indicates how important it is to avoid toll roads when finding the best route; it has a medium priority. Choosing AVOID_LOW would put lower importance on avoiding tolls; choosing AVOID_HIGH instead would give it a higher importance and thus make it more acceptable for the service to generate longer routes to avoid tolls. Choosing PROHIBITED would entirely disallow travel on toll roads, making it impossible for a route to travel on any portion of a toll road. Keep in mind that avoiding or prohibiting toll roads, and thus avoiding toll payments, is the objective for some; in contrast, others prefer to drive on toll roads because avoiding traffic is more valuable to them than the money spent on tolls. In the latter case, you would choose PREFER_LOW, PREFER_MEDIUM, or PREFER_HIGH as the value for Restriction Usage. The higher the preference, the farther the service will go out of its way to travel on the roads associated with the restriction.

The following table lists the restriction names and the default restriction parameter values for all the restrictions. The default value for the attribute_parameter_values parameter is the JSON structure containing all the rows from the table.

TipTip:

If you want to use the default value for any restriction, AttributeName, ParameterName, and ParameterValue do not have to be specified as part of the attribute_parameter_values parameter.

AttributeName

ParameterName

ParameterValue

Any Hazmat Prohibited

Restriction Usage

PROHIBITED

Avoid Carpool Roads

Restriction Usage

AVOID_HIGH

Avoid Express Lanes

Restriction Usage

AVOID_HIGH

Avoid Ferries

Restriction Usage

AVOID_MEDIUM

Avoid Gates

Restriction Usage

AVOID_MEDIUM

Avoid Limited Access Roads

Restriction Usage

AVOID_MEDIUM

Avoid Private Roads

Restriction Usage

AVOID_MEDIUM

Avoid Toll Roads

Restriction Usage

AVOID_MEDIUM

Avoid Truck Restricted Roads

Restriction Usage

AVOID_HIGH

Axle Count Restriction

Number of Axles

0

Restriction Usage

PROHIBITED

Driving a Bus

Restriction Usage

PROHIBITED

Driving a Delivery Vehicle

Restriction Usage

PROHIBITED

Driving a Taxi

Restriction Usage

PROHIBITED

Driving a Truck

Restriction Usage

PROHIBITED

Driving an Automobile

Restriction Usage

PROHIBITED

Driving an Emergency Vehicle

Restriction Usage

PROHIBITED

Height Restriction

Restriction Usage

PROHIBITED

Vehicle Height (meters)

0

Kingpin to Rear Axle Length Restriction

Restriction Usage

PROHIBITED

Vehicle Kingpin to Rear Axle Length (meters)

0

Length Restriction

Restriction Usage

PROHIBITED

Vehicle Length (meters)

0

Riding a Motorcycle

Restriction Usage

PROHIBITED

Roads Under Construction Prohibited

Restriction Usage

PROHIBITED

Semi or Tractor with One or More Trailers Prohibited

Restriction Usage

PROHIBITED

Single Axle Vehicles Prohibited

Restriction Usage

PROHIBITED

Tandem Axle Vehicles Prohibited

Restriction Usage

PROHIBITED

Through Traffic Prohibited

Restriction Usage

AVOID_HIGH

Truck with Trailers Restriction

Restriction Usage

PROHIBITED

Number of Trailers on Truck

0

Use Preferred Hazmat Routes

Restriction Usage

PREFER_MEDIUM

Use Preferred Truck Routes

Restriction Usage

PREFER_HIGH

Walking

Restriction Usage

PROHIBITED

WalkTime

Walking Speed (km/h)

5

Weight Restriction

Restriction Usage

PROHIBITED

Vehicle Weight (kilograms)

0

Weight per Axle Restriction

Restriction Usage

PROHIBITED

Vehicle Weight per Axle (kilograms)

0

Width Restriction

Restriction Usage

PROHIBITED

Vehicle Width (meters)

0

Syntax for specifying attribute_parameter_values
{
    "features": [
        {
            "attributes": {
                "<field1>": <value11>,
                "<field2>": <value12>,
                "<field3>": <value13>

            }
        },
        {
            "attributes": {
                "<field1>": <value21>,
                "<field2>": <value22>,
                "<field3>": <value13>
            }
        }
    ] 
}
Example: Specifying the vehicle height and weight and a high preference to use designated truck routes

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

Note that the Restriction Usage ParameterName for the Height Restriction and the Weight Restriction restrictions are not specified since we want to use the default value of PROHIBITED for these restriction parameters.

attribute_parameter_values=
{
    "features": [
        {
            "attributes": {
                "AttributeName": "Height Restriction",
                "ParameterName": "Vehicle Height (meters)",
                "ParameterValue": 4.12
            }
        },
        {
            "attributes": {
                "AttributeName": "Weight Restriction",
                "ParameterName": "Vehicle Weight (kilograms)",
                "ParameterValue": 36287
            }
        },
        {
            "attributes": {
                "AttributeName": "Use Preferred Truck Routes",
                "ParameterName": "Restriction Usage",
                "ParameterValue": "PREFER_HIGH"
            }
        }
    ]
}

route_shape

Use this parameter to specify the type of route features that are output by the service. The parameter can be specified using one of the following values:

  • True Shape (default): Return the exact shape of the resulting route that is based on the underlying streets. Since this option creates the most detailed geometry for the output routes, choosing it tends to make the process run longer and create larger output files.
  • True Shape with Measures: Return the exact shape of the resulting route that is based on the underlying streets. Additionally, construct measures so the shape may be used in linear referencing. The measurements increase from the first stop and record the cumulative travel time or travel distance in the units specified by the measurement_units parameter.
  • Straight Line: Return a straight line between the route start and end.
  • None: Do not return any route shapes. This value can be useful in cases where you want to optimize performance and are only interested in determing the route's total travel time or travel distance, but not the route paths.

When the route_shape parameter is set to True Shape, or True Shape with Measure, the generalization of the route shape can be further controlled using the appropriate value for the route_ line_simplification_tolerance parameter.

No matter which value you choose for the route_shape parameter, the best route is always determined by minimizing the travel time or the travel distance, never using the straight-line distance between stops. This means that only the route shapes are different, not the underlying streets that are searched when finding the route.

TipTip:

Specifying True Shape or True Shape with Measures creates the most detailed geometry for the output routes. So choosing these options tends to increase the response time for the request and also create larger responses. So use these options only when the exact route shape is required.

route_line_simplification_tolerance

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

NoteNote:
  • The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when travel_mode is set to any other value than Custom. The default value for travel_mode is Driving, so unless you set travel_mode to a different value, this parameter value will be overridden.

  • This parameter is relevant only when route_shape is set to True Shape because the other outputs cannot be simplified further.

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

The parameter is specified as a JSON structure that includes the following properties:

  • distance: The simplification distance value.
  • units: The units for the simplification distance value. The property value should be specified as one of the following values: esriCentimeters, esriDecimalDegrees, esriDecimeters, esriFeet, esriInches, esriKilometers, esriMeters, esriMiles, esriMillimeters, esriNauticalMiles, esriPoints, and esriYards.

The default value for the route_line_simplification_tolerance parameter is 10 meters.

Syntax for specifying route_line_simplification_tolerance
{
    "distance": <value>,
    "units": "<unit>"
}
Example: Specifying route_line_simplification_tolerance of 10 meters
{
    "distance": 10,
    "units": "esriMeters"
}

populate_directions

Use this parameter to specify whether the service should generate driving directions for each route.

  • true—Generate directions. This is the default value. The directions are configued based on the values for the directions_language, directions_style_name, and directions_distance_units parameters.

  • false—Don't generate directions. This is the default value. The service returns an empty value for the features property within the output_directions output parameter.

directions_language

Use this parameter to specify the language that should be used when generating driving directions. This parameter is used only when the populate_directions parameter is set to true. The parameter value can be specified using one of the following values:

  • ar - Generate directions in Arabic
  • cs - Generate directions in Czech
  • de - Generate directions in German
  • el - Generate directions in Greek
  • en (default) - Generate directions in English
  • es - Generate directions in Spanish
  • et - Generate directions in Estonian
  • fr - Generate directions in French
  • he - Generate directions in Hebrew
  • it - Generate directions in Italian
  • ja - Generate directions in Japanese
  • ko - Generate directions in Korean
  • lt - Generate directions in Lithuanian
  • lv - Generate directions in Latvian
  • nl - Generate directions in Dutch
  • pl - Generate directions in Polish
  • pt-BR - Generate directions in Brazilian Portuguese
  • pt-PT - Generate directions in Portuguese (Portugal)
  • ru - Generate directions in Russian
  • sv - Generate directions in Swedish
  • tr - Generate directions in Turkish
  • zh-CN - Simplified Chinese

NoteNote:

If an unsupported language code is specified, the service returns the directions using the default language, English.

directions_distance_units

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

  • Miles (default)
  • Kilometers
  • Meters
  • Feet
  • Yards
  • NauticalMiles

directions_style_name

Use this parameter to specify the name of the formatting style for the directions. This parameter is used only when the populate_directions parameter is set to true. The parameter can be specified using the following values:

  • NA Desktop (default)—Generates turn-by-turn directions suitable for printing.
  • NA Navigation—Generates turn-by-turn directions designed for an in-vehicle navigation device.

impedance

Specify the impedance.

CautionCaution:

The value of this parameter, regardless of whether you rely on its default or explicitly set a value, is overridden when travel_mode is set to any other value than Custom. The default value for travel_mode is Custom.

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

The impedance parameter can be specified using the following values:

  • Drive Time—Models travel times for a car. These travel times can be dynamic, fluctuating according to traffic flows, in areas where traffic data is available.
  • Truck Time (default)—Models travel times for a truck. These travel times are static for each road and don't fluctuate with traffic.
  • Walk Time—Models travel times for a pedestrian. The default walking speed is 5 kilometers per hour (3.1 miles per hour), but you can change that speed through the attribute_parameter_values parameter by setting Walking Speed (km/h) to a different value.
  • Travel Distance—Stores length measurements along roads and paths. To model walk distance, set impedance to Travel Distance and make sure to pass in the restriction parameter with the Walking restriction, which helps ensure the only paths traveled on allow pedestrian traffic. Similarly, to model car or truck distance, set impedance to Travel Distance and set appropriate values for the restrictions and attribute_parameter_values parameters. This will help ensure your vehicle travels only on roads where it is permitted to do so.

If you pass Drive Time, Truck Time, or Walk Time, the measurement_units parameter must be set to a time-based value; if you set impedance to Travel Distance, measurement_units must be distance-based.

analysis_region

Specify the region in which to perform the analysis. If a value is not specified for this parameter, the tool will automatically calculate the region name based on the location of the input points. Setting the name of the region is recommended to speed up the tool execution. To specify a region, use one of the following values:

  • Europe
  • Greece
  • India
  • Japan
  • Korea
  • MiddleEastAndAfrica
  • NorthAmerica
  • Oceania
  • SouthAmerica
  • SouthAsia
  • SouthEastAsia
  • Taiwan
  • Thailand

The data coverage page lists the countries that are grouped into each of these regions.

env:outSR

Use this parameter to specify the spatial reference of the geometries, such as the routes or the directions, returned by the service.

The parameter value can be specified as a well-known ID (WKID) for the spatial reference. If env:outSR is not specified, the geometries are returned in the default spatial reference, WGS84. See Geographic coordinate systems and Projected coordinate systems to look up WKID values.

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

save_route_data

Use this parameter to specify whether the service should create 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 your portal.

  • true—Saves route data. The route data zip file can be downloaded from the URL provided as part of the output_route_data parameter.

  • false—Don't save route data. This is the default value.

save_output_network_analysis_layer

Use this parameter to specify if the service should save the analysis settings as a network analysis layer file. You cannot directly work with this file even when you open the file in an ArcGIS Desktop application like ArcMap. It is meant to be sent to Esri Technical Support in order to diagnose the quality of results returned from the service.

  • true—Saves network analysis layer file. The file can be downloaded from the URL provided as part of the output_network_analysis_layer parameter.

  • false—Don't save network analysis layer file. This is the default value.

overrides

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

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

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

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

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

JSON response

When you submit a request, the service assigns a unique job ID for the transaction. The job ID and the status of the job are returned in the response.

JSON response syntax from the request
{
    "jobId": <jobID>,
    "jobStatus": <jobStatus>
}

The jobStatus property can have the following values:

You can use the job ID to periodically check the status of the job and messages. Additionally, if the job has successfully completed, you can use the job ID to retrive the results or even the inputs. The job information and results remain available for 24 hours after the job is done.

After the initial request is submitted, you can make a request of the following form to get the status of the job:

http://logistics.arcgis.com/arcgis/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities/jobs/<yourJobID>?token=<yourToken>&returnMessages=true&f=json

JSON response syntax during job execution
{
    "jobId": "<jobId>",
    "jobStatus": "<jobStatus>",
    "messages": [
        {
            "type": "<type1>",
            "description": "<description1>"
        },
        {
            "type": "<type2>",
            "description": "<description2>"
        }
    ]
}

While a job is executing, you can cancel it by making a request of the form

http://logistics.arcgis.com/arcgis/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities/jobs/<yourJobID>/cancel?token=<yourToken>&f=json

NoteNote:

When you submit your request, If the service is busy processing other requests, the job will wait in the queue. The job status will be reported as esriJobSubmitted. If your application cannot wait for the entire duration while the job is in the queue, you can cancel the request and submit it at a later time. A canceled request will not incur any service credits. However if your application did not cancel the request, it will eventually execute and will incur service credits irrespective of whether your application retrived the results or ignored them. Hence your application should always cancel the request if required.

After the successful completion of the job, you can make a request of the following form to retrieve the outputs. Refer to the Output Parameters section for more information on how to interpret the solution provided by the service.

http://logistics.arcgis.com/arcgis/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities/jobs/<yourJobID>/results/<output_parameter_name>?token=<yourToken>&f=json

You can also retrieve the value for any input parameter by making the requests of the the following form:

http://logistics.arcgis.com/arcgis/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities/jobs/<yourJobID>/inputs/<inputParameterName>?token=<yourToken>&f=json

Output Parameters

Upon successful execution, the service returns the best route and driving directions between the incident and the chosen facility and the status indicating if the analysis was successful using the following output parameters:

output_closest_facilities

This output parameter gives you access to the facilities that were closest to the incidents. It provides the location of the facilities and attribute information from the corresponding input facilities.

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

  • OID: A unique identifier for the route. This identifier is auto generated by the service.
  • FacilityOID: The ObjectID value of the input facility represented by the output facility. This field is often used to join information from the input facilities.
  • Any fields you included with the input facilities are automatically added as fields to the output closest facilities.

The output_closest_facilities parameter is returned as a JSON feature set with following syntax:

{
    "paramName": "Output_Closest_Facilities",
    "dataType": "GPFeatureRecordSetLayer",
    "value": {
        "displayFieldName": "",
        "geometryType": "esriGeometryPoint",
        "spatialReference": {
            "wkid": <wkid>,
            "latestWkid": <wkid>
        },
        "fields": [
            {
                "name": "<field1Name>",
                "type": "<field1Type>",
                "alias": "<field1Alias>""length": "<field1Length>"
            },
            {
                "name": "<field2Name>",
                "type": "<field2Type>",
                "alias": "<field2Alias>""length": "<field2Length>"
            }
        ],
        "features": [
            {
                "attributes": {
                    "<field1>": <value11>,
                    "<field2>;": <value12>;
                }"geometry": {
                    "x": <x11>,
                    "y": <y11>
                }
            },
            {
                "attributes": {
                    "<field1>": <value21>,
                    "<field2>;": <value22>;
                }"geometry": {
                    "x": <x21>,
                    "y": <y21>
                }
            ],
            "exceededTransferLimit": <true|false>
        }
    }
}

The following shows an example of the output_closest_facilities parameter.

{
    "paramName": "Output_Closest_Facilities",
    "dataType": "GPFeatureRecordSetLayer",
    "value": {
        "displayFieldName": "",
        "geometryType": "esriGeometryPoint",
        "spatialReference": {
            "wkid": 4326,
            "latestWkid": 4326
        },
        "fields": [
            {
                "name": "OID",
                "type": "esriFieldTypeOID",
                "alias": "OID"
            },
            {
                "name": "Name",
                "type": "esriFieldTypeString",
                "alias": "Name",
                "length": 128
            },
            {
                "name": "CurbApproach",
                "type": "esriFieldTypeInteger",
                "alias": "CurbApproach"
            },
            {
                "name": "ORIG_FID",
                "type": "esriFieldTypeSmallInteger",
                "alias": "ORIG_FID"
            }
        ],
        "features": [
            {
                "attributes": {
                    "OID": 1,
                    "Name": "Location 1",
                    "CurbApproach": 0,
                    "ORIG_FID": 1
                },
                "geometry": {
                    "x": -122.45596200044594,
                    "y": 37.75131599973366
                }
            },
            {
                "attributes": {
                    "OID": 2,
                    "Name": "Location 3",
                    "CurbApproach": 0,
                    "ORIG_FID": 3
                },
                "geometry": {
                    "x": -122.45784400000059,
                    "y": 37.74071300000497
                }
            }
        ],
        "exceededTransferLimit": false
    }
}

output_routes

Use this parameter to access the resulting route or routes between the facilities and the incidents. The route_shape and route_line_simplification_tolerance parameters highly influence the shape of the output routes. The route geometries are returned in the spatial reference specified as the env:outSR parameter.

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

  • OID: A unique identifier for the route. This identifier is auto generated by the service.
  • 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 Facility to Incident is specified as the travel_direction parameter. For example, Facility 5—Incident 3 indicates the route travels from Facility 5 to Incident 3.

    If Incident to Facility is specified as the travel_direction parameter, the incident name is first; for instance, Incident 3—Facility 5.

  • FacilityID: The unique ID of the facility the route visits. If the ID attribute is included when specifying the facilities parameter, the FacilityID value is the same as the value for the ID attribute. Otherwise, FacilityID contains an auto-generated identifier.
  • 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.
  • FacilityRank: The rank of the facility among all facilities found for the associated incident; the closest facility has a rank of 1.
  • 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.
  • IncidentID: The unique ID of the incident the route visits. If the ID attribute is included when specifying the incidents parameter, the IncidentID value is same as the value for the ID attribute. Otherwise IncidentID contains an auto-generated identifier.
  • 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.
  • 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.
  • 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.
  • Total_Minutes: The cumulative travel time in minutes of the route between the facility and the incident.
  • Total_Miles: The cumulative travel distance in miles of the route between the facility and the incident.
  • Total_Kilometers: The cumulative travel distance in kilometers of the route between the facility and the incident.
  • StartTime:The start time of the route, reported as local time at the first stop.
  • EndTime:The end time of the route, reported as local time at the last stop.
  • StartTimeUTC:The start time of the route in Coordinated Universal Time (UTC).
  • EndTimeUTC:The end time of the route in Coordinated Universal Time (UTC).
NoteNote:

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.

The output_routes parameter is returned as a JSON feature set with following syntax:

{
    "paramName": "Output_Routes",
    "dataType": "GPFeatureRecordSetLayer",
    "value": {
        "displayFieldName": "",
        "geometryType": "esriGeometryPolyline",
        "spatialReference": {
            "wkid": <wkid>,
            "latestWkid": <wkid>,
            
        },
        "fields": [
            {
                "name": "<field1Name>",
                "type": "<field1Type>",
                "alias": "<field1Alias>",
                "length": "<field1Length>" //length is included only for esriFieldTypeString
            },
            {
                "name": "<field2Name>",
                "type": "<field2Type>",
                "alias": "<field2Alias>",
                "length": "<field2Length>"
            }
        ],
        "features": [
            {
                "geometry": {
                    "paths": [
                        [
                            [
                                <x11>,
                                <y11>
                            ],
                            [
                                <x12>,
                                <y12>
                            ]
                        ],
                        [
                            [
                                <x21>,
                                <y21>
                            ],
                            [
                                <x22>,
                                <y22>
                            ]
                        ]
                    ]
                },
                "attributes": {
                    "<field1>": <value11>,
                    "<field2>": <value12>
                }
            },
            {
                "geometry": {
                    "paths": [
                        [
                            [
                                <x11>,
                                <y11>
                            ],
                            [
                                <x12>,
                                <y12>
                            ]
                        ],
                        [
                            [
                                <x21>,
                                <y21>
                            ],
                            [
                                <x22>,
                                <y22>
                            ]
                        ]
                    ]
                },
                "attributes": {
                    "<field1>": <value21>,
                    "<field2>": <value22>
                }
            }
        ],
        "exceededTransferLimit": <true|false>
    }
}

The following shows an example of the output_routes parameter.

NoteNote:

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

{
    "paramName": "Output_Routes",
    "dataType": "GPFeatureRecordSetLayer",
    "value": {
        "displayFieldName": "",
        "geometryType": "esriGeometryPolyline",
        "spatialReference": {
            "wkid": 4326,
            "latestWkid": 4326
        },
        "fields": [
            {
                "name": "OID",
                "type": "esriFieldTypeOID",
                "alias": "OID"
            },
            {
                "name": "FacilityID",
                "type": "esriFieldTypeString",
                "alias": "FacilityID",
                "length": 50
            },
            {
                "name": "FacilityRank",
                "type": "esriFieldTypeInteger",
                "alias": "FacilityRank"
            },
            {
                "name": "Name",
                "type": "esriFieldTypeString",
                "alias": "Name",
                "length": 128
            },
            {
                "name": "IncidentCurbApproach",
                "type": "esriFieldTypeInteger",
                "alias": "IncidentCurbApproach"
            },
            {
                "name": "FacilityCurbApproach",
                "type": "esriFieldTypeInteger",
                "alias": "FacilityCurbApproach"
            },
            {
                "name": "IncidentID",
                "type": "esriFieldTypeString",
                "alias": "IncidentID",
                "length": 50
            },
            {
                "name": "Total_Miles",
                "type": "esriFieldTypeDouble",
                "alias": "Total_Miles"
            },
            {
                "name": "Total_Kilometers",
                "type": "esriFieldTypeDouble",
                "alias": "Total_Kilometers"
            },
            {
                "name": "Total_Minutes",
                "type": "esriFieldTypeDouble",
                "alias": "Total_Minutes"
            },
            {
                "name": "Shape_Length",
                "type": "esriFieldTypeDouble",
                "alias": "Shape_Length"
            }
        ],
        "features": [
            {
                "attributes": {
                    "OID": 1,
                    "FacilityID": "3",
                    "FacilityRank": 1,
                    "Name": "Station 39 - Fire Incident",
                    "IncidentCurbApproach": 2,
                    "FacilityCurbApproach": 1,
                    "IncidentID": "1",
                    "Total_Miles": 0.6491655620477702,
                    "Total_Kilometers": 1.0447307022882064,
                    "Total_Minutes": 1.4172383469037848,
                    "Shape_Length": 0.010797590608192222
                },
                "geometry": {
                    "paths": [
                        [
                            [
                                -122.45787965542172,
                                37.74080213810822
                            ],
                            [
                                -122.45748000030176,
                                37.740979999727244
                            ],
                        ....
                        .... additional points in the route part
                        .... 
                        ]
                    ]
                }
            },
            {
                "attributes": {
                    "OID": 2,
                    "FacilityID": "1",
                    "FacilityRank": 2,
                    "Name": "Station 20 - Fire Incident",
                    "IncidentCurbApproach": 1,
                    "FacilityCurbApproach": 1,
                    "IncidentID": "1",
                    "Total_Miles": 0.5794746525076059,
                    "Total_Kilometers": 0.9325740551652006,
                    "Total_Minutes": 1.5610809309860056,
                    "Shape_Length": 0.009809811689090443
                },
                "geometry": {
                    "paths": [
                        [
                            [
                                -122.45596098061475,
                                37.75135883264409
                            ],
                            [
                                -122.45440000035967,
                                37.75123999982617
                            ],
						                  ....
                        .... additional points in the route part
                        .... 
                            
                        ]
                    ]
                }
            }
        ],
        "exceededTransferLimit": false
    }
}

output_directions

Use this parameter to access the turn-by-turn driving directions for each resulting route between the facilities and the incidents. 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 thepopulate_directions parameter is false. The directions_language, directions_distance_units and the directions_style_name parameters highly influence the driving directions.

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

  • ObjectID: A unique identifier for the directions feature. This identifier is auto generated by the service.
  • RouteName: The name of the route that the driving action applies to. This value is same as the Name attribute from output_routes parameter.
  • ArriveTime: The time of day to initiate the given driving action. The value is reported as milliseconds since midnight January 1, 1970.
  • Type: Indicates the type of maneuver that the direction 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 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 applications

    The Type value is an integer from the Maneuver Types or the Directions String Types tables 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 direction.
  • ElapsedTime: 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.

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

The output_directions parameter is returned as a JSON feature set with following syntax:

CautionCaution:

The service can only return a maximum of 100,000 features with the output_directions parameter. If this limit is exceeded, the exceededTransferLimit property is set to true.

{
    "paramName": "Output_Directions",
    "dataType": "GPFeatureRecordSetLayer",
    "value": {
        "displayFieldName": "",
        "geometryType": "esriGeometryPolyline",
        "spatialReference": {
            "wkid": <wkid>,
            "latestWkid": <wkid>,
            
        },
        "fields": [
            {
                "name": "<field1Name>",
                "type": "<field1Type>",
                "alias": "<field1Alias>",
                "length": "<field1Length>" //length is included only for esriFieldTypeString
            },
            {
                "name": "<field2Name>",
                "type": "<field2Type>",
                "alias": "<field2Alias>",
                "length": "<field2Length>"
            }
        ],
        "features": [
            {
                "geometry": {
                    "paths": [
                        [
                            [
                                <x11>,
                                <y11>
                            ],
                            [
                                <x12>,
                                <y12>
                            ]
                        ],
                        [
                            [
                                <x21>,
                                <y21>
                            ],
                            [
                                <x22>,
                                <y22>
                            ]
                        ]
                    ]
                },
                "attributes": {
                    "<field1>": <value11>,
                    "<field2>": <value12>
                }
            },
            {
                "geometry": {
                    "paths": [
                        [
                            [
                                <x11>,
                                <y11>
                            ],
                            [
                                <x12>,
                                <y12>
                            ]
                        ],
                        [
                            [
                                <x21>,
                                <y21>
                            ],
                            [
                                <x22>,
                                <y22>
                            ]
                        ]
                    ]
                },
                "attributes": {
                    "<field1>": <value21>,
                    "<field2>": <value22>
                }
            }
        ],
        "exceededTransferLimit": <true|false>
    }
}

The following shows an example of the output_directions parameter:

NoteNote:

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

{
    "paramName": "Output_Directions",
    "dataType": "GPFeatureRecordSetLayer",
    "value": {
        "displayFieldName": "",
        "geometryType": "esriGeometryPolyline",
        "spatialReference": {
            "wkid": 4326,
            "latestWkid": 4326
        },
        "fields": [
            {
                "name": "ObjectID",
                "type": "esriFieldTypeOID",
                "alias": "ObjectID"
            },
            {
                "name": "RouteName",
                "type": "esriFieldTypeString",
                "alias": "RouteName",
                "length": 128
            },
            {
                "name": "ArriveTime",
                "type": "esriFieldTypeDate",
                "alias": "ArriveTime",
                "length": 16
            },
            {
                "name": "Type",
                "type": "esriFieldTypeSmallInteger",
                "alias": "Type"
            },
            {
                "name": "SubItemType",
                "type": "esriFieldTypeSmallInteger",
                "alias": "SubItemType"
            },
            {
                "name": "Text",
                "type": "esriFieldTypeString",
                "alias": "Text",
                "length": 255
            },
            {
                "name": "ElapsedTime",
                "type": "esriFieldTypeSingle",
                "alias": "ElapsedTime"
            },
            {
                "name": "DriveDistance",
                "type": "esriFieldTypeSingle",
                "alias": "DriveDistance"
            },
            {
                "name": "Shape_Length",
                "type": "esriFieldTypeDouble",
                "alias": "Shape_Length"
            }
        ],
        "features": [
            {
                "attributes": {
                    "ObjectID": 1,
                    "RouteName": "Station 39 - Fire Incident",
                    "ArriveTime": 1365637673000,
                    "Type": 18,
                    "SubItemType": 1,
                    "Text": "Start at Station 39",
                    "ElapsedTime": 0,
                    "DriveDistance": 0,
                    "Shape_Length": 0
                }
            },
            {
                "attributes": {
                    "ObjectID": 2,
                    "RouteName": "Station 39 - Fire Incident",
                    "ArriveTime": 1365637673000,
                    "Type": 2,
                    "SubItemType": 1,
                    "Text": "Go northeast on PORTOLA DR toward REX AVE",
                    "ElapsedTime": 1.044524,
                    "DriveDistance": 0.5254771,
                    "Shape_Length": 0.008828940635196278
                },
                "geometry": {
                    "paths": [
                        [
                            [
                                -122.45787965542172,
                                37.74080213810822
                            ],
                            [
                                -122.45748000030176,
                                37.740979999727244
                            ],
                            ....
                            .... additional points in the route path
                            .... 
                        ]
                    ]
                }
            },
            ....
			         .... additional directions features 
			         ....
            {
                "attributes": {
                    "ObjectID": 5,
                    "RouteName": "Station 39 - Fire Incident",
                    "ArriveTime": 1365637758034,
                    "Type": 1,
                    "SubItemType": 1,
                    "Text": "Finish at Fire Incident",
                    "ElapsedTime": 0,
                    "DriveDistance": 0,
                    "Shape_Length": 0
                }
            },
            {
                "attributes": {
                    "ObjectID": 6,
                    "RouteName": "Station 20 - Fire Incident",
                    "ArriveTime": 1365637673000,
                    "Type": 18,
                    "SubItemType": 1,
                    "Text": "Start at Station 20",
                    "ElapsedTime": 0,
                    "DriveDistance": 0,
                    "Shape_Length": 0
                }
            },
            {
                "attributes": {
                    "ObjectID": 7,
                    "RouteName": "Station 20 - Fire Incident",
                    "ArriveTime": 1365637673000,
                    "Type": 2,
                    "SubItemType": 1,
                    "Text": "Go east on OLYMPIA WAY toward DELLBROOK AVE",
                    "ElapsedTime": 0.5452001,
                    "DriveDistance": 0.2105566,
                    "Shape_Length": 0.003820738935246935
                },
                "geometry": {
                    "paths": [
                        [
                            [
                                -122.45596098061475,
                                37.75135883264409
                            ],
                            [
                                -122.45516999989553,
                                37.75133999994108
                            ],
							                     ....
                            .... additional points in the route path
                            .... 
                            
                        ]
                    ]
                }
            },
            ....
			         .... additional directions features
			         ....
            {
                "attributes": {
                    "ObjectID": 9,
                    "RouteName": "Station 20 - Fire Incident",
                    "ArriveTime": 1365637766665,
                    "Type": 1,
                    "SubItemType": 1,
                    "Text": "Finish at Fire Incident",
                    "ElapsedTime": 0,
                    "DriveDistance": 0,
                    "Shape_Length": 0
                }
            }
        ],
        "exceededTransferLimit": false
    }
}

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.

The solve_succeeded parameter is returned as a JSON feature set with following syntax:

{
    "paramName": "Solve_Succeeded",
    "dataType": "GPBoolean",
    "value": <true | false>
}

The following shows an example of the solve_succeeded parameter:

{
    "paramName": "Solve_Succeeded",
    "dataType": "GPBoolean",
    "value": true
}

Usage limits

The table below lists the limits that apply to this service.

Limit Description

Limit Value

Maximum number of incidents:

1,000

Maximum number of facilities:

1,000

Maximum number of facilities to find (per incident):

100

Maximum number of (point) barriers:

250

Maximum number of street features intersected by polyline barriers:

500

Maximum number of street features intersected by polygon barriers:

2,000

Maximum straight-line distance for the walking travel mode:

(If the straight-line distance between any facility and incident is greater than this limit, the analysis will fail when the waking option for travel_mode is chosen.)

50 miles (80.46 kilometers)

Force hierarchy beyond a straight-line distance of:

(If the straight-line distance between any facility and incident is greater than the limit shown here, the analysis uses hierarchy, even if useHierarchy is set to false.)

50 miles (80.46 kilometers)

Maximum snap tolerance:

(If the distance between an input point and its nearest traversable street is greater than the distance specified here, the point is excluded from the analysis.)

12.42 miles (20 kilometers)

Maximum number of directions features that can be returned:

100,000

Maximum time a client can use the asynchronous closest facility service:

1 hour (3,600 seconds)

Examples

NoteNote:

If you copy and paste the request URL from the examples into a web browser, you will get an invalid token error message. You need to replace <yourToken> with a valid token. See Accessing services provided by Esri to see how to generate one.

Finding the closest fire stations.

In this example, you will find the two fire stations that can provide the quickest response to a fire at a given address. You will also generate routes and driving directions for the firefighters to follow.

All the fire stations in the neighborhood are specified as the facilities parameter and the location of the fire is specified as the incidents parameter. In order to include the name of the fire station in the driving directions, we specify the name as the attribute of the facilities. For facilities and incidents, the geometries are in the default spatial reference, WGS84. So the spatialReference property is not required.

As we want to model the fire engines traveling from the stations to the location of the fire, we specify Facility to Incident as the value for the travel_direction parameter. We need to find two closest fire stations within three minutes of the fire. So we specify 2 as the value for the number_of_facilities_to_find parameter and 3 as the value for the cutoff parameter. We need to calculate the best routes that account for the current traffic conditions. So we specify the current time as the time_of_day parameter and specify Start Time as the time_of_day_usage parameter.

Request URL to submit the job

The first request is to submit a job which returns the job id.

https://logistics.arcgis.com/arcgis/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities/submitJob?token=<yourToken>&incidents={"features":[{"geometry":{"x":-122.449614,"y":37.746712},"attributes":{"Name":"Fire Incident"}}]}&facilities={"features":[{"geometry":{"x":-122.455962,"y":37.751316},"attributes":{"Name":"Station 20"}},{"geometry":{"x":-122.440825,"y":37.753199},"attributes":{"Name":"Station 24"}},{"geometry":{"x":-122.457844,"y":37.740713},"attributes":{"Name":"Station 39"}}]}&travel_direction=Facility to Incident&number_of_facilities_to_find=2&cutoff=3&time_of_day=1365637673000&time_of_day_usage=Start Time&populate_directions=true&f=json

JSON response

{
    "jobId": "j4459787f65404b439dac83a70d042e98",
    "jobStatus": "esriJobSubmitted"
}

Request URL to query job status

The job ID obtained from the response of the first request can be queried periodically to determine the status of the job.

https://logistics.arcgis.com/arcgis/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities/jobs/<yourJobID>/?token=<yourToken>&returnMessages=true&f=json

JSON response

{
    "jobId": "j4459787f65404b439dac83a70d042e98",
    "jobStatus": "esriJobSucceeded",
    "results": {
        "Output_Routes": {
            "paramUrl": "results/Output_Routes"
        },
        "Output_Directions": {
            "paramUrl": "results/Output_Directions"
        },
        "Solve_Succeeded": {
            "paramUrl": "results/Solve_Succeeded"
        },
        "Output_Closest_Facilities": {
            "paramUrl": "results/Output_Closest_Facilities"
        }
    },
    "inputs": {
        "Incidents": {
            "paramUrl": "inputs/Incidents"
        },
        "Facilities": {
            "paramUrl": "inputs/Facilities"
        },
        "Measurement_Units": {
            "paramUrl": "inputs/Measurement_Units"
        },
        "Analysis_Region": {
            "paramUrl": "inputs/Analysis_Region"
        },
        "Number_of_Facilities_to_Find": {
            "paramUrl": "inputs/Number_of_Facilities_to_Find"
        },
        "Cutoff": {
            "paramUrl": "inputs/Cutoff"
        },
        "Travel_Direction": {
            "paramUrl": "inputs/Travel_Direction"
        },
        "Use_Hierarchy": {
            "paramUrl": "inputs/Use_Hierarchy"
        },
        "Time_of_Day": {
            "paramUrl": "inputs/Time_of_Day"
        },
        "Time_of_Day_Usage": {
            "paramUrl": "inputs/Time_of_Day_Usage"
        },
        "UTurn_at_Junctions": {
            "paramUrl": "inputs/UTurn_at_Junctions"
        },
        "Point_Barriers": {
            "paramUrl": "inputs/Point_Barriers"
        },
        "Line_Barriers": {
            "paramUrl": "inputs/Line_Barriers"
        },
        "Polygon_Barriers": {
            "paramUrl": "inputs/Polygon_Barriers"
        },
        "Restrictions": {
            "paramUrl": "inputs/Restrictions"
        },
        "Attribute_Parameter_Values": {
            "paramUrl": "inputs/Attribute_Parameter_Values"
        },
        "Route_Shape": {
            "paramUrl": "inputs/Route_Shape"
        },
        "Route_Line_Simplification_Tolerance": {
            "paramUrl": "inputs/Route_Line_Simplification_Tolerance"
        },
        "Populate_Directions": {
            "paramUrl": "inputs/Populate_Directions"
        },
        "Directions_Language": {
            "paramUrl": "inputs/Directions_Language"
        },
        "Directions_Distance_Units": {
            "paramUrl": "inputs/Directions_Distance_Units"
        },
        "Directions_Style_Name": {
            "paramUrl": "inputs/Directions_Style_Name"
        }
    },
    "messages": []
}

Request URL to return output closest facilities

Because the job succeeded, a request can be made to return the facilities that are closest to the incidents. The output parameter used to retrieve these results is output_closest_facilities.

https://logistics.arcgis.com/arcgis/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities/jobs/<yourJobID>/results/output_closest_facilities?token=<yourToken>&returnMessages=true&f=json

JSON response

The output closest facilities are essentially duplicates of the input facilities, but they exclude any facilities that weren't reached.

{
    "paramName": "Output_Closest_Facilities",
    "dataType": "GPFeatureRecordSetLayer",
    "value": {
        "displayFieldName": "",
        "geometryType": "esriGeometryPoint",
        "spatialReference": {
            "wkid": 4326,
            "latestWkid": 4326
        },
        "fields": [
            {
                "name": "OID",
                "type": "esriFieldTypeOID",
                "alias": "OID"
            },
            {
                "name": "Name",
                "type": "esriFieldTypeString",
                "alias": "Name",
                "length": 50
            },
            {
                "name": "ID",
                "type": "esriFieldTypeString",
                "alias": "ID",
                "length": 50
            },
            {
                "name": "AdditionalTime",
                "type": "esriFieldTypeDouble",
                "alias": "Additional Time"
            },
            {
                "name": "AdditionalDistance",
                "type": "esriFieldTypeDouble",
                "alias": "Additional Distance"
            },
            {
                "name": "CurbApproach",
                "type": "esriFieldTypeSmallInteger",
                "alias": "Curb Approach"
            },
            {
                "name": "ORIG_FID",
                "type": "esriFieldTypeSmallInteger",
                "alias": "ORIG_FID"
            }
        ],
        "features": [
            {
                "attributes": {
                    "OID": 1,
                    "Name": "Station 20",
                    "ID": null,
                    "AdditionalTime": 0,
                    "AdditionalDistance": 0,
                    "CurbApproach": 0,
                    "ORIG_FID": 1
                },
                "geometry": {
                    "x": -122.45596200044594,
                    "y": 37.75131599973366
                }
            },
            {
                "attributes": {
                    "OID": 2,
                    "Name": "Station 39",
                    "ID": null,
                    "AdditionalTime": 0,
                    "AdditionalDistance": 0,
                    "CurbApproach": 0,
                    "ORIG_FID": 3
                },
                "geometry": {
                    "x": -122.45784400000059,
                    "y": 37.74071300000497
                }
            }
        ],
        "exceededTransferLimit": false
    }
}

Request URL to return the output routes

Because the job succeeded, a request can be made to return the routes from the output_routes output parameter.

https://logistics.arcgis.com/arcgis/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities/jobs/<yourJobID>/results/output_routes?token=<yourToken>&returnMessages=true&f=json

JSON response

Note that output_routes includes routes from two of the three fire stations to the fire incident since the two fire stations are closest to the fire incident based on the travel time. The name of the fire station and the incident name are used to construct the Name attribute for each route.

NoteNote:

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

{
    "paramName": "Output_Routes",
    "dataType": "GPFeatureRecordSetLayer",
    "value": {
        "displayFieldName": "",
        "geometryType": "esriGeometryPolyline",
        "spatialReference": {
            "wkid": 4326,
            "latestWkid": 4326
        },
        "fields": [
            {
                "name": "OID",
                "type": "esriFieldTypeOID",
                "alias": "OID"
            },
            {
                "name": "FacilityID",
                "type": "esriFieldTypeString",
                "alias": "FacilityID",
                "length": 50
            },
            {
                "name": "FacilityRank",
                "type": "esriFieldTypeInteger",
                "alias": "FacilityRank"
            },
            {
                "name": "Name",
                "type": "esriFieldTypeString",
                "alias": "Name",
                "length": 128
            },
            {
                "name": "IncidentCurbApproach",
                "type": "esriFieldTypeInteger",
                "alias": "IncidentCurbApproach"
            },
            {
                "name": "FacilityCurbApproach",
                "type": "esriFieldTypeInteger",
                "alias": "FacilityCurbApproach"
            },
            {
                "name": "IncidentID",
                "type": "esriFieldTypeString",
                "alias": "IncidentID",
                "length": 50
            },
            {
                "name": "Total_Minutes",
                "type": "esriFieldTypeDouble",
                "alias": "Total_Minutes"
            },
            {
                "name": "Total_Miles",
                "type": "esriFieldTypeDouble",
                "alias": "Total_Miles"
            },
            {
                "name": "FacilityOID",
                "type": "esriFieldTypeInteger",
                "alias": "FacilityOID"
            },
            {
                "name": "IncidentOID",
                "type": "esriFieldTypeInteger",
                "alias": "IncidentOID"
            },
            {
                "name": "Total_Kilometers",
                "type": "esriFieldTypeDouble",
                "alias": "Total_Kilometers"
            },
            {
                "name": "Shape_Length",
                "type": "esriFieldTypeDouble",
                "alias": "Shape_Length"
            }
        ],
        "features": [
            {
                "attributes": {
                    "OID": 1,
                    "FacilityID": "1",
                    "FacilityRank": 1,
                    "Name": "Station 20 - Fire Incident",
                    "IncidentCurbApproach": 1,
                    "FacilityCurbApproach": 1,
                    "IncidentID": "1",
                    "Total_Minutes": 1.4635369356153203,
                    "Total_Miles": 0.5767923258767018,
                    "FacilityOID": 1,
                    "IncidentOID": 1,
                    "Total_Kilometers": 0.92826,
                    "Shape_Length": 0.009809810977047043
                },
                "geometry": {
                    "paths": [
                        [
                            [
                                -122.45596097999999,
                                37.75135883300004
                            ],
                            [
                                -122.45439999999996,
                                37.75124000000005
                            ],
							                     ...
							                     ... additional points in the route part
							                     ...                            
                        ]
                    ]
                }
            },
            {
                "attributes": {
                    "OID": 2,
                    "FacilityID": "3",
                    "FacilityRank": 2,
                    "Name": "Station 39 - Fire Incident",
                    "IncidentCurbApproach": 2,
                    "FacilityCurbApproach": 1,
                    "IncidentID": "1",
                    "Total_Minutes": 1.738154678946342,
                    "Total_Miles": 0.6440599460986813,
                    "FacilityOID": 3,
                    "IncidentOID": 1,
                    "Total_Kilometers": 1.03651,
                    "Shape_Length": 0.010791093352716757
                },
                "geometry": {
                    "paths": [
                        [
                            [
                                -122.45787965499994,
                                37.74080213800005
                            ],
                            [
                                -122.45747999999998,
                                37.740980000000036
                            ],
							                     ...
							                     ... additional points in the route part
							                     ...							
                        ]
                    ]
                }
            }
        ],
        "exceededTransferLimit": false
    }
}

Request URL to return output directions

Because the job succeeded, a request can be made to return the driving directions between the two closest fire stations and the fire incident from the output_directions output parameter.

https://logistics.arcgis.com/arcgis/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities/jobs/<yourJobID>/results/output_directions?token=<yourToken>&returnMessages=true&f=json

JSON response

The output directions include the driving directions as well as the geometry for the directions feature. Note that for each route, the first directions feature only includes the attributes property that contains the directions text. The subsequent directions features include the geometry property that is derived from the underlying streets included in the route along with the attributes property. The name of the fire stations and the incident are used in the driving directions.

NoteNote:

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

{
    "paramName": "Output_Directions",
    "dataType": "GPFeatureRecordSetLayer",
    "value": {
        "displayFieldName": "",
        "geometryType": "esriGeometryPolyline",
        "spatialReference": {
            "wkid": 4326,
            "latestWkid": 4326
        },
        "fields": [
            {
                "name": "ObjectID",
                "type": "esriFieldTypeOID",
                "alias": "ObjectID"
            },
            {
                "name": "RouteName",
                "type": "esriFieldTypeString",
                "alias": "RouteName",
                "length": 128
            },
            {
                "name": "ArriveTime",
                "type": "esriFieldTypeDate",
                "alias": "ArriveTime",
                "length": 16
            },
            {
                "name": "Type",
                "type": "esriFieldTypeSmallInteger",
                "alias": "Type"
            },
            {
                "name": "SubItemType",
                "type": "esriFieldTypeSmallInteger",
                "alias": "SubItemType"
            },
            {
                "name": "Text",
                "type": "esriFieldTypeString",
                "alias": "Text",
                "length": 255
            },
            {
                "name": "ElapsedTime",
                "type": "esriFieldTypeSingle",
                "alias": "ElapsedTime"
            },
            {
                "name": "DriveDistance",
                "type": "esriFieldTypeSingle",
                "alias": "DriveDistance"
            },
            {
                "name": "Shape_Length",
                "type": "esriFieldTypeDouble",
                "alias": "Shape_Length"
            }
        ],
        "features": [
            {
                "attributes": {
                    "ObjectID": 1,
                    "RouteName": "Station 20 - Fire Incident",
                    "ArriveTime": 1365637673000,
                    "Type": 18,
                    "SubItemType": 1,
                    "Text": "Start at Station 20",
                    "ElapsedTime": 0,
                    "DriveDistance": 0,
                    "Shape_Length": 0
                }
            },
            {
                "attributes": {
                    "ObjectID": 2,
                    "RouteName": "Station 20 - Fire Incident",
                    "ArriveTime": 1365637673000,
                    "Type": 2,
                    "SubItemType": 1,
                    "Text": "Go east on Olympia Way toward Dellbrook Ave",
                    "ElapsedTime": 0.5476729,
                    "DriveDistance": 0.2098574,
                    "Shape_Length": 0.0038207383571576604
                },
                "geometry": {
                    "paths": [
                        [
                            [
                                -122.45596097999999,
                                37.75135883300004
                            ],
                            [
                                -122.45516999999995,
                                37.75134000000003
                            ],
							                     ...
                     							...additional points in the route path
                     							...
                        ]
                    ]
                }
            },
            ...
			         ...additional directions features
         			...
            {
                "attributes": {
                    "ObjectID": 4,
                    "RouteName": "Station 20 - Fire Incident",
                    "ArriveTime": 1365637760812,
                    "Type": 1,
                    "SubItemType": 1,
                    "Text": "Finish at Fire Incident",
                    "ElapsedTime": 0,
                    "DriveDistance": 0,
                    "Shape_Length": 0
                }
            },
            {
                "attributes": {
                    "ObjectID": 5,
                    "RouteName": "Station 39 - Fire Incident",
                    "ArriveTime": 1365637673000,
                    "Type": 18,
                    "SubItemType": 1,
                    "Text": "Start at Station 39",
                    "ElapsedTime": 0,
                    "DriveDistance": 0,
                    "Shape_Length": 0
                }
            },
            {
                "attributes": {
                    "ObjectID": 6,
                    "RouteName": "Station 39 - Fire Incident",
                    "ArriveTime": 1365637673000,
                    "Type": 2,
                    "SubItemType": 1,
                    "Text": "Go northeast on Portola Dr toward Rex Ave",
                    "ElapsedTime": 1.350187,
                    "DriveDistance": 0.5206896,
                    "Shape_Length": 0.008828940334549
                },
                "geometry": {
                    "paths": [
                        [
                            [
                                -122.45787965499994,
                                37.74080213800005
                            ],
                            [
                                -122.45747999999998,
                                37.740980000000036
                            ],
							                     ...
                     							...additional points in the route path
                     							...
                        ]
                    ]
                }
            },
			         ...
         			...additional directions features
         			...
            {
                "attributes": {
                    "ObjectID": 9,
                    "RouteName": "Station 39 - Fire Incident",
                    "ArriveTime": 1365637777289,
                    "Type": 1,
                    "SubItemType": 1,
                    "Text": "Finish at Fire Incident",
                    "ElapsedTime": 0,
                    "DriveDistance": 0,
                    "Shape_Length": 0
                }
            }
        ],
        "exceededTransferLimit": false
    }
}
10/6/2017