Traffic service

Closest Facility service with synchronous execution

In this topic

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.

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 result. When using the synchronous execution mode, the application must wait for the request to finish and get the results. This execution mode is well-suited for requests that complete quickly (under 10 seconds). When using the asynchronous execution mode, the client must periodically check whether the service has finished execution and, once completed, get the result. While the service is executing, the application is available to do other things. This execution mode is well-suited for requests that take a long time to complete because it allows users to continue to interact with the application while the results are generated.

While the service supports the same functionality irrespective of execution mode, 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 5,000, the maximum number of incidents to 5,000, and the maximum number of facilities to find from each incident to 100. So, for example, if you are finding the closest facilities from a total of 100 or fewer, you can use the synchronous execution mode. However, if your application needs to support adding more than 100 facilities in a request, you need to use the asynchronous execution mode.

Caution:

The maximum time an application can use the closest facility service when using the synchronous execution mode is 5 minutes (300 seconds). If your request does not complete within this time frame, it will time out and return a failure.

Dive-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 a region. When you pass in your input incidents and facilities, the service determines the region containing all of the inputs based on the location of the first incident. The service does not support requests that span more than one region. Consequently, routes will be found only between those incidents and facilities that are in the same region as the first incident.

Request parameters

The closest facility request takes the following parameters. The only required parameters are incidents, facilities, token and f. The optional parameters have default values which will be used if the parameter is 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.

Caution:

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

You can use a simple comma- and semicolon-based syntax if you need to specify only incident point geometries in the default spatial reference WGS84 such as the longitude and latitude values.

Simple syntax for incidents

incidents=x1,y1; x2, y2; ...; xn, yn

Example using simple syntax

incidents=-117.1957,34.0564; -117.184,34.0546

You can specify incident geometries as well as attributes using a more comprehensive 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 property must be specified.

features: Specify an array of features. This property is optional. However, either the features or the url property must be specified.

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

geometry: Specifies the incident geometry as a point containing x and y properties along with a spatialReference property. The spatialReference 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.

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 using JSON structure, you can specify additional properties for incidents such as their names using attributes. The incidents parameter can be specified with the following attributes:

Name: The name of the incident. This name is used when generating driving directions. It is common to pass the actual name or street address for the incident as a value for Name attribute. If a value is not specified, an autogenerated name such as Location 1 or Location 2 is used for each incident.

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 might have come across when using ArcGIS Network Analyst extension software.

Setting

Coded value

Description

Either side of vehicle

0

The vehicle can approach and depart the incident in either direction, so a U-turn is allowed at the incident. This setting can be chosen if it is possible and desirable for your vehicle to turn around at the incident. This decision may depend on the width of the road and the amount of traffic or whether the incident has a parking lot where vehicles can pull in and turn around.All arrival and departure combinations are allowed with the Either side of vehicle curb approach.

Right side of vehicle

1

When the vehicle approaches and departs the incident, the incident must be on the right side of the vehicle. A U-turn is prohibited. This is typically used for vehicles like busses that must arrive with the bus stop on the right hand side.The allowed arrival and departure combination for the Right side of vehicle curb approach.

Left side of vehicle

2

When the vehicle approaches and departs the incident, the incident must be on the left side of the vehicle. A U-turn is prohibited. This is typically used for vehicles like busses that must arrive with the bus stop on the left hand side.The allowed arrival and departure combination for the Left side of vehicle curb approach.

No U-Turn

3

When the vehicle approaches the incident, the incident can be on either side of the vehicle; however, when it departs, the vehicle must continue in the same direction it arrived in. A U-turn is prohibited.The allowed arrival and departure combinations for the No U-Turn curb approach.

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 from the right or left side. 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 in the United States but Left side of vehicle in the United Kingdom.

With right-hand traffic, the curb approach that leaves the vehicle closest to the incident is Right side of vehicle.

With left-hand traffic, the curb approach that leaves the vehicle closest to the incident is Left side of vehicle.

Attr_TravelTime: Specifies the amount of time for cars, in minutes, that will be 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 value for this attribute is included in the total travel time for the route and is also displayed in driving directions as service time. A zero or null value indicates that the incident requires no service time. The default value is 0.

Attr_TruckTravelTime: Specifies the amount of time for trucks, in minutes, that will be 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.

The value for this attribute is included in the total travel time for the route and is also displayed in driving directions as service time. A zero or null value indicates that the incident requires no service time. The default value is 0.

Attr_WalkTime: Specifies the amount of time for pedestrians, in minutes, that will be 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.

The value for this attribute is included in the total travel time for the route and is also displayed in walking directions as service time. A zero or null value indicates that the incident requires no service time. The default value is 0.

Attr_Miles: Specifies the distance in miles that will be 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 default value is 0.

Attr_Kilometers: Specifies the distance in kilometers 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 default value is 0.

