Spatial - Post Closest Point

Applies to: S1 pricing tier.

This API returns the closest point between a base point and a given set of target points. The set of target points is provided by user data in post request body. The user data may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The algorithm does not take into account routing or traffic. The maximum number of points accepted is 100,000. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.

POST https://atlas.microsoft.com/spatial/closestPoint/json?api-version=1.0&lat={lat}&lon={lon}
POST https://atlas.microsoft.com/spatial/closestPoint/json?subscription-key={subscription-key}&api-version=1.0&lat={lat}&lon={lon}&numberOfClosestPoints={numberOfClosestPoints}

URI Parameters

Name In Required Type Description
format
path True

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

subscription-key
query
  • string

One of the Azure Maps keys provided from an Azure Map Account. Refer to the subscription-key security definition.

api-version
query True
  • string

Version number of Azure Maps API. Current version is 1.0

lat
query True
  • number

The base point latitude of the location being passed. Example: 47.622942.

lon
query True
  • number

The base point longitude of the location being passed. Example: -122.316456.

numberOfClosestPoints
query
  • integer

The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50

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
geometries

A valid GeoJSON FeatureCollection object type. Please refer to RFC 7946 for details. All the feature's properties should contain geometryId, which is used for identifying the geometry and is case-sensitive.

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

PostClosestPoint

Sample Request

POST https://atlas.microsoft.com/spatial/closestPoint/json?subscription-key=[subscription-key]&api-version=1.0&lat=47.622942&lon=-122.316456
{
  "FeatureCollection": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "properties": {
          "geometryId": 1001
        },
        "geometry": {
          "type": "Point",
          "coordinates": [
            -105.02860293715861,
            40.516153406773952
          ]
        }
      },
      {
        "type": "Feature",
        "properties": {
          "geometryId": 1002
        },
        "geometry": {
          "type": "Point",
          "coordinates": [
            -105.02860381672178,
            40.515990990037309
          ]
        }
      },
      {
        "type": "Feature",
        "properties": {
          "geometryId": 1003
        },
        "geometry": {
          "type": "Point",
          "coordinates": [
            -105.02812292879467,
            40.516058678088562
          ]
        }
      }
    ]
  }
}

Sample Response

{
  "summary": {
    "sourcePoint": {
      "lat": 47.622942,
      "lon": -122.316456
    },
    "udid": null,
    "information": "3 points processed in user data"
  },
  "result": [
    {
      "distanceInMeters": 1587492.66,
      "position": {
        "lat": 40.516153406773952,
        "lon": -105.02860293715861
      },
      "geometryId": "1001"
    }
  ]
}
{
  "error": {
    "code": "ClientParams",
    "message": "One or more parameters are missing.",
    "innererror": {
      "code": "MissingQueryParameter",
      "message": "Input parameter lon is missing."
    }
  }
}
{
  "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

ClosestPointRequestBody

An object with a set of Point geometries

ClosestPointResultEntry

Closest Point Result Entry Object

Coordinate

A location represented as a latitude and longitude

Error

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

ErrorResponse

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

JsonFormat

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

PostClosestPointResponse

This object is returned from a successful Post Spatial Closest Point call

PostClosestPointSummary

Post Closest Point Summary object

ClosestPointRequestBody

An object with a set of Point geometries

Name Type Description
geometries

A valid GeoJSON FeatureCollection object type. Please refer to RFC 7946 for details. All the feature's properties should contain geometryId, which is used for identifying the geometry and is case-sensitive.

ClosestPointResultEntry

Closest Point Result Entry Object

Name Type Description
distanceInMeters
  • number

The distance in meters from the source point to the closest point

geometryId
  • string

The unique id identifies a geometry

position

A location represented as a latitude and longitude

Coordinate

A location represented as a latitude and longitude

Name Type Description
lat
  • number

Latitude property

lon
  • number

Longitude property

Error

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

Name Type Description
code
  • string

The HTTP status code.

message
  • string

If available, a human readable description of the error.

ErrorResponse

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

JsonFormat

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

Name Type Description
json
  • string

The JavaScript Object Notation Data Interchange Format

PostClosestPointResponse

This object is returned from a successful Post Spatial Closest Point call

Name Type Description
result

Closest Point Result Array

summary

Post Closest Point Summary object

PostClosestPointSummary

Post Closest Point Summary object

Name Type Description
information
  • string

Processing information

sourcePoint

A location represented as a latitude and longitude

udid
  • string

A unique data id (udid) for the uploaded content. Udid is not applicable for POST spatial operations(set to null)