Skip to main content

Travel mode JSON

A JSON object can be used to represent a travel mode.

A TravelMode Python object's JSON property can be used to get a JSON object representing the travel mode or to set the TravelMode Python object's properties to the values represented by the JSON object.

The table below lists the travel mode JSON object's keys and descriptions of their values. The table focuses on the JSON structure. For more detailed conceptual information about travel mode properties and how they are used in network analysis, refer to the documentation for the TravelMode Python object.

Key

Description

attributeParameterValues

Lists the parameterized attributes used by the travel mode.

The property is a list of JSON objects, each of which represents an attribute parameter and its value, with keys and values as follows:

  • attributeName—The name of the network attribute to which the parameter applies

  • parameterName—The name of the attribute parameter

  • value—The value of the attribute parameter

An truncated example of a list of attribute parameters is below:

[
    {
        "attributeName": "Height Restriction",
        "parameterName": "Restriction Usage",
        "value": -1
    },
    {
        "attributeName": "Height Restriction",
        "parameterName": "Vehicle Height (meters)",
        "value": 3
    },
    ...
]

For restriction usage parameters, numerical values are used to represent prohibited, avoid, and prefer usages.

Learn more about restriction usage parameters and the meanings of these numerical values.

description

A short text description of the travel mode.

distanceAttributeName

The distance-based cost attribute used by the travel mode.

impedanceAttributeName

The name of the network cost attribute used as impedance.

name

The unique name of the travel mode.

restrictionAttributeNames

The list of the restriction attributes used when solving network analysis problems with this travel mode. An empty list, [], indicates that no restriction attributes are used for this travel mode.

simplificationTolerance

Simplification tolerance specifies whether the travel mode generalizes the geometry of analysis results and by how much. The simplificationTolerance key is used to specify the numerical value of the simplification tolerance, and the simplificationToleranceUnits key is used to specify the unit of measurement of the value.

simplificationToleranceUnits

Simplification tolerance specifies whether the travel mode generalizes the geometry of analysis results and by how much. The simplificationTolerance key is used to specify the numerical value of the simplification tolerance, and the simplificationToleranceUnits key is used to specify the unit of measurement of the value.

The units are specified as one of the following:

  • esriCentimeters—Centimeters

  • esriDecimeters—Decimeters

  • esriFeet—US Survey Feet

  • esriInches—US Survey Inches

  • esriIntFeet—International Feet

  • esriIntInches—International Inches

  • esriIntMiles—Statute Miles

  • esriIntNauticalMiles—International Nautical Miles

  • esriIntYards—International Yards

  • esriKilometers—Kilometers

  • esriMeters—Meters

  • esriMiles—US Survey Miles

  • esriMillimeters—Millimeters

  • esriNauticalMiles—US Survey Nautical Miles

  • esriYards—US Survey Yards

timeAttributeName

The time-based cost attribute used by the travel mode.

type

Indicates the category of travel or vehicle represented by this travel mode. The following is a list of possible values:

  • AUTOMOBILE—The travel mode is used to represent travel by automobile.

  • TRUCK—The travel mode is used to represent travel by truck.

  • WALK—The travel mode is used to represent pedestrians traveling on foot.

  • OTHER—The travel mode is used to represent some other category of travel or vehicle not described above.

useHierarchy

Indicates whether the travel mode uses a hierarchy attribute while performing the analysis. The value is specified as a Boolean.

uturnAtJunctions

Indicates how the U-turns at junctions that could occur during network traversal are handled by the solver. The following is a list of possible values:

  • esriNFSBAllowBacktrack—U-turns are permitted at junctions with any number of connected edges.

  • esriNFSBNoBacktrack—U-turns are prohibited at all junctions, regardless of junction valency (number of connected edges).

  • esriNFSBAtDeadEndsOnly—U-turns are prohibited at all junctions, except those that have only one adjacent edge (a dead end).

  • esriNFSBAtDeadEndsAndIntersections—U-turns are prohibited at junctions where exactly two adjacent edges meet but are permitted at intersections (junctions with three or more adjacent edges) and dead ends (junctions with exactly one adjacent edge).