Spatial - Post Closest Point

Reference

Service:: Maps

API Version:: 2022-08-01

Slouží k získání nejbližšího bodu mezi základním bodem a danou sadou cílových bodů.

Rozhraní Post Closest Point API je požadavek HTTP POST , který vrací nejbližší bod mezi základním bodem a danou sadou cílových bodů. Sada cílových bodů je poskytována uživatelskými daty v textu po žádosti. Uživatelská data mohou obsahovat pouze kolekci geometrie bodu. MultiPoint nebo jiné geometrie budou ignorovány, pokud jsou k dispozici. Algoritmus nebere v úvahu směrování ani provoz. Maximální počet přijatých bodů je 100 000. Vrácené informace zahrnují nejbližší zeměpisnou šířku bodu, zeměpisnou délku a vzdálenost v metrech od nejbližšího bodu.

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
format	path	True	JsonFormat	Požadovaný formát odpovědi. Podporuje se pouze `json` formát.
geography	path	True	string	Umístění účtu Azure Maps. Platné hodnoty jsou us (USA – východ, USA – středozápad, USA – západ 2) a eu (Severní Evropa, Západní Evropa). Tento parametr je povinný, pokud `udid` je v požadavku zadán parametr . Pokud se například Azure Maps účet nachází v oblasti USA – východ, budou přijaty pouze žádosti o geografickou oblast.
api-version	query	True	string	Číslo verze rozhraní API Azure Maps.
lat	query	True	number	Zeměpisná šířka předávaného umístění. Příklad: 48,36.
lon	query	True	number	Zeměpisná délka předávaného umístění. Příklad: -124,63.
numberOfClosestPoints	query		integer	Počet nejbližších bodů očekávaných od odpovědi. Výchozí hodnota: 1, minimum: 1 a maximum: 50

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích.

Text požadavku

Name	Vyžadováno	Typ	Description
features	True	GeoJsonFeature[]	Obsahuje seznam platných `GeoJSON Feature` objektů.
type	True	string: FeatureCollection	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

Odpovědi

Name	Typ	Description
200 OK	ClosestPointResponse	OK
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Další informace o Microsoft identity platform najdete v přehledu 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

Jedná se o sdílený klíč, který se zřizuje při vytváření Azure Maps prostředku prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace oprávnění pro přístup ke všem rozhraním REST API. Jinými slovy, ty je v současné době možné považovat za hlavní klíče k účtu, pro který jsou vystaveny.

U veřejně vystavených aplikací doporučujeme používat přístup mezi servery Azure Maps rozhraní REST API, ve kterých lze tento klíč bezpečně uložit.

Type: apiKey
In: header

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Type: apiKey
In: header

Příklady

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

Definice

Name	Description
ClosestPoint	Nejbližší objekt point result entry
ClosestPointResponse	Tento objekt se vrátí z úspěšného volání prostorového nejbližšího bodu.
ClosestPointSummary	Objekt Souhrn nejbližšího bodu
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
GeoJsonFeature	Platný `GeoJSON Feature` typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonFeatureCollection	Platný `GeoJSON FeatureCollection` typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonGeometry	Platný `GeoJSON` objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonGeometryCollection	Platný `GeoJSON GeometryCollection` typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonLineString	Platný `GeoJSON LineString` typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonMultiLineString	Platný `GeoJSON MultiLineString` typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonMultiPoint	Platný `GeoJSON MultiPoint` typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonMultiPolygon	Platný `GeoJSON MultiPolygon` typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonPoint	Platný `GeoJSON Point` typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
GeoJsonPolygon	Platný `GeoJSON Polygon` typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
JsonFormat	Požadovaný formát odpovědi Podporuje se pouze `json` formát.
LatLongPairAbbreviated	Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".

ClosestPoint

Nejbližší objekt point result entry

Name	Typ	Description
distanceInMeters	number	Vzdálenost v metrech od zdrojového bodu k nejbližšímu bodu
geometryId	string	Jedinečné ID identifikuje geometrii.
position	LatLongPairAbbreviated	Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".

ClosestPointResponse

Tento objekt se vrátí z úspěšného volání prostorového nejbližšího bodu.

Name	Typ	Description
result	ClosestPoint[]	Nejbližší pole výsledků v bodech
summary	ClosestPointSummary	Objekt Souhrn nejbližšího bodu

ClosestPointSummary

Objekt Souhrn nejbližšího bodu

Name	Typ	Description
information	string	Zpracování informací
sourcePoint	LatLongPairAbbreviated	Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
udid	string	Jedinečné ID dat (udid) pro nahraný obsah

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

GeoJsonFeature

Platný GeoJSON Feature typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
featureType	string	Typ funkce. Hodnota závisí na datovém modelu, který je součástí aktuální funkce. Některé datové modely můžou mít prázdnou hodnotu.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Platný `GeoJSON` objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .
id	string	Identifikátor funkce
type	string: Feature	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonFeatureCollection

Platný GeoJSON FeatureCollection typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
features	GeoJsonFeature[]	Obsahuje seznam platných `GeoJSON Feature` objektů.
type	string: FeatureCollection	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonGeometry

Platný GeoJSON objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
type	GeoJsonObjectType	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonGeometryCollection

Platný GeoJSON GeometryCollection typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Obsahuje seznam platných `GeoJSON` objektů geometrie. Všimněte si , že souřadnice v GeoJSON jsou v pořadí x, y (zeměpisná délka, zeměpisná šířka).
type	string: GeometryCollection	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonLineString

Platný GeoJSON LineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
coordinates	number[]	`GeoJson LineString` Souřadnice geometrie.
type	string: LineString	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonMultiLineString

Platný GeoJSON MultiLineString typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
coordinates	number[]	`GeoJson MultiLineString` Souřadnice geometrie.
type	string: MultiLineString	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonMultiPoint

Platný GeoJSON MultiPoint typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
coordinates	number[]	`GeoJson MultiPoint` Souřadnice geometrie.
type	string: MultiPoint	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonMultiPolygon

Platný GeoJSON MultiPolygon typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
coordinates	number[]	Obsahuje seznam platných `GeoJSON Polygon` objektů. Všimněte si , že souřadnice v GeoJSON jsou v pořadí x, y (zeměpisná délka, zeměpisná šířka).
type	string: MultiPolygon	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonPoint

Platný GeoJSON Point typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
coordinates	number[]	A `Position` je matice čísel se dvěma nebo více prvky. První dva prvky jsou zeměpisná délka a zeměpisná šířka, přesně v daném pořadí. Třetím prvkem je nadmořská výška nebo nadmořská výška. Podrobnosti najdete v dokumentu RFC 7946 .
type	string: Point	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

GeoJsonPolygon

Platný GeoJSON Polygon typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .

Name	Typ	Description
coordinates	number[]	Souřadnice typu `GeoJson Polygon` geometrie.
type	string: Polygon	Určuje `GeoJSON` typ. Musí být jedním z devíti platných typů objektů GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature a FeatureCollection.

JsonFormat

Požadovaný formát odpovědi Podporuje se pouze json formát.

Name	Typ	Description
json	string	Formát výměny dat zápisu objektů JavaScriptu

LatLongPairAbbreviated

Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".

Name	Typ	Description
lat	number	Vlastnost Zeměpisná šířka
lon	number	Zeměpisná délka – vlastnost

Share via