Spatial - Post Closest Point

Référence

Service:: Maps

API Version:: 2022-08-01

Utilisez pour obtenir le point le plus proche entre un point de base et un ensemble donné de points cibles.

L’API Post Closest Point est une requête HTTP POST qui retourne le point le plus proche entre un point de base et un ensemble donné de points cibles. L’ensemble de points cibles est fourni par les données utilisateur dans le corps post-requête. Les données utilisateur ne peuvent contenir qu’une collection de géométrie de point. MultiPoint ou d’autres géométries seront ignorées si elles sont fournies. L’algorithme ne prend pas en compte le routage ou le trafic. Le nombre maximal de points acceptés est de 100 000. Les informations retournées incluent la latitude du point le plus proche, la longitude et la distance en mètres par rapport au point le plus proche.

POST https://{geography}.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&lat={lat}&lon={lon}

With optional parameters:

POST https://{geography}.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&lat={lat}&lon={lon}&numberOfClosestPoints={numberOfClosestPoints}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
format	path	True	JsonFormat	Format souhaité de la réponse. Seul le format `json` est pris en charge.
geography	path	True	string	Emplacement du compte Azure Maps. Les valeurs valides sont us (USA Est, USA Centre-Ouest, USA Ouest 2) et eu (Europe Nord, Europe Ouest). Ce paramètre est requis lorsqu’un `udid` est fourni dans la demande. Par exemple, si le compte Azure Maps se trouve dans USA Est, seules les demandes qui nous sont adressées en zone géographique seront acceptées.
api-version	query	True	string	Numéro de version de l’API Azure Maps.
lat	query	True	number	Latitude de l’emplacement passé. Exemple : 48.36.
lon	query	True	number	Longitude de l’emplacement passé. Exemple : -124.63.
numberOfClosestPoints	query		integer	Nombre de points les plus proches attendus de la réponse. Valeur par défaut : 1, minimum : 1 et maximum : 50

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité Microsoft Entra ID. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte du plan de gestion Azure Maps. Pour utiliser Microsoft Entra ID sécurité dans Azure Maps consultez les articles suivants pour obtenir des conseils.

Corps de la demande

Nom	Obligatoire	Type	Description
features	True	GeoJsonFeature[]	Contient une liste d’objets valides `GeoJSON Feature` .
type	True	string: FeatureCollection	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

Réponses

Nom	Type	Description
200 OK	ClosestPointResponse	Ok
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressources ou sous-ressources. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps.

Authorization URL est spécifique au cloud public Azure instance. Les clouds souverains ont des URL d’autorisation et des configurations Microsoft Entra ID uniques. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, sdk Azure ou API REST. * L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

Pour plus d’informations sur Plateforme d'identités Microsoft, consultez Plateforme d'identités Microsoft vue d’ensemble.

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

Scopes

Nom	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Il s’agit d’une clé partagée provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.

Avec cette clé, toute application est autorisée à accéder à toutes les API REST. En d’autres termes, ces clés peuvent actuellement être traitées comme master clés du compte pour lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès de serveur à serveur de Azure Maps API REST où cette clé peut être stockée en toute sécurité.

Type: apiKey
In: header

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle de grain précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, notre recommandation est de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAP.

Type: apiKey
In: header

Exemples

PostClosestPoint

Sample Request

HTTP

POST https://us.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&lat=47.622942&lon=-122.316456

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "geometryId": 1001
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -105.02860293715861,
          40.51615340677395
        ]
      }
    },
    {
      "type": "Feature",
      "properties": {
        "geometryId": 1002
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -105.02860381672178,
          40.51599099003731
        ]
      }
    },
    {
      "type": "Feature",
      "properties": {
        "geometryId": 1003
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -105.02812292879467,
          40.51605867808856
        ]
      }
    }
  ]
}

Sample Response

Status code:: 200

{
  "summary": {
    "sourcePoint": {
      "lat": 47.622942,
      "lon": -122.316456
    },
    "udid": null,
    "information": "3 points processed in user data"
  },
  "result": [
    {
      "distanceInMeters": 1587492.66,
      "position": {
        "lat": 40.51615340677395,
        "lon": -105.02860293715861
      },
      "geometryId": "1001"
    }
  ]
}

Définitions

