Search - Get Search Fuzzy
Použijte, když potřebujete vyhledávací požadavek, který dokáže zpracovat kombinace adres a tokenů POI.
Rozhraní Get Search Fuzzy
API (Free Form Search) – požadavek HTTPGET
, který bezproblémově zpracovává kombinaci hledání poi a geokódování. Jedná se o rozhraní API Search volného formuláře, které zpracovává přibližné množství vstupů obsahujících libovolnou kombinaci tokenů adresy nebo poi jako kanonické "jednořádkové vyhledávání". Může být také vážena kontextovou polohou (dvojice lat/lon) nebo plně omezena souřadnicí a poloměrem, nebo může být provedena obecněji bez jakéhokoli geografického ukotvení bodu.
Důrazně doporučujeme, abyste pomocí parametru countrySet určili jenom země nebo oblasti, pro které vaše aplikace potřebuje pokrytí, protože výchozí chování bude hledat po celém světě, což může vrátit zbytečné výsledky.
Např.: countrySet
=US,FR
Úplný seznam všech podporovaných zemí a oblastí najdete v Search Pokrytí.
Většina Search dotazů má výchozí hodnotu maxFuzzyLevel
=2, aby se získal výkon a snížily se neobvyklé výsledky. Toto nové výchozí nastavení je možné podle potřeby přepsat na požadavek předáním maxFuzzyLevel
parametru dotazu =3 nebo 4.
GET https://atlas.microsoft.com/search/fuzzy/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/fuzzy/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&minFuzzyLevel={minFuzzyLevel}&maxFuzzyLevel={maxFuzzyLevel}&idxSet={idxSet}&brandSet={brandSet}&connectorSet={connectorSet}&entityType={entityType}&view={view}&openingHours=nextSevenDays
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
format
|
path | True |
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 |
string |
Příslušný řetězec dotazu (např. "seattle", "pizza"). Lze také zadat jako řetězec oddělený čárkami složený podle zeměpisné šířky a délky (např. "47,641268, -122,125679"). Musí být správně zakódovaná adresa URL. |
brand
|
query |
string[] |
Seznam názvů značek oddělených čárkami, který lze použít k omezení výsledku na konkrétní značky. Na pořadí položek nezáleží. Pokud je k dispozici více značek, vrátí se pouze výsledky, které patří do (alespoň) jedné ze zadaných značek. Značky, které v názvu obsahují ",", by měly být vloženy do uvozovek. Příklady použití: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Čárka",Pruh |
|
btm
|
query |
string |
Pozice v pravém dolním rohu ohraničujícího rámečku. Např. 37,553,-122,453 |
|
category
|
query |
integer[] |
Seznam ID sad kategorií oddělených čárkami, který lze použít k omezení výsledku na konkrétní kategorie bodů zájmu. Na pořadí ID nezáleží. Maximální počet podporovaných
|
|
connector
|
query |
Seznam typů konektorů oddělených čárkami, které lze použít k omezení výsledku na stanici elektrických vozidel podporujících konkrétní typy konektorů. Na pořadí položek nezáleží. Pokud je k dispozici více typů konektorů, vrátí se pouze výsledky, které patří (alespoň) do jednoho ze zadaného seznamu. Dostupné typy konektorů:
Příklady použití: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
||
country
|
query |
string[] |
Čárkami oddělený řetězec kódů země/oblasti, např. FR, ES. Tím se hledání omezí na zadané země nebo oblasti. |
|
entity
|
query |
Určuje úroveň filtrování prováděného v geografických oblastech. Zužuje hledání pro zadané typy entit geografie, například vrátí pouze obce. Výsledná odpověď bude obsahovat ID zeměpisné oblasti a odpovídající typ entity. Pokud jako seznam oddělený čárkami zadáte více než jednu entitu, koncový bod vrátí nejmenší dostupnou entitu. Vrácené ID geometrie lze použít k získání geometrie dané geografické oblasti prostřednictvím rozhraní Get Search Polygon API. Při nastavení entityType se ignorují následující parametry:
|
||
extended
|
query |
Indexy, jejichž rozšířená PSČ by měla být zahrnuta do výsledků. Dostupné indexy jsou: Addr = Rozsahy adres Geo = Geografická oblast PAD = adresy bodů POI = body zájmu Str = Ulice XStr = Křížové ulice (průsečíky) Hodnota by měla být čárkami oddělený seznam typů indexů (v libovolném pořadí) nebo Žádný pro žádné indexy. Ve výchozím nastavení jsou rozšířená PSČ zahrnuta pro všechny indexy s výjimkou geografické oblasti. Rozšířené seznamy PSČ pro geografické oblasti můžou být poměrně dlouhé, takže je nutné je v případě potřeby explicitně vyžádat. Příklady použití: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Rozšířené PSČ se vrátí jako vlastnost extendedPostalCode adresy. Dostupnost závisí na oblasti. |
||
idx
|
query |
Seznam indexů oddělených čárkami, který by měl být použit pro vyhledávání. Na pořadí položek nezáleží. Dostupné indexy jsou: Addr = Address range interpolation, Geo = Zeměpisné oblasti, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (křižovatky) |
||
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 . |
|
lat
|
query |
number double |
Zeměpisná šířka, kde by výsledky měly být zkreslené. Např. 37,337 |
|
limit
|
query |
integer |
Maximální počet odpovědí, které budou vráceny. Výchozí hodnota: 10, minimum: 1 a maximum: 100 |
|
lon
|
query |
number double |
Zeměpisná délka, kde by výsledky měly být zkreslené. Například -121,89 |
|
max
|
query |
integer |
Maximální úroveň přibližnosti, která se má použít. Výchozí hodnota: 2, minimum: 1 a maximum: 4
Vyhledávací web začne hledat shodu na úrovni definované minFuzzyLevel a zastaví vyhledávání na úrovni určené parametrem maxFuzzyLevel. |
|
min
|
query |
integer |
Minimální úroveň rozostření, která se má použít. Výchozí hodnota: 1, minimum: 1 a maximum: 4
Vyhledávací web začne hledat shodu na úrovni definované minFuzzyLevel a přestane hledat na úrovni určené maxFuzzyLevel. |
|
ofs
|
query |
integer |
Počáteční posun vrácených výsledků v rámci celé sady výsledků. Výchozí hodnota: 0 |
|
opening
|
query |
Provozní doba pro bod zájmu (Body zájmu). Dostupnost hodin provozu se bude lišit v závislosti na dostupných datech. Pokud se nepředá, nebudou vráceny žádné informace o otevírací době. Podporovaná hodnota: nextSevenDays |
||
radius
|
query |
integer |
Poloměr v metrech do, aby výsledky byly omezeny na definovanou oblast |
|
top
|
query |
string |
Levá horní pozice ohraničujícího rámečku. Např. 37,553,-122,453 |
|
typeahead
|
query |
boolean |
Boolean. Pokud je nastavený příznak typeahead, dotaz se interpretuje jako částečný vstup a hledání přejde do prediktivního režimu. |
|
view
|
query |
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í. |
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 |
OK |
|
Other Status Codes |
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 City Seattle
Ukázkový požadavek
GET https://atlas.microsoft.com/search/fuzzy/json?api-version=1.0&query=seattle&openingHours=nextSevenDays
Ukázková odpověď
{
"summary": {
"query": "seattle",
"queryType": "NON_NEAR",
"queryTime": 66,
"numResults": 10,
"offset": 0,
"totalResults": 3720,
"fuzzyLevel": 1
},
"results": [
{
"type": "Geography",
"id": "US/GEO/p0/188055",
"score": 2.531,
"entityType": "Municipality",
"address": {
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "Seattle, WA",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.60323,
"lon": -122.33028
},
"viewport": {
"topLeftPoint": {
"lat": 47.7344,
"lon": -122.4594
},
"btmRightPoint": {
"lat": 47.48106,
"lon": -122.22497
}
},
"dataSources": {
"geometry": {
"id": "00005557-4100-3c00-0000-0000596ae8ed"
}
}
},
{
"type": "Geography",
"id": "US/GEO/p0/183911",
"score": 2.382,
"entityType": "Municipality",
"address": {
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countrySubdivisionCode": "WA",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "Seattle, WA",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.55342,
"lon": -122.25007
},
"viewport": {
"topLeftPoint": {
"lat": 47.58995,
"lon": -122.26723
},
"btmRightPoint": {
"lat": 47.5169,
"lon": -122.23291
}
},
"dataSources": {
"geometry": {
"id": "00005557-4100-3c00-0000-00006553f33d"
}
}
},
{
"type": "POI",
"id": "ZA/POI/p0/449288",
"score": 2.226,
"info": "search:ta:710009004165863-ZA",
"poi": {
"name": "Seattle Coffee Co - Groote Kerk Sentrum",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Kloof Street",
"municipalitySubdivision": "Cape Town",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "8001",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Kloof Street, Gardens, City of Cape Town, Western Cape, 8001",
"localName": "Gardens"
},
"position": {
"lat": -33.92917,
"lon": 18.41178
},
"viewport": {
"topLeftPoint": {
"lat": -33.92827,
"lon": 18.4107
},
"btmRightPoint": {
"lat": -33.93007,
"lon": 18.41286
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -33.92907,
"lon": 18.41162
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/449396",
"score": 2.226,
"info": "search:ta:710009004163591-ZA",
"poi": {
"name": "Seattle Coffee Co - Pietermaritzburg",
"phone": "+(27)-(33)-3458486",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "9",
"streetName": "Armitage Road",
"municipalitySubdivision": "Pietermaritzburg City, Pietermaritzburg",
"municipality": "Pietermaritzburg",
"countrySecondarySubdivision": "The Msunduzi",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "3201",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Armitage Road 9, Athlone, The Msunduzi, KwaZulu-Natal, 3201",
"localName": "Athlone"
},
"position": {
"lat": -29.58611,
"lon": 30.37508
},
"viewport": {
"topLeftPoint": {
"lat": -29.58521,
"lon": 30.37405
},
"btmRightPoint": {
"lat": -29.58701,
"lon": 30.37611
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -29.58668,
"lon": 30.37531
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/451868",
"score": 2.226,
"info": "search:ta:710009002195538-ZA",
"poi": {
"name": "Seattle Coffee Co - Bedford Village",
"phone": "+(27)-(84)-5451111",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Van Buuren Road",
"municipalitySubdivision": "Bedfordview",
"municipality": "Germiston",
"countrySecondarySubdivision": "Ekurhuleni",
"countrySubdivisionCode": "Gauteng",
"postalCode": "2007",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Van Buuren Road, Bedfordview, Ekurhuleni, Gauteng, 2007",
"localName": "Bedfordview"
},
"position": {
"lat": -26.18009,
"lon": 28.13544
},
"viewport": {
"topLeftPoint": {
"lat": -26.17919,
"lon": 28.13444
},
"btmRightPoint": {
"lat": -26.18099,
"lon": 28.13644
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -26.18006,
"lon": 28.13636
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/488888",
"score": 2.226,
"info": "search:ta:710009002102639-ZA",
"poi": {
"name": "Seattle Coffee Co - Caltex Starstop Milly's",
"phone": "+(27)-(13)-2560340",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipality": "Wonderfontein",
"countrySecondarySubdivision": "Emakhazeni",
"countrySubdivisionCode": "Mpumalanga",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Wonderfontein, Emakhazeni, Mpumalanga"
},
"position": {
"lat": -25.68842,
"lon": 30.21291
},
"viewport": {
"topLeftPoint": {
"lat": -25.68752,
"lon": 30.21191
},
"btmRightPoint": {
"lat": -25.68932,
"lon": 30.21391
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -25.68913,
"lon": 30.21343
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/489433",
"score": 2.226,
"info": "search:ta:710009002184068-ZA",
"poi": {
"name": "Seattle Coffee Co - Southcoast Mall",
"phone": "+(27)-(39)-3150816",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipalitySubdivision": "Shelly Beach",
"municipality": "Shelly Beach",
"countrySecondarySubdivision": "Hibiscus Coast",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "4265",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265",
"localName": "Shelly Beach"
},
"position": {
"lat": -30.79937,
"lon": 30.40569
},
"viewport": {
"topLeftPoint": {
"lat": -30.79847,
"lon": 30.40464
},
"btmRightPoint": {
"lat": -30.80027,
"lon": 30.40674
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -30.7994,
"lon": 30.40618
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/489976",
"score": 2.226,
"info": "search:ta:710009004261897-ZA",
"poi": {
"name": "Seattle Cofee Co",
"phone": "+(27)-(39)-3150816",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipalitySubdivision": "Shelly Beach",
"municipality": "Shelly Beach",
"countrySecondarySubdivision": "Hibiscus Coast",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "4265",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265",
"localName": "Shelly Beach"
},
"position": {
"lat": -30.79801,
"lon": 30.40557
},
"viewport": {
"topLeftPoint": {
"lat": -30.79711,
"lon": 30.40452
},
"btmRightPoint": {
"lat": -30.79891,
"lon": 30.40662
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -30.79784,
"lon": 30.40523
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/490056",
"score": 2.226,
"info": "search:ta:710009004149612-ZA",
"poi": {
"name": "Seattle Coffee Co - Constantia Village",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Constantia Main Road",
"municipalitySubdivision": "Cape Town",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "7708",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Constantia Main Road, Constantia, City of Cape Town, Western Cape, 7708",
"localName": "Constantia"
},
"position": {
"lat": -34.02087,
"lon": 18.44503
},
"viewport": {
"topLeftPoint": {
"lat": -34.01997,
"lon": 18.44394
},
"btmRightPoint": {
"lat": -34.02177,
"lon": 18.44612
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -34.02017,
"lon": 18.44476
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/494340",
"score": 2.226,
"info": "search:ta:710009004152570-ZA",
"poi": {
"name": "Seattle Coffee Co - Canal Walk Shopping Centre",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Century Boulevard",
"municipalitySubdivision": "Milnerton",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "7441",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Century Boulevard, Century City, City of Cape Town, Western Cape, 7441",
"localName": "Century City"
},
"position": {
"lat": -33.89348,
"lon": 18.5122
},
"viewport": {
"topLeftPoint": {
"lat": -33.89258,
"lon": 18.51112
},
"btmRightPoint": {
"lat": -33.89438,
"lon": 18.51328
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -33.8943,
"lon": 18.51328
}
}
]
}
]
}
Definice
Name | Description |
---|---|
Address |
Adresa výsledku |
Address |
Popisuje rozsah adres na obou stranách ulice pro výsledek hledání. Jsou zahrnuté souřadnice počátečního a koncového umístění rozsahu adres. |
Bounding |
Zobrazení, které pokrývá výsledek představovaný souřadnicemi vlevo nahoře a vpravo dole v oblasti zobrazení. |
Bounding |
Ohraničující rámeček umístění. |
Brand |
Značka přidružená k poi |
Classification |
Klasifikace pro vrácené BŽS |
Classification |
Název klasifikace |
Data |
Volitelný oddíl. Referenční ID pro použití s rozhraním Get Search Polygon API |
Electric |
Seznam typů konektorů oddělených čárkami, které lze použít k omezení výsledku na stanici elektrických vozidel podporujících konkrétní typy konektorů. Na pořadí položek nezáleží. Pokud je k dispozici více typů konektorů, vrátí se pouze výsledky, které patří (alespoň) do jednoho ze zadaného seznamu. Dostupné typy konektorů:
Příklady použití: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
Entity |
Zdroj typu entity ohraničujícího rámečku. Pro reverzní geokódování je to vždy stejné jako pozice. |
Entry |
Vstupní bod pro vrácené BŽ. |
Entry |
Typ vstupního bodu. Hodnota může být hlavní nebo vedlejší. |
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě. |
Error |
Odpověď na chybu |
Geographic |
Typ entity Zeměpis. K dispozici pouze v případech, kdy byl požadován typ entity a je k dispozici. |
Geometry |
Informace o geometrickém tvaru výsledku. Je k dispozici pouze v případě, že zadáte == Zeměpis. |
Lat |
Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon". |
Localized |
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í. |
Match |
Typy shody pro operaci zpětného vyhledávání adres |
Operating |
Otevírací doba pro poi (body zájmu) |
Operating |
Hodiny provozu pro poi (body zájmu) Dostupnost hodin provozu se bude lišit v závislosti na dostupných datech. Pokud se nepředá, nebudou vráceny žádné informace o otevírací době. Podporovaná hodnota: nextSevenDays |
Operating |
Představuje datum a čas. |
Operating |
Otevřený časový rozsah pro den |
Point |
Podrobnosti o vrácených poi, včetně informací, jako je jméno, telefon, adresa URL a klasifikace. |
Point |
Kategorie POI |
Query |
Typ vráceného dotazu: BLÍZKO nebo NON_NEAR. |
Response |
Požadovaný formát odpovědi Hodnota může být json nebo xml. |
Search |
Tento objekt je vrácen z úspěšných volání Search. |
Search |
Objekt výsledku pro odpověď rozhraní API Search. |
Search |
Jedna z těchto možností:
|
Search |
Indexy, jejichž rozšířená POŠTOVNÍ SMĚROVACÍ ČÍSLA by měla být zahrnuta do výsledků. Dostupné indexy jsou: Addr = Rozsahy adres Geografická oblast = zeměpisné oblasti PAD = Point Addresses POI = body zájmu Str = Ulice XStr = křížení ulic (křižovatky) Hodnota by měla být čárkami oddělený seznam typů indexů (v libovolném pořadí) nebo žádný pro žádné indexy. Ve výchozím nastavení jsou rozšířená PSČ zahrnuta pro všechny indexy s výjimkou geografické oblasti. Rozšířené seznamy PSČ pro geografické oblasti můžou být poměrně dlouhé, takže je potřeba je explicitně vyžádat, když je to potřeba. Příklady použití: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Rozšířené PSČ se vrátí jako vlastnost extendedPostalCode adresy. Dostupnost závisí na oblasti. |
Search |
Souhrnný objekt pro odpověď rozhraní API Search |
Address
Adresa výsledku
Name | Typ | Description |
---|---|---|
boundingBox |
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, nikoli název země/oblasti.) |
countryCodeISO3 |
string |
Kód země ISO alfa-3 |
countrySecondarySubdivision |
string |
County |
countrySubdivision |
string |
Země/region nebo kraj |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
Úplný název první úrovně hierarchie správy země/oblasti. Toto pole se zobrazí pouze v případě, že se countrySubdivision 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á je překřížena. |
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 zeměpisné 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í |
municipality |
string |
Město / město |
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. |
AddressRanges
Popisuje rozsah adres na obou stranách ulice pro výsledek hledání. Jsou zahrnuté souřadnice počátečního a koncového umístění rozsahu adres.
Name | Typ | Description |
---|---|---|
from |
Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon". |
|
rangeLeft |
string |
Rozsah adres na levé straně ulice. |
rangeRight |
string |
Rozsah adres na pravé straně ulice. |
to |
Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon". |
BoundingBox
Zobrazení, které pokrývá výsledek představovaný souřadnicemi vlevo nahoře a vpravo dole v oblasti zobrazení.
Name | Typ | Description |
---|---|---|
btmRightPoint |
Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon". |
|
topLeftPoint |
Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon". |
BoundingBoxCompassNotation
Ohraničující rámeček umístění.
Name | Typ | Description |
---|---|---|
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 |
Brand
Značka přidružená k poi
Name | Typ | Description |
---|---|---|
name |
string |
Název značky |
Classification
Klasifikace pro vrácené BŽS
Name | Typ | Description |
---|---|---|
code |
string |
Vlastnost kódu |
names |
Pole Názvů |
ClassificationName
Název klasifikace
Name | Typ | Description |
---|---|---|
name |
string |
Name – vlastnost |
nameLocale |
string |
Vlastnost Name Locale |
DataSources
Volitelný oddíl. Referenční ID pro použití s rozhraním Get Search Polygon API
Name | Typ | Description |
---|---|---|
geometry |
Informace o geometrickém tvaru výsledku. Je k dispozici pouze v případě, že zadáte == Zeměpis. |
ElectricVehicleConnector
Seznam typů konektorů oddělených čárkami, které lze použít k omezení výsledku na stanici elektrických vozidel podporujících konkrétní typy konektorů. Na pořadí položek nezáleží. Pokud je k dispozici více typů konektorů, vrátí se pouze výsledky, které patří (alespoň) do jednoho ze zadaného seznamu.
Dostupné typy konektorů:
-
StandardHouseholdCountrySpecific
- Jedná se o standardní konektory pro domácnost pro určitou oblast. Všechny jsou střídavý jednofázový a standardní Napěťový a standardní Amperage. Viz také: Typy zásuvek & zásuvky – světové standardy. -
IEC62196Type1
- Konektor typu 1 podle definice ve standardu IEC 62196-2. Také se nazývá Yazaki po původním výrobci nebo SAE J1772 po standardu, který ho poprvé publikoval. Nejčastěji se používá v kombinaci s 120V jednofázovou nebo až 240V jednofázovou infrastrukturou. -
IEC62196Type1CCS
- Kombinovaný konektor typu 1 podle definice v normě IEC 62196-3. Konektor je založen na konektoru typu 1 – jak je definováno ve standardu IEC 62196-2 – se dvěma dalšími kontakty stejnosměrným proudem (DC), které umožňují rychlé nabíjení stejnosměrným proudem. -
IEC62196Type2CableAttached
- Konektor typu 2 podle definice v normě IEC 62196-2. K dispozici jako kabel a zástrčka připojená k nabíjecímu bodu. -
IEC62196Type2Outlet
- Konektor typu 2 podle definice v normě IEC 62196-2. K dispozici jako zásuvka nastavená do nabíjecího bodu. -
IEC62196Type2CCS
- Kombinovaný konektor typu 2 podle definice ve standardu IEC 62196-3. Konektor je založen na konektoru typu 2 – jak je definováno ve standardu IEC 62196-2 – se dvěma dodatečnými kontakty stejnosměrný proud (DC), které umožňují rychlé nabíjení stejnosměrným proudem. -
IEC62196Type3
- Konektor typu 3 podle definice v normě IEC 62196-2. Také se nazývá Scame podle původního výrobce. Nejčastěji se používá v kombinaci s až 240V jednofázovou nebo až 420V třífázovou infrastrukturou. -
Chademo
- Konektor CHAdeMO pojmenovaný podle asociace, kterou vytvořila Tokyo Electric Power Company a průmysloví partneři. Z tohoto důvodu se také označuje jako konektor TEPCO. Podporuje rychlé dc nabíjení. -
IEC60309AC1PhaseBlue
- Konektor Industrial Blue je konektor definovaný ve standardu IEC 60309. Někdy se označuje jako nějaká kombinace standardu, barvy a skutečnosti, že je jednofázová spojnice. Konektor má obvykle konfiguraci P+N+E, 6h. -
IEC60309DCWhite
- Konektor Industrial White je stejnosměrný konektor definovaný ve standardu IEC 60309. -
Tesla
- Konektor Tesla je regionálně specifický konektor Tesla Supercharger. To znamená, že se odkazuje buď na proprietární konektor Tesly, někdy označovaný jako Tesla Port, většinou omezený na Severní Amerika, nebo upravený typ 2 (DC nad typem 2) v Evropě.
Příklady použití:
connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Name | Typ | Description |
---|---|---|
Chademo |
string |
Konektor CHAdeMO pojmenovaný podle asociace, kterou vytvořila společnost Tokyo Electric Power Company a průmysloví partneři. Z tohoto důvodu se také označuje jako konektor TEPCO. Podporuje rychlé dc nabíjení. |
IEC60309AC1PhaseBlue |
string |
Konektor Industrial Blue je konektor definovaný ve standardu IEC 60309. Někdy se označuje jako nějaká kombinace standardu, barvy a skutečnosti, že je jednofázová spojnice. Konektor má obvykle konfiguraci P+N+E, 6h. |
IEC60309DCWhite |
string |
Konektor Industrial White je stejnosměrný konektor definovaný ve standardu IEC 60309. |
IEC62196Type1 |
string |
Konektor typu 1 podle definice v normě IEC 62196-2. Také se nazývá Yazaki po původním výrobci nebo SAE J1772 po standardu, který ho poprvé publikoval. Nejčastěji se používá v kombinaci s 120V jednofázovou nebo až 240V jednofázovou infrastrukturou. |
IEC62196Type1CCS |
string |
Kombinovaný konektor založený na typu 1 podle definice v normě IEC 62196-3. Konektor je založen na konektoru typu 1 – jak je definováno ve standardu IEC 62196-2 – se dvěma dalšími kontakty stejnosměrným proudem (DC), které umožňují rychlé nabíjení stejnosměrným proudem. |
IEC62196Type2CCS |
string |
Kombinovaný konektor založený na typu 2 podle definice v normě IEC 62196-3. Konektor je založen na konektoru typu 2 – jak je definováno ve standardu IEC 62196-2 – se dvěma dodatečnými kontakty stejnosměrný proud (DC), které umožňují rychlé nabíjení stejnosměrným proudem. |
IEC62196Type2CableAttached |
string |
Konektor typu 2 podle definice v normě IEC 62196-2. K dispozici jako kabel a zástrčka připojená k nabíjecímu bodu |
IEC62196Type2Outlet |
string |
Konektor typu 2 podle definice v normě IEC 62196-2. K dispozici jako zásuvka nastavená do nabíjecího bodu. |
IEC62196Type3 |
string |
Konektor typu 3 podle definice v normě IEC 62196-2. Také se nazývá Scame podle původního výrobce. Nejčastěji se používá v kombinaci s až 240V jednofázovou nebo až 420V třífázovou infrastrukturou. |
StandardHouseholdCountrySpecific |
string |
Jedná se o standardní konektory domácnosti pro určitou oblast. Všechny jsou střídavý jednofázový a standardní Napěťový a standardní Amperage. |
Tesla |
string |
Konektor Tesla je regionálně specifický konektor Tesla Supercharger. To znamená, že se odkazuje buď na proprietární konektor Tesly, někdy označovaný jako Tesla Port, většinou omezený na Severní Amerika, nebo upravený typ 2 (DC nad typem 2) v Evropě. |
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 |
EntryPoint
Vstupní bod pro vrácené BŽ.
Name | Typ | Description |
---|---|---|
position |
Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon". |
|
type |
Typ vstupního bodu. Hodnota může být hlavní nebo vedlejší. |
EntryPointType
Typ vstupního bodu. Hodnota může být hlavní nebo vedlejší.
Name | Typ | Description |
---|---|---|
main |
string |
|
minor |
string |
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 |
Další informace o chybě |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Odpověď na chybu
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
GeographicEntityType
Typ entity Zeměpis. K dispozici pouze v případech, kdy byl požadován typ entity a je k dispozici.
Name | Typ | Description |
---|---|---|
Country |
string |
název země/oblasti |
CountrySecondarySubdivision |
string |
County |
CountrySubdivision |
string |
Země/region nebo kraj |
CountryTertiarySubdivision |
string |
Pojmenovaná oblast |
Municipality |
string |
Město / město |
MunicipalitySubdivision |
string |
Sub / Super City |
Neighbourhood |
string |
Sousedství |
PostalCodeArea |
string |
PSČ |
Geometry
Informace o geometrickém tvaru výsledku. Je k dispozici pouze v případě, že zadáte == Zeměpis.
Name | Typ | Description |
---|---|---|
id |
string |
Předejte ho jako geometryId rozhraní Get Search Polygon API, abyste získali informace o geometrii pro tento výsledek. |
LatLongPairAbbreviated
Umístění reprezentované 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é zobrazení) |
Auto |
string |
Vrátí mapová data na základě IP adresy požadavku. |
BH |
string |
Bahrajn (zobrazení v arabštině) |
IN |
string |
Indie (indické zobrazení) |
IQ |
string |
Irák (zobrazení v arabštině) |
JO |
string |
Jordánsko (arabské zobrazení) |
KW |
string |
Kuvajt (zobrazení v arabštině) |
LB |
string |
Libanon (zobrazení arabštiny) |
MA |
string |
Maroko (marocké zobrazení) |
OM |
string |
Omán (zobrazení arabštiny) |
PK |
string |
Pákistán (pákistánské zobrazení) |
PS |
string |
Palestinská samospráva (zobrazení v arabštině) |
QA |
string |
Katar (zobrazení v arabštině) |
SA |
string |
Saúdská Arábie (arabské zobrazení) |
SY |
string |
Sýrie (zobrazení arabštiny) |
Unified |
string |
Sjednocené zobrazení (ostatní) |
YE |
string |
Jemen (arabské zobrazení) |
MatchType
Typy shody pro operaci zpětného vyhledávání adres
Name | Typ | Description |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
OperatingHours
Otevírací doba pro poi (body zájmu)
Name | Typ | Description |
---|---|---|
mode |
string |
Hodnota použitá v požadavku: none nebo "nextSevenDays" |
timeRanges |
Seznam časových rozsahů pro příštích 7 dnů |
OperatingHoursRange
Hodiny provozu pro poi (body zájmu) Dostupnost hodin provozu se bude lišit v závislosti na dostupných datech. Pokud se nepředá, nebudou vráceny žádné informace o otevírací době. Podporovaná hodnota: nextSevenDays
Name | Typ | Description |
---|---|---|
nextSevenDays |
string |
Zobrazuje provozní hodiny pro příští týden, počínaje aktuálním dnem v místním čase poi. |
OperatingHoursTime
Představuje datum a čas.
Name | Typ | Description |
---|---|---|
date |
string |
Představuje aktuální kalendářní datum v časovém pásmu BZ, například "2019-02-07". |
hour |
integer |
Hodiny jsou v místním čase poi ve formátu 24 hodin; možné hodnoty jsou 0 až 23. |
minute |
integer |
Minuty jsou v místním čase poi; možné hodnoty jsou 0 až 59. |
OperatingHoursTimeRange
Otevřený časový rozsah pro den
Name | Typ | Description |
---|---|---|
endTime |
Bod v rozsahu příštích 7 dnů, kdy je dané poi uzavřeno, nebo začátek rozsahu, pokud byl uzavřen před rozsahem. |
|
startTime |
Bod v rozsahu příštích 7 dnů, kdy se dané poi otevírá, nebo začátek rozsahu, pokud byl otevřen před rozsahem. |
PointOfInterest
Podrobnosti o vrácených poi, včetně informací, jako je jméno, telefon, adresa URL a klasifikace.
Name | Typ | Description |
---|---|---|
brands |
Brand[] |
Pole značek. Název značky pro vrácené poi. |
categories |
string[] |
Matice kategorií |
categorySet |
Seznam nejkonfiektnějších kategorií poi |
|
classifications |
Pole klasifikace |
|
name |
string |
Název vlastnosti POI |
openingHours |
Otevírací doba pro poi (body zájmu) |
|
phone |
string |
Vlastnost Telefonní číslo |
url |
string |
Vlastnost Adresa URL webu |
PointOfInterestCategorySet
Kategorie POI
Name | Typ | Description |
---|---|---|
id |
integer |
ID kategorie |
QueryType
Typ vráceného dotazu: BLÍZKO nebo NON_NEAR.
Name | Typ | Description |
---|---|---|
NEARBY |
string |
Search byly provedeny kolem určité zeměpisné šířky a délky s definovaným poloměrem. |
NON_NEAR |
string |
Search byly provedeny 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 |
|
xml |
string |
SearchAddressResult
Tento objekt je vrácen z úspěšných volání Search.
Name | Typ | Description |
---|---|---|
results |
Seznam výsledků rozhraní API Search. |
|
summary |
Souhrnný objekt pro odpověď rozhraní API Search |
SearchAddressResultItem
Objekt výsledku pro odpověď rozhraní API Search.
Name | Typ | Description |
---|---|---|
address |
Adresa výsledku |
|
addressRanges |
Popisuje rozsah adres na obou stranách ulice pro výsledek hledání. Jsou zahrnuté souřadnice počátečního a koncového umístění rozsahu adres. |
|
dataSources |
Volitelný oddíl. ID referenční geometrie pro použití s rozhraním Get Search Polygon API |
|
detourTime |
integer |
Čas objížďky v sekundách. Vráceno pouze pro volání rozhraní API Search Along Route. |
dist |
number |
Přímá vzdálenost mezi výsledkem a umístěním geobias v metrech. |
entityType |
Typ entity Zeměpis. Je k dispozici pouze v případech, kdy byl požadován typ entity a je k dispozici. |
|
entryPoints |
Pole vstupních bodů. Ty popisují typy vchodů, které jsou k dispozici na místě. Typ může být "main" pro hlavní vchody, jako jsou přední dveře, nebo předsálí, a "minor" pro boční a zadní dveře. |
|
id |
string |
Vlastnost ID |
info |
string |
Informace o původním zdroji dat výsledku. Používá se pro žádosti o podporu. |
matchType |
Informace o typu shody. Jedna z těchto možností:
|
|
poi |
Podrobnosti o vrácených poi, včetně informací, jako je jméno, telefon, adresa URL a klasifikace. |
|
position |
Umístění reprezentované jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon". |
|
score |
number |
Hodnota v sadě výsledků označující relativní skóre shody mezi výsledky. Můžete ho použít k určení, že výsledek x je dvakrát tak pravděpodobný jako výsledek y, pokud je hodnota x 2x hodnota y. Hodnoty se v jednotlivých dotazech liší a jsou určeny pouze jako relativní hodnota pro jednu sadu výsledků. |
type |
Jedna z těchto možností:
|
|
viewport |
Zobrazení, které pokrývá výsledek představovaný souřadnicemi vlevo nahoře a vpravo dole v oblasti zobrazení. |
SearchAddressResultType
Jedna z těchto možností:
- POI
- Ulice
- Geografie
- Adresa bodu
- Rozsah adres
- Křížová ulice
Name | Typ | Description |
---|---|---|
Address Range |
string |
|
Cross Street |
string |
|
Geography |
string |
|
POI |
string |
|
Point Address |
string |
|
Street |
string |
SearchIndexes
Indexy, jejichž rozšířená POŠTOVNÍ SMĚROVACÍ ČÍSLA by měla být zahrnuta do výsledků.
Dostupné indexy jsou:
Addr = Rozsahy adres
Geografická oblast = zeměpisné oblasti
PAD = Point Addresses
POI = body zájmu
Str = Ulice
XStr = křížení ulic (křižovatky)
Hodnota by měla být čárkami oddělený seznam typů indexů (v libovolném pořadí) nebo žádný pro žádné indexy.
Ve výchozím nastavení jsou rozšířená PSČ zahrnuta pro všechny indexy s výjimkou geografické oblasti. Rozšířené seznamy PSČ pro geografické oblasti můžou být poměrně dlouhé, takže je potřeba je explicitně vyžádat, když je to potřeba.
Příklady použití:
extendedPostalCodesFor=POI
extendedPostalCodesFor=PAD,Addr,POI
extendedPostalCodesFor=None
Rozšířené PSČ se vrátí jako vlastnost extendedPostalCode adresy. Dostupnost závisí na oblasti.
Name | Typ | Description |
---|---|---|
Addr |
string |
|
Geo |
string |
|
PAD |
string |
|
POI |
string |
|
Str |
string |
|
Xstr |
string |
SearchSummary
Souhrnný objekt pro odpověď rozhraní API Search
Name | Typ | Description |
---|---|---|
fuzzyLevel |
integer |
Maximální úroveň přibližnosti vyžadovaná k poskytnutí výsledků |
geoBias |
Označení, kdy interní vyhledávací web použil geoprostorové předsudky ke zlepšení pořadí 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 ostatních případech je čistě interní. |
|
limit |
integer |
Maximální počet odpovědí, které se vrátí |
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 |
Typ vráceného dotazu: BLÍZKO nebo NON_NEAR. |
|
totalResults |
integer |
Celkový počet nalezených výsledků |