Sdílet prostřednictvím


Search - Get Search Address Reverse Cross Street

Slouží k získání informací o poloze křížové ulice ze souřadnic zeměpisné šířky a délky.

Rozhraní Get Search Address Reverse Cross Street API je požadavek HTTP GET , který při zadání souřadnic zeměpisné šířky a délky vrátí nejbližší křížovou ulici. Může se stát, že budete potřebovat přeložit souřadnici (například 37,786505, -122,3862) na srozumitelnou křižovatku. Nejčastěji je to potřeba ve sledovacích aplikacích, kde přijímáte informační kanál GPS ze zařízení nebo prostředku a chcete vědět, na jaké adrese se souřadnice nachází. Tento koncový bod vrátí informace o křížové ulici pro danou souřadnici.

GET https://atlas.microsoft.com/search/address/reverse/crossStreet/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/address/reverse/crossStreet/{format}?api-version=1.0&query={query}&limit={limit}&heading={heading}&radius={radius}&language={language}&view={view}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
format
path True

ResponseFormat

Požadovaný formát odpovědi. Hodnota může být json nebo xml.

api-version
query True

string

Číslo verze rozhraní API Azure Maps.

query
query True

number[]

Příslušný dotaz zadaný jako řetězec oddělený čárkami složený podle zeměpisné šířky následované zeměpisnou délkou, např. "47.641268,-122.125679".

heading
query

integer

Směrový směr vozidla ve stupních pro jízdu po úseku vozovky. 0 je Sever, 90 je východ a tak dále, hodnoty jsou v rozsahu od -360 do 360. Přesnost může zahrnovat až jedno desetinné místo.

language
query

string

Jazyk, ve kterém se mají vracet výsledky hledání. Měl by být jednou z podporovaných značek jazyka IETF, nerozlišují se malá a velká písmena. Pokud data v zadaném jazyce nejsou pro konkrétní pole k dispozici, použije se výchozí jazyk.

Podrobnosti najdete v části Podporované jazyky .

limit
query

integer

Maximální počet odpovědí, které budou vráceny. Výchozí hodnota: 10, minimum: 1 a maximum: 100

radius
query

integer

Poloměr v metrech do, aby výsledky byly omezeny na definovanou oblast

view
query

LocalizedMapView

