Search - Get Search Address Reverse Cross Street

Reference

Služba:: Maps

Verze rozhraní API:: 1.0

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

Rozhraní API Get Search Address Reverse Cross Street je požadavek HTTP GET, který při zadání souřadnic zeměpisné šířky a délky vrátí nejbližší křížovou ulici. Někdy může být potřeba přeložit souřadnici (příklad: 37,786505, -122.3862) na lidskou srozumitelnou ulici. Nejčastěji je to potřeba při sledování aplikací, kde obdržíte GPS kanál ze zařízení nebo prostředku a chcete vědět, jakou adresu souřadnice se 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}

S volitelnými parametry:

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 služby 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říklad 47,641268–122,125679.
heading	query		integer minimum: -360 maximum: 360	Směrový nadpis vozidla ve stupních, pro cestování po segmentu silnice. 0 je north, 90 is East, and so on, values range from -360 to 360. Přesnost může obsahovat maximálně jedno desetinné místo.
language	query		string	Jazyk, ve kterém mají být vráceny výsledky hledání. Měla 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 dostupná, použije se výchozí jazyk. Podrobnosti najdete v podporovaných jazycích.
limit	query		integer minimum: 1 maximum: 100	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 k výsledkům, které mají být omezeny na definovanou oblast
view	query		LocalizedMapView	Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopolitické sporné oblasti. Různé země/oblasti mají různá zobrazení těchto oblastí a parametr View umožňuje vaší aplikaci dodržovat zobrazení vyžadované zemí nebo oblastí, kterou bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na Sjednocený, i když jste ho v požadavku nedefinovali. Je vaší zodpovědností určit umístění uživatelů a pak nastavit parametr View správně pro dané umístění. Alternativně máte možnost nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení ve službě Azure Maps se musí používat v souladu s příslušný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 přes Azure Maps, je zpřístupněn. Příklad: view=IN. Podrobnosti a dostupné zobrazení najdete v podporovaných zobrazeních.

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

Odpovědi

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

Zabezpečení

AADToken

Jedná se o Microsoft Entra OAuth 2.0 Flow. Při spárování s přístupu na základě role Azure se dá řídit přístup k rozhraním REST API služby Azure Maps. Řízení přístupu na základě role Azure slouží k určení přístupu k jednomu nebo více účtům prostředků Nebo dílčím prostředkům Azure Maps. 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 složené z jednoho nebo více oprávnění k rozhraním REST API služby Azure Maps.

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

Poznámka:

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení, ke kterému prostředku Azure Maps aplikace žádá o přístup. Můžete ho získat z rozhraní API pro správu Maps.
Authorization URL je specifická pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné adresy URL autorizace a konfigurace MICROSOFT Entra ID.
Řízení přístupu na základě role Azure se konfiguruje z roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad AZURE SDK nebo rozhraní REST API.
Použití webové sady SDK služby Azure Maps umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy 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 na webu Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

Díky tomuto klíči má každá aplikace přístup ke všem rozhraní REST API. Jinými slovy, tento klíč lze použít jako hlavní klíč v účtu, ve který jsou vydány.

U veřejně vystavených aplikací doporučujeme používat důvěrných klientských aplikací přístup k rozhraním REST API služby Azure Maps, aby bylo možné klíč 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 Vypsat SAS v prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad SDK Azure 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 Azure a jemně odstupňované řízení vypršení platnosti, rychlosti a oblastí použití pro konkrétní token. Jinými slovy, token SAS lze 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ů na prostředku účtu Map omezit zneužití vykreslování a pravidelně obnovovat token SAS.

Typ: apiKey
V: header

Příklady

Search address of the nearest intersection/crossroad

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

