/solveClosestFacility

Attributes for incidents

• Namestring (length: 500)nullable

  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.

• ObjectIDinteger (non-negative)nullable

  The object ID of the incident. ObjectID is a unique identifier for the incident. If you want to maintain a relationship between input and output, set preserveObjectID to true , and the ObjectID value of the input incident is included in the output routes (as the IncidentID field). The ObjectID value is also included in the output incidents (as the ObjectID field) and can be used to join additional information from the analysis outputs to the attribute of the incidents. If the ObjectID value is not specified, a unique ID is automatically generated in the output.

• TargetFacilityCountintegerdefault:null

  Specify the number of facilities that need to be found for the given 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.

• Attr_[Cost]number (non-negative)default:0nullable

  The name of the attribute can be: Attr_TravelTime, Attr_TruckTravelTime, Attr_Minutes, Attr_TruckMinutes, Attr_WalkTime, Attr_Miles, Attr_Kilometers

  This attribute specifies how much additional time spent or distance traveled can occur at the incident. The value for this attribute is included in the total travel time or distance for the output routes and is also displayed in output directionPoints as service time.

  The value for this attribute is specified in the units of the cost attribute. For instance, Attr_TravelTime is in minutes.

  Use case

  You can add time to an incident to represent how long it takes to make a delivery, install equipment, or perform some other task at the incident. Similarly, adding extra distance may be useful to account for a long driveway or other road that isn't represented by the network dataset. When a time-based cost attribute TravelTime is used, it will specify the travel 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. Attr_TravelTime is only referenced if TravelTime is used in the analysis as impedance or accumulate attribute. A zero or null value indicates that the incident requires no service time.

  However, when a distance-based cost attribute like Miles is used, it 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. The Attr_Miles attribute 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. Attr_Miles is only referenced if Miles is used in the analysis as impedance or accumulate attribute.

• Cutoff_[Impedance]number (non-negative)default:null

  Specify the travel time or distance at which to stop searching for facilities for a given incident.

  If Cutoff_[Impedance] is not set for an incident, the service will use the value specified as the defaultCutoff parameter. The default value for this attribute is null, which causes the service to use the value set for the defaultCutoff parameter. If the Cutoff_[Impedance] attribute is set to a value other than null, the defaultCutoff value is overridden.

  Use case

  For example, when a time-based cutoff impedance TravelTime is used, it will 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 facility basis. The default value for this attribute is null, which indicates not to use any cutoff.

  However, when a distance-based cutoff impedance like Miles is used, it will 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 defaultCutoffvalue on a per facility basis. The default value for this attribute is null, which indicates not to use any cutoff.

• CurbApproachint enumdefault:0

  Allowed values: 0, 1, 2, 3

  Specifies the direction a vehicle may arrive at and depart from the incident. The field value is specified as one of the following integers:

  • 0: Either side of vehicle. The vehicle can approach and depart the incident in either direction. U-turns are allowed. You should choose this setting if your vehicle can make a U-turn at the order or if it can pull into a driveway or parking lot and turn around.
  • 1: Right side of vehicle. When the vehicle approaches and departs the incident, the curb must be on the right side of the vehicle. A U-turn is prohibited.
  • 2: Left side of vehicle. When the vehicle approaches and departs the incident, the curb must be on the left side of the vehicle. A U-turn is prohibited.
  • 3: No U-turn. When the vehicle approaches the incident, the curb can be on either side of the vehicle; however, the vehicle must depart without turning around. Learn more about U-turn policies
  Show illustration

  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 a 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 location 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 such as buses that must arrive with the bus stop on the right side. The allowed arrival and departure combination for the Right side of vehicle curb approach is shown.
  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 such as buses that must arrive with the bus stop on the left side. The allowed arrival and departure combination for the Left side of vehicle curb approach is shown.
  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. A U-turn is prohibited. The allowed arrival and departure combinations for the No U-Turn curb approach are shown.

  The CurbApproach attribute is designed to work with both types 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, choose 1 (Right side of vehicle) in the United States and 2 (Left side of vehicle) in the United Kingdom.

  

  

• Bearingnumber (non-negative)nullable

  The direction in which a point is moving. The units are degrees and are measured clockwise from true north.

  This attribute is used in conjunction with the BearingTol attribute. Bearing data is usually sent automatically from a mobile device equipped with a GPS receiver. Try to include bearing data if you are loading an input location that is moving, such as a pedestrian or a vehicle. Using this attribute tends to prevent adding locations to the wrong edges, which can occur when a vehicle is near an intersection or an overpass, for example. Bearing also helps the solver determine the side of the street that the point is on.

  Learn more about bearing and bearing tolerance

• BearingTolnumber (range: 0 - 180)default:30nullable

  The bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing attribute.

  If the Bearing attribute value is within the range of acceptable values that are generated from the bearing tolerance on an edge, the point can be added as a network location there; otherwise, the closest point on the next-nearest edge is evaluated. The units are in degrees. A value of 30 means that when Network Analyst attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge.

  Learn more about bearing and bearing tolerance

