Spatial - Post Closest Point

Referentie

Service:: Maps

API Version:: 2022-08-01

Gebruik om het dichtstbijzijnde punt tussen een basispunt en een bepaalde set doelpunten op te halen.

De Post Closest Point API is een HTTP-aanvraag POST die het dichtstbijzijnde punt tussen een basispunt en een bepaalde set doelpunten retourneert. De set doelpunten wordt geleverd door gebruikersgegevens in de hoofdtekst van de aanvraag. De gebruikersgegevens mogen alleen een verzameling puntgeometrie bevatten. MultiPoint- of andere geometrieën worden genegeerd indien opgegeven. Het algoritme houdt geen rekening met routering of verkeer. Het maximum aantal geaccepteerde punten is 100.000. Geretourneerde informatie omvat de dichtstbijzijnde puntbreedte, lengtegraad en afstand in meters tot het dichtstbijzijnde punt.

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}

URI-parameters

Name	In	Vereist	Type	Description
format	path	True	JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
geography	path	True	string	Locatie van het Azure Maps-account. Geldige waarden zijn us (VS - oost, VS - west-centraal, VS - west 2) en eu (Europa - noord, Europa - west). Deze parameter is vereist wanneer een `udid` wordt opgegeven in de aanvraag. Als het Azure Maps-account zich bijvoorbeeld in VS - oost bevindt, worden alleen aanvragen aan ons geografisch gebied geaccepteerd.
api-version	query	True	string	Versienummer van Azure Maps API.
lat	query	True	number	De breedtegraad van de locatie die wordt doorgegeven. Voorbeeld: 48.36.
lon	query	True	number	De lengtegraad van de locatie die wordt doorgegeven. Voorbeeld: -124,63.
numberOfClosestPoints	query		integer	Het aantal dichtstbijzijnde punten dat van het antwoord wordt verwacht. Standaard: 1, minimaal: 1 en maximaal: 50

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID-beveiliging in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Aanvraagbody

Name	Vereist	Type	Description
features	True	GeoJsonFeature[]	Bevat een lijst met geldige `GeoJSON Feature` objecten.
type	True	string: FeatureCollection	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

Antwoorden

Name	Type	Description
200 OK	ClosestPointResponse	OK
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. In combinatie met op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Als u scenario's wilt implementeren, raden we u aan om verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id header om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.

Zie Microsoft identity platform overzicht voor meer informatie over Microsoft identity platform.

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

Scopes

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht bij het maken van een Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met deze sleutel wordt elke toepassing gemachtigd voor toegang tot alle REST API's. Met andere woorden, deze kunnen momenteel worden behandeld als hoofdsleutels voor het account waarvoor ze zijn uitgegeven.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om server-naar-servertoegang te gebruiken voor Azure Maps REST API's waar deze sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een shared access signature-token dat wordt gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle over het verloop, de snelheid en de gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

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"
    }
  ]
}

Definities

Name	Description
ClosestPoint	Dichtstbijzijnde puntresultaatitemobject
ClosestPointResponse	Dit object wordt geretourneerd na een geslaagde Spatial Dichtstbijzijnde punt-aanroep
ClosestPointSummary	Dichtstbijzijnde puntsamenvattingsobject
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GeoJsonFeature	Een geldig `GeoJSON Feature` objecttype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonFeatureCollection	Een geldig `GeoJSON FeatureCollection` objecttype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonGeometry	Een geldig `GeoJSON` geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonGeometryCollection	Een geldig `GeoJSON GeometryCollection` objecttype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonLineString	Een geldig `GeoJSON LineString` geometrietype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonMultiLineString	Een geldig `GeoJSON MultiLineString` geometrietype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonMultiPoint	Een geldig `GeoJSON MultiPoint` geometrietype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonMultiPolygon	Een geldig `GeoJSON MultiPolygon` objecttype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonPoint	Een geldig `GeoJSON Point` geometrietype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonPolygon	Een geldig `GeoJSON Polygon` geometrietype. Raadpleeg RFC 7946 voor meer informatie.
JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

ClosestPoint

Dichtstbijzijnde puntresultaatitemobject

Name	Type	Description
distanceInMeters	number	De afstand in meters van het bronpunt tot het dichtstbijzijnde punt
geometryId	string	De unieke id identificeert een geometrie
position	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

ClosestPointResponse

Dit object wordt geretourneerd na een geslaagde Spatial Dichtstbijzijnde punt-aanroep

Name	Type	Description
result	ClosestPoint[]	Dichtstbijzijnde matrix met puntresultaten
summary	ClosestPointSummary	Dichtstbijzijnde puntsamenvattingsobject

ClosestPointSummary

Dichtstbijzijnde puntsamenvattingsobject

Name	Type	Description
information	string	Informatie verwerken
sourcePoint	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
udid	string	Een unieke gegevens-id (udid) voor de geüploade inhoud

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GeoJsonFeature

Een geldig GeoJSON Feature objecttype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
featureType	string	Het type van de functie. De waarde is afhankelijk van het gegevensmodel waarvan de huidige functie deel uitmaakt. Sommige gegevensmodellen hebben mogelijk een lege waarde.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Een geldig `GeoJSON` geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946 voor meer informatie.
id	string	Id voor de functie.
type	string: Feature	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonFeatureCollection

Een geldig GeoJSON FeatureCollection objecttype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
features	GeoJsonFeature[]	Bevat een lijst met geldige `GeoJSON Feature` objecten.
type	string: FeatureCollection	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonGeometry

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
type	GeoJsonObjectType	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonGeometryCollection

Een geldig GeoJSON GeometryCollection objecttype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Bevat een lijst met geldige `GeoJSON` geometrieobjecten. Houd er rekening mee dat coördinaten in GeoJSON in de volgorde x, y (lengtegraad, breedtegraad) staan.
type	string: GeometryCollection	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonLineString

Een geldig GeoJSON LineString geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
coordinates	number[]	Coördinaten voor de `GeoJson LineString` geometrie.
type	string: LineString	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiLineString

Een geldig GeoJSON MultiLineString geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
coordinates	number[]	Coördinaten voor de `GeoJson MultiLineString` geometrie.
type	string: MultiLineString	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiPoint

Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
coordinates	number[]	Coördinaten voor de `GeoJson MultiPoint` geometrie.
type	string: MultiPoint	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiPolygon

Een geldig GeoJSON MultiPolygon objecttype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
coordinates	number[]	Bevat een lijst met geldige `GeoJSON Polygon` objecten. Houd er rekening mee dat coördinaten in GeoJSON in de volgorde x, y (lengtegraad, breedtegraad) staan.
type	string: MultiPolygon	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonPoint

Een geldig GeoJSON Point geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
coordinates	number[]	A `Position` is een matrix met getallen met twee of meer elementen. De eerste twee elementen zijn lengtegraad en breedtegraad, precies in die volgorde. Hoogte/hoogte is een optioneel derde element. Raadpleeg RFC 7946 voor meer informatie.
type	string: Point	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonPolygon

Een geldig GeoJSON Polygon geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Name	Type	Description
coordinates	number[]	Coördinaten voor het `GeoJson Polygon` geometrietype.
type	string: Polygon	Hiermee geeft u het `GeoJSON` type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

JsonFormat

Gewenste indeling van het antwoord. Alleen json de indeling wordt ondersteund.

Name	Type	Description
json	string	De JavaScript Object Notation Data Interchange-indeling

LatLongPairAbbreviated

Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

Name	Type	Description
lat	number	De eigenschap Breedtegraad
lon	number	De eigenschap Lengtegraad