Cutoff_TravelTime: Specify the travel time for cars, in minutes, at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched.

If Cutoff_TravelTime is not set for an incident, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_TravelTime attribute allows the ability to overwrite the defaultCutoff value on a per incident basis. The default value for this attribute is null which indicates not to use any cutoff.

Cutoff_TruckTravelTime: Specify the travel time for trucks, in minutes, at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched.

If Cutoff_TruckTravelTime is not set for an incident, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_TruckTravelTime attribute allows the ability to overwrite the defaultCutoff value on a per incident basis. The default value for this attribute is null which indicates not to use any cutoff.

Cutoff_WalkTime: Specify the travel time for pedestrians, in minutes, at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched.

If Cutoff_WalkTime is not set for an incident, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_WalkTime attribute allows the ability to overwrite the defaultCutoff value on a per incident basis. The default value for this attribute is null which indicates not to use any cutoff.

Cutoff_Miles: Specify the travel distance in miles at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched.

If Cutoff_Miles is not set for an incident, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_Miles attribute allows the ability to overwrite the defaultCutoff value on a per incident basis. The default value for this attribute is null which indicates not to use any cutoff.

Cutoff_Kilometers: Specify the travel distance in kilometers at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched.

If Cutoff_Kilometers is not set for an incident, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_Kilometers attribute allows the ability to overwrite the defaultCutoff value on a per incident basis. The default value for this attribute is null which indicates not to use any cutoff.

TargetFacilityCount: Specify the number of facilities that need to be found for the incident.

If TargetFacilityCount is not set for an incident, the service will use the value specified as the defaultTargetFacilityCount parameter. The value for the TargetFacilityCount attribute allows the ability to overwrite the defaultTargetFacilityCount value on a per incident basis. The default value for this attribute is null which causes the service to use the value set for the defaultTargetFacilityCount parameter. If the TargetFacilityCount attribute is set to a value other than null, the defaultTargetFacilityCount value is overwritten.

Bearing: Specify the direction the vehicle or person is moving in. Bearing is measured clockwise from true north and must be in degrees. Typically, values are between 0 and 360; however, negative values are interpreted by subtracting them from 360 degrees.

BearingTol: Short for bearing tolerance, this field specifies the maximum acceptable difference between the heading of a vehicle and a tangent line from the point on a street where Network Analyst attempts to locate the vehicle. The bearing tolerance is used to determine whether the direction in which a vehicle is moving generally aligns with the underlying road. If they align within the given tolerance, the vehicle is located on that edge; if not, the next nearest eligible edge is evaluated.

The example also shows how to specify the Name attribute for each incident and specify the distance in miles
between the actual incident location and its location on the street using the Attr_Miles attribute.

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

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.

Caution:

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

You can use a simple comma- and semicolon-based syntax if you need to specify only facility point geometries in the default spatial reference WGS84 such as the longitude and latitude values.

Simple syntax for facilities

facilities=x1,y1; x2, y2; ...; xn, yn

Example using simple syntax

facilities=-117.1957,34.0564; -117.184,34.0546

You can specify facility geometries as well as attributes using a more comprehensive 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 property must be specified.

features: Specify an array of features. This property is optional. However, either the features or the url property must be specified.

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

geometry: Specifies the facility geometry as a point containing x and y properties along with a spatialReference property. The spatialReference 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.

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 stops using JSON structure, you can specify additional properties for facilities such as their names using attributes. The facilities parameter can be specified with the following attributes:

Name: The name of the facility. This name is used when generating driving directions. It is common to pass the actual name or street address for the facility as a value for Name attribute. If a value is not specified, an autogenerated name such as Location 1 or Location 2 is used for each facility.

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 might have come across when using ArcGIS Network Analyst extension software.

Setting

Coded value

Description

Either side of vehicle

0

The vehicle can approach and depart the facility in either direction, so a U-turn is allowed at the facility. This setting can be chosen if it is possible and desirable for your vehicle to turn around at the facility. This decision may depend on the width of the road and the amount of traffic or whether the facility has a parking lot where vehicles can pull in and turn around.All arrival and departure combinations are allowed with the Either side of vehicle curb approach.

Right side of vehicle

1

When the vehicle approaches and departs the facility, the facility must be on the right side of the vehicle. A U-turn is prohibited. This is typically used for vehicles like busses that must arrive with the bus stop on the right hand side.The allowed arrival and departure combination for the Right side of vehicle curb approach.

Left side of vehicle

2

When the vehicle approaches and departs the facility, the facility must be on the left side of the vehicle. A U-turn is prohibited. This is typically used for vehicles like busses that must arrive with the bus stop on the left hand side.The allowed arrival and departure combination for the Left side of vehicle curb approach.

No U-Turn

3

When the vehicle approaches the facility, the facility can be on either side of the vehicle; however, when it departs, the vehicle must continue in the same direction it arrived in. A U-turn is prohibited.The allowed arrival and departure combinations for the No U-Turn curb approach.

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.

