Search - Post Search Address Reverse Batch Sync

Referencia

Service:: Maps

API Version:: 1.0

Lekérdezések kötegének elküldése a Keresés Address API-nak egyetlen szinkron kérésben.
Az Get Search Address Batch API egy HTTP-kérésGET, amely lekérdezések kötegeit küldi Keresés Address API-nak egyetlen szinkron API-hívásban. Meghívhatja Keresés Address Reverse Batch API-t aszinkron (aszinkron) vagy szinkron (szinkronizálási) futtatáshoz. Az async API lehetővé teszi, hogy a hívó legfeljebb 10 000 lekérdezést kötenek össze, és akár 100 lekérdezést szinkronizáljon az API-val.

Szinkron batch-kérelem elküldése

A szinkron API egyszerűsített kötegelt kérésekhez ajánlott. Amikor a szolgáltatás kérést kap, a rendszer azonnal válaszol a kötegelemek kiszámításakor, és később nem lesz lehetőség az eredmények lekérésére. A Szinkron API időtúllépési hibát (408-ra adott válasz) ad vissza, ha a kérés 60 másodpercnél tovább tart. Ehhez az API-hoz a kötegelemek száma legfeljebb 100 lehet.

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

Aszinkron batch-kérelem küldése

Az Aszinkron API alkalmas a viszonylag összetett keresési kérések nagy mennyiségének feldolgozására

Lehetővé teszi az eredmények lekérését egy külön hívásban (több letöltés is lehetséges).
Az aszinkron API megbízhatóságra van optimalizálva, és nem várható, hogy időtúllépésbe ütközik.
Ehhez az API-hoz a kötegelemek száma legfeljebb 10 000 lehet.

Ha aszinkron kéréssel küld kérést, a szolgáltatás alapértelmezés szerint egy 202-s válaszkódot ad vissza egy átirányítási URL-cím mentén a válaszfejléc Hely mezőjében. Ezt az URL-címet rendszeres időközönként ellenőrizni kell, amíg a válaszadatok vagy a hibainformációk nem érhetők el. Az aszinkron válaszok tárolása 14 napig történik. Az átirányítási URL-cím 404-et ad vissza, ha a lejárati idő után használják.

Vegye figyelembe, hogy az aszinkron kötegelt kérelem hosszú ideig futó művelet. Íme egy tipikus műveletsor:

Az ügyfél Keresés Cím fordított köteg POST kérést küld a Azure Maps.

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

A kiszolgáló a következők egyikével válaszol:

HTTP 202 Accepted – A Batch-kérés elfogadva.

HTTP Error – Hiba történt a Batch-kérelem feldolgozása közben. Ez lehet egy 400 Bad Request vagy bármely más Error állapotkód.
Ha a kötegkérelmet sikeresen elfogadták, a Location válasz fejléce tartalmazza a kötegelt kérelem eredményeinek letöltéséhez szükséges URL-címet. Az állapot URI-ja a következőképpen néz ki:

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

Az ügyfél kérést GET küld a 3. lépésben beszerzett letöltési URL-címre a kötegelt eredmények letöltéséhez.

POST törzs a Batch-kérelemhez

A keresési cím fordított lekérdezéseinek elküldéséhez olyan kérést POST kell használnia, amelyben a kérelem törzse formátumban tartalmazza a batchItems tömböt json , a fejléc pedig a Content-Type következőre application/jsonlesz állítva: . Íme egy mintakérés törzse, amely 5 keresési cím fordított lekérdezését tartalmazza:

{
    "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"}
    ]
}

