Skip To Content

Network Analysis Layer

Description

The network layer resource represents a single network layer in routing services published by ArcGIS Server. It provides basic information about the network layer, such as its name, type, and network classes. Depending on the layer type, it also provides additional information, as detailed in the examples below.

Updates at 11.0

The Network Analysis Service has been renamed Routing services.

Updates at 10.4

The network layer resource now includes defaultTravelMode to identify the ID of the default travel mode. Both the network layer resource and the network attributes now include trafficSupport to show the level of traffic data the service supports. Attribute parameter values also have parameterType to assist in converting parameter values to the correct type.

Updates at 10.3

The network layer resource now includes supportedTravelModes to show the travel modes configured on the network dataset used by the service.

Updates at 10.1

The network layer resource now includes hasZ and hasM properties to indicate if it is z- or m-aware.

Request parameters

ParameterDetails
f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL for the network layer resource:

https://machine.domain.com/webadaptor/rest/services/World/Route/NAServer/Route_World?token=<yourToken>&f=pjson

JSON Response syntax

Route layer syntax example

The sample JSON response syntax below is for route layers.

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


{
  "currentVersion": <version>,
  "cimVersion": "<cimVersion>",
  "currentBuild": <buildNumber>,
  "layerName": "<layerName>",
  "layerType": "esriNAServerRouteLayer",
  "impedance": "<impedanceAttributeName>",
  "restrictions": [
    "<restrictionAttributeName1>",
    "<restrictionAttributeName2>"
  ],
  "snapTolerance": <snapTolerance>,
  "maxSnapTolerance": <value>,
  "snapToleranceUnits": "<units>",
  "locateSettings": {
    "default": {
      "tolerance": <value>,
      "toleranceUnits": "<units>",
      "allowAutoRelocate": <true | false>,
      "sources": [
        {
          "name": "<sourceName1>",
          "where": "<whereClause>"
        },
        {
          "name": "<sourceName2>",
          "where": "<whereClause>"
        }
      ]
    }
  },
  "ignoreInvalidLocations": <true | false>,
  "restrictUTurns": "esriNFSBAtDeadEndsAndIntersections | esriNFSBAllowBacktrack | esriNFSBAtDeadEndsOnly | esriNFSBNoBacktrack",
  "accumulateAttributeNames": [
    "<accumulateAttribute1>",
    "<accumulateAttribute2>"
  ],
  "attributeParameterValues": [
    {
      "attributeName": "<attributeName>",
      "parameterName": "<parameterName>",
      "parameterType": "<parameterType>",
      "value": "<value>"
    },
    ...
  ],
  "outputSpatialReference": {
    "wkid": <wkid>
  },
  "useHierarchy": <true | false>,
  "hierarchyAttributeName": "<hierarchyAttributeName>",
  "hierarchyLevelCount": <value>,
  "hierarchyMaxValues": [
    <hierarchyMaxValue1>,
    <hierarchyMaxValue2>
  ],
  "hierarchyNumTransitions": [
    <hierarchyNumTransitions1>,
    <hierarchyNumTransitions2>
  ],
  "networkClasses": [
    {
      "className": "<className1>",
      "fields": [
        {
          "fieldName": "<name1_1>",
          "defaultValue": "<value1_1>",
          "candidateFields": [
            "<cf1_1_1>",
            "<cf1_1_2>"
          ]
        },
        {
          "fieldName": "<name1_2>",
          "defaultValue": "<value1_2>",
          "candidateFields": [
            "<cf1_2_1>",
            "<cf1_2_2>"
          ]
        }
      ]
    },
    {
      "className": "<className2>",
      "fields": [
        {
          "fieldName": "<name2_1>",
          "defaultValue": "<value2_1>",
          "candidateFields": [
            "<cf2_1_1>",
            "<cf2_1_2>"
          ]
        },
        {
          "fieldName": "<name1_2>",
          "defaultValue": "<value1_2>",
          "candidateFields": [
            "<cf2_2_1>",
            "<cf2_2_2>"
          ]
        },
        ...
      ]
    }
    ...
  ],
  "networkDataset": {
    "name": "<name>",
    "buildTime": <buildTime>,
    "state": "<state>",
    "networkAttributes": [
      {
        "name": "<name1>",
        "dataType": "<dataType>",
        "units": "<units>",
        "usageType": "<usageType>",
        "parameterNames": [
          "parameterName1",
          "parameterName2"
        ],
        "restrictionUsageParameterName": "<restrictionUsageParameterName>",
        "trafficSupport": "esriNTSNone | esriNTSHistorical | esriNTSHistoricalAndLive"
      },
      ...
    ],
    "networkSources": [
      {
        "name": "<name>",
        "elementType": "<elementType>",
        "sourceType": "<sourceType>",
        "id": "<id>"
      },
      ...
    ]
  },
  "hasM": <true | false>,
  "hasZ": <true | false>,
  "defaultTravelMode": "<defaultTravelMode>",
  "supportedTravelModes": [
    {
      "name": "<name>",
      "itemId": "<itemID>",
      "type": "<type>",
      "description": "<description>",
      "timeAttributeName": "<timeAttributeName>",
      "distanceAttributeName": "<distanceAttributeName>",
      "impedanceAttributeName": "<impedanceAttributeName>",
      "restrictionAttributeNames": [
        "<restrictionAttributeName1>",
        "<restrictionAttributeName2>",
        ...
      ],
      "attributeParameterValues": [
        {
          "attributeName": "<attributeName>",
          "parameterName": "<parameterName>",
          "value": "<value>"
        },
        ...
      ],
      "useHierarchy": <true | false>,
      "uturnAtJunctions": "esriNFSBAtDeadEndsAndIntersections | esriNFSBAllowBacktrack | esriNFSBAtDeadEndsOnly | esriNFSBNoBacktrack",
      "simplificationTolerance": <value>,
      "simplificationToleranceUnits": "<units>"
    },
    ...
  ],
  "trafficSupport": "esriNTSNone | esriNTSHistorical | esriNTSHistoricalAndLive",
  "outputGeometryPrecision": <value>,
  "outputGeometryPrecisionUnits": "<units>",
  "supportsPreservingObjectID": <true | false>,
  "preserveObjectID": <true | false>,
  "findBestSequence": <true | false>,
  "useStartTime": <true | false>,
  "startTime": "<startTime>",
  "startTimeIsUTC": <true | false>,
  "timeWindowsAreUTC": <true | false>,
  "useTimeWindows": <true | false>,
  "preserveFirstStop": <true | false>,
  "preserveLastStop": <true | false>,
  "outputLineType": "esriNAOutputLineTrueShape | esriNAOutputLineTrueShapeWithMeasure | esriNAOutputLineStraight | esriNAOutputLineNone",
  "directionsLanguage": "<languageCode>",
  "directionsSupportedLanguages": [
    "<languageCode1>",
    "<languageCode2>"
  ],
  "directionsStyleNames": [
    "<directionsStyleName1>",
    "<directionsStyleName2>"
  ],
  "directionsLengthUnits": "<units>",
  "directionsTimeAttribute": "<attributeName>",
  "supportsDirections": <true | false>,
  "returnDirections": <true | false>,
  "serviceLimits": {
    "AllowSaveLayerOnServer": <true | false>,
    "LicensedForAutomaticRerouting": <true | false>
  }
}

Closest facility layer syntax example

The sample JSON response syntax below is for a closest facility layer.

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


