Skip to content

Types

CoordinatesProperty

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
  [
    31.134167,
    29.979167
  ],
  [
    31.130833,
    29.976111
  ],
  [
    31.128333,
    29.9725
  ]
]

Array of (longitude, latitude) pairs in the WGS84 spatial reference. Maximum size of 100 coordinates.

The order of each pair must be:

  • longitude in the range -179.99 to 179.99 representing the east/west or x-axis
  • latitude in the range -85.05 to 85.05 representing the north/south or y-axis

For example: [[31.134167, 29.979167], [31.130833, 29.976111], [31.128333, 29.9725]]

Elevation

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
{
  "point": {
    "spatialReference": {
      "wkid": 4326,
      "vcsWkid": 105700
    },
    "x": 86.925278,
    "y": 27.988333,
    "z": 8743.9
  }
}

A structure containing a point including an elevation value (defined as Z).

Properties

NameTypeRequiredDescription
pointPoint

The point containing the elevation.

ElevationInfo

Example
Use dark colors for code blocksCopy
1
2
3
{
  "relativeTo": "meanSeaLevel"
}

A structure containing human readable metadata about the specified point.

Properties

NameTypeRequiredDescription
relativeTostring

The reference position (datum) from which to measure elevation. The valid values are:

  • meanSeaLevel: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.
  • ellipsoid: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.

Enumerated values

relativeTo
meanSeaLevel
Click to copy
ellipsoid
Click to copy

Elevations

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "points": [
    {
      "spatialReference": {
        "wkid": 4326,
        "vcsWkid": 105700
      },
      "x": 86.925278,
      "y": 27.988333,
      "z": 8743.9
    }
  ]
}

A structure containing a collection of points which contain elevation values (defined as Z). When returned from a request to the /elevation/at-many-points endpoint, the order of the points will match the order of the points in the request.

Properties

NameTypeRequired
points[Point]

Error

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
{
  "error": {
    "code": 400,
    "message": "string",
    "details": [
      "string"
    ],
    "restInfoUrl": "https://elevation-api.arcgis.com/arcgis/rest/info"
  }
}

Properties

NameTypeRequiredDescription
errorobject

Error information

error properties

NameTypeRequiredDescription
codeinteger

A code identifying the type of error, either an HTTP error code, 498 (signifying invalid or expired token), or 499 (signifying missing token).

messagestring

A message describing the error.

details[string]

List of details about the error.

restInfoUrlstring

URL that provides the elevation service information.

Enumerated values

code
400
Click to copy
401
Click to copy
403
Click to copy
404
Click to copy
413
Click to copy
415
Click to copy
498
Click to copy
499
Click to copy
500
Click to copy

Format

Example
Use dark colors for code blocksCopy
1
"json"

Optional, case-sensitive parameter to specify the format in which responses are given. Can either be json or pjson.

Type
string
Required
false
Restrictions
none

Enumerated values

anonymous
json
Click to copy
pjson
Click to copy

Point

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
  "spatialReference": {
    "wkid": 4326,
    "vcsWkid": 105700
  },
  "x": 86.925278,
  "y": 27.988333,
  "z": 8743.9
}

A geometry point referring to a location on a map.

Properties

NameTypeRequiredDescription
spatialReferenceobject

The spatial reference system the point is relative to.

xnumber

The X coordinate which is measured along the east/west axis.

ynumber

The Y coordinate which is measured along the north/south axis.

znumber

The Z coordinate represents the vertical position of a point above or below a reference level, such as sea level (in meters, rounded to the nearest 10cm).

spatialReference properties

NameTypeRequiredDescription
wkidnumber

The Well-Known ID (WKID) value of the horizontal coordinate system, such as WGS 1984 with WKID 4326.

vcsWkidnumber

The Well-Known ID (WKID) value of the vertical coordinate system, such as WGS_1984_Geoid with WKID 105700.

RelativeToProperty

Example
Use dark colors for code blocksCopy
1
"meanSeaLevel"

The reference position (datum) from which to measure elevation.

The valid values are:

  • meanSeaLevel: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.
  • ellipsoid: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.
Type
string
Required
false
Restrictions
none
Default value
meanSeaLevel

Enumerated values

anonymous
meanSeaLevel
Click to copy
ellipsoid
Click to copy

TokenProperty

Example
Use dark colors for code blocksCopy
1
"MyToken"

The authentication token, used to access the elevation service.

The token parameter can be either an API Key or short-lived token.

This parameter is required unless you supply an access token in the request header with one of the following keys using the "Bearer" scheme:

  • Authorization: Bearer <YOUR_TOKEN>
  • X-Esri-Authorization: Bearer <YOUR_TOKEN>

The provided token must be created from an ArcGIS Location Platform account and have the necessary premium:user:elevation privilege to use the elevation service.

Developer guide: To learn more, go to Security and authentication.

Type
string
Required
false
Restrictions
none

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.