Parametr View (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení takových oblastí a parametr View umožňuje, aby aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified", i když jste ho v požadavku nedefinovali. Je vaší zodpovědností určit umístění uživatelů a pak pro toto umístění správně nastavit parametr View. Případně máte možnost nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr View v Azure Maps musí být použit v souladu s platnými zákony, včetně těch, které se týkají mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps jsou dostupné. Příklad: view=IN.

Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.

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 dá se načíst z rozhraní API účtu Azure Maps roviny správy. Pokud chcete použít zabezpečení Microsoft Entra ID v Azure Maps pokyny najdete v následujících článcích.

Odpovědi

Name Typ Description
200 OK

ReverseSearchCrossStreetAddressResult

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ámka

  • 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 nastavit aplikaci na základě konfigurace pro více případů použití.
  • Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.

U veřejně vystavených aplikací doporučujeme používat pro přístup k rozhraním REST API Azure Maps přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.

Typ: apiKey
V: query

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.

Typ: apiKey
V: header

Příklady

Search address of the nearest intersection/crossroad

Ukázkový požadavek

GET https://atlas.microsoft.com/search/address/reverse/crossStreet/json?api-version=1.0&query=37.337,-121.89

Ukázková odpověď

{
  "summary": {
    "numResults": 1,
    "queryTime": 41
  },
  "addresses": [
    {
      "address": {
        "streetName": "East Santa Clara Street & North 2nd Street",
        "crossStreet": "East Santa Clara Street",
        "municipalitySubdivision": "San Jose, Downtown San Jose",
        "municipality": "San Jose",
        "countrySecondarySubdivision": "Santa Clara",
        "countryTertiarySubdivision": "San Jose",
        "countrySubdivisionCode": "CA",
        "postalCode": "95113",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "East Santa Clara Street & North 2nd Street, San Jose, CA 95113",
        "countrySubdivisionName": "California"
      },
      "position": "37.33666,-121.88951"
    }
  ]
}

Definice

Name Description
Address

Adresa výsledku

BoundingBoxCompassNotation

Ohraničující rámeček umístění.

Entity

Zdroj typu entity ohraničujícího rámečku. Pro reverzní geokódování je to vždy stejné jako pozice.

ErrorAdditionalInfo

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

ErrorDetail

Podrobnosti o chybě

ErrorResponse

Chybová odpověď

LatLongPairAbbreviated

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

LocalizedMapView

Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení těchto oblastí a parametr Zobrazení umožňuje, aby vaše aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN.

Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.

QueryType

Typ vráceného dotazu: BLÍZKÉ nebo NON_NEAR.

ResponseFormat

Požadovaný formát odpovědi Hodnota může být json nebo xml.

ReverseSearchCrossStreetAddressResult

Tento objekt je vrácen z úspěšného volání Search Address Reverse CrossStreet

ReverseSearchCrossStreetAddressResultItem

Objekt Result pro Search adresu – zpětná odpověď Cross Street

SearchSummary

Souhrnný objekt pro odpověď rozhraní API Search.

Address

Adresa výsledku

Name Typ Description
boundingBox

BoundingBoxCompassNotation

Ohraničující rámeček umístění.

buildingNumber

string

Číslo budovy na ulici. ZASTARALÉ, použijte místo toho streetNumber.

country

string

název země/oblasti

countryCode

string

Země (Poznámka: Toto je dvoumísmenný kód, ne název země/oblasti.)

countryCodeISO3

string

ISO alfa-3 kód země

countrySecondarySubdivision

string

County

countrySubdivision

string

Země/region nebo kraj

countrySubdivisionCode

string

countrySubdivisionCode s předponou countryCode ( countryCode-countrySubdivisionCode ) a spojovník tvoří kód ISO 3166-2. Příklady: TX pro Texas, SCT pro Skotsko a ON pro Ontario.

countrySubdivisionName

string

Úplný název první úrovně hierarchie správy země/oblasti. Toto pole se zobrazí pouze v případě, že je countrySubdivision prezentováno ve zkrácené podobě. Podporováno pouze pro USA, Kanadu a Spojené království.

countryTertiarySubdivision

string

Pojmenovaná oblast

crossStreet

string

Název překračované ulice.

extendedPostalCode

string

Rozšířené PSČ (dostupnost závisí na oblasti).

freeformAddress

string

Řádek adresy formátovaný podle pravidel formátování země/oblasti původu výsledku nebo v případě země/oblasti úplný název země/oblasti.

localName

string

Komponenta adresy, která představuje název geografické oblasti nebo lokality, která seskupuje více adresovatelných objektů pro účely adresování, aniž by to byla jednotka pro správu. Toto pole se používá k sestavení freeformAddress vlastnosti. localName zastupuje poštovní obec. V závislosti na umístění localName je běžně známý název města nebo města. Jako běžně známý název města nebo města použijte localName místo municipality.

municipality

string

Město / město
Poznámka: municipality představuje obytnou obec. V závislosti na umístění municipality se hodnota může lišit od běžně známého názvu města nebo města. Pro běžně známý název města se doporučuje localName místo hodnoty použít municipality hodnotu .

municipalitySubdivision

string

Sub / Super City

neighbourhood

string

Sousedství je geograficky lokalizovaná oblast v rámci města nebo města s výraznými charakteristikami a sociálními interakcemi mezi obyvateli.

postalCode

string

PSČ

routeNumbers

string[]

Kódy používané k jednoznačné identifikaci ulice

street

string

Název ulice. ZASTARALÉ, použijte místo toho streetName.

streetName

string

Název ulice.

streetNameAndNumber

string

Název ulice a číslo.

streetNumber

string

Číslo budovy na ulici.

BoundingBoxCompassNotation

Ohraničující rámeček umístění.

Name Typ Description
entity

Entity

Zdroj typu entity ohraničujícího rámečku. Pro reverzní geokódování je to vždy stejné jako pozice.

northEast

string

Severní a východní zeměpisná šířka, souřadnice délky ohraničujícího rámečku jako čárkami oddělené floaty

southWest

string

Jihovýchodní zeměpisná šířka, souřadnice délky ohraničujícího rámečku jako plovoucí čárky oddělené čárkami

Entity

Zdroj typu entity ohraničujícího rámečku. Pro reverzní geokódování je to vždy stejné jako pozice.

Name Typ Description
position

string

Pozice entity

ErrorAdditionalInfo

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

Name Typ Description
info

object

Další informace.

type

string

Další typ informací.

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.

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

LocalizedMapView

Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení těchto oblastí a parametr Zobrazení umožňuje, aby vaše aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN.

Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.

Name Typ Description
AE

string

Spojené arabské emiráty (arabské zobrazení)

AR

string

Argentina (argentinský pohled)

Auto

string

Vrátí mapová data na základě IP adresy požadavku.

BH

string

Bahrajn (arabské zobrazení)

IN

string

Indie (indické zobrazení)

IQ

string

Irák (arabské zobrazení)

JO

string

Jordánsko (arabské zobrazení)

KW

string

Kuvajt (arabské zobrazení)

LB

string

Libanon (arabské zobrazení)

MA

string

Maroko (marocké zobrazení)

OM

string

Omán (arabské zobrazení)

PK

string

Pákistán (pákistánské zobrazení)

PS

string

Palestinská samospráva (arabské zobrazení)

QA

string

Katar (arabské zobrazení)

SA

string

Saúdská Arábie (arabské zobrazení)

SY

string

Sýrie (arabské zobrazení)

Unified

string

Sjednocené zobrazení (ostatní)

YE

string

Jemen (arabské zobrazení)

QueryType

Typ vráceného dotazu: BLÍZKÉ nebo NON_NEAR.

Name Typ Description
NEARBY

string

Search byla provedena kolem určité zeměpisné šířky a délky s definovaným poloměrem.

NON_NEAR

string

Search byla provedena globálně, bez zkreslení na určitou zeměpisnou šířku a délku a bez definovaného poloměru.

ResponseFormat

Požadovaný formát odpovědi Hodnota může být json nebo xml.

Name Typ Description
json

string

Formát výměny dat zápisu objektů JavaScriptu

xml

string

The Extensible Markup Language

ReverseSearchCrossStreetAddressResult

Tento objekt je vrácen z úspěšného volání Search Address Reverse CrossStreet

Name Typ Description
addresses

ReverseSearchCrossStreetAddressResultItem[]

Pole adres

summary

SearchSummary

Objekt Summary pro odpověď Search Address Reverse Cross Street

ReverseSearchCrossStreetAddressResultItem

Objekt Result pro Search adresu – zpětná odpověď Cross Street

Name Typ Description
address

Address

Adresa výsledku

position

string

Vlastnost Position ve tvaru {zeměpisná šířka},{zeměpisná délka}

SearchSummary

Souhrnný objekt pro odpověď rozhraní API Search.

Name Typ Description
fuzzyLevel

integer

Maximální přibližná úroveň požadovaná k poskytnutí výsledků.

geoBias

LatLongPairAbbreviated

Označení, kdy interní vyhledávací web použil geoprostorové předsudky ke zlepšení hodnocení výsledků. V některých metodách to může být ovlivněno nastavením parametrů lat a lon tam, kde jsou k dispozici. V ostatních případech je čistě interní.

limit

integer

Maximální počet odpovědí, které budou vráceny

numResults

integer

Počet výsledků v odpovědi

offset

integer

Počáteční posun vrácených výsledků v rámci celé sady výsledků.

query

string

Parametr dotazu, který byl použit k vytvoření těchto výsledků hledání.

queryTime

integer

Doba strávená překladem dotazu v milisekundách

queryType

QueryType

Typ vráceného dotazu: BLÍZKÉ nebo NON_NEAR.

totalResults

integer

Celkový počet nalezených výsledků