Search - Get Search Address Reverse Batch

Search Address Reverse Batch API

Platí pro: zobrazení cenových úrovní.

Rozhraní API služby Search Address Batch odesílá dávky dotazů do reverzního rozhraní API pro vyhledávání adres pomocí jediného volání rozhraní API. Můžete volat rozhraní API služby Search Address Reverse Batch tak, aby se spustilo asynchronně (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ů.

Odeslat synchronní dávkový požadavek

Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží žádost, odpoví hned po výpočtu dávkových položek a nebude možné výsledky později načíst. 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 omezený na 100 pro toto rozhraní API.

POST https://atlas.microsoft.com/search/address/reverse/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ů vyhledávání.

  • Umožňuje načtení výsledků v samostatném volání (je možné získat více stažení).
  • 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 omezený na 10 000 pro toto rozhraní API.

Když požadavek provedete pomocí asynchronního požadavku, služba ve výchozím nastavení vrátí kód odpovědi 202 podél adresy URL přesměrování v poli Umístění hlavičky odpovědi. Tato adresa URL by se měla pravidelně kontrolovat, 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žadavek je dlouhotrvající požadavek. Tady je typická posloupnost operací:

  1. Klient odešle žádost služby Search Address Batch POST na Azure Maps

  2. Server odpoví jedním z následujících způsobů:

    HTTP 202 Accepted – Žádost batch byla přijata.

    HTTP Error – Při zpracování požadavku Batch došlo k chybě. Může se jednat o stavový 400 Bad Request kód nebo jakýkoli jiný Error stavový kód.

  3. Pokud byl dávkový požadavek úspěšně přijat, Location hlavička v odpovědi obsahuje adresu URL ke stažení výsledků dávkové žádosti. Identifikátor URI stavu vypadá takto:

    GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Klient vydá GET žádost o adresu URL pro stažení získanou v kroku 3 a stáhne výsledky dávky.

Text POST pro dávkový požadavek

Chcete-li odeslat vyhledávací adresu reverzní dotazy, použijete POST požadavek, ve kterém text požadavku bude obsahovat batchItems pole ve json formátu a Content-Type hlavička bude nastavena na application/json. Tady je ukázkový text požadavku obsahující 5 reverzních dotazů pro vyhledávání :

{
    "batchItems": [
        {"query": "?query=48.858561,2.294911"},
        {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
        {"query": "?query=47.621028,-122.348170"},
        {"query": "?query=43.722990,10.396695"},
        {"query": "?query=40.750958,-73.982336"}
    ]
}

Reverzní dotaz vyhledávací adresy v dávce je jenom částečná adresa URL bez protokolu, základní adresy URL, cesty, verze rozhraní API a klíče předplatného. Může přijmout libovolný z podporovaných parametrů URI adresy vyhledávání. Řetězcové hodnoty v reverzním dotazu vyhledávací adresy musí být správně uvozené (např. znak " by měl být řídicí znak s \ ) a měl by být také správně zakódován adresou 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.

Stažení asynchronních výsledků dávky

Pokud chcete stáhnout asynchronní výsledky dávky, vydáte GET žádost koncovému bodu dávkového stahování. Tuto adresu URL pro stažení je možné získat z Location hlavičky úspěšné POST dávkové žádosti a vypadá takto:

https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Tady je typická posloupnost operací pro stažení výsledků dávky:

  1. Klient odešle GET požadavek pomocí adresy URL pro stažení.

  2. Server odpoví jedním z následujících způsobů:

    HTTP 202 Accepted – Žádost batch byla přijata, ale stále se zpracovává. Zkuste to prosím znovu za nějakou dobu.

    HTTP 200 OK – Žádost batch se úspěšně zpracovala. Text odpovědi obsahuje všechny výsledky dávky.

Model dávkové odpovědi

Vrácený datový obsah se podobá asynchronním a synchronizačním požadavkům. Při stahování výsledků asynchronního dávkového požadavku, pokud dávka dokončila zpracování, text odpovědi obsahuje dávkovou odpověď. Tato dávková odpověď obsahuje summary komponentu, která označuje totalRequests , že 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ý a každý dotaz v dávkovém požadavku. Bude batchItems obsahovat výsledky ve stejném pořadí, v jakém byly původní dotazy odeslány v dávkovém požadavku. Každá položka obsahuje batchItemsstatusCode a response pole. Každý response z batchItems nich má jeden z následujících typů:

  • SearchAddressReverseResponse – Pokud se dotaz úspěšně dokončil.

  • Error – Pokud dotaz selhal. Odpověď bude obsahovat a code v tomto případě.message

Tady je ukázková dávková odpověď s 2 úspěšnými a 1 neúspěšnými výsledky:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 11
                },
                "addresses": [
                    {
                        "address": {
                            "country": "France",
                            "freeformAddress": "Avenue Anatole France, 75007 Paris"
                        },
                        "position": "48.858490,2.294820"
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 1
                },
                "addresses": [
                    {
                        "address": {
                            "country": "United States of America",
                            "freeformAddress": "157th Pl NE, Redmond WA 98052"
                        },
                        "position": "47.640470,-122.129430"
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
GET https://atlas.microsoft.com/search/address/reverse/batch/{format}?api-version=1.0

Parametry identifikátoru URI

Name In Required Type Description
format
path True
  • string

ID dávky pro dotazování na operaci

api-version
query True
  • string

Číslo verze rozhraní API Azure Maps

Hlavička požadavku

Name Required Type Description
x-ms-client-id
  • string

Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Azure AD. Představuje jedinečné ID účtu Azure Maps a lze ho načíst z rozhraní API Azure Maps roviny správy. Pokud chcete v Azure Maps používat zabezpečení Azure AD, přečtěte si následující články s pokyny.

Odpovědi

Name Type Description
200 OK

OK

202 Accepted

Podporováno pouze pro asynchronní požadavek. Žádost přijata: Žádost byla přijata ke zpracování. K opakování nebo přístupu k výsledkům použijte adresu URL v záhlaví umístění.

Headers

  • Location: string
Other Status Codes

Došlo k neočekávané chybě.

Zabezpečení

AADToken

Jedná se o toky Azure Active Directory OAuth2 . Při spárování s řízením přístupu na základě role Azure se dá použít k řízení přístupu k rozhraním REST API Azure Maps. Řízení přístupu na základě role 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 s jednou nebo více oprávněními k Azure Maps rozhraní REST API.

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

Poznámky

  • Tato definice zabezpečení vyžaduje použití x-ms-client-id hlavičky k označení, ke kterému Azure Maps prostředku, ke kterému aplikace požaduje přístup. Můžete ho získat z rozhraní API pro správu map.

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

  • Azure Active Directory verze 1.0 nebo v2.0 v současné době podporuje pracovní, školní a hosty, ale nepodporuje osobní účty.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytváření Azure Maps účtu 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í REST API. Jinými slovy, tento klíč lze použít jako hlavní klíč v účtu, ve který jsou vystaveny.

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

Type: apiKey
In: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace Výpis SAS u 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í pro přístup pomocí řízení přístupu na základě role Azure a jemně odstupňované řízení vypršení platnosti, rychlosti a oblastí použití pro konkrétní token. Jinými slovy, token SAS lze použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

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

Type: apiKey
In: header

Příklady

A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries

Sample Request

GET https://atlas.microsoft.com/search/address/reverse/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

Sample Response

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "7",
              "routeNumbers": [],
              "streetName": "Avenue Anatole France",
              "streetNameAndNumber": "7 Avenue Anatole France",
              "countryCode": "FR",
              "countrySubdivision": "Île-de-France",
              "countrySecondarySubdivision": "Paris",
              "municipality": "Paris",
              "postalCode": "75007",
              "municipalitySubdivision": "7ème Arrondissement",
              "country": "France",
              "countryCodeISO3": "FRA",
              "freeformAddress": "7 Avenue Anatole France, Paris, 75007",
              "boundingBox": {
                "northEast": "48.858321,2.295167",
                "southWest": "48.858136,2.295027",
                "entity": "position"
              }
            },
            "position": "48.858231,2.295089"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "routeNumbers": [],
              "countryCode": "US",
              "countrySubdivision": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "municipality": "Redmond",
              "postalCode": "98052",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "Redmond, WA 98052",
              "boundingBox": {
                "northEast": "47.639765,-122.128661",
                "southWest": "47.639502,-122.129456",
                "entity": "position"
              },
              "countrySubdivisionName": "Washington"
            },
            "position": "47.639687,-122.128677"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 19,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "410",
              "routeNumbers": [],
              "streetName": "Thomas Street",
              "streetNameAndNumber": "410 Thomas Street",
              "countryCode": "US",
              "countrySubdivision": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "municipality": "Seattle",
              "postalCode": "98109",
              "municipalitySubdivision": "Seattle, Lower Queen Anne",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "410 Thomas Street, Seattle, WA 98109",
              "boundingBox": {
                "northEast": "47.620954,-122.347601",
                "southWest": "47.620944,-122.348498",
                "entity": "position"
              },
              "extendedPostalCode": "981094621",
              "countrySubdivisionName": "Washington"
            },
            "position": "47.620945,-122.348175"
          }
        ]
      }
    }
  ]
}