With right-hand traffic, the curb approach that leaves the vehicle closest to the facility is Right side of vehicle.

With left-hand traffic, the curb approach that leaves the vehicle closest to the facility is Left side of vehicle.

Attr_TravelTime: Specifies the amount of time for cars, in minutes, that will be 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 value for this attribute is included in the total travel time for the route and is also displayed in driving directions as service time. A zero or null value indicates that the facility requires no service time. The default value is 0.

Attr_TruckTravelTime: Specifies the amount of time for trucks, in minutes, that will be added to the total travel time of the route between the incident and the closest facility.

The value for this attribute is included in the total travel time for the route and is also displayed in driving directions as service time. A zero or null value indicates that the facility requires no service time. The default value is 0.

Attr_WalkTime: Specifies the amount of time for pedestrians, in minutes, that will be added to the total travel time of the route between the incident and the closest facility.

The value for this attribute is included in the total travel time for the route and is also displayed in walking directions as service time. A zero or null value indicates that the facility requires no service time. The default value is 0.

Attr_Miles: Specifies the distance in miles 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 default value is 0.

Attr_Kilometers: Specifies the distance in kilometers 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 default value is 0.

Cutoff_TravelTime: Specify the travel time for cars, in minutes, at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched.

If Cutoff_TravelTime is not set for a facility, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_TravelTime attribute allows the ability to overwrite the defaultCutoff value on a per facility basis. The default value for this attribute is null which indicates not to use any cutoff.

Cutoff_TruckTravelTime: Specify the travel time for trucks, in minutes, at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched.

If Cutoff_TruckTravelTime is not set for a facility, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_TruckTravelTime attribute allows the ability to overwrite the defaultCutoff value on a per facility basis. The default value for this attribute is null which indicates not to use any cutoff.

Cutoff_WalkTime: Specify the travel time for trucks, in minutes, at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched.

If Cutoff_WalkTime is not set for a facility, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_WalkTime attribute allows the ability to overwrite the defaultCutoff value on a per facility basis. The default value for this attribute is null which indicates not to use any cutoff.

Cutoff_Miles: Specify the travel distance in miles at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched.

If Cutoff_Miles is not set for a facility, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_Miles attribute allows the ability to overwrite the defaultCutoff value on a per facility basis. The default value for this attribute is null which indicates not to use any cutoff.

Cutoff_Kilometers: Specify the travel distance in kilometers at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched.

If Cutoff_Kilometers is not set for a facility, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_Kilometers attribute allows the ability to overwrite the defaultCutoff value on a per facility basis. The default value for this attribute is null which indicates not to use any cutoff.

Bearing: Specify the direction the vehicle or person is moving in. Bearing is measured clockwise from true north and must be in degrees. Typically, values are between 0 and 360; however, negative values are interpreted by subtracting them from 360 degrees.

BearingTol: Short for bearing tolerance, this field specifies the maximum acceptable difference between the heading of a vehicle and a tangent line from the point on a street where Network Analyst attempts to locate the vehicle. The bearing tolerance is used to determine whether the direction in which a vehicle is moving generally aligns with the underlying road. If they align within the given tolerance, the vehicle is located on that edge; if not, the next nearest eligible edge is evaluated.

The example also shows how to specify the Name attribute for each facility and specify the distance in miles
between the actual facility location and its location on the street using the Attr_Miles attribute.

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

returnCFRoutes

true—Routes are generated. The routes are available in the routes property of the JSON response. The shape of the routes depends on the value for the outputLines parameter.

false—Routes are not generated.

Caution:

The default value for the returnCFRoutes parameter is false. In order to get the best routes between the incident and the closest facilities, this parameter should be specified as true. If you also want the service to return the point features representing the closest facilities from the incidents, you should specify the returnFacilities parameter as true

Tip:

You may not want to return routes if your application has to display only the driving directions between the stops. It is sufficient in this case to set the returnDirections parameter to true; returning routes will not provide any additional information and will increase the overall response size.

token

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

Example (replace <yourToken> with a valid token):

token=<yourToken>

f

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

Optional parameters

travelMode

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.

The value for the travelMode parameter is the JSON object containing the settings for a travel mode supported by your organization. To get the supported travel modes, execute the retrieveTravelModes operation.

You can make a request to retrieve travel modes using the following form:

Note:

If you copy and paste the above URL 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.

Below is the response as returned by the retrieveTravelModes operation.

Note:

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

Caution:

When the travelMode parameter is set, you are choosing a travel mode configured in 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: impedanceAttributeName, attributeParameterValues, restrictUturns, useHierarchy, restrictionAttributeNames, outputGeometryPrecision, outputGeometryPrecisionUnits, and directionsTimeAttributeName.