A kötegelt keresési címek fordított lekérdezése csak részleges URL-cím a protokoll, az alap URL-cím, az elérési út, az api-verzió és az előfizetési kulcs nélkül . A támogatott keresési címek fordítottURI-paramétereinek bármelyikét elfogadhatja. A keresési cím fordított lekérdezésében szereplő sztringértékeket megfelelően kell feloldani (például a " karaktert a \ karakterrel kell feloldani), és az URL-címnek is megfelelően kell kódolnia.

Az async API lehetővé teszi a hívó számára, hogy legfeljebb 10 000 lekérdezést kötenek össze, és legfeljebb 100 lekérdezést szinkronizáljon az API-val, és a kötegnek legalább 1 lekérdezést kell tartalmaznia.

Aszinkron Batch-eredmények letöltése

Az aszinkron kötegeredmények letöltéséhez kérést GET küld a kötegletöltési végpontnak. Ez a letöltési URL-cím lekérhető egy sikeres POST kötegelt kérelem fejlécébőlLocation, és a következőképpen néz ki:

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

A kötegelt eredmények letöltésének tipikus műveletsorozata a következő:

Az ügyfél kérést GET küld a letöltési URL-cím használatával.
A kiszolgáló a következők egyikével válaszol:

HTTP 202 Accepted – A Batch-kérést elfogadták, de még folyamatban van a feldolgozás. Próbálkozzon újra egy ideig.

HTTP 200 OK – A Batch-kérelem feldolgozása sikerült. A válasz törzse tartalmazza az összes kötegelt eredményt.

Batch-válaszmodell

A visszaadott adattartalom hasonló az aszinkron és szinkronizálási kérelmekhez. Egy aszinkron kötegkérés eredményeinek letöltésekor, ha a köteg feldolgozása befejeződött, a válasz törzse tartalmazza a kötegelt választ. Ez a batch-válasz tartalmaz egy summary összetevőt, amely azt jelzi, hogy az totalRequests eredeti kötegelt kérelem successfulRequestsrésze volt, azaz a sikeresen végrehajtott lekérdezések. A kötegelt válasz tartalmaz egy batchItems tömböt is, amely a batch-kérelem minden egyes lekérdezéséhez tartalmaz választ. A batchItems parancs pontosan ugyanabban a sorrendben tartalmazza az eredményeket, mint az eredeti lekérdezéseket a kötegelt kérelemben. Minden elem tartalmaz batchItemsstatusCode és response mezőket tartalmaz. Mindegyik response a batchItems következő típusok egyikét tartalmazza:

SearchAddressReverseResponse – Ha a lekérdezés sikeresen befejeződött.
Error – Ha a lekérdezés sikertelen volt. A válasz ebben az esetben egy code és egy message elemet fog tartalmazni.

Íme egy minta Batch-válasz 2 sikeres és 1 sikertelen eredménnyel:

{
    "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."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0

URI-paraméterek

Name	In	Kötelező	Típus	Description
format	path	True	JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
api-version	query	True	string	A Azure Maps API verziószáma.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen használatban a Microsoft Entra ID biztonsági modellel együtt. A Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeleti sík fiók API-jából. A biztonsági Microsoft Entra ID Azure Maps az alábbi cikkekben talál útmutatást.

Kérelem törzse

Name	Típus	Description
batchItems	BatchRequestItem[]	A feldolgozandó lekérdezések listája.

Válaszok

Name	Típus	Description
200 OK	ReverseSearchAddressBatchProcessResult	OK
Other Status Codes	ErrorResponse	Időtúllépés: A kérés befejezése hosszabb időt vett igénybe, mint az API-ban meghatározott maximális időtartam.
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek az OAuth 2.0-folyamatok Microsoft Entra. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható a Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több, a REST API-khoz Azure Maps engedélyekkel rendelkező egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Megjegyzés

Ez a biztonsági definíció a fejléc használatával x-ms-client-id jelzi, hogy az alkalmazás melyik Azure Maps erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.
Ez Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID konfigurációkkal rendelkeznek.
Az Azure szerepköralapú hozzáférés-vezérlés az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.
A Azure Maps Webes SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esethez.
A Microsoft Identitásplatform kapcsolatos további információkért lásd: Microsoft Identitásplatform áttekintés.

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

Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps fiókot hoz létre a Azure Portal vagy a PowerShell, a CLI, az Azure SDK-k vagy a REST API használatával.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítésével férhessen hozzá Azure Maps REST API-khoz, hogy a kulcs biztonságosan tárolható legyen.

Type: apiKey
In: query

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat, amely a Azure Maps erőforrás SAS listázási műveletéből jön létre az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonat lejáratához, sebességéhez és régiójához. Más szóval az SAS-jogkivonattal az alkalmazások biztonságosabb módon szabályozhatják a hozzáférést, mint a megosztott kulcs.

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy konfigurálja az engedélyezett források adott listáját a Térképfiók erőforráson a megjelenítési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.

Type: apiKey
In: header

Példák

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

Sample Request

HTTP

POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0

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

Sample Response

Status code:: 200

{
  "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",
              "countrySubdivisionCode": "Î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",
              "countrySubdivisionCode": "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",
              "countrySubdivisionCode": "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"
          }
        ]
      }
    }
  ]
}