Definice

Address

Adresa výsledku

AddressRanges

Popisuje rozsah adres na obou stranách ulice pro výsledek hledání. Zahrnou se souřadnice počátečního a koncového umístění rozsahu adres.

BoundingBox

Zobrazení, které pokrývá výsledek reprezentovaný souřadnicemi v levém horním a dolním rohu zobrazení.

BoundingBoxCompassNotation

Ohraničující pole umístění.

Brand

Značka přidružená k poi

Classification

Klasifikace vrácené poI

ClassificationName

Název klasifikace

DataSources

Nepovinný oddíl. Id odkazů pro použití s rozhraním GET Search Polygon API

Entity

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

EntryPoint

Vstupní bod pro vrácenou poi.

EntryPointType

Typ vstupního bodu. Hodnota může být buď hlavní , nebo menší.

ErrorAdditionalInfo

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

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Chybová odpověď

GeographicEntityType

Typ entity zeměpisu Prezentovat pouze v případě, že byl požadován typ entityType a je k dispozici.

Geometry

Informace o geometrickém tvaru výsledku K dispozici pouze v případě, že je typ == Zeměpis.

LatLongPairAbbreviated

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

MatchType

Typy shody pro operaci vyhledávání reverzních adres

OperatingHours

Otevírací doba pro poi (body zájmu).

