Share via

Spatial - Post Point In Polygon

  • Référence
Service:
Maps
API Version:
2022-08-01

Utilisez pour déterminer si un point donné se trouve à l’intérieur d’un ensemble de polygones.

L’API Post Point In Polygon est une requête HTTP POST qui retourne une valeur booléenne indiquant si un point se trouve à l’intérieur d’un ensemble de polygones. Les données utilisateur peuvent contenir des géométries Polygon et MultiPolygon. D’autres géométries seront ignorées si elles sont fournies. Si le point se trouve à l’intérieur ou sur la limite de l’un de ces polygones, la valeur retournée est true. Dans tous les autres cas, la valeur retournée est false. Lorsque le point se trouve à l’intérieur de plusieurs polygones, le résultat donne une section de géométries croisées pour afficher toutes les géométries valides (référencées par geometryId) dans les données utilisateur. Le nombre maximal de sommets acceptés pour former un polygone est de 10 000.

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

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 nous (USA Est, USA Centre-Ouest, USA Ouest 2) et eu (Europe Nord, Europe Ouest). Ce paramètre est obligatoire lorsqu’un udid est fourni dans la demande. Par exemple, si le compte Azure Maps se trouve dans la région USA Est, seules les demandes qui nous sont adressées à la zone géographique sont 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.

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

PointInPolygonResult

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 ressource 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.

est Authorization URL 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, kits 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.

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 qui est 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, celles-ci peuvent actuellement être traitées comme des clés master du compte pour lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès 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 Répertorier les SAP 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 précis à l’expiration, au taux et à la ou les régions d’utilisation du 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, nous vous recommandons 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 SAS.

Type: apiKey
In: header

Exemples

PostPointInPolygon

Sample Request

POST https://us.atlas.microsoft.com/spatial/pointInPolygon/json?api-version=2022-08-01&lat=33.5362475&lon=-111.9267386

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "geometryId": 1001
      },
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -111.9267386,
              33.5362475
            ],
            [
              -111.9627875,
              33.5104882
            ],
            [
              -111.9027061,
              33.5004686
            ],
            [
              -111.9267386,
              33.5362475
            ]
          ]
        ]
      }
    }
  ]
}

Sample Response

Status code:
200 
{
  "summary": {
    "sourcePoint": {
      "lat": 33.5362475,
      "lon": -111.9267386
    },
    "udid": null,
    "information": "1 polygons processed in user data"
  },
  "result": {
    "pointInPolygons": true,
    "intersectingGeometries": [
      "1001"
    ]
  }
}

Définitions

Nom Description
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 ».
PointInPolygonResult

Retourne true si point se trouve dans le polygone, false sinon
PointInPolygonSummary

Objet Point In Polygon Summary
Result

Point In Polygon Result Object

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:

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[]:

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é

PointInPolygonResult

Retourne true si point se trouve dans le polygone, false sinon

Nom Type Description
result

Result

Point In Polygon Result Object
summary

PointInPolygonSummary

Objet Point In Polygon Summary

PointInPolygonSummary

Objet Point In Polygon Summary

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é. Udid n’est pas applicable aux opérations spatiales POST(définie sur null)

Result

Point In Polygon Result Object

Nom Type Description
intersectingGeometries

string[]

Tableau de géométries
pointInPolygons

boolean

Point in Polygons, propriété