Status code:: 408

{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

Definíciók

Name	Description
Address	Az eredmény címe
AddressRanges	Az utca mindkét oldalán található címtartományt ismerteti a keresési eredményekhez. A címtartomány kezdő és záró helyének koordinátáit is tartalmazza.
BatchRequest	Ez a típus a Batch szolgáltatás kérelemtörzsét jelöli.
BatchRequestItem	Batch-kérelemobjektum
BoundingBox	A nézetport bal felső és jobb alsó koordinátái által ábrázolt eredményt lefedő nézetport.
BoundingBoxCompassNotation	A hely határolókerete.
Brand	A POI-hoz társított márka
Classification	A visszaadott POI besorolása
ClassificationName	A besorolás neve
DataSources	Nem kötelező szakasz. Referenciaazonosítók a Get Keresés Polygon API-val való használathoz.
Entity	A határolókeret entitástípus-forrása. Fordított geokódolás esetén ez mindig egyenlő a pozícióval.
EntryPoint	A visszaadott POI belépési pontja.
EntryPointType	A belépési pont típusa. Az érték lehet fő vagy alérték.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
GeographicEntityType	Földrajzi entitás típusa. Csak akkor jelenik meg, ha az entityType kérése megtörtént, és elérhető.
Geometry	Információ az eredmény geometriai alakjáról. Csak akkor jelenik meg, ha a típus == Földrajzi hely.
JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon".
MatchType	A fordított címkeresési művelethez tartozó egyezések típusai.
OperatingHours	PoI nyitvatartási ideje (érdekes pontok).
OperatingHoursTime	Dátumot és időpontot jelöl
OperatingHoursTimeRange	Nyitott időtartomány egy napra
PointOfInterest	A visszaadott POI részletei, beleértve az olyan információkat, mint a név, a telefon, az URL-cím és a besorolások.
PointOfInterestCategorySet	POI-kategória
QueryType	A visszaadott lekérdezés típusa: KÖZELI vagy NON_NEAR.
Response	A lekérdezés eredménye. SearchAddressResult ha a lekérdezés sikeresen befejeződött, az ErrorResponse egyéb módon.
ReverseSearchAddressBatchItem	Az Keresés Address Reverse Batch szolgáltatáshívásából visszaadott elem.
ReverseSearchAddressBatchProcessResult	Ezt az objektumot egy sikeres Keresés Cím fordított köteg szolgáltatáshívása adja vissza.
SearchAddressResultItem	Eredményobjektum egy Keresés API-válaszhoz.
SearchAddressResultType	Az alábbiak egyike: POI Utca Földrajzi hely Pont címe Címtartomány Kereszt utca
SearchSummary	Egy Keresés API-válasz összefoglaló objektuma.
Summary	A kötegelt kérelem eredményeinek összegzése

Address

Az eredmény címe

Name	Típus	Description
boundingBox	BoundingBoxCompassNotation	A hely határolókerete.
buildingNumber	string	Az épület száma az utcán. ELAVULT, használja helyette a streetNumber parancsot.
country	string	ország/régió neve
countryCode	string	Country (Megjegyzés: Ez egy kétbetűs kód, nem ország/régió neve.)
countryCodeISO3	string	ISO alpha-3 országkód
countrySecondarySubdivision	string	Megye
countrySubdivision	string	Állam vagy tartomány
countrySubdivisionCode	string	`countrySubdivisionCode` az előtagja `countryCode` ( countryCode-countrySubdivisionCode ) és a kötőjel alkotja az ISO 3166-2 kódot. Példák: TX Texashoz, SCT Skóciához és ON Ontarióhoz.
countrySubdivisionName	string	Az ország-/régiószintű felügyeleti hierarchia első szintjének teljes neve. Ez a mező csak abban az esetben jelenik meg, ha a countrySubdivision rövidített formában jelenik meg. Csak az USA, Kanada és az Egyesült Királyság esetében támogatott.
countryTertiarySubdivision	string	Elnevezett terület
crossStreet	string	A keresztezett utca neve.
extendedPostalCode	string	Kiterjesztett irányítószám (a rendelkezésre állás a régiótól függ).
freeformAddress	string	Az eredmény származási országának/régiójának formázási szabályai szerint formázott címsor, illetve ország/régió esetén annak teljes országának/régiójának neve.
localName	string	Egy olyan címösszetevő, amely egy olyan földrajzi terület vagy hely nevét jelöli, amely több címezhető objektumot csoportosít címzés céljából, felügyeleti egység nélkül. Ez a mező a tulajdonság összeállítására `freeformAddress` szolgál. `localName` a postai önkormányzatot jelöli. A helytől `localName` függően a város vagy város általánosan ismert neve. Egy város vagy város általánosan ismert neveként használja `localName` a következőt: `municipality`.
municipality	string	Város /város Megjegyzés: `municipality` a lakótelepi önkormányzatot jelöli. A helytől függően az `municipality` érték eltérhet egy város vagy város általánosan ismert nevétől. A város vagy város általánosan ismert nevének használata javasolt az `localName` érték helyett `municipality` .
municipalitySubdivision	string	Al- és Szuperváros
neighbourhood	string	A szomszédság egy földrajzilag honosított terület egy városban vagy városban, jellegzetes jellemzőkkel és a lakosság közötti társadalmi interakciókkal.
postalCode	string	Irányítószám / Irányítószám
routeNumbers	string[]	Az utca egyértelmű azonosítására használt kódok
street	string	Az utcanév. ELAVULT, használja helyette a streetName nevet.
streetName	string	Az utcanév.
streetNameAndNumber	string	Az utca neve és száma.
streetNumber	string	Az épület száma az utcán.

AddressRanges

Az utca mindkét oldalán található címtartományt ismerteti a keresési eredményekhez. A címtartomány kezdő és záró helyének koordinátáit is tartalmazza.

Name	Típus	Description
from	LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".
rangeLeft	string	Címtartomány az utca bal oldalán.
rangeRight	string	Címtartomány az utca jobb oldalán.
to	LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".

BatchRequest

Ez a típus a Batch szolgáltatás kérelemtörzsét jelöli.

Name	Típus	Description
batchItems	BatchRequestItem[]	A feldolgozandó lekérdezések listája.

BatchRequestItem

Batch-kérelemobjektum

Name	Típus	Description
query	string	Ez a paraméter egy strukturálatlan geokódolási művelet végrehajtásához használt lekérdezési sztringet tartalmaz. A lekérdezési sztringet a rendszer szó szerint átadja a keresési API-nak feldolgozás céljából.

BoundingBox

A nézetport bal felső és jobb alsó koordinátái által ábrázolt eredményt lefedő nézetport.

Name	Típus	Description
btmRightPoint	LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".
topLeftPoint	LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".

BoundingBoxCompassNotation

A hely határolókerete.

Name	Típus	Description
entity	Entity	A határolókeret entitástípus-forrása. Fordított geokódolás esetén ez mindig egyenlő a pozícióval.
northEast	string	Észak-keleti szélesség, a határolókeret hosszúsági koordinátája vesszővel tagolt lebegőpontos lebegőpontosként
southWest	string	Dél-nyugati szélesség, a határolókeret hosszúsági koordinátája vesszővel tagolt úszókként

Brand

A POI-hoz társított márka

Name	Típus	Description
name	string	A márka neve

Classification

A visszaadott POI besorolása

Name	Típus	Description
code	string	Kód tulajdonság
names	ClassificationName[]	Névtömb

ClassificationName

A besorolás neve

Name	Típus	Description
name	string	Name tulajdonság
nameLocale	string	Name Locale tulajdonság

DataSources

Nem kötelező szakasz. Referenciaazonosítók a Get Keresés Polygon API-val való használathoz.

Name	Típus	Description
geometry	Geometry	Információ az eredmény geometriai alakjáról. Csak akkor jelenik meg, ha a típus == Földrajzi hely.

Entity

A határolókeret entitástípus-forrása. Fordított geokódolás esetén ez mindig egyenlő a pozícióval.

Name	Típus	Description
position	string	Pozíció entitás

EntryPoint

A visszaadott POI belépési pontja.

Name	Típus	Description
position	LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid névvel, & "lon".
type	EntryPointType	A belépési pont típusa. Az érték lehet fő vagy alérték.

EntryPointType

A belépési pont típusa. Az érték lehet fő vagy alérték.

Name	Típus	Description
main	string
minor	string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

GeographicEntityType

Földrajzi entitás típusa. Csak akkor jelenik meg, ha az entityType kérése megtörtént, és elérhető.

Name	Típus	Description
Country	string	ország/régió neve
CountrySecondarySubdivision	string	Megye
CountrySubdivision	string	Állam vagy tartomány
CountryTertiarySubdivision	string	Elnevezett terület
Municipality	string	Város /város
MunicipalitySubdivision	string	Al- és Szuperváros
Neighbourhood	string	Szomszédságában
PostalCodeArea	string	Irányítószám / Irányítószám

Geometry

Információ az eredmény geometriai alakjáról. Csak akkor jelenik meg, ha a típus == Földrajzi hely.

Name	Típus	Description
id	string	Adja át ezt geometriaazonosítóként a Get Keresés Polygon API-nak az eredmény geometriai információinak lekéréséhez.

JsonFormat

A válasz kívánt formátuma. Csak json a formátum támogatott.

Name	Típus	Description
json	string	A JavaScript-objektum jelölési adatcseréjének formátuma

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon".

Name	Típus	Description
lat	number	Latitude tulajdonság
lon	number	Hosszúság tulajdonság

MatchType

A fordított címkeresési művelethez tartozó egyezések típusai.

Name	Típus	Description
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

PoI nyitvatartási ideje (érdekes pontok).

Name	Típus	Description
mode	string	A kérelemben használt érték: none vagy "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	A következő 7 nap időtartományainak listája

OperatingHoursTime

Dátumot és időpontot jelöl

Name	Típus	Description
date	string	Az aktuális naptárdátumot jelöli a POI időzónájában, például "2019-02-07".
hour	integer	Az órák 24 órás formátumban vannak a POI helyi idejében; lehetséges értékek: 0 – 23.
minute	integer	A percek a poI helyi idejében vannak; lehetséges értékek: 0 – 59.

OperatingHoursTimeRange

Nyitott időtartomány egy napra

Name	Típus	Description
endTime	OperatingHoursTime	A következő 7 napos tartomány azon pontja, amikor egy adott POI zárva van, vagy a tartomány kezdete, ha az a tartomány előtt lett lezárva.
startTime	OperatingHoursTime	A következő 7 napos tartomány azon pontja, amikor egy adott POI meg van nyitva, vagy a tartomány kezdete, ha a tartomány előtt nyitották meg.

PointOfInterest

A visszaadott POI részletei, beleértve az olyan információkat, mint a név, a telefon, az URL-cím és a besorolások.

Name	Típus	Description
brands	Brand[]	Brands tömb. A visszaadott POI márkaneve.
categories	string[]	Kategóriák tömb
categorySet	PointOfInterestCategorySet[]	A legspecifikusabb POI-kategóriák listája
classifications	Classification[]	Besorolási tömb
name	string	A POI tulajdonság neve
openingHours	OperatingHours	PoI nyitvatartási ideje (érdekes pontok).
phone	string	Telefonszám tulajdonság
url	string	Webhely URL-címe tulajdonság

PointOfInterestCategorySet

POI-kategória

Name	Típus	Description
id	integer	Kategóriaazonosító

QueryType

A visszaadott lekérdezés típusa: KÖZELI vagy NON_NEAR.

Name	Típus	Description
NEARBY	string	Keresés egy meghatározott sugarú szélesség és hosszúság körül végezték el
NON_NEAR	string	Keresés globálisan végezték el, anélkül, hogy torzítanak egy bizonyos szélességre és hosszúságra, és nincs meghatározott sugár

Response

A lekérdezés eredménye. SearchAddressResult ha a lekérdezés sikeresen befejeződött, az ErrorResponse egyéb módon.

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.
results	SearchAddressResultItem[]	Keresés API-eredmények listája.
summary	SearchSummary	Keresés API-válasz összefoglaló objektuma

ReverseSearchAddressBatchItem

Az Keresés Address Reverse Batch szolgáltatáshívásából visszaadott elem.

Name	Típus	Description
response	Response	A lekérdezés eredménye. SearchAddressReverseResponse, ha a lekérdezés sikeresen befejeződött, az ErrorResponse ettől eltérő módon.
statusCode	integer	HTTP-kérés állapotkódja.

ReverseSearchAddressBatchProcessResult

Ezt az objektumot egy sikeres Keresés Cím fordított köteg szolgáltatáshívása adja vissza.

Name	Típus	Description
batchItems	ReverseSearchAddressBatchItem[]	A kötegelt eredményeket tartalmazó tömb.
summary	Summary	A kötegelt kérelem eredményeinek összegzése

SearchAddressResultItem

Eredményobjektum egy Keresés API-válaszhoz.

Name	Típus	Description
address	Address	Az eredmény címe
addressRanges	AddressRanges	Az utca mindkét oldalán található címtartományt ismerteti a keresési eredményhez. A címtartomány kezdő és záró helyének koordinátáit tartalmazza.
dataSources	DataSources	Nem kötelező szakasz. Referenciageometriai azonosító a Get Keresés Polygon API-hoz.
detourTime	integer	Kitérő másodpercben. Csak a Keresés Route API-ra irányuló hívások esetén ad vissza.
dist	number	Egyenes vonal távolsága az eredmény és a geobiák helye között méterben.
entityType	GeographicEntityType	Földrajzi entitás típusa. Csak akkor jelenik meg, ha az entityType kérése megtörtént, és elérhető.
entryPoints	EntryPoint[]	EntryPoint-tömb. Ezek a helyszínen elérhető bejáratok típusait írják le. A típus lehet "fő" a főbejáratokhoz, például a bejárati ajtóhoz vagy az előszobához, valamint "minor" az oldalsó és hátsó ajtókhoz.
id	string	Id tulajdonság
info	string	Információ az eredmény eredeti adatforrásáról. Támogatási kérelmekhez használható.
matchType	MatchType	Az egyezés típusára vonatkozó információk. Az alábbiak egyike: AddressPoint HouseNumberRange Utca
poi	PointOfInterest	A visszaadott POI részletei, beleértve az olyan információkat, mint a név, a telefon, az URL-cím és a besorolások.
position	LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon".
score	number	Az eredményhalmazon belüli érték, amely az eredmények közötti relatív egyező pontszámot jelzi. Ezzel megállapíthatja, hogy az x eredmény kétszer akkora valószínűséggel lesz releváns, mint y, ha az x értéke 2x az y értékével. Az értékek lekérdezésenként eltérőek, és csak egy eredményhalmaz relatív értékeként értik.
type	SearchAddressResultType	Az alábbiak egyike: POI Utca Földrajzi hely Pont címe Címtartomány Kereszt utca
viewport	BoundingBox	A nézetport bal felső és jobb alsó koordinátái által képviselt eredményt lefedő nézetport.

SearchAddressResultType

Az alábbiak egyike:

POI
Utca
Földrajzi hely
Pont címe
Címtartomány
Kereszt utca

Name	Típus	Description
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchSummary

Egy Keresés API-válasz összefoglaló objektuma.

Name	Típus	Description
fuzzyLevel	integer	Az eredmények megadásához szükséges maximális fuzzy szint.
geoBias	LatLongPairAbbreviated	Annak jelzése, hogy a belső keresőmotor térinformatikai torzításokat alkalmazott az eredmények rangsorolásának javítására. Egyes metódusok ezt a lat és a lon paraméterek beállításával befolyásolhatják, ahol elérhető. Más esetekben ez tisztán belső.
limit	integer	A visszaadott válaszok maximális száma
numResults	integer	A válasz eredményeinek száma.
offset	integer	A visszaadott eredmények kezdő eltolása a teljes eredménykészleten belül.
query	string	A keresési eredmények előállításához használt lekérdezési paraméter.
queryTime	integer	A lekérdezés feloldásával töltött idő ezredmásodpercben.
queryType	QueryType	A visszaadott lekérdezés típusa: KÖZELI vagy NON_NEAR.
totalResults	integer	A talált eredmények teljes száma.

Summary

A kötegelt kérelem eredményeinek összegzése

Name	Típus	Description
successfulRequests	integer	Sikeres kérelmek száma a kötegben
totalRequests	integer	A kötegben lévő kérések teljes száma

Share via