OperatingHoursTime

Představuje datum a čas.

OperatingHoursTimeRange

Otevřený časový rozsah pro den

PointOfInterest

Podrobnosti o vrácené poI včetně informací, jako je jméno, telefon, adresa URL a klasifikace.

PointOfInterestCategorySet

Kategorie POI

QueryType

Vrácený typ dotazu: NEDALE nebo NON_NEAR.

Response

Výsledek dotazu. SearchAddressResponse pokud se dotaz úspěšně dokončil, ErrorResponse jinak.

ReverseSearchAddressBatchItem

Položka vrácená z volání služby Search Address Reverse Batch

ReverseSearchAddressBatchProcessResult

Tento objekt se vrátí z úspěšného volání služby Reverse Batch adresy vyhledávání.

SearchAddressResultItem

Objekt výsledku odpovědi rozhraní API pro vyhledávání

SearchAddressResultType

Jedna z těchto možností:

  • Poi
  • Ulice
  • Geografie
  • Adresa bodu
  • Rozsah adres
  • Křížová ulice
SearchSummary

Souhrnný objekt odpovědi rozhraní API pro vyhledávání

Summary

Souhrn výsledků dávkové žádosti

Address

Adresa výsledku

Name Type Description
boundingBox

Ohraničující pole umístění.

buildingNumber
  • string

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

country
  • string

Název země

countryCode
  • string

Země (Poznámka: Jedná se o dvoumísmenný kód, nikoli název země.)

countryCodeISO3
  • string

Kód země ISO alfa-3

countrySecondarySubdivision
  • string

County

countrySubdivision
  • string

Země/region nebo kraj

countrySubdivisionName
  • string

Úplný název první úrovně hierarchie správy země. Toto pole se zobrazí pouze v případě, že zeměSubdivision je uvedena ve zkrácené podobě. Podporuje se jenom usa, Kanada a Velká Británie.

countryTertiarySubdivision
  • string

Pojmenovaná oblast

crossStreet
  • string

Název ulice, která se překříží.

extendedPostalCode
  • string

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

freeformAddress
  • string

Řádek adresy formátovaný podle pravidel formátování země původu výsledku nebo v případě země, ve které je jeho celá země.

localName
  • string

Komponenta adresy, která představuje název geografické oblasti nebo lokality, která seskupuje řadu adresovatelných objektů pro účely adresování, aniž by to byla jednotka správy. Toto pole slouží k sestavení freeformAddress vlastnosti.

municipality
  • string

Město / město

municipalitySubdivision
  • string