If you don't set travelMode, the service honors the default or user-defined values for the parameters that would otherwise be overridden, so you can create your own travel mode.

defaultTargetFacilityCount

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.

Caution:

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

The value for the defaultTargetFacilityCount parameter can be overwritten on a per incident basis by specifying a value for the TargetFacilityCount attribute when specifying the incidents parameter.

travelDirection

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:

esriNATravelDirectionFromFacility: Direction of travel is from facilities to incidents.

esriNATravelDirectionToFacility: Direction of travel is from incidents to facilities.

Using one of the parameter value can find different facilities as the travel time along some streets may vary based on the travel direction 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 of different travel time in that direction.

Fire departments commonly use the esriNATravelDirectionFromFacility 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 esriNATravelDirectionToFacility parameter value.

The default value for this parameter is esriNATravelDirectionToFacility.

defaultCutoff

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 based on the value of the impedanceAttributeName parameter. If impedanceAttributeName parameter is TravelTime, the defaultCutoff is specified in minutes. Otherwise the value is specified in miles or kilometers based on whether the impedanceAttributeName is set to Miles or Kilometers respectively. The default value for this parameter is null which indicates not to use any cutoff.

The value for the defaultCutoff parameter can be overwritten on a per incident or facility basis by specifying a value for the Cutoff_TravelTime, Cutoff_Miles, or Cutoff_Kilometers attributes when specifying the incidents or the facilities parameter.

timeOfDay

Specify whether travel times should consider traffic conditions. To use traffic in the analysis, set impedanceAttributeName to TravelTime, and assign a value to timeOfDay.

The timeOfDay value indicates the target start time of the routes in the analysis. If timeOfDayUsage is set to esriNATimeOfDayUseAsEndTime, 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.

Note:

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.

"timeOfDay": 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.

"timeOfDay": 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.

timeOfDayIsUTC

Specify the time zone or zones of the timeOfDay parameter. There are two options: false (default) and true.

false (use geographically local time zones):

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

Illustration of setting the value to false (geographically local): Setting timeOfDay to 9:00 a.m., 4 January 1990 (631443600000 milliseconds); timeOfDayIsUTC to false; 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).

true (use UTC):

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

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

Note:

This parameter is ignored when impedanceAttributeName is set to distance units.

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

timeOfDayUsage

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

esriNATimeOfDayUseAsStartTime: When this value is specified, the service finds the best route considering the timeOfDay parameter value as the departure time from the facility or incident.

esriNATimeOfDayUseAsEndTime: When this value is specified, the service considers the timeOfDay 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 timeOfDay.

The default value for this parameter is esriNATimeOfDayUseAsStartTime. The parameter value is ignored if the timeOfDay parameter has none value.

useHierarchy

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

Caution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

true (default)—Use hierarchy when measuring between points. 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.

Caution:

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.

restrictUTurns

Use this parameter to restrict or permit the route from making U-turns at junctions.

Caution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

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

esriNFSBAllowBacktrack (default)

U-turns are permitted everywhere. Allowing U-turns implies that the vehicle can turn around at a junction and double back on the same street. U-turns are permitted at junctions with any number of adjacent streets.

esriNFSBAtDeadEndsAndIntersections

U-turns are prohibited at junctions where exactly two adjacent streets meet. U-turns are permitted only at intersections or dead ends.

esriNFSBAtDeadEndsOnly

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

esriNFSBNoBacktrack

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

impedanceAttributeName

Specify the impedance.

Caution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

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:

TravelTime (default)—Models travel times for a car. These travel times can be dynamic, fluctuating according to traffic flows, in areas where traffic data is available.

TruckTravelTime—Models travel times for a truck. These travel times are static for
each road and don't fluctuate with traffic.

WalkTime—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 attributeParameterValues parameter by setting Walking Speed (km/h) to a different value.

Miles—Specifies that the travel distance between the stops should be minimized. The total distance between the stops is calculated in miles.

Kilometers—Specifies that the travel distance between the stops should be minimized. The total distance between the stops is calculated in kilometers.

accumulateAttributeNames

Use this parameter to specify whether the service should accumulate values other than the value specified for impedanceAttributeName. For example, if your impedanceAttributeName is set to TravelTime, the total travel time for the route will be calculated by the service. However, if you also want to calculate the total distance of the route in miles, you can specify Miles as the value for the accumulateAttributeNames parameter.

The parameter value should be specified as a comma-separated list of names. The parameter values are the same as the impedanceAttributeName parameter. For example, accumulateAttributeNames=Miles,Kilometers indicates that the total cost of the route should also be calculated in miles and kilometers. This is also the default value for this parameter.

Note:

The values specified for the accumulateAttributeNames parameter are purely for reference. The service always uses impedanceAttributeName to find the best routes.

restrictionAttributeNames

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.

Caution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