• NavLatencynumber (non-negative)nullable

  Indicates how much cost is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device.

  This attribute is only used in the solve process if the Bearing and BearingTol fields also have values; however, providing a NavLatency attribute value is optional, even when values are present in the Bearing and BearingTol.

Attributes for facilities

• Namestring (length: 500)nullable

  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 and directions.

• ObjectIDinteger (non-negative)nullable

  The object ID of the facility. ObjectID is a unique identifier for the facility. If you want to maintain a relationship between input and output, set preserveObjectID to true, and the ObjectID value of the input facility is included in the output routes (as the FacilityID field). The ObjectID value is also included in the output facilities (as the ObjectID field) and can be used to join additional information from the analysis outputs to the attribute of the facilities. If the ObjectID value is not specified, a unique ID is automatically generated in the output.

• CurbApproachint enumdefault:0

  Allowed values: 0, 1, 2, 3

  Specifies the direction a vehicle may arrive at and depart from the facility. The field value is specified as one of the following integers:

  • 0: Either side of vehicle. The vehicle can approach and depart the facility in either direction. U-turns are allowed. You should choose this setting if your vehicle can make a U-turn at the order or if it can pull into a driveway or parking lot and turn around.
  • 1: Right side of vehicle. When the vehicle approaches and departs the facility, the curb must be on the right side of the vehicle. A U-turn is prohibited.
  • 2: Left side of vehicle. When the vehicle approaches and departs the facility, the curb must be on the left side of the vehicle. A U-turn is prohibited.
  • 3: No U-turn. When the vehicle approaches the facility, the curb can be on either side of the vehicle; however, the vehicle must depart without turning around. Learn more about U-turn policies
  Show illustration

  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 a 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 location 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 such as buses that must arrive with the bus stop on the right side. The allowed arrival and departure combination for the Right side of vehicle curb approach is shown.
  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 such as buses that must arrive with the bus stop on the left side. The allowed arrival and departure combination for the Left side of vehicle curb approach is shown.
  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. A U-turn is prohibited. The allowed arrival and departure combinations for the No U-Turn curb approach are shown.

  The CurbApproach attribute is designed to work with both types 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, choose 1 (Right side of vehicle) in the United States and 2 (Left side of vehicle) in the United Kingdom.

  

  

• Attr_[Cost]number (non-negative)default:0nullable

  The name of the attribute can be: Attr_TravelTime, Attr_TruckTravelTime, Attr_Minutes, Attr_TruckMinutes, Attr_WalkTime, Attr_Miles, Attr_Kilometers

  This attribute specifies how much additional time spent or distance traveled can occur at the facility. The value for this attribute is included in the total travel time or distance for the output routes and is also displayed in output directionPoints as service time.

  The value for this attribute is specified in the units of the cost attribute. For instance, Attr_TravelTime is in minutes.

  Use case

  When a time-based cost attribute TravelTime is used, it will specify the travel 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. Attr_TravelTime is only referenced if TravelTime is used in the analysis as impedance or accumulate attribute. A zero or null value indicates that the incident requires no service time.

  However, when a distance-based cost attribute like Miles is used, it 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. The Attr_Miles attribute 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. Attr_Miles is only referenced if Miles is used in the analysis as impedance or accumulate attribute.

• Cutoff_[Impedance]number (non-negative)default:null

  Specify the travel time or distance at which to stop searching for facilities for a given incident.

  If Cutoff_[Impedance] is not set for an incident, the service will use the value specified as the defaultCutoff parameter. The default value for this attribute is null, which causes the service to use the value set for the defaultCutoff parameter. If the Cutoff_[Impedance] attribute is set to a value other than null, the defaultCutoff value is overridden.

  Use case

  For example, when a time-based cutoff impedance TravelTime is used, it will 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 facility basis. The default value for this attribute is null, which indicates not to use any cutoff.

  However, when a distance-based cutoff impedance like Miles is used, it will 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 defaultCutoffvalue on a per facility basis. The default value for this attribute is null, which indicates not to use any cutoff.

• Bearingnumber (non-negative)nullable

  The direction in which a point is moving. The units are degrees and are measured clockwise from true north.

  This attribute is used in conjunction with the BearingTol attribute. Bearing data is usually sent automatically from a mobile device equipped with a GPS receiver. Try to include bearing data if you are loading an input location that is moving, such as a pedestrian or a vehicle. Using this attribute tends to prevent adding locations to the wrong edges, which can occur when a vehicle is near an intersection or an overpass, for example. Bearing also helps the solver determine the side of the street that the point is on.

  Learn more about bearing and bearing tolerance

• BearingTolnumber (range: 0 - 180)default:30nullable

  The bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing attribute.

  If the Bearing attribute value is within the range of acceptable values that are generated from the bearing tolerance on an edge, the point can be added as a network location there; otherwise, the closest point on the next-nearest edge is evaluated. The units are in degrees. A value of 30 means that when Network Analyst attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge.

  Learn more about bearing and bearing tolerance

