Search - Post Search Fuzzy Batch Sync
Slouží k odeslání dávky dotazů do rozhraní Search Fuzzy API v jednom synchronním požadavku.
Rozhraní Post Search Fuzzy Batch API je požadavek HTTPPOST, který odesílá dávky dotazů do Search Rozhraní Fuzzy API v jednom synchronním volání. Můžete volat Post Search Fuzzy Batch rozhraní API pro asynchronní spuštění (asynchronní) nebo synchronně (synchronizace). Asynchronní rozhraní API umožňuje volajícímu dávkovat až 10 000 dotazů a synchronizovat rozhraní API až 100 dotazů.
Odeslání synchronní dávkové žádosti
Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, zareaguje hned po výpočtu dávkových položek a nebude možné později načíst výsledky. Synchronní rozhraní API vrátí chybu časového limitu (odpověď 408), pokud požadavek trvá déle než 60 sekund. Počet dávkových položek je pro toto rozhraní API omezený na 100 .
POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
Odeslání asynchronního dávkového požadavku
Asynchronní rozhraní API je vhodné pro zpracování velkých objemů relativně složitých požadavků na vyhledávání.
- Umožňuje načtení výsledků v samostatném volání (je možné stáhnout více položek).
- Asynchronní rozhraní API je optimalizované pro spolehlivost a neočekává se, že dojde k vypršení časového limitu.
- Počet dávkových položek je pro toto rozhraní API omezený na 10 000 .
Když vytvoříte požadavek pomocí asynchronního požadavku, služba ve výchozím nastavení vrátí kód odpovědi 202 spolu s adresou URL pro přesměrování v poli Umístění hlavičky odpovědi. Tato adresa URL by měla být pravidelně kontrolována, dokud nebudou k dispozici data odpovědi nebo informace o chybě. Asynchronní odpovědi se ukládají po dobu 14 dnů. Adresa URL přesměrování vrátí odpověď 404, pokud se použije po uplynutí období vypršení platnosti.
Upozorňujeme, že asynchronní dávkové požadavky jsou dlouhotrvající operace. Tady je typická posloupnost operací:
- Klient odešle Search Fuzzy Batch
POSTpožadavek na Azure Maps.
POST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0&subscription-key={subscription-key}
Server odpoví jedním z následujících způsobů:
HTTP
202 Accepted– Dávkový požadavek byl přijat.HTTP
Error– Při zpracování požadavku Batch došlo k chybě. Může se jednat o stavový400 Bad Requestkód nebo jakýkoli jinýError.Pokud byl dávkový požadavek úspěšně přijat,
Locationhlavička v odpovědi obsahuje adresu URL pro stažení výsledků dávkového požadavku. Tento identifikátor URI stavu vypadá takto:
GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
- Klient vydá na adresu URL pro stažení získanou
GETv kroku 3 žádost o stažení výsledků dávky.
Text POST pro dávkový požadavek
K odeslání vyhledávacích dotazů použijete POST požadavek, kde text požadavku bude obsahovat batchItems pole ve json formátu a hlavička Content-Type bude nastavená na application/json. Tady je ukázkový text požadavku obsahující 5 přibližných vyhledávacích dotazů:
{
"batchItems": [
{"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"},
{"query": "?query=Statue Of Liberty&limit=2"},
{"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"},
{"query": "?query=Space Needle"},
{"query": "?query=pizza&limit=10"}
]
}
Přibližný vyhledávací dotaz v dávce je pouze částečná adresa URL bez protokolu, základní adresy URL, cesty, verze rozhraní API a klíče předplatného. Může přijmout kterýkoli z podporovaných parametrůidentifikátoru URI přibližného vyhledávání. Řetězcové hodnoty v vyhledávacím dotazu musí být správně uvozené (např. znak " by měl být uvozován znakem \ ) a měl by být také správně zakódován pomocí adresy URL.
Asynchronní rozhraní API umožňuje volajícímu dávkovat až 10 000 dotazů a synchronizovat rozhraní API až 100 dotazů a dávka by měla obsahovat alespoň 1 dotaz.
Stáhnout výsledky asynchronní dávky
Pokud chcete stáhnout výsledky asynchronní dávky, odešlete GET požadavek na koncový bod dávkového stahování. Tuto adresu URL pro stažení můžete získat z Location hlavičky úspěšného POST dávkového požadavku a vypadá takto:
https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
Tady je typická posloupnost operací pro stažení výsledků dávky:
Klient odešle
GETpožadavek pomocí adresy URL pro stažení.Server odpoví jedním z následujících způsobů:
HTTP
202 Accepted– Dávkový požadavek byl přijat, ale stále se zpracovává. Zkuste to prosím znovu za nějakou dobu.HTTP
200 OK– Dávkový požadavek se úspěšně zpracoval. Text odpovědi obsahuje všechny dávkové výsledky.
Model dávkové odpovědi
Vrácený datový obsah se podobá asynchronním a synchronizačním požadavkům. Pokud se při stahování výsledků asynchronní dávkové žádosti dokončilo zpracování dávky, tělo odpovědi obsahuje dávkovou odpověď. Tato dávková odpověď obsahuje komponentu summarytotalRequests , která označuje, které byly součástí původního dávkového požadavku, a successfulRequeststj. dotazy, které byly úspěšně provedeny. Dávková odpověď obsahuje batchItems také pole, které obsahuje odpověď pro každý dotaz v dávkovém požadavku. Bude batchItems obsahovat výsledky v přesně stejném pořadí, v jakém byly původní dotazy odeslány v dávkovém požadavku. Každá položka v batchItems souboru obsahuje statusCode pole a response . Každý response v batchItems systému má jeden z následujících typů:
SearchAddressResult– Pokud se dotaz úspěšně dokončil.Error– Pokud dotaz selhal. Odpověď bude v tomto případě obsahovat acode.message
Tady je ukázka dávkové odpovědi se 2 úspěšnými a 1 neúspěšnými výsledky:
{
"summary": {
"successfulRequests": 2,
"totalRequests": 3
},
"batchItems": [
{
"statusCode": 200,
"response":
{
"summary": {
"query": "atm"
},
"results": [
{
"type": "POI",
"poi": {
"name": "ATM at Wells Fargo"
},
"address": {
"country": "United States Of America",
"freeformAddress": "3240 157th Ave NE, Redmond, WA 98052"
}
}
]
}
},
{
"statusCode": 200,
"response":
{
"summary": {
"query": "statue of liberty"
},
"results": [
{
"type": "POI",
"poi": {
"name": "Statue of Liberty"
},
"address": {
"country": "United States Of America",
"freeformAddress": "New York, NY 10004"
}
}
]
}
},
{
"statusCode": 400,
"response":
{
"error":
{
"code": "400 BadRequest",
"message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
}
}
}
]
}
POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
format
|
path | True |
Požadovaný formát odpovědi. Podporuje se pouze |
|
|
api-version
|
query | True |
string |
Číslo verze rozhraní API Azure Maps. |
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. |
Text požadavku
| Name | Typ | Description |
|---|---|---|
| batchItems |
Seznam dotazů ke zpracování |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Časový limit: Dokončení požadavku trvalo déle, než je maximální doba definovaná v rozhraní API. |
|
| 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-idk 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 URLspecifický 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
A Sync Search Fuzzy Batch API call containing 5 Search Fuzzy API queries
Ukázkový požadavek
POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0
{
"batchItems": [
{
"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"
},
{
"query": "?query=Statue Of Liberty&limit=2"
},
{
"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"
}
]
}
Ukázková odpověď
{
"batchItems": [
{
"statusCode": 200,
"response": {
"summary": {
"query": "atm",
"queryType": "NON_NEAR",
"queryTime": 5,
"numResults": 5,
"offset": 0,
"totalResults": 262,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.639769,
"lon": -122.128362
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/3656546",
"score": 2.671,
"dist": 1336.1815386162032,
"info": "search:ta:840539002005905-US",
"poi": {
"name": "US Bank ATM-MONEYPASS",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "14808",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "14808 NE 24th St, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63229,
"lon": -122.14232
},
"viewport": {
"topLeftPoint": {
"lat": 47.63319,
"lon": -122.14365
},
"btmRightPoint": {
"lat": 47.63139,
"lon": -122.14099
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.63154,
"lon": -122.1423
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/8673325",
"score": 2.671,
"dist": 1206.8488178244172,
"info": "search:ta:840539002022072-US",
"poi": {
"name": "US Bank ATM NATIONAL ASSOCIATION",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "15000",
"streetName": "Northeast 24Th Street",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525522",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15000 Northeast 24Th Street, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63265,
"lon": -122.14052
},
"viewport": {
"topLeftPoint": {
"lat": 47.63355,
"lon": -122.14185
},
"btmRightPoint": {
"lat": 47.63175,
"lon": -122.13919
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14056
}
},
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14058
}
},
{
"type": "main",
"position": {
"lat": 47.63156,
"lon": -122.14048
}
},
{
"type": "main",
"position": {
"lat": 47.6324,
"lon": -122.13938
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/2736315",
"score": 2.671,
"dist": 864.7591776519859,
"info": "search:ta:840539002187855-US",
"poi": {
"name": "US Bank ATM-MONEYPASS",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "15521",
"streetName": "Bel Red Rd",
"municipalitySubdivision": "Redmond, Northeast Bellevue, Bellevue",
"municipality": "Redmond, Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525501",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15521 Bel Red Rd, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63259,
"lon": -122.1328
},
"viewport": {
"topLeftPoint": {
"lat": 47.63349,
"lon": -122.13413
},
"btmRightPoint": {
"lat": 47.63169,
"lon": -122.13147
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.63255,
"lon": -122.13275
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/3656412",
"score": 2.67,
"dist": 2140.198538580941,
"info": "search:ta:840539001998867-US",
"poi": {
"name": "US Bank ATM NATIONAL ASSOCIATION",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1128",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62069,
"lon": -122.13213
},
"viewport": {
"topLeftPoint": {
"lat": 47.62159,
"lon": -122.13346
},
"btmRightPoint": {
"lat": 47.61979,
"lon": -122.1308
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62069,
"lon": -122.13236
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/2736876",
"score": 2.67,
"dist": 2140.198538580941,
"info": "search:ta:840539001396789-US",
"poi": {
"name": "US Bank ATM",
"phone": "+(1)-(800)-8722657",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"url": "www.usbank.com",
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1128",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62069,
"lon": -122.13213
},
"viewport": {
"topLeftPoint": {
"lat": 47.62159,
"lon": -122.13346
},
"btmRightPoint": {
"lat": 47.61979,
"lon": -122.1308
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62069,
"lon": -122.13236
}
}
]
}
]
}
},
{
"statusCode": 200,
"response": {
"summary": {
"query": "statue of liberty",
"queryType": "NON_NEAR",
"queryTime": 37,
"numResults": 2,
"offset": 0,
"totalResults": 18,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/9189660",
"score": 6.942,
"info": "search:ta:840369001174316-US",
"poi": {
"name": "Statue of Liberty",
"categorySet": [
{
"id": 7376003
}
],
"classifications": [
{
"code": "IMPORTANT_TOURIST_ATTRACTION",
"names": [
{
"nameLocale": "en-US",
"name": "monument"
},
{
"nameLocale": "en-US",
"name": "important tourist attraction"
}
]
}
]
},
"address": {
"municipalitySubdivision": "New York",
"municipality": "New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "New York, NY 10004",
"localName": "New York",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.68955,
"lon": -74.04483
},
"viewport": {
"topLeftPoint": {
"lat": 40.69045,
"lon": -74.04602
},
"btmRightPoint": {
"lat": 40.68865,
"lon": -74.04364
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.69001,
"lon": -74.04683
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/3264566",
"score": 6.942,
"info": "search:ta:840019000670588-US",
"poi": {
"name": "Statue of Liberty",
"phone": "+(1)-(205)-9700251",
"categorySet": [
{
"id": 7376003
}
],
"url": "www.1bsa.org",
"classifications": [
{
"code": "IMPORTANT_TOURIST_ATTRACTION",
"names": [
{
"nameLocale": "en-US",
"name": "important tourist attraction"
}
]
}
]
},
"address": {
"streetNumber": "516",
"streetName": "Liberty Pkwy",
"municipalitySubdivision": "Vestavia Hills",
"municipality": "Vestavia Hills, Birmingham",
"countrySecondarySubdivision": "Jefferson",
"countryTertiarySubdivision": "Leeds",
"countrySubdivisionCode": "AL",
"postalCode": "35242",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "516 Liberty Pkwy, Vestavia Hills, AL 35242",
"localName": "Vestavia Hills",
"countrySubdivisionName": "Alabama"
},
"position": {
"lat": 33.48234,
"lon": -86.70719
},
"viewport": {
"topLeftPoint": {
"lat": 33.48324,
"lon": -86.70827
},
"btmRightPoint": {
"lat": 33.48144,
"lon": -86.70611
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 33.48129,
"lon": -86.7065
}
}
]
}
]
}
},
{
"statusCode": 200,
"response": {
"summary": {
"query": "starbucks",
"queryType": "NON_NEAR",
"queryTime": 35,
"numResults": 10,
"offset": 0,
"totalResults": 17,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.639769,
"lon": -122.128362
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/153678",
"score": 2.671,
"dist": 1206.8488178244172,
"info": "search:ta:840531000006554-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8695816",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15000",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525522",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15000 NE 24th St, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63265,
"lon": -122.14052
},
"viewport": {
"topLeftPoint": {
"lat": 47.63355,
"lon": -122.14185
},
"btmRightPoint": {
"lat": 47.63175,
"lon": -122.13919
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14056
}
},
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14058
}
},
{
"type": "main",
"position": {
"lat": 47.63156,
"lon": -122.14048
}
},
{
"type": "main",
"position": {
"lat": 47.6324,
"lon": -122.13938
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/152316",
"score": 2.67,
"dist": 2315.294397491255,
"info": "search:ta:840539000484552-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-6436471",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/store/15097",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15600",
"streetName": "NE 8th St",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98008",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15600 NE 8th St, Bellevue, WA 98008",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61896,
"lon": -122.12945
},
"viewport": {
"topLeftPoint": {
"lat": 47.61986,
"lon": -122.13078
},
"btmRightPoint": {
"lat": 47.61806,
"lon": -122.12812
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.619,
"lon": -122.12945
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167545",
"score": 2.67,
"dist": 1979.2222952267998,
"info": "search:ta:840539001950429-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-7470690",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "1350",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1350 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62212,
"lon": -122.13179
},
"viewport": {
"topLeftPoint": {
"lat": 47.62302,
"lon": -122.13312
},
"btmRightPoint": {
"lat": 47.62122,
"lon": -122.13046
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62213,
"lon": -122.13236
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/168519",
"score": 2.67,
"dist": 2490.3337046455963,
"info": "search:ta:840539001015090-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-4556500",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "https://www.starbucks.com/store-locator/store/15901",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "1645",
"streetName": "140th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98005",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1645 140th Ave NE, Bellevue, WA 98005",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62626,
"lon": -122.15487
},
"viewport": {
"topLeftPoint": {
"lat": 47.62716,
"lon": -122.1562
},
"btmRightPoint": {
"lat": 47.62536,
"lon": -122.15354
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62645,
"lon": -122.15446
}
},
{
"type": "minor",
"position": {
"lat": 47.62579,
"lon": -122.15377
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/152428",
"score": 2.668,
"dist": 3529.7080738812224,
"info": "search:ta:840539001033722-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-3789496",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "180",
"streetName": "148th Ave SE",
"municipalitySubdivision": "West Lake Hills, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "180 148th Ave SE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.60901,
"lon": -122.14
},
"viewport": {
"topLeftPoint": {
"lat": 47.60991,
"lon": -122.14133
},
"btmRightPoint": {
"lat": 47.60811,
"lon": -122.13867
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.60901,
"lon": -122.14008
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167147",
"score": 2.668,
"dist": 3479.393294615887,
"info": "search:ta:840539000326896-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8619198",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "7425",
"streetName": "166th Ave NE",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980526288",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "7425 166th Ave NE, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67055,
"lon": -122.12001
},
"viewport": {
"topLeftPoint": {
"lat": 47.67145,
"lon": -122.12135
},
"btmRightPoint": {
"lat": 47.66965,
"lon": -122.11867
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.67069,
"lon": -122.11889
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/153695",
"score": 2.667,
"dist": 3622.441074618729,
"info": "search:ta:840531000006551-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8822881",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/store/15022",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "7625",
"streetName": "170th Ave NE",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980520910",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "7625 170th Ave NE, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67086,
"lon": -122.11392
},
"viewport": {
"topLeftPoint": {
"lat": 47.67176,
"lon": -122.11526
},
"btmRightPoint": {
"lat": 47.66996,
"lon": -122.11258
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.67073,
"lon": -122.1135
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167420",
"score": 2.667,
"dist": 3818.293513029088,
"info": "search:ta:840539000640782-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8853323",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "17246",
"streetName": "Redmond Way",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980524403",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "17246 Redmond Way, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67174,
"lon": -122.10976
},
"viewport": {
"topLeftPoint": {
"lat": 47.67264,
"lon": -122.1111
},
"btmRightPoint": {
"lat": 47.67084,
"lon": -122.10842
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6706,
"lon": -122.11026
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/153686",
"score": 2.666,
"dist": 4009.922205147074,
"info": "search:ta:840531000006548-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8859590",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15738",
"streetName": "Redmond Way Pad 3 Redmond Center",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980523873",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15738 Redmond Way Pad 3 Redmond Center, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67583,
"lon": -122.12877
},
"viewport": {
"topLeftPoint": {
"lat": 47.67673,
"lon": -122.13011
},
"btmRightPoint": {
"lat": 47.67493,
"lon": -122.12743
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.67456,
"lon": -122.12887
}
},
{
"type": "main",
"position": {
"lat": 47.67668,
"lon": -122.12829
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/168511",
"score": 2.666,
"dist": 3987.80992387863,
"info": "search:ta:840531000006669-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8818265",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "6617",
"streetName": "132Nd Ave Ne Bridle Trails Shopping Center",
"municipalitySubdivision": "Kirkland, Bridle Trails",
"municipality": "Kirkland",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98033",
"extendedPostalCode": "980338234",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "6617 132Nd Ave Ne Bridle Trails Shopping Center, Kirkland, WA 98033",
"localName": "Kirkland",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.66514,
"lon": -122.16599
},
"viewport": {
"topLeftPoint": {
"lat": 47.66604,
"lon": -122.16733
},
"btmRightPoint": {
"lat": 47.66424,
"lon": -122.16465
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.666,
"lon": -122.16669
}
},
{
"type": "minor",
"position": {
"lat": 47.66553,
"lon": -122.16405
}
}
]
}
]
}
}
],
"summary": {
"successfulRequests": 3,
"totalRequests": 3
}
}{
"error": {
"code": "408 Timeout",
"message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
}
}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. |
|
Batch |
Tento typ představuje text požadavku pro službu Batch. |
|
Batch |
Objekt žádosti Batch |
|
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 |
| 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 |
Chybová odpověď |
|
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. |
|
Json |
Požadovaný formát odpovědi Podporuje se pouze |
|
Lat |
Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon". |
|
Match |
Typy shody pro operaci zpětného vyhledávání adres |
|
Operating |
Otevírací doba pro poi (body zájmu) |
|
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ÍZKÉ nebo NON_NEAR. |
| Response |
Výsledek dotazu. SearchAddressResult, pokud se dotaz úspěšně dokončil, v opačném případě ErrorResponse. |
|
Search |
Položka vrácená voláním služby Batch adresy Search. |
|
Search |
Tento objekt se vrátí z úspěšného volání služby Batch adresy Search. |
|
Search |
Objekt Result pro odpověď rozhraní API Search. |
|
Search |
Jedna z těchto možností:
|
|
Search |
Souhrnný objekt pro odpověď rozhraní API Search. |
| Summary |
Souhrn výsledků žádosti o dávku |
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". |
BatchRequest
Tento typ představuje text požadavku pro službu Batch.
| Name | Typ | Description |
|---|---|---|
| batchItems |
Seznam dotazů ke zpracování. |
BatchRequestItem
Objekt žádosti Batch
| Name | Typ | Description |
|---|---|---|
| query |
string |
Tento parametr obsahuje řetězec dotazu, který se používá k provedení nestrukturované operace geografického kódování. Řetězec dotazu se předá doslovně rozhraní API pro vyhledávání ke zpracování. |
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. |
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 |
Typ další informace. |
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
Chybová odpověď
| 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. |
JsonFormat
Požadovaný formát odpovědi Podporuje se pouze json formát.
| Name | Typ | Description |
|---|---|---|
| json |
string |
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 |
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ů |
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Í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. |
Response
Výsledek dotazu. SearchAddressResult, pokud se dotaz úspěšně dokončil, v opačném případě ErrorResponse.
| Name | Typ | Description |
|---|---|---|
| error |
Objekt chyby. |
|
| results |
Seznam výsledků rozhraní API Search. |
|
| summary |
Souhrnný objekt pro odpověď rozhraní API Search |
SearchAddressBatchItem
Položka vrácená voláním služby Batch adresy Search.
| Name | Typ | Description |
|---|---|---|
| response |
Výsledek dotazu. SearchAddressResult, pokud se dotaz úspěšně dokončil, v opačném případě ErrorResponse. |
|
| statusCode |
integer |
Stavový kód požadavku HTTP. |
SearchAddressBatchProcessResult
Tento objekt se vrátí z úspěšného volání služby Batch adresy Search.
| Name | Typ | Description |
|---|---|---|
| batchItems |
Pole obsahující výsledky dávky. |
|
| summary |
Souhrn výsledků žádosti o dávku |
SearchAddressResultItem
Objekt Result 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 zahrnuty souřadnice počátečního a koncového umístění rozsahu adres. |
|
| dataSources |
Volitelný oddíl. REFERENČNÍ ID 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. 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 "hlavní" pro hlavní vchody, jako jsou přední dveře nebo vstupní halu, a "vedlejší" 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í vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon". |
|
| score |
number |
Hodnota v sadě výsledků k označení relativního skóre shody mezi výsledky. Tuto možnost můžete použít k určení, že výsledek x bude dvakrát tak relevantní jako výsledek y, pokud je hodnota x 2x hodnota y. Hodnoty se v jednotlivých dotazech liší a jsou míněné pouze jako relativní hodnota pro jednu sadu výsledků dotazu. |
| type |
Jedna z těchto možností:
|
|
| viewport |
Zobrazení, které pokrývá výsledek představovaný souřadnicemi levého horního a pravého dolního rohu oblasti. |
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 |
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 |
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 |
Typ vráceného dotazu: BLÍZKÉ nebo NON_NEAR. |
|
| totalResults |
integer |
Celkový počet nalezených výsledků |
Summary
Souhrn výsledků žádosti o dávku
| Name | Typ | Description |
|---|---|---|
| successfulRequests |
integer |
Počet úspěšných požadavků v dávce |
| totalRequests |
integer |
Celkový počet požadavků v dávce |