The parameter value is specified as a comma-separated list of restriction names. For example, the default value for this parameter is restrictionAttributeNames=Avoid Carpool Roads, Avoid Express Lanes, Avoid Gates, Avoid Private Roads, Avoid Unpaved Roads, Driving an Automobile, Roads Under Construction Prohibited, Through Traffic Prohibited. A value of none indicates that no restrictions should be used when finding shortest paths.

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

Note:

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.

Note:

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

Restriction Name

Description

Availability

Any Hazmat Prohibited

The route will not include 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 that are 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 that are 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 Truck Restricted Roads

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

All countries

Avoid Unpaved Roads

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

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 not include roads where buses are prohibited. Using this restriction will also ensure that the route will honor one-way streets.

All countries

Driving a Delivery Vehicle

The route will not include roads where delivery vehicle are prohibited. Using this restriction will also ensure that the route will honor one-way streets.

All countries

Driving a Taxi

The route will not include roads where taxis are prohibited. Using this restriction will also ensure that the route will honor one-way streets.

All countries

Driving a Truck

The route will not include roads where trucks are prohibited. Using this restriction will also ensure that the route will honor one-way streets.

All countries

Driving an Automobile

The route will not include roads where automobiles are prohibited. Using this restriction will also ensure that the route will honor one-way streets.

All countries

Driving an Emergency Vehicle

The route will not include roads where emergency vehicles are prohibited. Using this restriction will also ensure that the route will honor one-way streets.

All countries

Height Restriction

The route will not include 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 not include roads where the vehicle length exceeds the maximum allowed kingpin to rear axle for all trucks on the road. The 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 not include 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 not include roads where motorcycles are prohibited. Using this restriction will also ensure that the route will honor one-way streets.

All countries

Roads Under Construction Prohibited

The route will not include roads that are under construction.

All countries

Semi or Tractor with One or More Trailers Prohibited

The route will not include 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 not include roads where vehicles with single axles are prohibited.

Select countries in North America and Europe

Tandem Axle Vehicles Prohibited

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

Select countries in North America and Europe

Through Traffic Prohibited

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

All countries

Truck with Trailers Restriction

The route will not include 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 that are designated for transporting any kind of hazardous materials.

Select countries in North America and Europe

Use Preferred Truck Routes

The route will prefer roads that are designated as trucks 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 roads that are preferred by the trucks when driving in an area.

Select countries in North America and Europe

Walking

The route will not include roads where pedestrians are prohibited.

All countries

Weight Restriction

The route will not include 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 not include roads where the vehicle weight per axle exceeds the maximum allowed weight per axle for the road. The vehicle 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 not include roads where the vehicle width exceeds the maximum allowed width for the road. The vehicle width can be specified using the Vehicle Width(meters) restriction parameter.

Select countries in North America and Europe

Legacy:

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.

attributeParameterValues

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.

Caution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

The parameter value is specified as an array of objects each having the following properties:

attributeName— The name of the restriction

parameterName—The name of the parameter associated with the restriction. A restriction can have one or more parameterName properties.

value—The value for parameterName.

Most attribute parameters are related to the restriction attributes in restrictionAttributeNames. Each restriction has at least one attribute parameter named Restriction Usage, which 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 parameter can be assigned any of the following string values, or their equivalent numeric values listed within the parentheses:

Prohibited (-1)—Travel on the roads that have the restriction is completely prohibited.

Avoid_High (5)—It is very unlikely for the service to include in the route the roads that are associated with the restriction.

Avoid_Medium (2)—It is unlikely for the service to include in the route the roads that are associated with the restriction.

Avoid_Low (1.3)—It is somewhat unlikely for the service to include in the route the roads that are associated with the restriction.

Prefer_Low (0.8)—It is somewhat likely for the service to include in the route the roads that are associated with the restriction.

Prefer_Medium(0.5)—It is likely for the service to include in the route the roads that are associated with the restriction.

Prefer_High (0.2)—It is very likely for the service to include in the route the roads that are associated with the restriction.

Note:

The restrictionAttributeNames parameter is associated with attributeParameterValues. The restriction attribute's parameter value is specified as part of attributeParameterValues. Each restriction has at least one parameter named Restriction Usage, which specifies whether travel on roads that have the restriction is prohibitied, should be avoided, or should be preferred. For the latter two options, it also specifies the degree to which the roads are avoided or preferred.

In most cases, you can use the default value, Prohibit, for the 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 routing 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 attribute parameter names and the default parameter values.

Tip:

If you wish to use the default value for a restriction parameter, the restriction name, restriction parameter name, and restriction parameter value do not have to be specified as part of the attributeParameterValues.

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 the 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 route 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 parameter for the Height Restriction and the
Weight Restriction are not specified as we want to use the default value of Prohibit for these restriction parameters.

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.

Caution:

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

The barriers parameter can be specified using a simple comma- and semicolon-based syntax if you need to specify only point barrier geometries as longitude and latitude values in the default spatial reference (WGS84).