{
  "currentVersion": <version>,
  "cimVersion": "<cimVersion>",
  "currentBuild": <buildNumber>,
  "layerName": "<layerName>",
  "layerType": "esriNAServerClosestFacilityLayer",
  "impedance": "<impedanceAttributeName>",
  "restrictions": [
    "<restrictionAttributeName1>",
    "<restrictionAttributeName2>"
  ], 
  "snapTolerance": <snapTolerance>,
  "maxSnapTolerance": <value>,
  "snapToleranceUnits": "<units>",
  "locateSettings": {
    "default": {
      "tolerance": <value>,
      "toleranceUnits": "<units>",
      "allowAutoRelocate": <true | false>,
      "sources": [
        {
          "name": "<sourceName1>",
          "where": "<whereClause>"
        },
        {
          "name": "<sourceName2>",
          "where": "<whereClause>"
        }
      ]
    }
  },
  "ignoreInvalidLocations": <true | false>,
  "restrictUTurns": "esriNFSBAtDeadEndsAndIntersections | esriNFSBAllowBacktrack | esriNFSBAtDeadEndsOnly | esriNFSBNoBacktrack",
  "accumulateAttributeNames": [
    "<accumulateAttribute1>",
    "<accumulateAttribute2>"
  ],
  "attributeParameterValues": [
    {
      "attributeName": "<attributeName>",
      "parameterName": "<parameterName>",
      "parameterType": "<parameterType>",
      "value": "<value>"
    },
    ...
  ],
  "outputSpatialReference": {
    "wkid": <wkid>
  },
  "useHierarchy": <true | false>,
  "hierarchyAttributeName": "<hierarchyAttributeName>",
  "hierarchyLevelCount": <value>,
  "hierarchyMaxValues": [
    <hierarchyMaxValue1>,
    <hierarchyMaxValue2>
  ],
  "hierarchyNumTransitions": [
    <hierarchyNumTransitions1>,
    <hierarchyNumTransitions2>
  ],
  "networkClasses": [
    {
      "className": "<className1>",
      "fields": [
        {
          "fieldName": "<name1_1>",
          "defaultValue": "<value1_1>",
          "candidateFields": [
            "<cf1_1_1>",
            "<cf1_1_2>"
          ]
        },
        {
          "fieldName": "<name1_2>",
          "defaultValue": "<value1_2>",
          "candidateFields": [
            "<cf1_2_1>",
            "<cf1_2_2>"
          ]
        }
        ...
      ]
    },
    {
      "className": "<className2>",
      "fields": [
        {
          "fieldName": "<name2_1>",
          "defaultValue": "<value2_1>",
          "candidateFields": [
            "<cf2_1_1>",
            "<cf2_1_2>"
          ]
        },
        {
          "fieldName": "<name1_2>",
          "defaultValue": "<value1_2>",
          "candidateFields": [
            "<cf2_2_1>",
            "<cf2_2_2>"
          ]
        },
        ...
      ]
    }
    ...
  ],
  "networkDataset": {
    "name": "<name>",
    "buildTime": <buildTime>,
    "state": "esriNDSBuilt",
    "networkAttributes": [
      {
        "name": "<name1>",
        "dataType": "<dataType>",
        "units": "<units>",
        "usageType": "<usageType>",
        "parameterNames": [
          "parameterName1",
          "parameterName2"
        ],
        "restrictionUsageParameterName": "<restrictionUsageParameterName>",
        "trafficSupport": "esriNTSNone | esriNTSHistorical | esriNTSHistoricalAndLive"
      },
      ...
    ],
    "networkSources": [
      {
        "name": "<name>",
        "elementType": "<elementType>",
        "sourceType": "<sourceType>",
        "id": "<id>"
      },
      ...
    ]
  },
  "hasM": <true | false>,
  "hasZ": <true | false>,
  "defaultTravelMode": "<defaultTravelMode>",
  "supportedTravelModes": [
    {
      "name": "<name>",
      "itemId": "<itemID>",
      "type": "<type>",
      "description": "<description>",
      "timeAttributeName": "<timeAttributeName>",
      "distanceAttributeName": "<distanceAttributeName>",
      "impedanceAttributeName": "<impedanceAttributeName>",
      "restrictionAttributeNames": [
        "<restrictionAttributeName1>",
        "<restrictionAttributeName2>",
        ...
      ],
      "attributeParameterValues": [
        {
          "attributeName": "<attributeName>",
          "parameterName": "<parameterName>",
          "value": "<value>"
        },
        ...
      ],
      "useHierarchy": <true | false>,
      "uturnAtJunctions": "esriNFSBAtDeadEndsAndIntersections | esriNFSBAllowBacktrack | esriNFSBAtDeadEndsOnly | esriNFSBNoBacktrack",
      "simplificationTolerance": <value>,
      "simplificationToleranceUnits": "<units>"
    },
    ...
  ],
  "trafficSupport": "esriNTSNone | esriNTSHistorical | esriNTSHistoricalAndLive",
  "outputGeometryPrecision": <value>,
  "outputGeometryPrecisionUnits": "<units>",
  "supportsPreservingObjectID": <true | false>,
  "preserveObjectID": <true | false>,
  "defaultCutoffValue": <defaultCutoffValue>,
  "facilityCount": <value>,
  "travelDirection": "esriNATravelDirectionFromFacility | esriNATravelDirectionToFacility",
  "outputLineType": "esriNAOutputLineTrueShape | esriNAOutputLineTrueShapeWithMeasure | esriNAOutputLineStraight | esriNAOutputLineNone",
  "directionsLanguage": "<languageCode>", 
  "directionsSupportedLanguages": [
    "<languageCode1>",
    "<languageCode2>"
  ],
  "directionsStyleNames": [
    "<directionsStyleName1>",
    "<directionsStyleName2>"
  ],
  "directionsLengthUnits": "<units>",
  "directionsTimeAttribute": "<attributeName>",
  "supportsDirections": <true | false>,
  "returnDirections": <true | false>,
  "timeOfDay": "<timeOfDay>",
  "timeOfDayIsUTC": <true | false>,
  "timeOfDayUsage": "esriNATimeOfDayUseAsStartTime | esriNATimeOfDayUseAsEndTime",
  "serviceLimits": {
    "AllowSaveLayerOnServer": <true | false>,
    "LicensedForAutomaticRerouting": <true | false>
  }
}

Service area layer syntax example

The sample JSON response syntax below is for a service area layer.

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


{
  "currentVersion": <version>,
  "cimVersion": "<cimVersion>",
  "currentBuild": <buildNumber>,
  "layerName": "<layerName>",
  "layerType": "esriNAServerServiceAreaLayer",
  "impedance": "<impedanceAttributeName>",
  "restrictions": [
    "<restrictionAttributeName1>",
    "<restrictionAttributeName2>"
  ],
  "snapTolerance": <snapTolerance>,
  "maxSnapTolerance": <value>,
  "snapToleranceUnits": "<units>",
  "locateSettings": {
    "default": {
      "tolerance": <value>,
      "toleranceUnits": "<units>",
      "allowAutoRelocate": <true | false>,
      "sources": [
        {
          "name": "<sourceName1>",
          "where": "<whereClause>"
        },
        {
          "name": "<sourceName2>",
          "where": "<whereClause>"
        }
      ]
    }
  },
  "ignoreInvalidLocations": <true | false>,
  "restrictUTurns": "esriNFSBAtDeadEndsAndIntersections | esriNFSBAllowBacktrack | esriNFSBAtDeadEndsOnly | esriNFSBNoBacktrack",
  "accumulateAttributeNames": [
    "<accumulateAttribute1>",
    "<accumulateAttribute2>"
  ],
  "attributeParameterValues": [
    {
      "attributeName": "<attributeName>",
      "parameterName": "<parameterName>",
      "parameterType": "<parameterType>",
      "value": "<value>"
    },
    ...
  ],
  "outputSpatialReference": {
    "wkid": <wkid>
  },
  "useHierarchy": <true | false>,
  "hierarchyAttributeName": "<hierarchyAttributeName>",
  "hierarchyLevelCount": <value>,
  "hierarchyMaxValues": [
    <hierarchyMaxValue1>,
    <hierarchyMaxValue2>
  ],
  "hierarchyNumTransitions": [
    <hierarchyNumTransitions1>,
    <hierarchyNumTransitions2>
  ],
  "networkClasses": [
    {
      "className": "<className1>",
      "fields": [
        {
          "fieldName": "<name1_1>",
          "defaultValue": "<value1_1>",
          "candidateFields": [
            "<cf1_1_1>",
            "<cf1_1_2>"
          ]
        },
        ...
      ]
    },       
    {
      "className": "<className2>",
      "fields": [
        {
          "fieldName": "<name2_1>",
          "defaultValue": "<value2_1>",
          "candidateFields": [
            "<cf2_1_1>",
            "<cf2_1_2>"
          ]
        },
        {
          "fieldName": "<name1_2>",
          "defaultValue": "<value1_2>",
          "candidateFields": [
            "<cf2_2_1>",
            "<cf2_2_2>"
          ]
        },
        ...
      ]
    }
    ...
  ],
  "networkDataset": {
    "name": "<name>",
    "buildTime": <buildTime>,
    "state": "<state>",
    "networkAttributes": [
      {
        "name": "<name1>",
        "dataType": "<dataType>",
        "units": "<units>",
        "usageType": "<usageType>",
        "parameterNames": [
          "parameterName1",
          "parameterName2"
        ],
        "restrictionUsageParameterName": "<restrictionUsageParameterName>",
        "trafficSupport": "esriNTSNone | esriNTSHistorical | esriNTSHistoricalAndLive"
      }
      ...
    ],
    "networkSources": [
      {
        "name": "<name>",
        "elementType": "<elementType>",
        "sourceType": "<sourceType>",
        "id": "<id>"
      },
      ...
    ]  
  },
  "hasM": true,
  "hasZ": false,
  "defaultTravelMode": "1",
  "supportedTravelModes": [
    {
      "name": "<name>",
      "itemId": "<itemID>",
      "type": "<type>",
      "description": "<description>",
      "timeAttributeName": "<timeAttributeName>",
      "distanceAttributeName": "<distanceAttributeName>",
      "impedanceAttributeName": "<impedanceAttributeName>",
        "restrictionAttributeNames": [
          "<restrictionAttributeName1>",
          "<restrictionAttributeName2>",
          ...
        ],
        "attributeParameterValues": [
          {
            "attributeName": "<attributeName>",
            "parameterName": "<parameterName>",
            "value": "<value>"
          },
          ...
        ],
        "useHierarchy": <true | false>,
        "uturnAtJunctions": "esriNFSBAtDeadEndsAndIntersections | esriNFSBAllowBacktrack | esriNFSBAtDeadEndsOnly | esriNFSBNoBacktrack",
        "simplificationTolerance": <value>,
        "simplificationToleranceUnits": "<units>"
      },
      ...
    ], 
    "trafficSupport": "esriNTSNone | esriNTSHistorical | esriNTSHistoricalAndLive",
    "outputGeometryPrecision": <value>,
    "outputGeometryPrecisionUnits": "<units>",
    "supportsPreservingObjectID": <true | false>,
    "preserveObjectID": <true | false>,  
    "defaultBreaks": [
      <value1>,
      <value2>,
      <value3>
    ],
    "splitPolygonsAtBreaks": <true | false>,
    "mergeSimilarPolygonRanges": <true | false>,
    "excludeSourcesFromPolygons": [],
    "splitLinesAtBreaks": <true | false>,
    "overlapLines": <true | false>,
    "outputPolygons": "esriNAOutputPolygonSimplified | esriNAOutputPolygonNone | esriNAOutputPolygonDetailed",
    "outputLines": "esriNAOutputLineNone | esriNAOutputLineTrueShape | esriNAOutputLineTrueShapeWithMeasure",
    "includeSourceInformationOnLines": <true | false>,
    "overlapPolygons": <true | false>,
    "trimOuterPolygon": <true | false>,
    "trimPolygonDistance": 100,
    "trimPolygonDistanceUnits": "<trimPolygonDistanceUnits>",
    "travelDirection": "esriNATravelDirectionFromFacility | esriNATravelDirectionToFacility",
    "timeOfDay": null,
    "timeOfDayIsUTC": <true | false>,
    "timeOfDayUsage": "<timeOfDayUsage>",
    "serviceLimits": {
      "AllowSaveLayerOnServer": "<true | false>"
    }
  ]
}

