Spatial - Post Closest Point

Referencia

Service:: Maps

API Version:: 2022-08-01

A következőkre vonatkozik: lásd: tarifacsomagok.

Ez az API az alappont és egy adott célpontcsoport közötti legközelebbi pontot adja vissza. A célpontok készletét a felhasználói adatok adják meg a kérést követő törzsben. A felhasználói adatok csak pontgeometriai gyűjteményt tartalmazhatnak. A multiPoint vagy más geometriák figyelmen kívül lesznek hagyva, ha meg vannak adva. Az algoritmus nem veszi figyelembe az útválasztást vagy a forgalmat. Az elfogadott pontok maximális száma 100 000. A visszaadott információk közé tartozik a legközelebbi pont szélessége, hosszúsága és távolsága a legközelebbi ponttól mért méterben.

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-paraméterek

Name	In	Kötelező	Típus	Description
format	path	True	JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
geography	path	True	string	A Azure Maps-fiók helye. Érvényes értékek: mi (USA keleti régiója, USA nyugati középső régiója, USA 2. nyugati régiója) és az EU (Észak-Európa, Nyugat-Európa). Erre a paraméterre akkor van szükség, ha a `udid` kérelemben egy meg van adva. Ha például a Azure Maps-fiók az USA keleti régiójában található, akkor csak a földrajzra vonatkozó kérések lesznek elfogadva.
api-version	query	True	string	A Azure Maps API verziószáma.
lat	query	True	number	Az átadott hely szélessége. Példa: 48.36.
lon	query	True	number	Az átadott hely hosszúsága. Példa: -124.63.
numberOfClosestPoints	query		integer	A választól várt legközelebbi pontok száma. Alapértelmezett: 1, minimum: 1 és maximum: 50

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen a Azure AD biztonsági modellel együtt használva. Ez a Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeletisík Fiók API-jából. Ha Azure AD biztonságot szeretne használni Azure Maps tekintse meg az alábbi cikkeket.

Kérelem törzse

Name	Kötelező	Típus	Description
features	True	GeoJsonFeature[]	Az érvényes `GeoJSON Feature` objektumok listáját tartalmazza.
type	True	string: FeatureCollection	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature és FeatureCollection.

Válaszok

Name	Típus	Description
200 OK	ClosestPointResponse	OK
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek az Azure Active Directory OAuth2-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható a Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több, a REST API-khoz Azure Maps engedélyekkel rendelkező egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Jegyzetek

Ez a biztonsági definíció a fejléc használatával x-ms-client-id jelzi, hogy az alkalmazás melyik Azure Maps erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.

Ez Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Azure Active Directory-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlés az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.

Jelenleg az Azure Active Directory 1.0-s vagy 2.0-s verziója támogatja a Munkahelyi, iskolai és vendégfelhasználói verziót, de nem támogatja a személyes fiókokat.

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

Ez egy megosztott kulcs, amely akkor van kiépítve, amikor Azure Maps erőforrást hoz létre az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ezek jelenleg főkulcsként kezelhetők ahhoz a fiókhoz, amelyhez ki vannak adva.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy használja a Azure Maps REST API-k kiszolgálóról kiszolgálóra való hozzáférését, ahol ez a kulcs biztonságosan tárolható.

Type: apiKey
In: header

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat, amely a Azure Maps erőforrás SAS listázási műveletéből jön létre az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonat lejáratához, sebességéhez és régiójához. Más szóval az SAS-jogkivonattal az alkalmazások biztonságosabb módon szabályozhatják a hozzáférést, mint a megosztott kulcs.

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy konfigurálja az engedélyezett források adott listáját a Térképfiók erőforráson a megjelenítési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.

Type: apiKey
In: header

Példák

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

Definíciók

Name	Description
ClosestPoint	Legközelebbi pont eredménybeviteli objektuma
ClosestPointResponse	Ezt az objektumot egy sikeres Spatial Closest Point-hívás adja vissza
ClosestPointSummary	Legközelebbi pont összegzése objektum
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
GeoJsonFeature	Érvényes `GeoJSON Feature` objektumtípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonFeatureCollection	Érvényes `GeoJSON FeatureCollection` objektumtípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonGeometry	Érvényes `GeoJSON` geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon és GeometryCollection. A részleteket az RFC 7946-os verziójában találja.
GeoJsonGeometryCollection	Érvényes `GeoJSON GeometryCollection` objektumtípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonLineString	Érvényes `GeoJSON LineString` geometriatípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonMultiLineString	Érvényes `GeoJSON MultiLineString` geometriatípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonMultiPoint	Érvényes `GeoJSON MultiPoint` geometriatípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonMultiPolygon	Érvényes `GeoJSON MultiPolygon` objektumtípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonPoint	Érvényes `GeoJSON Point` geometriatípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonPolygon	Érvényes `GeoJSON Polygon` geometriatípus. A részleteket az RFC 7946-os verziójában találja.
JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként ábrázolt hely a "lat" "lon" & rövid nevek használatával.

ClosestPoint