Simple syntax for barriers

barriers=x1,y1; x2, y2; ...; xn, yn

Example using simple syntax

barriers=-117.1957,34.0564; -117.184,34.0546

You can specify barrier geometries as well as attributes using a more comprehensive JSON structure that represents a set of features. The JSON structure can include the following properties:

features: Specify an array of features. This property is optional. However, either the features or the url property must be specified.

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 the features or the url property must be specified.

Each feature in this array represents a point barrier and contains the following fields:

geometry: Specifies the barrier geometry as a point containing x and y properties along with a spatialReference property. The spatialReference 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.

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 barriers

When specifying the barriers parameter using JSON structure, you can specify additional information about barriers, such as the barrier type, using attributes. The 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. 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 Attr_TravelTime, Attr_Miles, or Attr_Kilometers attributes. This barrier type is referred to as an added cost point barrier. The map on the left shows the shortest path between two stops without any added cost point barrier. For the map on the right, the travel time from stop one to stop two would be the same whether going around the north end of the block or the south end; however, since crossing railroad tracks incurs a time penalty (modeled with added cost point barriers), the route with only one railroad crossing is chosen. The cost of crossing the barrier is added to the accumulated travel time of the resulting route.

Note:

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

FullEdge: This attribute is applicable only for restriction point barriers. The value for this attribute is specified as one of the following integers.

0 - Permits travel on the edge up to the barrier, but not through it. This is the default value.

1 - Restricts travel anywhere on the underlying street.

Attr_TravelTime: Indicates how much travel time in minutes is added when the barrier is traversed. This attribute is applicable only for added-cost barriers. The attribute value must be greater than or equal to zero.

Attr_Miles: Indicates how much distance in miles is added when the barrier is traversed. This attribute is applicable only for added-cost barriers. The attribute value must be greater than or equal to zero.

Attr_Kilometers: Indicates how much distance in kilometers is added when the barrier is traversed. This attribute is applicable only for added-cost barriers. The attribute value must be greater than or equal to zero.

This example shows how to use an added cost point barrier to model a 5 minute delay at a rail road crossing. The BarrierType attribute is used to specify that the
point barrier is of type added cost and the Attr_TravelTime attribute is used to specify the delay in minutes. The barrier geometry is in the default spatial reference,
WGS84, and hence the spatialReference property is not required within the geometry property.

polylineBarriers

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.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 polyline barrier.

Caution:

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

You can specify polyline barrier geometries as well as attributes using a JSON structure that represents a set of features. The JSON structure can include the following properties:

features: Specify an array of features. This property is optional. However, either the features or the url property must be specified.

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 the features or the url property must be specified.

Each feature in this array represents a polyline barrier and contains the following fields:

geometry: Specifies the barrier geometry. The structure is based on ArcGIS REST polyline object. A polyline contains an array of paths and a spatialReference. 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. The spatialReference 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.

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 polylineBarriers

When specifying the polylineBarriers parameter using JSON structure, the parameter can be specified with the following attributes:

Name: The name of the polyline barrier.

Syntax for specifying polyline barriers using JSON structure for features

The example shows how to add two lines as polyline barriers to restrict travel on the streets intersected by the lines. Barrier 1 is a single-part line feature made up of two points. Barrier 2 is a
two-part line feature. The first part is made up of three points, and the 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 within the geometry property.

polygonBarriers

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.

Caution:

The service imposes a limit on the number of streets you can restrict using the polygonBarriers 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 should not exceed 2,000. If the value is exceeded, the response returns an error message.

You can specify polygon barrier geometries as well as attributes using a JSON structure that represents a set of features. The JSON structure can include the following properties:

features: Specify an array of features. This property is optional. However, either the features or the url property must be specified.

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 the features or the url property must be specified.

Each feature in this array represents a polygon barrier and contains the following fields:

geometry: Specifies the barrier geometry. The structure is based on ArcGIS REST polygon object. A polygon contains an array of rings and a spatialReference. 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. The spatialReference 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.

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 polygonBarriers

When specifying the polygonBarriers parameter using JSON structure, you can specify additional information about barriers, such as the barrier type, using attributes. The polygonBarriers 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 covering areas of the street that make traveling on those streets impossible. This is the default value. 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 Attr_TravelTime, Attr_Miles, or Attr_Kilometers 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. 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.

Attr_TravelTime: This is the factor by which the travel time of the streets intersected by the barrier is multiplied. This attribute is applicable only for scaled-cost barriers. You should specify this attribute if the impedanceAttributeName request parameter has the value TravelTime. The attribute value must be greater than zero.

Attr_Miles: This is the factor by which the distance of the streets intersected by the barrier is multiplied. This attribute is applicable only for scaled-cost barriers. You should specify a value for this attribute if the impedanceAttributeName request parameter has the value Miles. The attribute value must be greater than zero.