Travel cost matrix layer syntax example

The sample JSON response syntax below is for a travel cost matrix layer.

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


{
  "currentVersion": <version>,
  "cimVersion": "<cimVersion>",
  "currentBuild": <buildNumber>,
  "layerName": "<layerName>",
  "layerType": "esriNAServerODCostMatrixLayer",
  "impedance": "<impedanceAttributeName>",
  "restrictions": [
    "<restrictionAttributeName1>",
    "<restrictionAttributeName2>"
  ],
  "snapTolerance": <snapTolerance>,
  "maxSnapTolerance": <value>,
  "snapToleranceUnits": "<units>",
  "locateSettings": {
    "default": {
      "tolerance": <value>,
      "toleranceUnits": "<units>",
      "allowAutoRelocate": <true | false>,
      "sources": [
        {
          "name": "<sourceName1>",
          "where": "<whereClause>"
        },
        {
          "name": "<sourceName2>",
          "where": "<whereClause>"
        }
      ]
    }
  },
  "ignoreInvalidLocations": <true | false>,
  "restrictUTurns": "esriNFSBAtDeadEndsAndIntersections | esriNFSBAllowBacktrack | esriNFSBAtDeadEndsOnly | esriNFSBNoBacktrack",
  "accumulateAttributeNames": [
    "<accumulateAttribute1>",
    "<accumulateAttribute2>"
  ],
  "attributeParameterValues": [
    {
      "attributeName":"<attributeName>",
      "parameterName": "<parameterName>",
      "parameterType": "<parameterType>",
      "value": "<value>"
    },
    ...
  ],
  "outputSpatialReference": {
    "wkid": <wkid>
  },
  "useHierarchy": <true | false>,
  "hierarchyAttributeName": "<hierarchyAttributeName>",
  "hierarchyLevelCount": <value>,
  "hierarchyMaxValues": [
    <hierarchyMaxValue1>,
    <hierarchyMaxValue2>
  ],
  "hierarchyNumTransitions": [
    <hierarchyNumTransitions1>,
    <hierarchyNumTransitions2>
  ],
  "networkClasses": [
    {
      "className": "<className1>",
      "fields": [
        {
          "fieldName": "<name1_1>",
          "defaultValue": "<value1_1>",
          "candidateFields": [
            "<cf1_1_1>",
            "<cf1_1_2>"
          ]
        },
        {
          "fieldName": "<name1_2>",
          "defaultValue": "<value1_2>",
          "candidateFields": [
            "<cf1_2_1>",
            "<cf1_2_2>"
          ]
        } 
        ... 
      ]
    },       
    {
      "className": "<className2>",
        "fields": [
          {
            "fieldName": "<name2_1>",
            "defaultValue": "<value2_1>",
            "candidateFields": [
              "<cf2_1_1>",
              "<cf2_1_2>"
            ]
          },
          {
            "fieldName": "<name1_2>",
            "defaultValue": "<value1_2>",
            "candidateFields": [
              "<cf2_2_1>",
              "<cf2_2_2>"
            ]
          },
          ...
        ]
      }
      ...
    ],
    "networkDataset": {
      "name": "<name>",
      "buildTime": <buildTime>,
      "state": "<state>",
      "networkAttributes": [
        {
          "name": "<name1>",
          "dataType": "<dataType>",
          "units": "<units>",
          "usageType": "<usageType>",
          "parameterNames": [
            "parameterName1",
            "parameterName2"
          ],
          "restrictionUsageParameterName": "<restrictionUsageParameterName>",
          "trafficSupport": "esriNTSNone | esriNTSHistorical | esriNTSHistoricalAndLive"
        }
        ...
      ],
      "networkSources": [
        {
          "name": "<name>",
          "elementType": "<elementType>",
          "sourceType": "<sourceType>",
          "id": "<id>"
        },
        ...
      ]  
    },
    "hasM": <true | false>,
    "hasZ": <true | false>,
    "defaultTravelMode": "<defaultTravelMode>",
    "supportedTravelModes": [
      {
        "name": "<name>",
        "itemId": "<itemID>",
        "type": "<type>",
        "description": "<description>",
        "timeAttributeName": "<timeAttributeName>",
        "distanceAttributeName": "<distanceAttributeName>",
        "impedanceAttributeName": "<impedanceAttributeName>",
        "restrictionAttributeNames": [
          "<restrictionAttributeName1>",
          "<restrictionAttributeName2>",
          ...
        ],    
        "attributeParameterValues": [
          {
            "attributeName": "<attributeName>",
            "parameterName": "<parameterName>",
            "value": "<value>"
          },
          ...
        ],
        "useHierarchy": <true | false>,
        "uturnAtJunctions": "esriNFSBAtDeadEndsAndIntersections | esriNFSBAllowBacktrack | esriNFSBAtDeadEndsOnly | esriNFSBNoBacktrack",
        "simplificationTolerance": <value>,
        "simplificationToleranceUnits": "<units>"
      },
      ...
    ],
    "trafficSupport": "esriNTSNone | esriNTSHistorical | esriNTSHistoricalAndLive",
    "supportsPreservingObjectID": <true | false>,
    "defaultCutoffValue": <value>,
    "defaultTargetDestinationCount": <value>,
    "outputType": "esriNAODOutputSparseMatrix | esriNAODOutputStraightLines | esriNAODOutputNoLines",
    "timeOfDay": null,
    "timeOfDayIsUTC": false,
    "serviceLimits": {
      "AllowSaveLayerOnServer": "<true | false>"
    }
  ]
}

JSON Response examples

Route layer example

The sample JSON response below is for a route layer.

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