• NavLatencynumber (non-negative)nullable

  Indicates how much cost is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device.

  This attribute is only used in the solve process if the Bearing and BearingTol fields also have values; however, providing a NavLatency attribute value is optional, even when values are present in the Bearing and BearingTol.

This parameter can have the following values:

Parameter Value	Description
esriNFSBAllowBacktrack	U-turns are permitted everywhere. Permitting 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 intersections 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. Even when this parameter value is chosen, a route can still make U-turns at stops. To prohibit U-turns at a stop, you can set its CurbApproach property to the appropriate value (3).

Attributes for barriers

• Namestringnullable

  The name of the barrier.

• BarrierTypeint enumdefault:0

  Allowed values: 0, 2

  Specify 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: Restriction. Prohibits travel through the barrier. The barrier is referred to as a restriction point barrier since it acts as a restriction.

    

    The first map shows the shortest path between two stops without any restriction point barriers. The second map has a road that is blocked by a fallen tree, so the shortest path between the same points is longer.

  • 2: Added Cost. Traveling through the barrier increases the travel time or distance by the amount specified in the Attr_[Cost] 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.

• FullEdgeint enumdefault:0

  Allowed values: 0, 1

  Specify how the restriction point barriers are applied to the edge elements during the analysis

  • 0:False—Permits travel on the edge up to the barrier but not through it.
  • 1:True—Restricts travel anywhere on the associated edge.

• Attr_[Cost]number (non-negative)default:0

  Indicates how the cost (time or distance) is added when the barrier is traversed. This attribute is applicable only for added cost point barriers. The attribute value must be greater than or equal to zero.

Attributes for polylineBarriers

• Namestring (length: 500)nullable

  The name of the barrier.

• ObjectIDinteger (non-negative)nullable

  The object ID of the line barrier. ObjectID is a unique identifier for the line barrier. If you want to maintain a relationship between the input and output, set preserveObjectID to true. The ObjectID value of the input line barrier is included in the output line barrier (as the ObjectID field) and can be used to join additional information from analysis outputs to the attribute of the line barriers. If the ObjectID value is not specified, a unique ID is automatically generated in the output.