Attr_Kilometers: This is the factor by which the distance of the streets intersected by the barrier is multiplied. This attribute is applicable only for scaled-cost barriers. You should specify a value for this attribute if the impedanceAttributeName request parameter has the value Kilometers. The attribute value must be greater than zero.

Syntax for specifying polygon barriers using JSON structure for features

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 reduces
the travel time on underlying streets to one third of the original value. The polygon is a two-part polygon feature. Both parts are made up of four points.

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

returnDirections

Specify whether the service should generate driving directions for each route.

The default value is false.

true—Generate directions. The directions are configued based on the values for the directionsLanguage, directionsOutputType, directionsStyleName, and directionsLengthUnits parameters. The directions are available in the directions property of the JSON response.

false—Don't generate directions.

directionsLanguage

Specify the language that should be used when generating driving directions. This parameter applies only when the returnDirections parameter is set to true. The service supports generating directions in the following languages:

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

The value for the parameter is specified using the language code. For example, directionsLanguage=zh-CN will result in driving directions to be generated in simplified Chinese.

Note:

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

directionsOutputType

Define the content and verbosity of the driving directions. This parameter applies only when the returnDirections parameter is set to true. The parameter can be specified using the following values:

esriDOTComplete—Directions output that includes all directions properties.

esriDOTCompleteNoEvents—Directions output that includes all directions properties except events.

esriDOTInstructionsOnly—Directions output that includes text instructions, time, length and ETA. Does not include geometry.

NA Navigation—Generates turn-by-turn directions designed for an in-vehicle navigation device.

directionsLengthUnits

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

esriNAUCentimeters

esriNAUDecimalDegrees

esriNAUDecimeters

esriNAUFeet

esriNAUInches

esriNAUKilometers

esriNAUMeters

esriNAUMiles (default)

esriNAUMillimeters

esriNAUNauticalMiles

esriNAUPoints

esriNAUYards

directionsTimeAttributeName

Set the time-based impedance attribute to display the duration of a maneuver, such as "Go northwest on Alvorado St. for 5 minutes." The units for all the time attributes is minutes.

TravelTime (default)—Travel times for a car

TruckTravelTime—Travel times for a truck

WalkTime—Travel times for a pedestrian

outputLines

Use this parameter to specify the type of route features that are output by the service. This parameter is applicable only if the returnCFRoutes parameter is set to true. The outputLines parameter can have one of the following values:

esriNAOutputLineTrueShape—Return the exact shape of the resulting route that is based on the underlying streets. This is the default value.

esriNAOutputLineTrueShapeWithMeasure—Return the exact shape of the resulting route that is based on the underlying streets and include route measurements that keep track of the cumulative travel time or travel distance along the route relative to the first stop. When this value is chosen for the outputLines parameter, each point that make up the route shape will include an M value along with X and Y values. The M value, also known as the measure value, indicates the accumulated travel time or travel distance at that point along the route. The M values can be used to determine how far you have traveled from the start of the route or the remaining distance or time left to reach the destination. The M values store travel time if the impedanceAttributeName is set to TravelTime and store the travel distance if the impedanceAttributeName is set to Kilometers or Miles.

esriNAOutputLineStraight—Return a straight line between the incident and the closest facility.

esriNAOutputLineNone—Do not return any shapes for the routes. This value can be useful in cases where you are only interested in determing the total travel time or travel distance of the route. For example, if your application has already calculated the route and after some time your application needs to only calculate the expected time of arrival (ETA) to the destination, you can set the returnCFRoutes parameter to true and the outputLines parameter to esriNAOutputLineNone. The routes property of the JSON response will only contain the total travel time that can be used to determine the ETA. Since the route shape is not returned when using the esriNAOutputLineNone value, the response size will be considerably smaller.

Tip:

When the outputLines parameter is set to esriNAOutputLineTrueShape or esriNAOutputLineTrueShapeWith Measure, the generalization of the route shape can be further controlled using the appropriate values for the outputGeometryPrecision and the outputGeometryPrecisionUnits parameters.

Note:

No matter which value you choose for the outputLines parameter, the best route is always determined by minimizing the travel time or the travel distance, never using the Euclidean distance (or as the crow flies distance) between the stops. This means that only the route shapes are different, not the underlying streets that are searched when finding the route.

returnFacilities

Use this parameter to specify if facilities will be returned by the service. The possible values for this parameter are true, or false. A true value indicates that the facilities used as input will be returned as part of the facilities property in the JSON response. The default value for this parameter is false.

If you have specified the facilities parameter using a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set, returning facilities can allow you to draw the facility locations in your application. You may also want to set the returnFacilities property to true in order to determine if the facilities were successfully located on the street network or had some other errors by checking the Status property in the JSON response.

returnIncidents

