Distance

geometry1

Specifies the geometry from which the distance is measured. The structure of the geometry is the same as the structure of the JSON geometry objects returned by ArcGIS REST API. The use of simple syntax is not supported.

Syntax

1
{"geometryType": "<esriGeometryPoint | esriGeometryPolyline | esriGeometryEnvelope | esriGeometryPolygon | esriGeometryMultipoint>","geometry": <geometry1> }

Example

1
2
3
4
5
6
7
{
  "geometryType": "esriGeometryPoint",
  "geometry": {
    "x" : -118.15,
    "y" : 33.80
  }
}

geometry2

Specifies the geometry to which the distance is measured. The structure of the geometry is the same as the structure of the JSON geometry objects returned by ArcGIS REST API. The use of simple syntax is not supported.

Syntax

1
{"geometryType": "<esriGeometryPoint | esriGeometryPolyline | esriGeometryEnvelope | esriGeometryPolygon | esriGeometryMultipoint>","geometry": <geometry1>}

Example

1
2
3
4
5
6
7
{
  "geometryType": "esriGeometryPoint",
  "geometry": {
    "x": -95.23,
    "y": 31.71
  }
}

sr

Specifies the well-known ID (WKID) or a spatial reference JSON object for input geometries. The spatial reference can be either a projected coordinate system (PCS) or a geographic coordinate system (GCS). For a list of valid WKID values, see Using spatial references.

distanceUnit

(Optional)

Specifies the units for measuring distance between the geometry1 and geometry2 geometries. For a list of valid units, see esriSRUnitType Constants and esriSRUnit2Type Constants.

For planar distance, if distanceUnit is not specified, the distance is in the units of the given spatial reference. If distanceUnit is specified, the unit must be compatible with the given spatial reference. That is, if sr is a PCS, distanceUnit must be linear. If sr is a GCS, distanceUnit must be angular.

For geodesic distance, If distanceUnit is not specified, the distance is measured in meters. If distanceUnit is specified, the unit must be linear.

geodesic

(Optional)

If geodesic is set to true, the geodesic distance between the geometry1 and geometry2 geometries is returned. Geodesic distance is the shortest path between two points along the ellipsoid of the earth. If geodesic is set to false or not specified, the planar distance is returned. The default value is false.

Values: true | false

f

The response format. The default response format is html.

Values: html | json | pjson