{
  "currentVersion": 11.1,
  "cimVersion": "3.1.0",
  "currentBuild": 41738,
  "layerName": "Route",
  "layerType": "esriNAServerRouteLayer",
  "impedance": "TravelTime",
  "restrictions": [
    "Avoid Unpaved Roads",
    "Avoid Private Roads",
    "Driving an Automobile",
    "Through Traffic Prohibited",
    "Roads Under Construction Prohibited",
    "Avoid Gates",
    "Avoid Express Lanes",
    "Avoid Carpool Roads"
  ],
  "snapTolerance": 0,
  "maxSnapTolerance": 20000,
  "snapToleranceUnits": "esriMeters",
  "locateSettings": {
    "default": {
      "tolerance": 20000,
      "toleranceUnits": "esriMeters",
      "allowAutoRelocate": true,
      "sources": [
        {"name": "Routing_Streets"},
        {"name": "Custom_Streets"},
        {"name": "Custom_Streets_Override"}
      ]
    }
  },
  "ignoreInvalidLocations": true,
  "restrictUTurns": "esriNFSBAtDeadEndsAndIntersections",
  "accumulateAttributeNames": [
    "Miles",
    "Kilometers"
  ],
  "attributeParameterValues": [
    {
      "attributeName": "Any Hazmat Prohibited",
      "parameterName": "Restriction Usage",
      "parameterType": "float",
      "value": "Prohibited"
    },
    {
      "attributeName": "Avoid Carpool Roads",
      "parameterName": "Restriction Usage",
      "parameterType": "float",
      "value": "Prohibited"
    },
    ...
  ],
  "outputSpatialReference": {"wkid": 102100},
  "useHierarchy": true,
  "hierarchyAttributeName": "Hierarchy",
  "hierarchyLevelCount": 3,
  "hierarchyMaxValues": [
    2,
    4
  ],
  "hierarchyNumTransitions": [
    9,
    6
  ],
  "networkClasses": [
    {
      "className": "Stops",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Address",
            "Label",
            "Location",
            "Stop",
            "WayPoint",
            "Description",
            "Title",
            "DepotName"
          ]
        },
        {
          "fieldName": "RouteName",
          "defaultValue": null,
          "candidateFields": [
            "RouteName",
            "Route",
            "RouteID",
            "NoteType"
          ]
        },
        {
          "fieldName": "Sequence",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "TimeWindowStart",
          "defaultValue": null,
          "candidateFields": [
            "TimeWindowStart1",
            "TWStart1",
            "FromTime1",
            "FromTimeWindow1",
            "FromTW1",
            "From1",
            "TimeWindowStart",
            "TWStart",
            "FromTime",
            "FromTimeWindow",
            "FromTW",
            "From"
          ]
        },
        {
          "fieldName": "TimeWindowEnd",
          "defaultValue": null,
          "candidateFields": [
            "TimeWindowEnd1",
            "TWEnd1",
            "ToTime1",
            "ToTimeWindow1",
            "ToTW1",
            "To1",
            "TimeWindowEnd",
            "TWEnd",
            "ToTime",
            "ToTimeWindow",
            "ToTW",
            "To"
          ]
        },
        {
          "fieldName": "LocationType",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "SourceID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceID",
            "SID",
            "Source"
          ]
        },
        {
          "fieldName": "SourceOID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceOID",
            "SOID"
          ]
        },
        {
          "fieldName": "PosAlong",
          "defaultValue": 0,
          "candidateFields": [
            "PosAlong",
            "PA",
            "Pos"
          ]
        },
        {
          "fieldName": "SideOfEdge",
          "defaultValue": 2,
          "candidateFields": [
            "SideOfEdge",
            "SOE"
          ]
        },
        {
          "fieldName": "CurbApproach",
          "defaultValue": 0,
          "candidateFields": [
            "CurbApproach",
            "SideOfStreet",
            "SideApproach",
            "CurbSide",
            "Curb"
          ]
        },
        {
          "fieldName": "Status",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Minutes",
            "Minutes",
            "VisitTime",
            "StopTime",
            "Delay",
            "ServiceTime",
            "SrvTime",
            "StartDepotServiceTime",
            "StartSrvTime",
            "StartSrv"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 0,
          "candidateFields": null
        }
      ]
    },
    {
      "className": "Barriers",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Address",
            "Label",
            "Location",
            "Barrier",
            "Description",
            "Title"
          ]
        },
        {
          "fieldName": "SourceID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceID",
            "SID",
            "Source"
          ]
        },
        {
          "fieldName": "SourceOID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceOID",
            "SOID"
          ]
        },
        {
          "fieldName": "PosAlong",
          "defaultValue": 0,
          "candidateFields": [
            "PosAlong",
            "PA",
            "Pos"
          ]
        },
        {
          "fieldName": "SideOfEdge",
          "defaultValue": 2,
          "candidateFields": [
            "SideOfEdge",
            "SOE"
          ]
        },
        {
          "fieldName": "CurbApproach",
          "defaultValue": 0,
          "candidateFields": [
            "CurbApproach",
            "SideOfStreet",
            "SideApproach",
            "CurbSide",
            "Curb"
          ]
        },
        {
          "fieldName": "Status",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "FullEdge",
          "defaultValue": 0,
          "candidateFields": [
            "FullEdge",
            "IsFullEdge",
            "BlockEntire"
          ]
        },
        {
          "fieldName": "BarrierType",
          "defaultValue": 0,
          "candidateFields": [
            "BarrierType",
            "BarType",
            "BarrierTyp"
          ]
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Minutes",
            "Minutes",
            "VisitTime",
            "StopTime",
            "Delay",
            "ServiceTime",
            "SrvTime",
            "StartDepotServiceTime",
            "StartSrvTime",
            "StartSrv"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 0,
          "candidateFields": null
        }
      ]
    },
    {
      "className": "PolylineBarriers",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Label",
            "Locations",
            "Barrier",
            "Description",
            "Title"
          ]
        },
        {
          "fieldName": "Locations",
          "defaultValue": null,
          "candidateFields": [
            "Locations",
            "LocRanges"
          ]
        },
        {
          "fieldName": "BarrierType",
          "defaultValue": 0,
          "candidateFields": [
            "BarrierType",
            "BarType",
            "BarrierTyp"
          ]
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Minutes",
            "Minutes",
            "Scaled_Cost",
            "Scaled_Time"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Kilometers",
            "Kilometers"
          ]
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 1,
          "candidateFields": null
        }
      ]
    },
    {
      "className": "PolygonBarriers",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Label",
            "Locations",
            "Barrier",
            "Description",
            "Title"
          ]
        },
        {
          "fieldName": "Locations",
          "defaultValue": null,
          "candidateFields": [
            "Locations",
            "LocRanges"
          ]
        },
        {
          "fieldName": "BarrierType",
          "defaultValue": 0,
          "candidateFields": [
            "BarrierType",
            "BarType",
            "BarrierTyp"
          ]
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Minutes",
            "Minutes",
            "Scaled_Cost",
            "Scaled_Time"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Kilometers",
            "Kilometers"
          ]
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 1,
          "candidateFields": null
        }
      ]
    }
  ],
  "networkDataset": {
    "name": "Routing_ND",
    "buildTime": 1631404171000,
    "state": "esriNDSBuilt",
    "networkAttributes": [
      {
        "name": "Hierarchy",
        "dataType": "esriNADTInteger",
        "units": "esriNAUUnknown",
        "usageType": "esriNAUTHierarchy",
        "parameterNames": [],
        "restrictionUsageParameterName": null,
        "trafficSupport": "esriNTSNone"
      },
      {
        "name": "Minutes",
        "dataType": "esriNADTDouble",
        "units": "esriNAUMinutes",
        "usageType": "esriNAUTCost",
        "parameterNames": [],
        "restrictionUsageParameterName": null,
        "trafficSupport": "esriNTSNone"
      },
      ...
    ],
    "networkSources": [
      {
        "name": "Routing_Streets",
        "elementType": "esriNETEdge",
        "sourceType": "esriNSTEdgeFeature",
        "id": 1
      },
      {
        "name": "Custom_Streets",
        "elementType": "esriNETEdge",
        "sourceType": "esriNSTEdgeFeature",
        "id": 6
      },
      {
        "name": "Routing_Streets_Override",
        "elementType": "esriNETJunction",
        "sourceType": "esriNSTJunctionFeature",
        "id": 4
      },
      {
        "name": "Custom_Streets_Override",
        "elementType": "esriNETJunction",
        "sourceType": "esriNSTJunctionFeature",
        "id": 5
      },
      {
        "name": "Routing_ND_Junctions",
        "elementType": "esriNETJunction",
        "sourceType": "esriNSTSystemJunction",
        "id": 3
      },
      {
        "name": "RestrictedTurns",
        "elementType": "esriNETTurn",
        "sourceType": "esriNSTTurnFeature",
        "id": 2
      },
      {
        "name": "Custom_Turns",
        "elementType": "esriNETTurn",
        "sourceType": "esriNSTTurnFeature",
        "id": 7
      }
    ]
  },
  "hasM": true,
  "hasZ": false,
  "defaultTravelMode": "1",
  "supportedTravelModes": [
    {
      "name": "Driving Time",
      "itemId": "1",
      "type": "AUTOMOBILE",
      "description": "Models the movement of cars and other similar small automobiles, such as pickup trucks, and finds solutions that optimize travel time.
                      Travel obeys one-way roads, avoids illegal turns, and follows other rules that are specific to cars. When you specify a start time, 
                      dynamic travel speeds based on traffic are used where it is available.",
      "timeAttributeName": "TravelTime",
      "distanceAttributeName": "Kilometers",
      "impedanceAttributeName": "TravelTime",
      "restrictionAttributeNames": [
        "Avoid Unpaved Roads",
        "Avoid Private Roads",
        "Driving an Automobile",
        "Through Traffic Prohibited",
        "Roads Under Construction Prohibited",
        "Avoid Gates",
        "Avoid Express Lanes",
        "Avoid Carpool Roads"
      ],
      "attributeParameterValues": [
        {
          "attributeName": "Avoid Limited Access Roads",
          "parameterName": "Restriction Usage",
          "value": "Avoid_Medium"
        },
        ...
      ],
      "useHierarchy": true,
      "uturnAtJunctions": "esriNFSBAtDeadEndsAndIntersections",
      "simplificationTolerance": 10,
      "simplificationToleranceUnits": "esriMeters"
    },
    ...
  ],
  "trafficSupport": "esriNTSHistorical",
  "outputGeometryPrecision": 10,
  "outputGeometryPrecisionUnits": "esriMeters",
  "supportsPreservingObjectID": true,
  "preserveObjectID": false,
  "findBestSequence": false,
  "useStartTime": false,
  "startTime": null,
  "startTimeIsUTC": false,
  "timeWindowsAreUTC": false,
  "useTimeWindows": false,
  "preserveFirstStop": true,
  "preserveLastStop": true,
  "outputLineType": "esriNAOutputLineTrueShape",
  "directionsLanguage": "",
  "directionsSupportedLanguages": [
    "ar",
    "bg",
    "bs",
    "ca",
    "cs",
    ...
  ],
  "directionsStyleNames": [
    "NA Desktop",
    "NA Navigation",
    "NA Campus"
  ],
  "directionsLengthUnits": "esriNAUMiles",
  "directionsTimeAttribute": "TravelTime",
  "supportsDirections": true,
  "returnDirections": true,
  "serviceLimits": {
    "AllowSaveLayerOnServer": "true",
    "LicensedForAutomaticRerouting": "false"
  }
}