Use this parameter to specify if incidents will be returned by the service. The possible values for this parameter are true, or false. A true value indicates that the incidents used as input will be returned as part of the facilities property in the JSON response. The default value for this parameter is false.

If you have specified the incidents parameter using a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set, returning incidents can allow you to draw the incident locations in your application. You may also want to set the returnIncidents property to true in order to determine if the incidents were successfully located on the street network or had some other errors by checking the Status property in the JSON response.

returnBarriers

Specify whether barriers will be returned by the service.

true—The input point barriers are returned as part of the barriers property in the JSON response.

false (default)—Point barriers are not returned.

Setting this parameter has no effect if you don't also specify a value for the barriers parameter.

If you have specified the barriers parameter using a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set, returning barriers can allow you to draw the point barrier locations in your application. You may also want to set the returnBarriers property to true to see where the barriers were located on the street network or, if they weren't located at all, understand what the problem was by checking the Status property in the JSON response.

returnPolylineBarriers

Specify whether polyline barriers will be returned by the service.

true—The input polyline barriers are returned as part of the polylineBarriers property in the JSON response.

false (default)—Polyline barriers are not returned.

Setting this parameter has no effect if you don't also specify a value for the polylineBarriers parameter.

If you have specified the polylineBarriers parameter using a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set, the returnPolylineBarriers parameter can be set to true so that you can draw the polyline barrier locations in your application.

returnPolygonBarriers

Specify whether polygon barriers will be returned by the service.

true—The input polygon barriers are returned as part of the polygonBarriers property in the JSON response.

false (default)—Polygon barriers are not returned.

Setting this parameter has no effect if you don't also specify a value for the polygonBarriers parameter.

If you have specified the polygonBarriers parameter using a REST query request to any ArcGIS Server feature, map, or geoprocessing service that returns a JSON feature set, the returnPolygonBarriers parameter can be set to true so that you can draw the polygon barrier locations in your application.

ignoreInvalidLocations

Specify whether invalid input locations should be ignored when finding the best solution. An input point is deemed invalid by the service if there are no streets within 12.42 miles (20 kilometers) of the stop location.

true (default)—Any invalid point in your request will cause the service to return a failure.

false—Invalid point are ignored.

outSR

Use this parameter to specify the spatial reference of the geometries, such as line or point features, returned by the service.

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.

outputGeometryPrecision

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

Caution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

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 the applications.

The default value for this parameter is 10. The units are specified with the outputGeometryPrecisionUnits parameter.

outputGeometryPrecisionUnits

Use this parameter to specify the units for the value specified for the outputGeometryPrecision parameter.

Caution:

The value of this parameter, regardless of whether you rely on the default or explicitly set a value, is overridden when you pass in travelMode.

The parameter value should be specified as one of the following values:

esriCentimeters

esriDecimalDegrees

esriDecimeters

esriFeet

esriInches

esriKilometers

esriMeters (default)

esriMiles

esriMillimeters

esriNauticalMiles

esriPoints

esriYards

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

The JSON response from the closest facility service is based on the following syntax. The actual properties returned in the response depend upon the request parameters. For example, the routes property is returned only if the returnCFRoutes parameter is set to true. If a request fails, the JSON response only contains the error property. The examples in the subsequent section illustrate the response returned with specific request parameters.

(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 time a client can use the synchronous closest facility service:

5 minutes (300 seconds)

Examples

Note:

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. Learn how to generate one.

Finding closest fire stations

This example shows how to find the two fire stations that can provide the quickest response to a fire at a given incident location within three minutes. You will also generate routes and driving directions for the firefighters to follow.

We specify the four fire stations in the area as the facilities parameter. We use the JSON structure to specify the facilities parameter as we want to specify the name of the fire station that can be used by the service when generating driving directions for the routes from the fire stations. The geometries are in the default spatial reference WGS84. Hence, the spatialReference property is not specified.

We specify the longitude and latitude value for the fire location as the incidents parameter.

Since we need to find the two closest fire stations, we specify 2 as the value for the defaultTargetFacilityCount parameter. In order to model the fire engines traveling from the stations to the fire (incident), we specify esriNATravelDirectionFromFacility as the value for the travelDirection parameter. We need to search for fire stations that are within three minutes of the fire. Hence we specify 3 as the value for the defaultCutoff parameter. Any fire stations outside the cutoff time are ignored by the service.

As we need to generate driving directions and report the distance information within the directions in miles, we specify the returnDirections parameter as true and the directionsLengthUnits parameter as esriNAUMiles. In order to get the route geometries, we specify the returnCFRoutes parameter as true. We also specify the 102100 as the value for the outSR parameter so that the output routes are returned in the Web Mercator spatial reference and can be displayed on top of an ArcGIS Online basemap.

JSON response

The response contains two route features representing the best route to travel from the two closest fire stations to the incident.
The response includes the routes and directions properties
because the returnCFRoutesand returnDirections parameters are set
to true in the request.

Note:

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