{
  "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. V případě zpětného geokódování se toto umístění vždy rovná pozici.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
LatLongPairAbbreviated	Umístění reprezentované jako zeměpisná šířka a délka s krátkými názvy "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 geopolitické sporné oblasti. Různé země/oblasti mají různá zobrazení těchto oblastí a parametr View umožňuje vaší aplikaci dodržovat zobrazení vyžadované zemí nebo oblastí, kterou bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na Sjednocený, i když jste ho v požadavku nedefinovali. Je vaší zodpovědností určit umístění uživatelů a pak nastavit parametr View správně pro dané umístění. Alternativně máte možnost nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení ve službě Azure Maps se musí používat v souladu s příslušný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 přes Azure Maps, je zpřístupněn. Příklad: view=IN. Podrobnosti a dostupné zobrazení najdete v podporovaných zobrazeních.
QueryType	Typ vráceného dotazu: NEDALE nebo NON_NEAR.
ResponseFormat	Požadovaný formát odpovědi Hodnota může být json nebo xml.
ReverseSearchCrossStreetAddressResult	Tento objekt se vrátí z úspěšného volání Search Address Reverse CrossStreet
ReverseSearchCrossStreetAddressResultItem	Výsledek objektu odpovědi Search Address Reverse Cross Street
SearchSummary	Souhrnný objekt odpovědi rozhraní API služby Search

Address

Objekt

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 argument streetNumber.
country	string	název země/oblasti
countryCode	string	Země (Poznámka: Jedná se o dvoumísmenný kód, nikoli název země/oblasti.)
countryCodeISO3	string	Kód země ISO alfa-3
countrySecondarySubdivision	string	Kraj
countrySubdivision	string	Stát nebo provincie
countrySubdivisionCode	string	`countrySubdivisionCode` 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 pro správu země/oblasti. Toto pole se zobrazí pouze v případě, že se zeměSubdivision zobrazí ve zkrácené podobě. Podporováno pouze pro USA, Kanadu a Spojené království.
countryTertiarySubdivision	string	Pojmenovaná oblast
crossStreet	string	Název ulice, která se překříží.
extendedPostalCode	string	Rozšířená PSČ (dostupnost závisí na oblasti).
freeformAddress	string	Řádek adresy naformátovaný podle pravidel formátování země nebo oblasti původu výsledku nebo v případě země/oblasti má úplný název země/oblasti.
localName	string	Součást 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 slouží k sestavení vlastnosti `freeformAddress`. `localName` představuje poštovní obec. V závislosti na umístění `localName` je běžně známý název města nebo města. Pro běžně známý název města nebo města použijte místo `municipalitylocalName` .
municipality	string	Město / město Poznámka: `municipality` představuje místní obec. V závislosti na umístění se hodnota `municipality` může lišit od běžně známého názvu města nebo města. U běžně známého názvu města nebo města se navrhuje, aby se místo hodnoty `municipality` použila hodnota `localName`.
municipalitySubdivision	string	Sub / Super City
neighbourhood	string	Čtvrť 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Č / PSČ
routeNumbers	string[]	Kódy používané k jednoznačné identifikaci ulice
street	string	Název ulice. ZASTARALÉ, použijte místo toho název ulice.
streetName	string	Název ulice.
streetNameAndNumber	string	Název a číslo ulice.
streetNumber	string	Číslo budovy na ulici.

BoundingBoxCompassNotation

Objekt

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

Name	Typ	Description
entity	Entity	Zdroj typu entity ohraničujícího rámečku. V případě zpětného geokódování se toto umístění vždy rovná pozici.
northEast	string	Severní východ zeměpisné šířky, souřadnice zeměpisné délky ohraničujícího rámečku jako čárkami oddělené plováky
southWest	string	Zeměpisná šířka – západ, souřadnice zeměpisné délky ohraničujícího rámečku jako čárkami oddělené plováky

Entity

Výčet

Zdroj typu entity ohraničujícího rámečku. V případě zpětného geokódování se toto umístění vždy rovná pozici.

Hodnota	Description
position	Entita Pozice

ErrorAdditionalInfo

Objekt

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

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

ErrorDetail

Objekt

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

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

LatLongPairAbbreviated

Objekt

Umístění reprezentované jako zeměpisná šířka a délka s krátkými názvy "lat" & "lon".

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

LocalizedMapView

Výčet

Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopolitické sporné oblasti. Různé země/oblasti mají různá zobrazení těchto oblastí a parametr View umožňuje vaší aplikaci dodržovat zobrazení vyžadované zemí nebo oblastí, kterou bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na Sjednocený, i když jste ho v požadavku nedefinovali. Je vaší zodpovědností určit umístění uživatelů a pak nastavit parametr View správně pro dané umístění. Alternativně máte možnost nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení ve službě Azure Maps se musí používat v souladu s příslušný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 přes Azure Maps, je zpřístupněn. Příklad: view=IN.

Podrobnosti a dostupné zobrazení najdete v podporovaných zobrazeních.

Hodnota	Description
AE	Spojené arabské emiráty (zobrazení arabštiny)
AR	Argentina (argentinský pohled)
Auto	Vrátí data mapy na základě IP adresy požadavku.
BH	Arabština (zobrazení arabštiny)
IN	Indie (indické zobrazení)
IQ	Irák (arabské zobrazení)
JO	Jordánsko (arabské zobrazení)
KW	Kuvajt (arabské zobrazení)
LB	Libanon (zobrazení arabštiny)
MA	Maroko (marocký pohled)
OM	Omán (zobrazení arabštiny)
PK	Pákistán (pákistánské zobrazení)
PS	Palestinská autorita (arabské zobrazení)
QA	Katar (zobrazení arabštiny)
SA	Saúdská Arábie (zobrazení arabštiny)
SY	Sýrie (zobrazení arabštiny)
Unified	Jednotné zobrazení (ostatní)
YE	Jemen (arabské zobrazení)

QueryType

Výčet

Typ vráceného dotazu: NEDALE nebo NON_NEAR.

Hodnota	Description
NEARBY	Hledání bylo provedeno kolem určité zeměpisné šířky a délky s definovaným poloměrem.
NON_NEAR	Vyhledávání bylo provedeno globálně, bez předsudků na určitou zeměpisnou šířku a délku a bez definovaného poloměru.

ResponseFormat

Výčet

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

Hodnota	Description
json	formát výměny dat javascriptového objektu
xml	rozšiřitelného jazyka značek

ReverseSearchCrossStreetAddressResult

Objekt

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

Name	Typ	Description
addresses	ReverseSearchCrossStreetAddressResultItem[]	Pole Adres
summary	SearchSummary	Souhrnný objekt pro odpověď Zpětné adresy vyhledávání na křížové ulici

ReverseSearchCrossStreetAddressResultItem

Objekt

Výsledek objektu odpovědi Search Address Reverse Cross Street

Name	Typ	Description
address	Address	Adresa výsledku
position	string	Vlastnost Position ve tvaru {latitude},{zeměpisná délka}

SearchSummary

Objekt

Souhrnný objekt odpovědi rozhraní API služby Search

Name	Typ	Description
fuzzyLevel	integer	Maximální úroveň přibližné hodnoty potřebná k zadání výsledků.
geoBias	LatLongPairAbbreviated	Označení, kdy interní vyhledávací modul 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, pokud jsou k dispozici. V jiných případech je to čistě interní.
limit	integer	Maximální počet vrácených odpovědí
numResults	integer	Počet výsledků v odpovědi
offset	integer	Počáteční posun vrácených výsledků v celé sadě výsledků.
query	string	Parametr dotazu, který se použil k vytvoření těchto výsledků hledání.
queryTime	integer	Čas strávený překladem dotazu v milisekundách
queryType	QueryType	Typ vráceného dotazu: NEDALE nebo NON_NEAR.
totalResults	integer	Celkový počet nalezených výsledků

Sdílet prostřednictvím

Search - Get Search Address Reverse Cross Street

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

AADToken

Rozsahy

subscription-key

SAS Token

Příklady

Search address of the nearest intersection/crossroad

Ukázkový požadavek

Ukázková odpověď

Definice

Address

BoundingBoxCompassNotation

Entity

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LatLongPairAbbreviated

LocalizedMapView

QueryType

ResponseFormat

ReverseSearchCrossStreetAddressResult

ReverseSearchCrossStreetAddressResultItem

SearchSummary

Další materiály