Closest facility layer example

The sample JSON response below is for a closest facility layer.

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


{
  "currentVersion": 11.1,
  "cimVersion": "3.1.0",
  "currentBuild": 41738,
  "layerName": "ClosestFacility",
  "layerType": "esriNAServerClosestFacilityLayer",
  "impedance": "TravelTime",
  "restrictions": [
    "Avoid Unpaved Roads",
    "Avoid Private Roads",
    "Driving an Automobile",
    "Through Traffic Prohibited",
    "Roads Under Construction Prohibited",
    "Avoid Gates",
    "Avoid Express Lanes",
    "Avoid Carpool Roads"
  ],
  "snapTolerance": 0,
  "maxSnapTolerance": 20000,
  "snapToleranceUnits": "esriMeters",
  "locateSettings": {
    "default": {
      "tolerance": 20000,
      "toleranceUnits": "esriMeters",
      "allowAutoRelocate": true,
      "sources": [
        {"name": "Routing_Streets"},
        {"name": "Custom_Streets"},
        {"name": "Custom_Streets_Override"}
      ]
    }
  },
  "ignoreInvalidLocations": true,
  "restrictUTurns": "esriNFSBAtDeadEndsAndIntersections",
  "accumulateAttributeNames": [
    "Miles",
    "Kilometers"
  ],
  "attributeParameterValues": [
    {
      "attributeName": "Any Hazmat Prohibited",
      "parameterName": "Restriction Usage",
      "parameterType": "float",
      "value": "Prohibited"
    },
    {
      "attributeName": "Avoid Carpool Roads",
      "parameterName": "Restriction Usage",
      "parameterType": "float",
      "value": "Prohibited"
    },  
  ],
  "outputSpatialReference": {"wkid": 102100},
  "useHierarchy": true,
  "hierarchyAttributeName": "Hierarchy",
  "hierarchyLevelCount": 3,
  "hierarchyMaxValues": [
    2,
    4
  ],
  "hierarchyNumTransitions": [
    9,
    6
  ],
  "networkClasses": [
    {
      "className": "Facilities",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Address",
            "Label",
            "Location",
            "Facility",
            "Origin",
            "Destination",
            "WayPoint",
            "Description",
            "Title",
            "DepotName"
          ]
        },
        {
          "fieldName": "SourceID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceID",
            "SID",
            "Source"
          ]
        },
        {
          "fieldName": "SourceOID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceOID",
            "SOID"
          ]
        },
        {
          "fieldName": "PosAlong",
          "defaultValue": 0,
          "candidateFields": [
            "PosAlong",
            "PA",
            "Pos"
          ]
        },
        {
          "fieldName": "SideOfEdge",
          "defaultValue": 2,
          "candidateFields": [
            "SideOfEdge",
            "SOE"
          ]
        },
        {
          "fieldName": "CurbApproach",
          "defaultValue": 0,
          "candidateFields": [
            "CurbApproach",
            "SideOfStreet",
            "SideApproach",
            "CurbSide",
            "Curb"
          ]
        },
        {
          "fieldName": "Status",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Minutes",
            "Minutes",
            "Delay",
            "ServiceTime",
            "SrvTime",
            "StartDepotServiceTime",
            "StartSrvTime",
            "StartSrv"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_Minutes",
          "defaultValue": null,
          "candidateFields": [
            "Cutoff_Minutes",
            "Cut_Mins"
          ]
        },
        {
          "fieldName": "Cutoff_TravelTime",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_Miles",
          "defaultValue": null,
          "candidateFields": [
            "Cutoff_Miles",
            "Cut_Miles"
          ]
        },
        {
          "fieldName": "Cutoff_Kilometers",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_TimeAt1KPH",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_WalkTime",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_TruckMinutes",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_TruckTravelTime",
          "defaultValue": null,
          "candidateFields": null
        }
      ]
    },
    {
      "className": "Incidents",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Address",
            "Label",
            "Location",
            "Incident",
            "Origin",
            "Destination",
            "Description",
            "Title",
            "DepotName"
          ]
        },
        {
          "fieldName": "TargetFacilityCount",
          "defaultValue": null,
          "candidateFields": [
            "MaxFacilities",
            "FacilityCount",
            "TargetFacilityCount",
            "MaxFacilityCount",
            "FacilityCutoff"
          ]
        },
        {
          "fieldName": "SourceID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceID",
            "SID",
            "Source"
          ]
        },
        {
          "fieldName": "SourceOID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceOID",
            "SOID"
          ]
        },
        {
          "fieldName": "PosAlong",
          "defaultValue": 0,
          "candidateFields": [
            "PosAlong",
            "PA",
            "Pos"
          ]
        },
        {
          "fieldName": "SideOfEdge",
          "defaultValue": 2,
          "candidateFields": [
            "SideOfEdge",
            "SOE"
          ]
        },
        {
          "fieldName": "CurbApproach",
          "defaultValue": 0,
          "candidateFields": [
            "CurbApproach",
            "SideOfStreet",
            "SideApproach",
            "CurbSide",
            "Curb"
          ]
        },
        {
          "fieldName": "Status",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Minutes",
            "Minutes",
            "Delay",
            "ServiceTime",
            "SrvTime",
            "StartDepotServiceTime",
            "StartSrvTime",
            "StartSrv"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_Minutes",
          "defaultValue": null,
          "candidateFields": [
            "Cutoff_Minutes",
            "Cut_Mins"
          ]
        },
        {
          "fieldName": "Cutoff_TravelTime",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_Miles",
          "defaultValue": null,
          "candidateFields": [
            "Cutoff_Miles",
            "Cut_Miles"
          ]
        },
        {
          "fieldName": "Cutoff_Kilometers",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_TimeAt1KPH",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_WalkTime",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_TruckMinutes",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_TruckTravelTime",
          "defaultValue": null,
          "candidateFields": null
        }
      ]
    },
    {
      "className": "Barriers",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Address",
            "Label",
            "Location",
            "Barrier",
            "Description",
            "Title"
          ]
        },
        {
          "fieldName": "SourceID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceID",
            "SID",
            "Source"
          ]
        },
        {
          "fieldName": "SourceOID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceOID",
            "SOID"
          ]
        },
        {
          "fieldName": "PosAlong",
          "defaultValue": 0,
          "candidateFields": [
            "PosAlong",
            "PA",
            "Pos"
          ]
        },
        {
          "fieldName": "SideOfEdge",
          "defaultValue": 2,
          "candidateFields": [
            "SideOfEdge",
            "SOE"
          ]
        },
        {
          "fieldName": "CurbApproach",
          "defaultValue": 0,
          "candidateFields": [
            "CurbApproach",
            "SideOfStreet",
            "SideApproach",
            "CurbSide",
            "Curb"
          ]
        },
        {
          "fieldName": "Status",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "FullEdge",
          "defaultValue": 0,
          "candidateFields": [
            "FullEdge",
            "IsFullEdge",
            "BlockEntire"
          ]
        },
        {
          "fieldName": "BarrierType",
          "defaultValue": 0,
          "candidateFields": [
            "BarrierType",
            "BarType",
            "BarrierTyp"
          ]
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Minutes",
            "Minutes",
            "VisitTime",
            "StopTime",
            "Delay",
            "ServiceTime",
            "SrvTime",
            "StartDepotServiceTime",
            "StartSrvTime",
            "StartSrv"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 0,
          "candidateFields": null
        }
      ]
    },
    {
      "className": "PolylineBarriers",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Label",
            "Locations",
            "Barrier",
            "Description",
            "Title"
          ]
        },
        {
          "fieldName": "Locations",
          "defaultValue": null,
          "candidateFields": [
            "Locations",
            "LocRanges"
          ]
        },
        {
          "fieldName": "BarrierType",
          "defaultValue": 0,
          "candidateFields": [
            "BarrierType",
            "BarType",
            "BarrierTyp"
          ]
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 1,
          "candidateFields": [
          "Attr_Minutes",
            "Minutes",
            "Scaled_Cost",
            "Scaled_Time"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Kilometers",
            "Kilometers"
          ]
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 1,
          "candidateFields": null
        }
      ]
    },
    {
      "className": "PolygonBarriers",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Label",
            "Locations",
            "Barrier",
            "Description",
            "Title"
          ]
        },
        {
          "fieldName": "Locations",
          "defaultValue": null,
          "candidateFields": [
          "Locations",
            "LocRanges"
          ]
        },
        {
          "fieldName": "BarrierType",
          "defaultValue": 0,
          "candidateFields": [
            "BarrierType",
            "BarType",
            "BarrierTyp"
          ]
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Minutes",
            "Scaled_Cost",
            "Scaled_Time"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Kilometers",
            "Kilometers"
          ]
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 1,
          "candidateFields": null
        }
      ]
    }
  ],
  "networkDataset": {
    "name": "Routing_ND",
    "buildTime": 1631404171000,
    "state": "esriNDSBuilt",
    "networkAttributes": [
      {
        "name": "RoadClass",
        "dataType": "esriNADTInteger",
        "units": "esriNAUUnknown",
        "usageType": "esriNAUTDescriptor",
        "parameterNames": [],
        "restrictionUsageParameterName": null,
        "trafficSupport": "esriNTSNone"
      },
      {
        "name": "TimeZoneID",
        "dataType": "esriNADTInteger",
        "units": "esriNAUUnknown",
        "usageType": "esriNAUTDescriptor",
        "restrictionUsageParameterName": null,
        "trafficSupport": "esriNTSNone"
      },
      ...
    ],
    "networkSources": [
      {
        "name": "Routing_Streets",
        "elementType": "esriNETEdge",
        "sourceType": "esriNSTEdgeFeature",
        "id": 1
      },
      {
        "name": "Custom_Streets",
        "elementType": "esriNETEdge",
        "sourceType": "esriNSTEdgeFeature",
        "id": 6
      },
      {
        "name": "Routing_Streets_Override",
        "elementType": "esriNETJunction",
        "sourceType": "esriNSTJunctionFeature",
        "id": 4
      },
      {
        "name": "Custom_Streets_Override",
        "elementType": "esriNETJunction",
        "sourceType": "esriNSTJunctionFeature",
        "id": 5
      },
      {
        "name": "Routing_ND_Junctions",
        "elementType": "esriNETJunction",
        "sourceType": "esriNSTSystemJunction",
        "id": 3
      },
      {
        "name": "RestrictedTurns",
        "elementType": "esriNETTurn",
        "sourceType": "esriNSTTurnFeature",
        "id": 2
      },
      {
        "name": "Custom_Turns",
        "elementType": "esriNETTurn",
        "sourceType": "esriNSTTurnFeature",
        "id": 7
      }
    ]
  },
  "hasM": true,
  "hasZ": false,
  "defaultTravelMode": "1",
  "supportedTravelModes": [
    {
      "name": "Driving Time",
      "itemId": "1",
      "type": "AUTOMOBILE",
      "description": "Models the movement of cars and other similar small automobiles, such as pickup trucks, and finds solutions that optimize travel time. Travel obeys one-way roads, avoids illegal turns, and follows other rules that are specific to cars. When you specify a start time, dynamic travel speeds based on traffic are used where it is available.",
      "timeAttributeName": "TravelTime",
      "distanceAttributeName": "Kilometers",
      "impedanceAttributeName": "TravelTime",
      "restrictionAttributeNames": [
        "Avoid Unpaved Roads",
        "Avoid Private Roads",
        "Driving an Automobile",
        "Through Traffic Prohibited",
        "Roads Under Construction Prohibited",
        "Avoid Gates",
        "Avoid Express Lanes",
        "Avoid Carpool Roads"
      ],
      "attributeParameterValues": [
        {
          "attributeName": "Avoid Limited Access Roads",
          "parameterName": "Restriction Usage",
          "value": "Avoid_Medium"
        },
        {
          "attributeName": "Avoid Ferries",
          "parameterName": "Restriction Usage",
          "value": "Avoid_Medium"
        },
        ... 
      ],
      "useHierarchy": true,
      "uturnAtJunctions": "esriNFSBAtDeadEndsAndIntersections",
      "simplificationTolerance": 10,
      "simplificationToleranceUnits": "esriMeters"
    },
    ...
  ],
  "trafficSupport": "esriNTSHistorical",
  "outputGeometryPrecision": 10,
  "outputGeometryPrecisionUnits": "esriMeters",
  "supportsPreservingObjectID": true,
  "preserveObjectID": false,
  "defaultCutoffValue": null,
  "facilityCount": 1,
  "travelDirection": "esriNATravelDirectionToFacility",
  "outputLineType": "esriNAOutputLineTrueShape",
  "directionsLanguage": "",
  "directionsSupportedLanguages": [
    "ar",
    "bg",
    "bs",
    "ca",
    "cs",
    "da",
    "de",
    "el",
    ...
  ],
  "directionsStyleNames": [
    "NA Desktop",
    "NA Navigation",
    "NA Campus"
  ],
  "directionsLengthUnits": "esriNAUMiles",
  "directionsTimeAttribute": "TravelTime",
  "supportsDirections": true,
  "returnDirections": false,
  "timeOfDay": null,
  "timeOfDayIsUTC": false,
  "timeOfDayUsage": "esriNATimeOfDayUseAsStartTime",
  "serviceLimits": {
    "AllowSaveLayerOnServer": "true",
    "LicensedForAutomaticRerouting": "false"
  }
}

