Elevation - Post Data For Polyline

Query elevation data along a polyline.
Applies to: S1 pricing tier. The Post Data for Polyline API provides elevation data along a polyline. A polyline is defined by passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. In addition to passing in endpoints, customers can specify number of sample points that will be used to divide polyline into equally spaced segments. Elevation data at both start and end points and equally spaced points along the polyline will be returned. A line between two endpoints is a straight Cartesian line, the shortest line between those two points in the coordinate reference system. Note that the point is chosen based on Euclidean distance and may markedly differ from the geodesic path along the curved surface of the reference ellipsoid.

POST https://atlas.microsoft.com/elevation/line/json?api-version=1.0
POST https://atlas.microsoft.com/elevation/line/json?subscription-key={subscription-key}&api-version=1.0&samples={samples}

URI Parameters

Name In Required Type Description
format
path True

Desired format of the response. Only json format is supported.

api-version
query True
  • string

Version number of Azure Maps API. Current version is 1.0

samples
query
  • number

The samples parameter specifies the number of equally spaced points at which elevation values should be provided along a polyline path. The number of samples should range from 2 to 2,000. Default value is 10 if not provided.

subscription-key
query
  • string

One of the Azure Maps keys provided from an Azure Map Account. Please refer to this article for details on how to manage authentication.

Request Header

Name Required Type Description
x-ms-client-id
  • string

Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following articles for guidance.

Request Body

Name Type Description
linesRequestBody

The string representation of a polyline path. A polyline is defined by endpoint coordinates, with each endpoint separated by a pipe ('|') character. The polyline should be defined in the following format: [longitude_point1, latitude_point1 | longitude_point2, latitude_point2, ..., longitude_pointN, latitude_pointN]. The longitude and latitude values refer to the World Geodetic System (WGS84) coordinate reference system. The resolution of the data used to compute the elevation will depend on the distance between the endpoints.

Responses

Name Type Description
200 OK

OK

400 Bad Request

Bad request: one or more parameters were incorrectly specified or are mutually exclusive.

401 Unauthorized

Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the WWW-Authenticate header for error code and description of the provided AAD bearer token.

Headers

  • WWW-Authenticate: string
403 Forbidden

Permission, capacity, or authentication issues.

404 Not Found

Not Found: the requested resource could not be found, but it may be available again in the future.

500 Internal Server Error

An error occurred while processing the request. Please try again later.

Security

azure_auth

These are the Azure Active Directory OAuth2 Flows. When paired with Azure Role Based Access control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Note

  • This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.
  • The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations.
  • The Azure role based access control is configured from the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.
  • Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.
  • Currently Azure Active Directory v1.0 tokens are supported.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

subscription-key

This is a shared key which is provisioned when creating an Azure Maps resource through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.

Type: apiKey
In: query

Examples

PostDataForPolyLine

Sample Request

POST https://atlas.microsoft.com/elevation/line/json?subscription-key=[subscription-key]&api-version=1.0&samples=5
[
  {
    "lon": -121.66853362143819,
    "lat": 46.846464798637129
  },
  {
    "lon": -121.67853362143818,
    "lat": 46.856464798637127
  }
]

Sample Response

{
  "data": [
    {
      "coordinate": {
        "latitude": 46.846464798637129,
        "longitude": -121.66853362143819
      },
      "elevationInMeter": 2298.6581875651746
    },
    {
      "coordinate": {
        "latitude": 46.848964798637127,
        "longitude": -121.67103362143818
      },
      "elevationInMeter": 2466.4058976953679
    },
    {
      "coordinate": {
        "latitude": 46.851464798637124,
        "longitude": -121.67353362143818
      },
      "elevationInMeter": 2504.8855800948654
    },
    {
      "coordinate": {
        "latitude": 46.853964798637129,
        "longitude": -121.67603362143818
      },
      "elevationInMeter": 2477.8929009638578
    },
    {
      "coordinate": {
        "latitude": 46.856464798637127,
        "longitude": -121.67853362143818
      },
      "elevationInMeter": 2394.5290079897059
    }
  ]
}
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Definitions

Coordinate

A location represented as a latitude and longitude.

CoordinateAbbreviated

A location represented as a latitude and longitude.

JsonFormat

Desired format of the response. Only json format is supported.

LinesResult

The response from a successful Elevation Polyline request.

ODataError

This object is returned when an error occurs in the Maps API.

ODataErrorResponse

This response object is returned when an error occurs in the Maps API.

PointElevationResult

The elevation data.

Coordinate

A location represented as a latitude and longitude.

Name Type Description
latitude
  • number

Latitude property

longitude
  • number

Longitude property

CoordinateAbbreviated

A location represented as a latitude and longitude.

Name Type Description
lat
  • number

Latitude property

lon
  • number

Longitude property

JsonFormat

Desired format of the response. Only json format is supported.

Name Type Description
json
  • string

The JavaScript Object Notation Data Interchange Format

LinesResult

The response from a successful Elevation Polyline request.

Name Type Description
data

The response from the Get Data for Polyline API. The results will be listed in the direction from the first endpoint towards the last endpoint.

ODataError

This object is returned when an error occurs in the Maps API.

Name Type Description
code
  • string

The ODataError code.

details

This object is returned when an error occurs in the Maps API.

message
  • string

If available, a human readable description of the error.

target
  • string

If available, the target causing the error.

ODataErrorResponse

This response object is returned when an error occurs in the Maps API.

Name Type Description
error

This object is returned when an error occurs in the Maps API.

PointElevationResult

The elevation data.

Name Type Description
coordinate

A location represented as a latitude and longitude.

elevationInMeter
  • number

The elevation value in meters.