/solveODCostMatrix

Attributes for origins

• Namestring (length: 500)nullable

  The name of the origin. The name can be a unique identifier for the origin.

  If outputType is esriNAODOutputStraightLines or esriNAODOutputNoLines, the name is included in the output lines Name field (the output lines name will be origin name – destination name). The name is also included in the output origins as the Name field.

  If the name is not specified, a unique name prefixed with Location is automatically generated.

• ObjectIDinteger (non-negative)nullable

  The object ID of the origin.

  ObjectID is a unique identifier for the origin. If the outputType value is esriNAODOutputStraightLines or esriNAODOutputNoLines, the ObjectID value is included in the output lines (as the OriginID field). If outputType is esriNAODOutputSparseMatrix, the ObjectID value is included in the output matrix. The ObjectID value is also included in the output origins (as the ObjectID field) and can be used to join additional information from analysis outputs to the attribute of the origins. If the ObjectID value is not specified, a unique ID is automatically generated in the output.

• TargetDestinationCountinteger

  The maximum number of destinations to find for the origin.

  If a value is not specified, the value from the defaultTargetDestinationCount parameter is used.

  This field allows you to specify a different number of destinations to find for each origin. For example, using this field, you can find the three closest destinations from one origin and the two closest destinations from another origin.

• Cutoff_[Impedance]number (non-negative)

  If you want to stop searching for destinations once the search has exceeded a certain impedance value, specify a Cutoff_[Impedance] field value for your origin.

  This is the impedance attribute name in the analysis, or the impedance name of the travel mode if you specify a travel mode. This attribute allows you to specify a different cutoff value for each destination.

  For example, using this attribute, you can specify to search for destinations within five minutes of travel time from one origin and to search for destinations within eight minutes of travel time from another origin.

  The units of the cutoff are the same as the units of the impedance attribute. If a value is not specified, the defaultCutoff parameter value is used.

• CurbApproachint enumdefault:0

  Allowed values: 0, 1, 2, 3

  Specify the direction a vehicle can depart from the origin. The field value is specified as one of the following integers:

  • 0: Either side of vehicle. The vehicle can depart the origin in either direction. U-turns are allowed. You should choose this setting if your vehicle can make a U-turn at the origin or if it can pull into a driveway or parking lot and turn around.
  • 1: Right side of vehicle. When the vehicle departs the origin, the curb must be on the right side of the vehicle. A U-turn is prohibited.
  • 2: Left side of vehicle. When the vehicle departs the origin, the curb must be on the left side of the vehicle. A U-turn is prohibited.
  • 3: No U-turn. When the vehicle departs the origin, 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 depart the origin in either direction, so a U-turn is allowed at the origin. This setting can be chosen if it is possible and desirable for a vehicle to turn around at the origin. 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 departs the origin, the origin 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 departs the origin, the origin 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 departs the origin, the origin 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 origin 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 depart an origin 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 depart at an origin and not have a lane of traffic between the vehicle and the facility, 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 destinations

• Namestring (length: 500)nullable

  The name of the destination. The name can be a unique identifier for the destination.

  If outputType is esriNAODOutputStraightLines or esriNAODOutputNoLines, the name is included in the output lines Name field (the output lines name will be origin name – destination name). The name is also included in the output destinations as the Name field.

  If the name is not specified, a unique name prefixed with Location is automatically generated.

• ObjectIDinteger (non-negative)nullable

  The object ID of the destination.

  ObjectID is a unique identifier for the destination. If the outputType value is esriNAODOutputStraightLines or esriNAODOutputNoLines, the ObjectID value is included in the output lines (as the DestinationID field). If outputType is esriNAODOutputSparseMatrix, the ObjectID value is included in the output matrix. The ObjectID value is also included in the output destinations (as the ObjectID field) and can be used to join additional information from analysis outputs to the attribute of the destinations. 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

  Specify the direction a vehicle can arrive at a destination. The field value is specified as one of the following integers:

  • 0: Either side of vehicle. The vehicle can arrive at a destination in either direction. U-turns are allowed. You should choose this setting if your vehicle can make a U-turn at the destination or if it can pull into a driveway or parking lot and turn around.
  • 1: Right side of vehicle. When the vehicle arrive at a destination, the curb must be on the right side of the vehicle. A U-turn is prohibited.
  • 2: Left side of vehicle. When the vehicle arrive at a destination, the curb must be on the left side of the vehicle. A U-turn is prohibited.
  • 3: No U-turn. When the vehicle arrives at a destination, 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 arrive at a destination in either direction, so a U-turn is allowed at the destination. This setting can be chosen if it is possible and desirable for a vehicle to turn around at the destination. 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 arrive at a destination, the destination 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 arrive at a destination, the destination 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 arrive at a destination, the destination 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 a destination 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 arrive at a destination 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 a destination and not have a lane of traffic between the vehicle and the destination, 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.

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"
      }
    ]
  }
}

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.

• ObjectIDinteger (non-negative)nullable

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

• 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

• ObjectIDintegernullable

  The system-managed ID field.

• Namestring (length: 500)nullable

  The name of the corresponding input origin and destination feature. The origin name is first and the destination name is second, for example, Origin 1 – Destination 1. If the name is not specified for origin or destination, a unique name prefixed with Location is automatically generated for that origin or destination.

• OriginIDintegernullable

  The ObjectID value of the corresponding input origin feature. This can be used to join additional attributes between the input origins and the origin destination lines.

• DestinationIDintegernullable

  The ObjectID value of the corresponding input destination feature. This can be used to join additional attributes between the input destinations and the origin-destination lines.

• DestinationRankintegernullable

  The rank of the destination among all destinations found for the associated origin. The destination that is closest to the origin has a rank of 1.

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

  The travel cost along the street network from the associated origin to the associated destination. These fields are populated for the impedance attribute and any accumulated attributes.

• ObjectIDinteger

  The object ID of the input origin. If ObjectID is not specified, it will be a system-generated ID for the origin.

• Namestring (length: 500)nullable

  The name of the origin. If the name of the origin was specified as part of the Name field, this field has the same value. Otherwise, it includes an automatically generated value prefixed with Location.

• TargetDestinationCountintegernullable

  The value of the TargetDestinationCount field in the corresponding input origins.

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

  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 value of the CurbApproach field in the corresponding input origins.

• Statusint enum

  Allowed values: 0, 1, 2, 3, 4, 5, 6, 7

  Indicates the status of the point with respect to its location on the network and the outcome of the analysis. The possible values are as following:

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

• Cutoff_[Impedance]type:double (non-negative)nullable

  The value of the cutoff field in the corresponding input origins.

• ObjectIDinteger

  The object ID of the input destination. If ObjectID is not specified, it will be a system-generated ID for the destination.

• Namestring (length: 500)nullable

  The name of the destination. If the name for the origin was specified as part of the Name field, this field has the same value. Otherwise, it includes an automatically generated value prefixed with Location .

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

  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 value of the CurbApproach field in the corresponding input destinations.

• Statusint enum

  Allowed values: 0, 1, 2, 3, 4, 5, 6, 7

  Indicates the status of the point with respect to its location on the network and the outcome of the analysis. The possible values are as following:

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

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

  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

  Allowed 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

  Allowed values: 0, 1, 2, 3, 4, 5, 6, 7

  Indicates the status of the point with respect to its location on the network and the outcome of the analysis. The possible values are as following:

  • 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

  Allowed 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

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

  Allowed 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

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