Service area layer example

The sample JSON response below is for a service area layer.

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


{
  "currentVersion": 11.1,
  "cimVersion": "3.1.0",
  "currentBuild": 41738,
  "layerName": "ServiceArea",
  "layerType": "esriNAServerServiceAreaLayer",
  "impedance": "TravelTime",
  "restrictions": [
    "Avoid Unpaved Roads",
    "Avoid Private Roads",
    "Driving an Automobile",
    "Through Traffic Prohibited",
    "Roads Under Construction Prohibited",
    "Avoid Gates",
    "Avoid Express Lanes",
    "Avoid Carpool Roads"
  ],
  "snapTolerance": 0,
  "maxSnapTolerance": 20000,
  "snapToleranceUnits": "esriMeters",
  "locateSettings": {
    "default": {
      "tolerance": 20000,
      "toleranceUnits": "esriMeters",
      "allowAutoRelocate": true,
      "sources": [
        {"name": "Routing_Streets"},
        {"name": "Custom_Streets"},
        {"name": "Custom_Streets_Override"}
      ]
    }
  },
  "ignoreInvalidLocations": true,
  "restrictUTurns": "esriNFSBAtDeadEndsAndIntersections",
  "accumulateAttributeNames": [
    "Miles",
    "Kilometers"
  ],
  "attributeParameterValues": [
    {
      "attributeName": "Any Hazmat Prohibited",
      "parameterName": "Restriction Usage",
      "parameterType": "float",
      "value": "Prohibited"
    },
    {
      "attributeName": "Avoid Carpool Roads",
      "parameterName": "Restriction Usage",
      "parameterType": "float",
      "value": "Prohibited"
    },
    ...
  ],
  "outputSpatialReference": {"wkid": 102100},
  "useHierarchy": false,
  "hierarchyAttributeName": "Hierarchy",
  "hierarchyLevelCount": 3,
  "hierarchyMaxValues": [
    2,
    4
  ],
  "hierarchyNumTransitions": [
    9,
    6
  ],
  "networkClasses": [
    {
      "className": "Facilities",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Address",
            "Label",
            "Location",
            "Facility",
            "WayPoint",
            "Description",
            "Title",
            "DepotName"
          ]
        },
        {
          "fieldName": "SourceID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceID",
            "SID",
            "Source"
          ]
        },
        {
          "fieldName": "SourceOID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceOID",
            "SOID"
          ]
        },
        {
          "fieldName": "PosAlong",
          "defaultValue": 0,
          "candidateFields": [
            "PosAlong",
            "PA",
            "Pos"
          ]
        },
        {
          "fieldName": "SideOfEdge",
          "defaultValue": 2,
          "candidateFields": [
            "SideOfEdge",
            "SOE"
          ]
        },
        {
          "fieldName": "CurbApproach",
          "defaultValue": 0,
          "candidateFields": [
            "CurbApproach",
            "SideOfStreet",
            "SideApproach",
            "CurbSide",
            "Curb"
          ]
        },
        {
          "fieldName": "Status",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Minutes",
            "Minutes",
            "Delay",
            "ServiceTime",
            "SrvTime",
            "StartDepotServiceTime",
            "StartSrvTime",
            "StartSrv"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Breaks_Minutes",
          "defaultValue": null,
          "candidateFields": [
            "Breaks_Minutes",
            "Breaks"
          ]
        },
        {
          "fieldName": "Breaks_TravelTime",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Breaks_Miles",
          "defaultValue": null,
          "candidateFields": [
            "Breaks_Miles",
            "Breaks"
          ]
        },
        {
          "fieldName": "Breaks_Kilometers",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Breaks_TimeAt1KPH",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Breaks_WalkTime",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Breaks_TruckMinutes",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Breaks_TruckTravelTime",
          "defaultValue": null,
          "candidateFields": null
        }
      ]
    },
    {
      "className": "Barriers",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Address",
            "Label",
            "Location",
            "Barrier",
            "Description",
            "Title"
          ]
        },
        {
          "fieldName": "SourceID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceID",
            "SID",
            "Source"
          ]
        },
        {
          "fieldName": "SourceOID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceOID",
            "SOID"
          ]
        },
        {
          "fieldName": "PosAlong",
          "defaultValue": 0,
          "candidateFields": [
            "PosAlong",
            "PA",
            "Pos"
          ]
        },
        {
          "fieldName": "SideOfEdge",
          "defaultValue": 2,
          "candidateFields": [
            "SideOfEdge",
            "SOE"
          ]
        },
        {
          "fieldName": "CurbApproach",
          "defaultValue": 0,
          "candidateFields": [
            "CurbApproach",
            "SideOfStreet",
            "SideApproach",
            "CurbSide",
            "Curb"
          ]
        },
        {
          "fieldName": "Status",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "FullEdge",
          "defaultValue": 0,
          "candidateFields": [
            "FullEdge",
            "IsFullEdge",
            "BlockEntire"
          ]
        },
        {
          "fieldName": "BarrierType",
          "defaultValue": 0,
          "candidateFields": [
            "BarrierType",
            "BarType",
            "BarrierTyp"
          ]
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Minutes",
            "Minutes",
            "VisitTime",
            "StopTime",
            "Delay",
            "ServiceTime",
            "SrvTime",
            "StartDepotServiceTime",
            "StartSrvTime",
            "StartSrv"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 0,
          "candidateFields": null
        }
      ]
    },
    {
      "className": "PolylineBarriers",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Label",
            "Locations",
            "Barrier",
            "Description",
            "Title"
          ]
        },
        {
          "fieldName": "Locations",
          "defaultValue": null,
          "candidateFields": [
            "Locations",
            "LocRanges"
          ]
        },
        {
          "fieldName": "BarrierType",
          "defaultValue": 0,
          "candidateFields": [
            "BarrierType",
            "BarType",
            "BarrierTyp"
          ]
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Minutes",
            "Minutes",
            "Scaled_Cost",
            "Scaled_Time"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Kilometers",
            "Kilometers"
          ]
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 1,
          "candidateFields": null
        }
      ]
    },
    {
      "className": "PolygonBarriers",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Label",
            "Locations",
            "Barrier",
            "Description",
            "Title"
          ]
        },
        {
          "fieldName": "Locations",
          "defaultValue": null,
          "candidateFields": [
            "Locations",
            "LocRanges"
          ]
        },
        {
          "fieldName": "BarrierType",
          "defaultValue": 0,
          "candidateFields": [
            "BarrierType",
            "BarType",
            "BarrierTyp"
          ]
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Minutes",
            "Minutes",
            "Scaled_Cost",
            "Scaled_Time"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Kilometers",
            "Kilometers"
          ]
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 1,
          "candidateFields": null
        }
      ]
    }
  ],
  "networkDataset": {
    "name": "Routing_ND",
    "buildTime": 1631404171000,
    "state": "esriNDSBuilt",
    "networkAttributes": [
      {
        "name": "Hierarchy",
        "dataType": "esriNADTInteger",
        "units": "esriNAUUnknown",
        "usageType": "esriNAUTHierarchy",
        "parameterNames": [],
        "restrictionUsageParameterName": null,
        "trafficSupport": "esriNTSNone"
      },
      {
        "name": "Minutes",
        "dataType": "esriNADTDouble",
        "units": "esriNAUMinutes",
        "usageType": "esriNAUTCost",
        "parameterNames": [],
        "restrictionUsageParameterName": null,
        "trafficSupport": "esriNTSNone"
      },
      ...
    ],
    "networkSources": [
      {
        "name": "Routing_Streets",
        "elementType": "esriNETEdge",
        "sourceType": "esriNSTEdgeFeature",
        "id": 1
      },
      {
        "name": "Custom_Streets",
        "elementType": "esriNETEdge",
        "sourceType": "esriNSTEdgeFeature",
        "id": 6
      },
      {
        "name": "Routing_Streets_Override",
        "elementType": "esriNETJunction",
        "sourceType": "esriNSTJunctionFeature",
        "id": 4
      },
      ...
    ]
  },
  "hasM": true,
  "hasZ": false,
  "defaultTravelMode": "1",
  "supportedTravelModes": [
    {
      "name": "Driving Time",
      "itemId": "1",
      "type": "AUTOMOBILE",
      "description": "Models the movement of cars and other similar small automobiles, such as pickup trucks, and finds solutions that optimize travel time. 
                   Travel obeys one-way roads, avoids illegal turns, and follows other rules that are specific to cars. When you specify a start time, 
                   dynamic travel speeds based on traffic are used where it is available.",
      "timeAttributeName": "TravelTime",
      "distanceAttributeName": "Kilometers",
      "impedanceAttributeName": "TravelTime",
      "restrictionAttributeNames": [
        "Avoid Unpaved Roads",
        "Avoid Private Roads",
        "Driving an Automobile",
        "Through Traffic Prohibited",
        "Roads Under Construction Prohibited",
        "Avoid Gates",
        "Avoid Express Lanes",
        "Avoid Carpool Roads"
      ],
      "attributeParameterValues": [
        {
          "attributeName": "Avoid Limited Access Roads",
          "parameterName": "Restriction Usage",
          "value": "Avoid_Medium"
        },
        {
          "attributeName": "Avoid Ferries",
          "parameterName": "Restriction Usage",
          "value": "Avoid_Medium"
        },
        ...
      ],
      "useHierarchy": true,
      "uturnAtJunctions": "esriNFSBAtDeadEndsAndIntersections",
      "simplificationTolerance": 10,
      "simplificationToleranceUnits": "esriMeters"
    },
    ...
  ],
  "trafficSupport": "esriNTSHistorical",
  "outputGeometryPrecision": 10,
  "outputGeometryPrecisionUnits": "esriMeters",
  "supportsPreservingObjectID": true,
  "preserveObjectID": false,
  "defaultBreaks": [
    5,
    10,
    15
  ],
  "splitPolygonsAtBreaks": true,
  "mergeSimilarPolygonRanges": false,
  "excludeSourcesFromPolygons": [],
  "splitLinesAtBreaks": false,
  "overlapLines": true,
  "outputPolygons": "esriNAOutputPolygonSimplified",
  "outputLines": "esriNAOutputLineNone",
  "includeSourceInformationOnLines": true,
  "overlapPolygons": true,
  "trimOuterPolygon": true,
  "trimPolygonDistance": 100,
  "trimPolygonDistanceUnits": "esriMeters",
  "travelDirection": "esriNATravelDirectionFromFacility",
  "timeOfDay": null,
  "timeOfDayIsUTC": false,
  "timeOfDayUsage": "esriNATimeOfDayNotUsed",
  "serviceLimits": {"AllowSaveLayerOnServer": "true"}
}