Nom	Description
ClosestPoint	Objet d’entrée de résultat du point le plus proche
ClosestPointResponse	Cet objet est retourné à partir d’un appel de point le plus proche spatial réussi
ClosestPointSummary	Objet Summary du point le plus proche
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
GeoJsonFeature	Type d’objet valide `GeoJSON Feature` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonFeatureCollection	Type d’objet valide `GeoJSON FeatureCollection` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonGeometry	Objet geometry valide `GeoJSON` . Le type doit être l’un des sept types géométriques GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, consultez RFC 7946 .
GeoJsonGeometryCollection	Type d’objet valide `GeoJSON GeometryCollection` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonLineString	Type geometry valide `GeoJSON LineString` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonMultiLineString	Type geometry valide `GeoJSON MultiLineString` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonMultiPoint	Type geometry valide `GeoJSON MultiPoint` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonMultiPolygon	Type d’objet valide `GeoJSON MultiPolygon` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonPoint	Type geometry valide `GeoJSON Point` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonPolygon	Type geometry valide `GeoJSON Polygon` . Pour plus d’informations, consultez RFC 7946 .
JsonFormat	Format souhaité de la réponse. Seul le format `json` est pris en charge.
LatLongPairAbbreviated	Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

ClosestPoint

Objet d’entrée de résultat du point le plus proche

Nom	Type	Description
distanceInMeters	number	Distance en mètres entre le point source et le point le plus proche
geometryId	string	L’ID unique identifie une géométrie
position	LatLongPairAbbreviated	Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

ClosestPointResponse

Cet objet est retourné à partir d’un appel de point le plus proche spatial réussi

Nom	Type	Description
result	ClosestPoint[]	Tableau de résultats de points les plus proches
summary	ClosestPointSummary	Objet Summary du point le plus proche

ClosestPointSummary

Objet Summary du point le plus proche

Nom	Type	Description
information	string	Traitement des informations
sourcePoint	LatLongPairAbbreviated	Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
udid	string	ID de données unique (udid) pour le contenu chargé

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet error.

GeoJsonFeature

Type d’objet valide GeoJSON Feature . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
featureType	string	Type de la fonctionnalité. La valeur dépend du modèle de données dont fait partie la fonctionnalité actuelle. Certains modèles de données peuvent avoir une valeur vide.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Objet geometry valide `GeoJSON` . Le type doit être l’un des sept types géométriques GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, consultez RFC 7946 .
id	string	Identificateur de la fonctionnalité.
type	string: Feature	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonFeatureCollection

Type d’objet valide GeoJSON FeatureCollection . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
features	GeoJsonFeature[]	Contient une liste d’objets valides `GeoJSON Feature` .
type	string: FeatureCollection	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonGeometry

Objet geometry valide GeoJSON . Le type doit être l’un des sept types géométriques GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
type	GeoJsonObjectType	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonGeometryCollection

Type d’objet valide GeoJSON GeometryCollection . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Contient une liste d’objets géométriques valides `GeoJSON` . Notez que les coordonnées dans GeoJSON sont dans l’ordre x, y (longitude, latitude).
type	string: GeometryCollection	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonLineString

Type geometry valide GeoJSON LineString . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées de la `GeoJson LineString` géométrie.
type	string: LineString	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonMultiLineString

Type geometry valide GeoJSON MultiLineString . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées de la `GeoJson MultiLineString` géométrie.
type	string: MultiLineString	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonMultiPoint

Type geometry valide GeoJSON MultiPoint . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées de la `GeoJson MultiPoint` géométrie.
type	string: MultiPoint	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonMultiPolygon

Type d’objet valide GeoJSON MultiPolygon . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Contient une liste d’objets valides `GeoJSON Polygon` . Notez que les coordonnées dans GeoJSON sont dans l’ordre x, y (longitude, latitude).
type	string: MultiPolygon	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonPoint

Type geometry valide GeoJSON Point . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Un `Position` est un tableau de nombres avec deux éléments ou plus. Les deux premiers éléments sont la longitude et la latitude, précisément dans cet ordre. Altitude/Elevation est un troisième élément facultatif. Pour plus d’informations, consultez RFC 7946 .
type	string: Point	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonPolygon

Type geometry valide GeoJSON Polygon . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées du `GeoJson Polygon` type geometry.
type	string: Polygon	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

JsonFormat

Format souhaité de la réponse. Seul le format json est pris en charge.

Nom	Type	Description
json	string	Format d’échange de données de notation d’objet JavaScript

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

Nom	Type	Description
lat	number	Latitude, propriété
lon	number	Longitude, propriété

Share via