Sub / Super Město

postalCode
  • string

PSČ / PSČ

routeNumbers
  • string[]

Kódy použité 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 a číslo ulice.

streetNumber
  • string

Číslo budovy na ulici.

AddressRanges

Popisuje rozsah adres na obou stranách ulice pro výsledek hledání. Zahrnou se souřadnice počátečního a koncového umístění rozsahu adres.

Name Type 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 reprezentovaný souřadnicemi v levém horním a dolním rohu zobrazení.

Name Type 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í pole umístění.

Name Type Description
entity

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

northEast
  • string

Severní východ zeměpisné šířky, délka souřadnice ohraničujícího rámečku jako čárkami oddělených plovoucími čárkami

southWest
  • string

Zeměpisná šířka jih-západ, souřadnice zeměpisné délky ohraničujícího rámečku jako plovoucí čárkami oddělené čárkami

Brand

Značka přidružená k poi

Name Type Description
name
  • string

Název značky

Classification

Klasifikace vrácené poI

Name Type Description
code
  • string

Vlastnost kódu

names

Pole názvů

ClassificationName

Název klasifikace

Name Type Description
name
  • string

Name – vlastnost

nameLocale
  • string

Name Locale – vlastnost

DataSources

Nepovinný oddíl. Id odkazů pro použití s rozhraním GET Search Polygon API

Name Type Description
geometry

Informace o geometrickém tvaru výsledku K dispozici pouze v případě, že je typ == Zeměpis.

Entity

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

Name Type Description
position
  • string

Entita pozice

EntryPoint

Vstupní bod pro vrácenou poi.

Name Type 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 buď hlavní , nebo menší.

EntryPointType

Typ vstupního bodu. Hodnota může být buď hlavní , nebo menší.

Name Type Description
main
  • string
minor
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

Další informace.

type
  • string

Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name Type 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 Type Description
error

Objekt chyby.

GeographicEntityType

Typ entity zeměpisu Prezentovat pouze v případě, že byl požadován typ entityType a je k dispozici.

Name Type Description
Country
  • string

Název země

CountrySecondarySubdivision
  • string

County

CountrySubdivision
  • string

Země/region nebo kraj

CountryTertiarySubdivision
  • string

Pojmenovaná oblast

Municipality
  • string

Město / město

MunicipalitySubdivision
  • string

Sub / Super Město

Neighbourhood
  • string

Sousedství

PostalCodeArea
  • string

PSČ / PSČ

Geometry

Informace o geometrickém tvaru výsledku K dispozici pouze v případě, že je typ == Zeměpis.

Name Type Description
id
  • string

Předejte ho jako geometryId do rozhraní Get Search Polygon API pro načtení informací 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 Type Description
lat
  • number

Vlastnost Zeměpisná šířka

lon
  • number

Zeměpisná délka – vlastnost

MatchType

Typy shody pro operaci vyhledávání reverzních adres

Name Type Description
AddressPoint
  • string
HouseNumberRange
  • string
Street
  • string

OperatingHours

Otevírací doba pro poi (body zájmu).

Name Type Description
mode
  • string

Hodnota použitá v požadavku: žádná nebo "nextSevenDays"

timeRanges

Seznam časových rozsahů pro příštích 7 dnů

OperatingHoursTime

Představuje datum a čas.

Name Type Description
date
  • string

Představuje aktuální datum kalendáře v časovém pásmu POI, například "2019-02-07".

hour
  • integer

Hodiny jsou ve formátu 24 hodin v místním čase ukazatele výkonu; možné hodnoty jsou 0 až 23.

minute
  • integer

Počet minut se nachází v místním čase poi; možné hodnoty jsou 0 až 59.

OperatingHoursTimeRange

Otevřený časový rozsah pro den

Name Type Description
endTime

Bod v následujícím 7denním rozsahu, kdy je daná poI uzavřena, nebo začátek rozsahu, pokud byl uzavřen před rozsahem.

startTime

Bod v následujícím 7denním rozsahu při otevření dané poI nebo začátku rozsahu, pokud byl otevřen před rozsahem.

PointOfInterest

Podrobnosti o vrácené poI včetně informací, jako je jméno, telefon, adresa URL a klasifikace.

Name Type Description
brands

Pole značek. Název značky pro vrácenou poi.

categories
  • string[]

Pole kategorií

categorySet

Seznam nejkonfiriktně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ího čísla

url
  • string