Travel cost matrix layer response example

The sample JSON response below is for a travel cost matrix layer.

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


{
  "currentVersion": 11.1,
  "cimVersion": "3.1.0",
  "currentBuild": 41738,
  "layerName": "OriginDestinationCostMatrix",
  "layerType": "esriNAServerODCostMatrixLayer",
  "impedance": "TravelTime",
  "restrictions": [
    "Avoid Unpaved Roads",
    "Avoid Private Roads",
    "Driving an Automobile",
    "Through Traffic Prohibited",
    "Roads Under Construction Prohibited",
    "Avoid Gates",
    "Avoid Express Lanes",
    "Avoid Carpool Roads"
  ],
  "snapTolerance": 0,
  "maxSnapTolerance": 20000,
  "snapToleranceUnits": "esriMeters",
  "locateSettings": {
    "default": {
      "tolerance": 20000,
      "toleranceUnits": "esriMeters",
      "allowAutoRelocate": true,
      "sources": [
        {"name": "Routing_Streets"},
        {"name": "Custom_Streets"},
        {"name": "Custom_Streets_Override"}
      ]
    }
  },
  "ignoreInvalidLocations": true,
  "restrictUTurns": "esriNFSBAtDeadEndsAndIntersections",
  "accumulateAttributeNames": [
    "Miles",
    "Kilometers"
  ],
  "attributeParameterValues": [
    {
      "attributeName": "Any Hazmat Prohibited",
      "parameterName": "Restriction Usage",
      "parameterType": "float",
      "value": "Prohibited"
    },
    {
      "attributeName": "Avoid Carpool Roads",
      "parameterName": "Restriction Usage",
      "parameterType": "float",
      "value": "Prohibited"
    },
    {
      "attributeName": "Avoid Express Lanes",
      "parameterName": "Restriction Usage",
      "parameterType": "float",
      "value": "Prohibited"
    },
    ...
  ],
  "outputSpatialReference": {"wkid": 102100},
  "useHierarchy": true,
  "hierarchyAttributeName": "Hierarchy",
  "hierarchyLevelCount": 3,
  "hierarchyMaxValues": [
    2,
    4
  ],
  "hierarchyNumTransitions": [
    9,
    6
  ],
  "networkClasses": [
    {
      "className": "Origins",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Origin",
            "DepotName"
          ]
        },
        {
          "fieldName": "TargetDestinationCount",
          "defaultValue": null,
          "candidateFields": [
            "MaxDestinations",
            "DestinationCount",
            "TargetDestinationCount",
            "MaxDestinationCount",
            "DestinationCutoff"
          ]
        },
        {
          "fieldName": "SourceID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceID",
            "SID",
            "Source"
          ]
        },
        {
          "fieldName": "SourceOID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceOID",
            "SOID"
          ]
        },
        {
          "fieldName": "PosAlong",
          "defaultValue": 0,
          "candidateFields": [
            "PosAlong",
            "PA",
            "Pos"
          ]
        },
        {
          "fieldName": "SideOfEdge",
          "defaultValue": 2,
          "candidateFields": [
            "SideOfEdge",
            "SOE"
          ]
        },
        {
          "fieldName": "CurbApproach",
          "defaultValue": 0,
          "candidateFields": [
            "CurbApproach",
            "SideOfStreet",
            "SideApproach",
            "CurbSide",
            "Curb"
          ]
        },
        {
          "fieldName": "Status",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_Minutes",
          "defaultValue": null,
          "candidateFields": [
            "Cutoff_Minutes",
            "Cut_Mins"
          ]
        },
        {
          "fieldName": "Cutoff_TravelTime",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_Miles",
          "defaultValue": null,
          "candidateFields": [
            "Cutoff_Miles",
            "Cut_Miles"
          ]
        },
        {
          "fieldName": "Cutoff_Kilometers",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_TimeAt1KPH",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_WalkTime",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_TruckMinutes",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Cutoff_TruckTravelTime",
          "defaultValue": null,
          "candidateFields": null
        }
      ]
    },
    {
      "className": "Destinations",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Destination",
            "DepotName"
          ]
        },
        {
          "fieldName": "SourceID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceID",
            "SID",
            "Source"
          ]
        },
        {
          "fieldName": "SourceOID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceOID",
            "SOID"
          ]
        },
        {
          "fieldName": "PosAlong",
          "defaultValue": 0,
          "candidateFields": [
            "PosAlong",
            "PA",
            "Pos"
          ]
        },
        {
          "fieldName": "SideOfEdge",
          "defaultValue": 2,
          "candidateFields": [
            "SideOfEdge",
            "SOE"
          ]
        },
        {
          "fieldName": "CurbApproach",
          "defaultValue": 0,
          "candidateFields": [
            "CurbApproach",
            "SideOfStreet",
            "SideApproach",
            "CurbSide",
            "Curb"
          ]
        },
        {
          "fieldName": "Status",
          "defaultValue": 0,
          "candidateFields": null
        }
      ]
    },
    {
      "className": "Barriers",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Address",
            "Label",
            "Location",
            "Barrier",
            "Description",
            "Title"
          ]
        },
        {
          "fieldName": "SourceID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceID",
            "SID",
            "Source"
          ]
        },
        {
          "fieldName": "SourceOID",
          "defaultValue": -1,
          "candidateFields": [
            "SourceOID",
            "SOID"
          ]
        },
        {
          "fieldName": "PosAlong",
          "defaultValue": 0,
          "candidateFields": [
            "PosAlong",
            "PA",
            "Pos"
          ]
        },
        {
          "fieldName": "SideOfEdge",
          "defaultValue": 2,
          "candidateFields": [
            "SideOfEdge",
            "SOE"
          ]
        },
        {
          "fieldName": "CurbApproach",
          "defaultValue": 0,
          "candidateFields": [
            "CurbApproach",
            "SideOfStreet",
            "SideApproach",
            "CurbSide",
            "Curb"
          ]
        },
        {
          "fieldName": "Status",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "FullEdge",
          "defaultValue": 0,
          "candidateFields": [
            "FullEdge",
            "IsFullEdge",
            "BlockEntire"
          ]
        },
        {
          "fieldName": "BarrierType",
          "defaultValue": 0,
          "candidateFields": [
            "BarrierType",
            "BarType",
            "BarrierTyp"
          ]
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Minutes",
            "Minutes",
            "VisitTime",
            "StopTime",
            "Delay",
            "ServiceTime",
            "SrvTime",
            "StartDepotServiceTime",
            "StartSrvTime",
            "StartSrv"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 0,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 0,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 0,
          "candidateFields": null
        }
      ]
    },
    {
      "className": "PolylineBarriers",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Label",
            "Locations",
            "Barrier",
            "Description",
            "Title"
          ]
        },
        {
          "fieldName": "Locations",
          "defaultValue": null,
          "candidateFields": [
            "Locations",
            "LocRanges"
          ]
        },
        {
          "fieldName": "BarrierType",
          "defaultValue": 0,
          "candidateFields": [
            "BarrierType",
            "BarType",
            "BarrierTyp"
          ]
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Minutes",
            "Minutes",
            "Scaled_Cost",
            "Scaled_Time"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Kilometers",
            "Kilometers"
          ]
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 1,
          "candidateFields": null
        }
      ]
    },
    {
      "className": "PolygonBarriers",
      "fields": [
        {
          "fieldName": "Shape",
          "defaultValue": null,
          "candidateFields": null
        },
        {
          "fieldName": "Name",
          "defaultValue": null,
          "candidateFields": [
            "Name",
            "Label",
            "Locations",
            "Barrier",
            "Description",
            "Title"
          ]
        },
        {
          "fieldName": "Locations",
          "defaultValue": null,
          "candidateFields": [
            "Locations",
            "LocRanges"
          ]
        },
        {
          "fieldName": "BarrierType",
          "defaultValue": 0,
          "candidateFields": [
            "BarrierType",
            "BarType",
            "BarrierTyp"
          ]
        },
        {
          "fieldName": "Attr_Minutes",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Minutes",
            "Minutes",
            "Scaled_Cost",
            "Scaled_Time"
          ]
        },
        {
          "fieldName": "Attr_TravelTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_Miles",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Miles",
            "Miles"
          ]
        },
        {
          "fieldName": "Attr_Kilometers",
          "defaultValue": 1,
          "candidateFields": [
            "Attr_Kilometers",
            "Kilometers"
          ]
        },
        {
          "fieldName": "Attr_TimeAt1KPH",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_WalkTime",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckMinutes",
          "defaultValue": 1,
          "candidateFields": null
        },
        {
          "fieldName": "Attr_TruckTravelTime",
          "defaultValue": 1,
          "candidateFields": null
        }
      ]
    }
  ],
  "networkDataset": {
    "name": "Routing_ND",
    "buildTime": 1631404171000,
    "state": "esriNDSBuilt",
    "networkAttributes": [
      {
        "name": "Hierarchy",
        "dataType": "esriNADTInteger",
        "units": "esriNAUUnknown",
        "usageType": "esriNAUTHierarchy",
        "parameterNames": [],
        "restrictionUsageParameterName": null,
        "trafficSupport": "esriNTSNone"
      },
      {
        "name": "Minutes",
        "dataType": "esriNADTDouble",
        "units": "esriNAUMinutes",
        "usageType": "esriNAUTCost",
        "parameterNames": [],
        "restrictionUsageParameterName": null,
        "trafficSupport": "esriNTSNone"
      },
      ...
    ],
    "networkSources": [
      {
        "name": "Routing_Streets",
        "elementType": "esriNETEdge",
        "sourceType": "esriNSTEdgeFeature",
        "id": 1
      },
      {
        "name": "Custom_Streets",
        "elementType": "esriNETEdge",
        "sourceType": "esriNSTEdgeFeature",
        "id": 6
      },
      {
        "name": "Routing_Streets_Override",
        "elementType": "esriNETJunction",
        "sourceType": "esriNSTJunctionFeature",
        "id": 4
      },
      {
        "name": "Custom_Streets_Override",
        "elementType": "esriNETJunction",
        "sourceType": "esriNSTJunctionFeature",
        "id": 5
      },
      {
        "name": "Routing_ND_Junctions",
        "elementType": "esriNETJunction",
        "sourceType": "esriNSTSystemJunction",
        "id": 3
      },
      {
        "name": "RestrictedTurns",
        "elementType": "esriNETTurn",
        "sourceType": "esriNSTTurnFeature",
        "id": 2
      },
      {
        "name": "Custom_Turns",
        "elementType": "esriNETTurn",
        "sourceType": "esriNSTTurnFeature",
        "id": 7
      }
    ]
  },
  "hasM": true,
  "hasZ": false,
  "defaultTravelMode": "1",
  "supportedTravelModes": [
    {
      "name": "Driving Time",
      "itemId": "1",
      "type": "AUTOMOBILE",
      "description": "Models the movement of cars and other similar small automobiles, such as pickup trucks, and finds solutions that optimize travel time. 
                   Travel obeys one-way roads, avoids illegal turns, and follows other rules that are specific to cars. When you specify a start time, 
                   dynamic travel speeds based on traffic are used where it is available.",
      "timeAttributeName": "TravelTime",
      "distanceAttributeName": "Kilometers",
      "impedanceAttributeName": "TravelTime",
      "restrictionAttributeNames": [
        "Avoid Unpaved Roads",
        "Avoid Private Roads",
        "Driving an Automobile",
        "Through Traffic Prohibited",
        "Roads Under Construction Prohibited",
        "Avoid Gates",
        "Avoid Express Lanes",
        "Avoid Carpool Roads"
      ],
      "attributeParameterValues": [
        {
          "attributeName": "Avoid Limited Access Roads",
          "parameterName": "Restriction Usage",
          "value": "Avoid_Medium"
        },
        {
          "attributeName": "Avoid Ferries",
          "parameterName": "Restriction Usage",
          "value": "Avoid_Medium"
        },
        ...
      ],
      "useHierarchy": true,
      "uturnAtJunctions": "esriNFSBAtDeadEndsAndIntersections",
      "simplificationTolerance": 10,
      "simplificationToleranceUnits": "esriMeters"
    },
    ...
  ],
  "trafficSupport": "esriNTSHistorical",
  "supportsPreservingObjectID": true,
  "defaultCutoffValue": null,
  "defaultTargetDestinationCount": null,
  "outputType": "esriNAODOutputSparseMatrix",
  "timeOfDay": null,
  "timeOfDayIsUTC": false,
  "serviceLimits": {"AllowSaveLayerOnServer": "true"}
}