Legközelebbi pont eredménybeviteli objektuma

Name	Típus	Description
distanceInMeters	number	A távolság méterben a forrásponttól a legközelebbi pontig
geometryId	string	Az egyedi azonosító azonosítja a geometriát
position	LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként ábrázolt hely a "lat" "lon" & rövid nevek használatával.

ClosestPointResponse

Ezt az objektumot egy sikeres Spatial Closest Point-hívás adja vissza

Name	Típus	Description
result	ClosestPoint[]	Legközelebbi pont eredménytömbje
summary	ClosestPointSummary	Legközelebbi pont összegzése objektum

ClosestPointSummary

Legközelebbi pont összegzése objektum

Name	Típus	Description
information	string	Adatok feldolgozása
sourcePoint	LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként ábrázolt hely a "lat" "lon" & rövid nevek használatával.
udid	string	A feltöltött tartalom egyedi adatazonosítója (udid)

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

GeoJsonFeature

Érvényes GeoJSON Feature objektumtípus. A részleteket az RFC 7946-os verziójában találja.

Name	Típus	Description
featureType	string	A szolgáltatás típusa. Az érték attól az adatmodelltől függ, amelybe az aktuális funkció tartozik. Egyes adatmodellek üres értékkel rendelkezhetnek.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Érvényes `GeoJSON` geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon és GeometryCollection. A részleteket az RFC 7946-os verziójában találja.
id	string	A szolgáltatás azonosítója.
type	string: Feature	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature és FeatureCollection.

GeoJsonFeatureCollection

Érvényes GeoJSON FeatureCollection objektumtípus. A részleteket az RFC 7946-os verziójában találja.

Name	Típus	Description
features	GeoJsonFeature[]	Az érvényes `GeoJSON Feature` objektumok listáját tartalmazza.
type	string: FeatureCollection	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature és FeatureCollection.

GeoJsonGeometry

Érvényes GeoJSON geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon és GeometryCollection. A részleteket az RFC 7946-os verziójában találja.

Name	Típus	Description
type	GeoJsonObjectType	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature és FeatureCollection.

GeoJsonGeometryCollection

Érvényes GeoJSON GeometryCollection objektumtípus. A részleteket az RFC 7946-os verziójában találja.

Name	Típus	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Érvényes geometriai objektumok listáját `GeoJSON` tartalmazza. Vegye figyelembe , hogy a GeoJSON koordinátái x, y sorrendben vannak (hosszúság, szélesség).
type	string: GeometryCollection	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature és FeatureCollection.

GeoJsonLineString

Érvényes GeoJSON LineString geometriatípus. A részleteket az RFC 7946-os verziójában találja.

Name	Típus	Description
coordinates	number[]	A geometria koordinátái `GeoJson LineString` .
type	string: LineString	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature és FeatureCollection.

GeoJsonMultiLineString

Érvényes GeoJSON MultiLineString geometriatípus. A részleteket az RFC 7946-os verziójában találja.

Name	Típus	Description
coordinates	number[]	A geometria koordinátái `GeoJson MultiLineString` .
type	string: MultiLineString	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature és FeatureCollection.

GeoJsonMultiPoint

Érvényes GeoJSON MultiPoint geometriatípus. A részleteket az RFC 7946-os verziójában találja.

Name	Típus	Description
coordinates	number[]	A geometria koordinátái `GeoJson MultiPoint` .
type	string: MultiPoint	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature és FeatureCollection.

GeoJsonMultiPolygon

Érvényes GeoJSON MultiPolygon objektumtípus. A részleteket az RFC 7946-os verziójában találja.

Name	Típus	Description
coordinates	number[]	Az érvényes `GeoJSON Polygon` objektumok listáját tartalmazza. Vegye figyelembe , hogy a GeoJSON koordinátái x, y sorrendben vannak (hosszúság, szélesség).
type	string: MultiPolygon	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature és FeatureCollection.

GeoJsonPoint

Érvényes GeoJSON Point geometriatípus. A részleteket az RFC 7946-os verziójában találja.

Name	Típus	Description
coordinates	number[]	Az A `Position` két vagy több elemet tartalmazó számtömb. Az első két elem a hosszúság és a szélesség, pontosan ebben a sorrendben. A magasság/magasság nem kötelező harmadik elem. A részleteket az RFC 7946-os verziójában találja.
type	string: Point	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature és FeatureCollection.

GeoJsonPolygon

Érvényes GeoJSON Polygon geometriatípus. A részleteket az RFC 7946-os verziójában találja.

Name	Típus	Description
coordinates	number[]	A geometriatípus koordinátái `GeoJson Polygon` .
type	string: Polygon	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature és FeatureCollection.

JsonFormat

A válasz kívánt formátuma. Csak json a formátum támogatott.

Name	Típus	Description
json	string	A JavaScript object Notation Data Interchange formátuma

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként ábrázolt hely a "lat" "lon" & rövid nevek használatával.

Name	Típus	Description
lat	number	Latitude tulajdonság
lon	number	Hosszúság tulajdonság