This 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 composed of two points. Barrier 2 is a two-part line feature. The first part is composed of three points, and the second part is composed of two points.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  "spatialReference": {
    "wkid": 102100
  },
  "features": [
    {
      "geometry": {
        "paths": [
          [
            [-10804823.397, 3873688.372],
            [-10804811.152, 3873025.945]
          ]
        ]
      },
      "attributes": {
        "Name": "Barrier 1"
      }
    },
    {
      "geometry": {

Attributes for polygonBarriers

• Namestringnullable

  The name of the barrier.

• ObjectIDinteger (non-negative)nullable

  The object ID of the polygon barrier. ObjectID is a unique identifier for the polygon barrier. If you want to maintain a relationship between the input and output, set preserveObjectID to true. The ObjectID value of the input polygon barrier is included in the output polygon barrier (as the ObjectID field) and can be used to join additional information from analysis outputs to the attribute of the polygon barriers. If the ObjectID value is not specified, a unique ID is automatically generated in the output.

• BarrierTypeint enumdefault:0

  Allowed values: 0, 1

  Specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.

  The value for this attribute can be specified as one of the following integers:

  • 0: Restriction. Prohibits traveling through any part of the barrier. The barrier is referred to as a 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.

    

    The first map depicts the shortest path between two stops. The second map shows a polygon barrier blocking flooded streets, so the shortest path between the same two stops is different.

  • 1: Scaled Cost. Scales the cost (such as travel time or distance) required to travel the underlying streets by a factor specified using the Attr_[Cost] attributes.

    If the streets are partially covered by the barrier, the travel time or distance is apportioned and then scaled. For example, a factor of 0.25 means that travel on underlying streets is expected to be four times faster than normal. A factor of 3.0 means it is expected to take three times longer than normal to travel on underlying streets. This barrier type is referred to as a scaled-cost polygon barrier. It can be used to model storms that reduce travel speeds in specific regions, for example.

  

  The first map shows a route that goes through inclement weather without regard for the effect that poor road conditions have on travel time. The second map shows a scaled polygon barrier that doubles the travel time of the roads covered by the storm. 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, and the modified travel time is reported as the total travel time in the response.

• Attr_[Cost]number (non-negative)default:0

  This is the factor by which the cost of the streets intersected by the barrier is multiplied. This attribute is applicable only for scaled cost barriers. The attribute value must be greater than zero.

This example shows how to add two polygons as barriers. The first polygon, Flood zone, is a restriction polygon barrier that prohibits travel on the underlying streets. The polygon is a single-part polygon feature composed of four points. The second polygon, 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 composed of four points.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{
  "spatialReference": {
    "wkid": 4326
  },
  "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

The service supports generating directions in the following languages:

• ar: Arabic
• bg: Bulgarian
• bs: Bosnian
• ca: Catalan
• cs: Czech
• da: Danish
• de: German
• el: Greek
• en: English
• es: Spanish
• et: Estonian
• fi: Finnish
• fr: French
• he: Hebrew
• hr: Croatian
• hu: Hungarian
• id: Indonesian
• it: Italian
• ja: Japanese
• ko: Korean
• lt: Lithuanian
• lv: Latvian
• nb: Norwegian
• nl: Dutch
• pl: Polish
• pt-BR: Portuguese (Brazil)
• pt-PT: Portuguese (Portugal)
• ro: Romanian
• ru: Russian
• sk: Slovak
• sl: Slovenian
• sr: Serbian
• sv: Swedish
• th: Thai
• tr: Turkish
• uk: Ukrainian
• vi: Vietnamese
• zh-CN: Chinese (China)
• zh-HK: Chinese (Hong Kong)
• zh-TW: Chinese (Taiwan)

Example for locate_settings

Example 1: Specify locate settings using a JSON structure

This example shows how to specify locate settings so inputs are only located within 500 meters of the specified location. A small search tolerance like this can be helpful if you are solving using a walking travel mode and don't want inputs to be located farther than 500 meters from the original point location.

1
2
3
4
5
6
7
8
9
10
11
12
{
  "default": {
    "tolerance": 500,
    "toleranceUnits": "esriMeters",
    "allowAutoRelocate": true,
    "sources": [
      {
        "name": "Routing_Streets"
      }
    ]
  }
}

• ObjectIDinteger

  The system-managed ID field.

• Namestring (length: 500)nullable

  The name of the closest facility route is based on the names of the associated facility and incident.

  The facility name is first if the value for the travelDirection property on the analysis object is set to esriNATravelDirectionFromFacility. For example, Facility 5 - Incident 3 indicates that the route travels from Facility 5 to Incident 3.

  If esriNATravelDirectionToFacility is specified as the value for the travelDirection property, the incident name is first, for example, Incident 3 — Facility 5 .

• FacilityRankintegernullable

  The rank of the facility among all facilities found for the associated incident; the closest facility has a rank of 1.

• FacilityIDintegernullable

  The unique ID of the facility the route visits.

  If you specify preserveObjectID=false, the value for this field will be a system-generated ID. If preserveObjectID=True, the value for this field will be the ObjectID of your associated input.

• IncidentIDintegernullable

  The unique ID of the incident the route visits.

  If you specify preserveObjectID=false, the value for this field will be a system-generated ID. If preserveObjectID=True, the value for this field will be the ObjectID of your associated input.

• FacilityCurbApproachint enumnullable

  Possible values: 1, 2

  The side of the vehicle the facility is on when arriving at or departing from the facility.

  • 1—Indicates the right side of vehicle
  • 2—Indicates the left side of vehicle

• IncidentCurbApproachintegernullable

  Possible values: 1, 2

  The side of the vehicle the incident is on when arriving at or departing from the incident.

  • 1—Indicates the right side of vehicle
  • 2—Indicates the left side of vehicle

• StartTimedatetimenullable

  The start time of the route, reported in the time zone in which the first stop is located.

• EndTimedatetimenullable

  The end time of the route, reported in the time zone in which the last stop is located.

• StartTimeUTCdatetimenullable

  The start time of the route in coordinated universal time (UTC).

• EndTimeUTCdatetimenullable

  The end time of the route in coordinated universal time (UTC).

• Total_[Cost]number (non-negative)nullable

  The total distance, time, or other travel cost from the beginning of the first stop to the end of the last stop. The total travel cost and the Attr_[Cost] of the visited stops are included in this value.

  This field will be populated if the [Cost] part of this field is used as impedance attribute or accumulated attributes.

• ObjectIDinteger

  If you specify preserveObjectID=false, the value for this field will be a system-generated ID. If preserveObjectID=True, the value for this field will be the ObjectID of your associated input.

• Namestring (length: 500)nullable

  The name of the facility. The values for this field are copied from the Name field on the input facilities.

• SourceIDinteger (non-negative)nullable

  The numeric identifier of the network dataset source feature class on which the input point is located.

• SourceOIDinteger (non-negative)nullable

  The object ID of the feature in the source on which the input point is located.

• PosAlongnumber (non-negative)nullable

  The position along the digitized direction of the source line feature. This value is stored as a ratio. This attribute is null if the network location references a junction.

• SideOfEdgeint enumnullable

  Allowed values: 1, 2

  The side of the edge in relation to the digitized direction of the line feature.

  This attribute is limited to a domain of two values:

  • 1: Right Side
  • 2: Left Side

• CurbApproachintegernullable

  The direction a vehicle may arrive at and depart from the facility. The values for this field are copied from the CurbApproach field on the input facilities.

• Statusint enum

  Indicates the status of the point with respect to its location on the network and the outcome of the analysis.

  Possible values:

  • 0: OK.The point was located on the network.
  • 1: Not Located. The point was not located on the network and was not included in the analysis.
  • 2: Network element not located. The network element identified by the point's network location fields cannot be found. This can occur when a network element where the point should be was deleted, and the network location was not recalculated.
  • 3: Element not traversable. The network element that the point is located on is not traversable. This can occur when the element is restricted by a restriction attribute.
  • 4: Invalid Field Values. Field values fall outside a range or coded-value domain. For example, a negative number exists where positive numbers are required.
  • 5: Not reached. The point cannot be reached by the solver. The point may be on a separate, disconnected area of the network from the other inputs, or barriers or restrictions prevent travel to or from the point.
  • 6: Time window violation. The point could not be reached within the designated time windows. This status only applies to network analysis types that support time windows.
  • 7: Not located on closest. The closest network location to the point is not traversable because of a restriction or barrier, so the point has been located on the closest traversable network feature instead. If time windows are used and the route arrives early or late, the value changes to 6 (Time window violation)

• SnapXnumber (non-negative)

  The x-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

• SnapYnumber (non-negative)

  The y-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

• SnapZnumber (non-negative)

  The z-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset. The SnapZ attribute is 0 if the network is two-dimensional.

• DistanceToNetworkInMetersnumber (non-negative)

  The distance in meters between the point's geographic location and the position where it was located on the network.

• Attr_[Cost]number (non-negative)nullable

  This field stores an extra cost for the network location.

• Cutoff_[Impedance]number (non-negative)nullable

  While searching for the closest incident from a facility, a cutoff value for the impedance can be used. Any incident beyond the cutoff value will not be searched.

  If the Cutoff_[Cost] value is not set for a facility, the analysis will use the defaultCutoff value. If the defaultCutoff value is not set on the service, the closest incident will be found, regardless of how far it may be.

• ObjectIDinteger

  If you specify preserveObjectID=false, the value for this field will be a system-generated ID. If preserveObjectID=True, the value for this field will be the ObjectID of your associated input.

• Namestring (length: 500)nullable

  The name of the incident. The values for this field are copied from the Name field on the input incidents.

• TargetFacilityCountstring (length: 500)nullable

  The number of facilities that need to be found for the given incident. The values for this field are copied from the TargetFacilityCount field on the input incident.

• SourceIDinteger (non-negative)nullable

  The numeric identifier of the network dataset source feature class on which the input point is located.

• SourceOIDinteger (non-negative)nullable

  The object ID of the feature in the source on which the input point is located.

• PosAlongnumber (non-negative)nullable

  The position along the digitized direction of the source line feature. This value is stored as a ratio. This attribute is null if the network location references a junction.

• SideOfEdgeint enumnullable

  Allowed values: 1, 2

  The side of the edge in relation to the digitized direction of the line feature.

  This attribute is limited to a domain of two values:

  • 1: Right Side
  • 2: Left Side

• CurbApproachintegernullable

  The direction a vehicle may arrive at and depart from the incident. The values for this field are copied from the CurbApproach field on the input incident.

• Statusint enum

  Indicates the status of the point with respect to its location on the network and the outcome of the analysis.

  Possible values:

  • 0: OK.The point was located on the network.
  • 1: Not Located. The point was not located on the network and was not included in the analysis.
  • 2: Network element not located. The network element identified by the point's network location fields cannot be found. This can occur when a network element where the point should be was deleted, and the network location was not recalculated.
  • 3: Element not traversable. The network element that the point is located on is not traversable. This can occur when the element is restricted by a restriction attribute.
  • 4: Invalid Field Values. Field values fall outside a range or coded-value domain. For example, a negative number exists where positive numbers are required.
  • 5: Not reached. The point cannot be reached by the solver. The point may be on a separate, disconnected area of the network from the other inputs, or barriers or restrictions prevent travel to or from the point.
  • 6: Time window violation. The point could not be reached within the designated time windows. This status only applies to network analysis types that support time windows.
  • 7: Not located on closest. The closest network location to the point is not traversable because of a restriction or barrier, so the point has been located on the closest traversable network feature instead. If time windows are used and the route arrives early or late, the value changes to 6 (Time window violation)

• SnapXnumber (non-negative)

  The x-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

• SnapYnumber (non-negative)

  The y-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

• SnapZnumber (non-negative)

  The z-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset. The SnapZ attribute is 0 if the network is two-dimensional.

• DistanceToNetworkInMetersnumber (non-negative)

  The distance in meters between the point's geographic location and the position where it was located on the network.

• Attr_[Cost]number (non-negative)nullable

  This field stores an extra cost for the network location.

• Cutoff_[Impedance]number (non-negative)nullable

  The cutoff value indicates the farthest network distance to search for a facility. Any facility farther from the incident than the cutoff value will not be searched or included in the results.

  If the Cutoff_[Cost] value is not set for an incident, the analysis will use the defaultCutoff value. If the defaultCutoff value is not set on the service, the closest facility will be found, regardless of how far it may be.

• ObjectIDinteger

  If you specify preserveObjectID=false, the value for this field will be a system-generated ID. If preserveObjectID=True, the value for this field will be the ObjectID of your associated input.

• Namestring (length: 500)

  The name of the barrier.

• SourceIDinteger (non-negative)nullable

  The numeric identifier of the network dataset source feature class on which the input point is located.

• SourceOIDinteger (non-negative)nullable

  The object ID of the feature in the source on which the input point is located.

• PosAlongnumber (non-negative)nullable

  The position along the digitized direction of the source line feature. This value is stored as a ratio. This attribute is null if the network location references a junction.

• SideOfEdgeint enumnullable

  Allowed values: 1, 2

  The side of the edge in relation to the digitized direction of the line feature.

  This attribute is limited to a domain of two values:

  • 1: Right Side
  • 2: Left Side

• CurbApproachint enumdefault:0

  Possible values: 0, 1, 2

  The direction of traffic that is affected by the barrier. The field value is specified as one of the following integers:

  • 0: Either side of vehicle. The barrier affects travel over the edge in both directions.
  • 1: Right side of vehicle. Vehicles are only affected if the barrier is on their right side during the approach. Vehicles that traverse the same edge but approach the barrier on their left side are not affected by the barrier.
  • 2: Vehicles are only affected if the barrier is on their left side during the approach. Vehicles that traverse the same edge but approach the barrier on their right side are not affected by the barrier.

• Statusint enum

  Indicates the status of the point with respect to its location on the network and the outcome of the analysis.

  Possible values:

  • 0: OK.The point was located on the network.
  • 1: Not Located. The point was not located on the network and was not included in the analysis.
  • 2: Network element not located. The network element identified by the point's network location fields cannot be found. This can occur when a network element where the point should be was deleted, and the network location was not recalculated.
  • 3: Element not traversable. The network element that the point is located on is not traversable. This can occur when the element is restricted by a restriction attribute.
  • 4: Invalid Field Values. Field values fall outside a range or coded-value domain. For example, a negative number exists where positive numbers are required.
  • 5: Not reached. The point cannot be reached by the solver. The point may be on a separate, disconnected area of the network from the other inputs, or barriers or restrictions prevent travel to or from the point.
  • 6: Time window violation. The point could not be reached within the designated time windows. This status only applies to network analysis types that support time windows.
  • 7: Not located on closest. The closest network location to the point is not traversable because of a restriction or barrier, so the point has been located on the closest traversable network feature instead. If time windows are used and the route arrives early or late, the value changes to 6 (Time window violation)

• FullEdgeint enum

  Possible values: 0, 1

  Point barriers are applied to the edge elements during the analysis. The field value is specified as one of the following integers

  • 0:False. Permits travel on the edge up to the barrier but not through it.
  • 1:True. Restricts travel anywhere on the associated edge.

• BarrierTypeint enum

  Possible values: 0, 2

  Specify 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:Restriction. Prohibits travel through the barrier. The barrier is referred to as a restriction point barrier since it acts as a restriction.
  • 2:Added Cost. Traveling through the barrier increases the travel time or distance by the amount specified in the Attr_[Cost] attribute.

• Attr_[Cost]number (non-negative)default:0

  This attribute is specific to added-cost barriers and is limited to values that are greater than or equal to zero. It indicates how much cost is added when the barrier is traversed.

• ObjectIDinteger

  If you specify preserveObjectID=false, the value for this field will be a system-generated ID. If preserveObjectID=True, the value for this field will be the ObjectID of your associated input.

• Namestring (length: 500)nullable

  The name of the barrier.

• BarrierTypeint enum

  Possible values: 0, 1

  Indicates whether the barrier restricts travel completely or scales time or distance when it is crossed. The value for this attribute is specified as one of the following integers:

  • 0:Restriction. Prohibits travel through the barrier. The barrier is referred to as a restriction point barrier since it acts as a restriction.
  • 1:Scaled Cost. Scales the time or distance required to travel the underlying streets by a factor specified using the Attr_[Cost] attribute.

• Attr_[Cost]number (non-negative)

  This attribute is specific to scaled-cost barriers. It is the factor by which the cost of edges underlying the barrier are multiplied.

• ObjectIDinteger

  If you specify preserveObjectID=false, the value for this field will be a system-generated ID. If preserveObjectID=True, the value for this field will be the ObjectID of your associated input.

• Namestring (length: 500)nullable

  The name of the barrier.

• BarrierTypeint enum

  Possible values: 0, 1

  Indicates whether the barrier restricts travel completely or scales time or distance when it is crossed. The value for this attribute is specified as one of the following integers:

  • 0:Restriction. Prohibits travel through the barrier. The barrier is referred to as a restriction point barrier since it acts as a restriction.
  • 1:Scaled Cost. Scales the time or distance required to travel the underlying streets by a factor specified using the Attr_[Cost] attribute.

• Attr_[Cost]number (non-negative)

  This attribute is specific to scaled-cost barriers. It is the factor by which the cost of edges underlying the barrier are multiplied.

• ObjectIDinteger

  The system-managed ID field.

• SourceIDinteger (non-negative)nullable

  The numeric identifier of the feature class the traversal element is referencing.

• SourceOIDinteger (non-negative)nullable

  The object ID of the traversed source feature.

• EIDinteger (non-negative)nullable

  The element ID (EID) of the traversed network edge. An EID uniquely describes a network element. The EID of a network element is independent of the object ID of the feature. One feature can be stored as many different elements in the network.

• FromPositionintegernullable

  Specifies where the output RouteEdges feature begins in reference to the digitized direction of the underlying street feature.

  • 0 (zero) indicates that the line begins at the from point of the underlying street feature.
  • 1 indicates that the line begins at the to point of the street feature.
  • A value between 0 and 1 indicates that the line begins at a point along the underlying street feature; for example, a value of 0.25 means the line begins 25 percent along the digitized direction of the underlying street feature.

• ToPositionintegernullable

  Specifies where the output RouteEdges feature ends in reference to the digitized direction of the underlying street feature.

  • 0 indicates that the line ends at the from point of the underlying street feature.
  • 1 indicates that the line ends at the to point of the street feature.
  • A value between 0 and 1 indicates that the line ends at a point along the underlying street feature; for example, a value of 0.25 means the line ends 25 percent along the digitized direction of the underlying street feature.

• FromJunctionIDintegernullable

  The reference to the object ID of the junction in the traversedJunctions record set that is coincident with the start of the edge.

• ToJunctionIDintegernullable

  The reference to the object ID of the junction in the traversedJunctions record set that is coincident with the end of the edge.

• RouteIDintegernullable

  The object ID of the route in the output routes record set.

• Attr_[Cost]number (non-negative)

  The cost of the underlying edge. The units of this field are the same as the units of the cost attribute referred to in the field name.

  This field will be populated if the [Cost] part of this field is used as an impedance attribute or accumulated attributes.

• Cumul_[Cost]number (non-negative)

  The cumulative cost of the underlying network elements from the beginning of the route to the end of the edge represented by the line feature.

  The units of this field are the same as the units of the cost attribute referred to in the field name.

  This field will be populated if the [Cost] part of this field is used as an impedance attribute or accumulated attributes.

• Attr_[Restriction]int enum

  Possible values: 0, 1

  Indicates whether the traversed edge used the restriction attribute referred to in this field's name.

  • 0—The traversed edge didn't use the restriction.
  • 1—The traversed edge used the restriction.

• ObjectIDinteger

  The system-managed ID field.

• SourceIDinteger (non-negative)nullable

  The numeric identifier of the feature class the traversal element is referencing.

• SourceOIDinteger (non-negative)nullable

  The object ID of the traversed source feature.

• EIDinteger (non-negative)nullable

  The element ID (EID) of the traversed network element. An EID uniquely describes a network element. The EID of a network element is independent of the object ID of the feature. One feature can be stored as many different elements in the network.

  EID is -1 if the current record doesn't represent a junction. For example, it is -1 if the record represents a stop on a route.

• RouteIDintegernullable

  The object ID of the route in the output routes record set.

• Attr_[Cost]number (non-negative)

  The cost of the underlying junction. The units of this field are the same as the units of the cost attribute referred to in the field name.

  This field will be populated if the [Cost] part of this field is used as an impedance attribute or accumulated attributes.

• Cumul_[Cost]number (non-negative)

  The cumulative cost of the underlying network elements from the beginning of the route through the location of the current point feature.

  The units of this field are the same as the units of the cost attribute referred to in the field name.

  This field will be populated if the [Cost] part of this field is used as an impedance attribute or accumulated attributes.

• Attr_[Restriction]int enum

  Possible values: 0, 1

  Indicates whether the traversed junction used the restriction attribute referred to in this field's name.

  • 0—The traversed junction didn't use the restriction.
  • 1—The traversed junction used the restriction.

• ObjectIDinteger

  The system-managed ID field.

• SourceIDinteger (non-negative)nullable

  The numeric identifier of the feature class the traversal element is referencing.

• SourceOIDinteger (non-negative)nullable

  The object ID of the traversed source feature.

• EIDinteger (non-negative)nullable

  The element ID (EID) of the traversed network element. An EID uniquely describes a network element. The EID of a network element is independent of the object ID of the feature. One feature can be stored as many different elements in the network.

  EID is -1 if the record represents a traversed global turn.

• FromEdgeIDintegernullable

  The object ID of the edge in the traversedEdges record set that is coincident with the turn.

• ToEdgeIDintegernullable

  The object ID of the edge in the traversedEdges record set that is coincident with the end of the turn.

• RouteIDintegernullable

  The object ID of the route in the output routes record set.

• Attr_[Cost]number (non-negative)

  The cost of the underlying turn. The units of this field are the same as the units of the cost attribute referred to in the field name.

  This field will be populated if the [Cost] part of this field is used as an impedance attribute or accumulated attributes.

• Cumul_[Cost]number (non-negative)

  The cumulative cost of the underlying network elements from the beginning of the route through the location of the current turn.

  The units of this field are the same as the units of the cost attribute referred to in the field name.

  This field will be populated if the [Cost] part of this field is used as an impedance attribute or accumulated attributes.

• Attr_[Restriction]int enum

  Possible values: 0, 1

  Indicates whether the traversed turn used the restriction attribute referred to in this field's name.

  • 0—The traversed turn didn't use the restriction.
  • 1—The traversed turn used the restriction.

• RouteIDintegernullable

  The ObjectID of the output routes feature with which this direction point is associated.

• Sequenceintegernullable

  The sequence of the direction points for the route, starting with 1.

• DirectionPointTypeintegernullable

  The type of direction event or maneuver described by the point, designated by one of the values below:

  Show values

  • 0: Unknown
  • 1: Header
  • 50: Arrival
  • 51: Departure
  • 52: Straight
  • 100: On Ferry
  • 101: Off Ferry
  • 102: Central Fork
  • 103: Roundabout
  • 104: U-Turn
  • 150: Door
  • 151: Stairs
  • 152: Elevator
  • 153: Escalator
  • 154: Pedestrian Ramp
  • 200: Left Fork
  • 201: Left Ramp
  • 202: Clockwise Roundabout
  • 203: Left-handed U-turn
  • 204: Bear left
  • 205: Left Turn
  • 206: Sharp Left
  • 207: Left Turn and immediate Left Turn
  • 208: Left Turn and immediate Right Turn
  • 300: Right Fork
  • 301: Right Ramp
  • 302: Counter-Clockwise Roundabout
  • 303: Right-handed U-turn
  • 304: Bear right
  • 305: Right Turn
  • 306: Sharp Right
  • 307: Right Turn and immediate Left Turn
  • 308: Right Turn and immediate Right Turn
  • 400: Up Elevator
  • 401: Up Escalator
  • 402: Up Stairs
  • 500: Down Elevator
  • 501: Down Escalator
  • 502: Down stairs
  • 1000: General Event
  • 1001: Landmark
  • 1002: Time Zone change
  • 1003: Traffic Event
  • 1004: Scaled Cost Barrier Event
  • 1005: Boundary Crossing
  • 1006: Restriction Violation

• FacilityIDintegernullable

  The object ID of the facility with which this direction point is associated, if any. If the point does not represent a visit to a facility, the value is null.

• IncidentIDintegernullable

  The object ID of the incident with which this direction point is associated, if any. If the point does not represent a visit to an incident, the value is null.

• DisplayTextstring (length: 1024)nullable

  The directions text to display in the consuming application.

• ArrivalTimedatetimenullable

  The time the direction event occurs in coordinated universal time (UTC).

• ArrivalUTCOffsetnumber (non-negative)nullable

  The difference in minutes between the local time at the maneuver location and UTC time shown in the ArrivalTime field.

• Namestring (length: 1024)nullable

  The name of the direction point.

• ExitNamestringnullable

  The highway exit name that appears in the directions instruction.

• AlternateNamestringnullable

  The alternate source name that appears in the directions instruction.

• IntersectingNamestringnullable

  The name of the intersecting or cross street that appears in the directions instruction.

• BranchNamestringnullable

  The signpost branch name that appears in the directions instruction.

• TowardNamestringnullable

  The signpost toward destination name that appears in the directions instruction.

• Levelintegernullable

  The building level at which this direction event occurs. This value corresponds to the Level property defined in the network dataset used for the analysis. This is relevant for 3D routing.

• ShortVoiceInstructionstring (length: 1024)nullable

  The shortened direction information that will be used for voice instructions. It provides turn actions or alerts.

• VoiceInstructionstring (length: 1024)nullable

  The direction information that will be used for voice instructions. It provides the expanded abbreviations or plurals along with turn actions or alerts.

• Azimuthnumber (non-negative)nullable

  The bearing in degrees of the vehicle departing this point. Zero indicates north. Null indicates that it is not applicable to this feature.

• DirectionPointIDintegernullable

  The ObjectID value of the feature in the DirectionPoints table with which this line is associated.

• RouteIDintegernullable

  The ObjectID of the output routes feature with which this direction line is associated.

• DirectionLineTypeintegernullable

  The type of direction situation described by this line, designated by one of the following values:

  Show values

  The type of direction of this line, designated by one of the following values:

  • 0: Unknown
  • 1: Segment
  • 2: Maneuver Segment
  • 3: Restriction Violation
  • 4: Scaled Cost Barrier Event
  • 5: Heavy Traffic
  • 6: Slow Traffic
  • 7: Moderate Traffic

• Metersnumber (non-negative)nullable

  The length of the line segment measured in meters.

• Minutesnumber (non-negative)nullable

  The travel time along the line segment in minutes.

• FromLevelintegernullable

  The building level at which this direction event begins. This value corresponds to the Level property defined in the network dataset used for the analysis.

• ToLevelintegernullable

  The building level at which this direction event ends. This value corresponds to the Level property defined in the network dataset used for the analysis.