Vlastnost url webu

PointOfInterestCategorySet

Kategorie POI

Name Type Description
id
  • integer

ID kategorie

QueryType

Vrácený typ dotazu: NEDALE nebo NON_NEAR.

Name Type Description
NEARBY
  • string

Hledání bylo provedeno kolem určité zeměpisné šířky a délky s definovaným poloměrem.

NON_NEAR
  • string

Vyhledávání se provádělo globálně, aniž by došlo k předsudkům určité zeměpisné šířky a délky a bez definovaného poloměru.

Response

Výsledek dotazu. SearchAddressResponse pokud se dotaz úspěšně dokončil, ErrorResponse jinak.

Name Type Description
error

Objekt chyby.

results

Seznam výsledků rozhraní API vyhledávání

summary

Souhrnný objekt odpovědi rozhraní API pro vyhledávání

ReverseSearchAddressBatchItem

Položka vrácená z volání služby Search Address Reverse Batch

Name Type Description
response

Výsledek dotazu. SearchAddressReverseResponse, pokud se dotaz úspěšně dokončil, errorResponse jinak.

statusCode
  • integer

Stavový kód požadavku HTTP

ReverseSearchAddressBatchProcessResult

Tento objekt se vrátí z úspěšného volání služby Reverse Batch adresy vyhledávání.

Name Type Description
batchItems

Pole obsahující výsledky dávky

summary

Souhrn výsledků dávkové žádosti

SearchAddressResultItem

Objekt výsledku odpovědi rozhraní API pro vyhledávání

Name Type Description
address

Adresa výsledku

addressRanges

Popisuje rozsah adres na obou stranách ulice pro výsledek hledání. Zahrnou se souřadnice počátečního a koncového umístění rozsahu adres.

dataSources

Nepovinný oddíl. ID referenční geometrie pro použití s rozhraním Get Search Polygon API

detourTime
  • integer

Doba objížďky v sekundách. Vráceno pouze pro volání rozhraní API pro vyhledávání podél trasy.

dist
  • number

Přímá čára vzdálenost mezi výsledkem a umístěním geobií v metrech.

entityType

Typ entity zeměpisu Prezentovat pouze v případě, že byl požadován typ entityType a je k dispozici.

entryPoints

Pole vstupních bodů Ty popisují typy vchodů dostupných na místě. Typ může být "main" pro hlavní vchody, jako jsou přední dveře nebo předsálí a "podverze", 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í:

  • AddressPoint
  • HouseNumberRange
  • Ulice
poi

Podrobnosti o vrácené 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í odpovídající skóre mezi výsledky. Můžete to použít k určení, že výsledek x je dvakrát tak pravděpodobné, že bude relevantní jako výsledek y, pokud je hodnota x 2x hodnota y. Hodnoty se liší mezi dotazy a jsou určené pouze jako relativní hodnota pro jednu sadu výsledků.

type

Jedna z těchto možností:

  • Poi
  • Ulice
  • Geografie
  • Adresa bodu
  • Rozsah adres
  • Křížová ulice
viewport

Zobrazení, které pokrývá výsledek reprezentovaný souřadnicemi v levém horním a dolním rohu zobrazení.

SearchAddressResultType

Jedna z těchto možností:

  • Poi
  • Ulice
  • Geografie
  • Adresa bodu
  • Rozsah adres
  • Křížová ulice
Name Type Description
Address Range
  • string
Cross Street
  • string
Geography
  • string
POI
  • string
Point Address
  • string
Street
  • string

SearchSummary

Souhrnný objekt odpovědi rozhraní API pro vyhledávání

Name Type Description
fuzzyLevel
  • integer

Maximální úroveň fuzzy potřebná k zadání výsledků.

geoBias

Označení, kdy interní vyhledávací modul použil geoprostorový předsudky ke zlepšení hodnocení výsledků. V některých metodách to může být ovlivněno nastavením lat a lon parametrů, pokud jsou k dispozici. V jiných případech je to č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 celé sadě výsledků

query
  • string

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

queryTime
  • integer

Čas strávený řešením dotazu v milisekundách

queryType

Vrácený typ dotazu: NEDALE nebo NON_NEAR.

totalResults
  • integer

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

Summary

Souhrn výsledků dávkové žádosti

Name Type Description
successfulRequests
  • integer

Počet úspěšných požadavků v dávce

totalRequests
  • integer

Celkový počet požadavků v dávce