Share via

Search - Post Search Address Reverse Batch Sync

  • Referenz
Service:
Maps
API Version:
1.0

Verwenden Sie, um einen Batch von Abfragen an die Search-Adress-API in einer einzigen synchronen Anforderung zu senden.
Die Get Search Address Batch API ist eine HTTP-AnforderungGET, die Batches von Abfragen an Search Adress-API in einem einzelnen synchronen API-Aufruf sendet. Sie können Search Address Reverse Batch-API aufrufen, um entweder asynchron (asynchron) oder synchron (Synchronisierung) auszuführen. Die asynchrone API ermöglicht dem Aufrufer das Batchieren von bis zu 10.000 Abfragen und die Synchronisierungs-API mit bis zu 100 Abfragen.

Senden einer synchronen Batchanforderung

Die synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet wurden, und es gibt keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist für diese API auf 100 beschränkt.

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

Übermitteln einer asynchronen Batchanforderung

Die asynchrone API eignet sich für die Verarbeitung großer Mengen relativ komplexer Suchanforderungen.

  • Es ermöglicht das Abrufen von Ergebnissen in einem separaten Aufruf (mehrere Downloads sind möglich).
  • Die asynchrone API ist auf Zuverlässigkeit optimiert und es wird nicht erwartet, dass ein Timeout auftritt.
  • Die Anzahl der Batchelemente ist für diese API auf 10.000 begrenzt.

Wenn Sie eine Anforderung mithilfe der asynchronen Anforderung stellen, gibt der Dienst standardmäßig einen 202-Antwortcode entlang einer Umleitungs-URL im Feld Speicherort des Antwortheaders zurück. Diese URL sollte regelmäßig überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Die asynchronen Antworten werden 14 Tage lang gespeichert. Die Umleitungs-URL gibt eine Antwort 404 zurück, wenn sie nach dem Ablaufzeitraum verwendet wird.

Beachten Sie, dass es sich bei der asynchronen Batchanforderung um einen Vorgang mit langer Ausführungsdauer handelt. Hier sehen Sie eine typische Abfolge von Vorgängen:

  1. Der Client sendet eine Search Address Reverse Batch-Anforderung POST an Azure Maps.
POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP 202 Accepted : Batchanforderung wurde akzeptiert.

    HTTP Error : Fehler bei der Verarbeitung Ihrer Batch-Anforderung. Dies kann entweder ein oder ein 400 Bad Request anderer Error status Code sein.

  2. Wenn die Batchanforderung erfolgreich angenommen wurde, enthält der Location Header in der Antwort die URL zum Herunterladen der Ergebnisse der Batchanforderung. Dieser status-URI sieht wie folgt aus:

    GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Der Client stellt eine GET Anforderung für die download-URL aus, die in Schritt 3 abgerufen wurde, um die Batchergebnisse herunterzuladen.

POST-Text für Batchanforderung

Zum Senden von Reverseabfragen für die Suchadresse verwenden Sie eine POST Anforderung, bei der der Anforderungstext das batchItems Array im json Format enthält und der Content-Type Header auf application/jsonfestgelegt wird. Hier sehen Sie einen Beispielanforderungstext mit 5 umgekehrten Suchadressenabfragen :

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

Eine Umgekehrtabfrage der Suchadresse in einem Batch ist nur eine partielle URL ohne Protokoll, Basis-URL, Pfad, API-Version und Abonnementschlüssel. Er kann alle unterstützten Reverse-URI-Parameter der Suchadresse akzeptieren. Die Zeichenfolgenwerte in der umgekehrten Abfrage der Suchadresse müssen ordnungsgemäß mit escaped versehen sein (z. B. "zeichen sollte mit \ ) versehen werden, und es sollte auch ordnungsgemäß URL-codiert sein.

Die asynchrone API ermöglicht dem Aufrufer das Batchieren von bis zu 10.000 Abfragen und die Synchronisierungs-API mit bis zu 100 Abfragen. Der Batch sollte mindestens eine Abfrage enthalten.

Herunterladen asynchroner Batchergebnisse

Zum Herunterladen der asynchronen Batchergebnisse stellen Sie eine GET Anforderung an den Batchdownloadendpunkt. Diese Download-URL kann aus der Location Kopfzeile einer erfolgreichen POST Batchanforderung abgerufen werden und sieht wie folgt aus:

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

Hier sehen Sie die typische Abfolge von Vorgängen zum Herunterladen der Batchergebnisse:

  1. Der Client sendet eine GET Anforderung über die Download-URL.

  2. Der Server antwortet mit einer der folgenden Aktionen:

    HTTP 202 Accepted : Batchanforderung wurde akzeptiert, wird aber weiterhin verarbeitet. Versuchen Sie es nach einiger Zeit erneut.

    HTTP 200 OK : Batchanforderung erfolgreich verarbeitet. Der Antworttext enthält alle Batchergebnisse.

Batchantwortmodell

Der zurückgegebene Dateninhalt ähnelt für asynchrone Anforderungen und Synchronisierungsanforderungen. Wenn die Ergebnisse einer asynchronen Batchanforderung heruntergeladen werden, enthält der Antworttext die Batchantwort, wenn die Verarbeitung abgeschlossen ist. Diese Batchantwort enthält eine summary Komponente, die angibt totalRequests , dass Teil der ursprünglichen Batchanforderung war, d successfulRequests. h. Abfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein batchItems Array, das eine Antwort für jede Abfrage in der Batchanforderung enthält. Enthält batchItems die Ergebnisse in der gleichen Reihenfolge wie die ursprünglichen Abfragen, die in der Batchanforderung gesendet wurden. Jedes Element in batchItems enthält statusCode und response Felder. Jedes response in batchItems hat einen der folgenden Typen:

  • SearchAddressReverseResponse – Wenn die Abfrage erfolgreich abgeschlossen wurde.

  • Error – Wenn bei der Abfrage ein Fehler aufgetreten ist. Die Antwort enthält in diesem Fall ein code und ein message .

Hier sehen Sie eine Beispiel-Batchantwort mit 2 erfolgreichen und 1 fehlgeschlagenen Ergebnis:

{
    "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-Parameter

Name In Erforderlich Typ Beschreibung
format
 path True

JsonFormat

Gewünschtes Format der Antwort. Nur das json-Format wird unterstützt.
api-version
 query True

string

Versionsnummer der Azure Maps API.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-id

string

Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID Sicherheitsmodell vorgesehen ist. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der konto-API auf Azure Maps Verwaltungsebene abgerufen werden. Anleitungen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Anforderungstext

Name Typ Beschreibung
batchItems

BatchRequestItem[]

Die Liste der zu verarbeitenden Abfragen.

Antworten

Name Typ Beschreibung
200 OK

ReverseSearchAddressBatchProcessResult

OK
Other Status Codes

ErrorResponse

Timeout: Die Anforderung dauerte länger als die in der API definierte maximale Zeit.
Other Status Codes

ErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

Hinweis

  • Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.
  • Der Authorization URL ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen.
  • Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
  • Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
  • Weitere Informationen zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.

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

Scopes

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

subscription-key

Dies ist ein gemeinsam genutzter Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal erstellen oder PowerShell, CLI, Azure SDKs oder REST-API verwenden.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

SAS Token

Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

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

Sample Request

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

Definitionen

Name Beschreibung
Address

Die Adresse des Ergebnisses
AddressRanges

Beschreibt den Adressbereich auf beiden Straßenseiten für ein Suchergebnis. Koordinaten für die Anfangs- und Endpositionen des Adressbereichs sind enthalten.
BatchRequest

Dieser Typ stellt den Anforderungstext für den Batch-Dienst dar.
BatchRequestItem

Batch-Anforderungsobjekt
BoundingBox

Der Viewport, der das Ergebnis abdeckt, das durch die koordinaten oben links und unten rechts des Viewports dargestellt wird.
BoundingBoxCompassNotation

Das begrenzungsfeld der Position.
Brand

Die Marke, die dem POI zugeordnet ist
Classification

Die Klassifizierung für den zurückgegebenen POI
ClassificationName

Name für die Klassifizierung
DataSources

Optionaler Abschnitt Referenz-IDs für die Verwendung mit der Get Search Polygon-API.
Entity

Entitätstypquelle des Begrenzungsrahmens. Bei umgekehrter Geocodierung ist dies immer gleich der Position.
EntryPoint

Der Einstiegspunkt für den zurückgegebenen POI.
EntryPointType

Der Typ des Einstiegspunkts. Der Wert kann entweder Standard oder Nebenwert sein.
ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail

Die Fehlerdetails.
ErrorResponse

Fehlerantwort
GeographicEntityType

Geography-Entitätstyp. Nur vorhanden, wenn entityType angefordert wurde und verfügbar ist.
Geometry

Informationen über die geometrische Form des Ergebnisses. Nur vorhanden, wenn typ == Geography.
JsonFormat

Das gewünschte Format der Antwort. Nur das json-Format wird unterstützt.
LatLongPairAbbreviated

Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.
MatchType

Übereinstimmungstypen für einen Suchvorgang für umgekehrte Adressen.
OperatingHours

Öffnungszeiten für einen POI (Points of Interest).
OperatingHoursTime

Stellt ein Datum und eine Uhrzeit dar.
OperatingHoursTimeRange

Geöffneter Zeitbereich für einen Tag
PointOfInterest

Details des zurückgegebenen POI, einschließlich Informationen wie Name, Telefon, URL-Adresse und Klassifizierungen.
PointOfInterestCategorySet

POI-Kategorie
QueryType

Der Typ der zurückgegebenen Abfrage: NEARBY oder NON_NEAR.
Response

Das Ergebnis der Abfrage. SearchAddressResult, wenn die Abfrage erfolgreich abgeschlossen wurde, andernfalls ErrorResponse.
ReverseSearchAddressBatchItem

Ein Element, das von Search Anruf des Adress reverse Batch-Diensts zurückgegeben wird.
ReverseSearchAddressBatchProcessResult

Dieses Objekt wird von einem erfolgreichen aufruf des Search Address Reverse Batch-Diensts zurückgegeben.
SearchAddressResultItem

Ergebnisobjekt für eine Search API-Antwort.
SearchAddressResultType

Enthält einen der folgenden Werte:

  • POI
  • Straße
  • Gebiet
  • Punktadresse
  • Adressbereich
  • Querstraße
SearchSummary

Zusammenfassungsobjekt für eine Search-API-Antwort.
Summary

Zusammenfassung der Ergebnisse für die Batchanforderung

Address

Die Adresse des Ergebnisses

Name Typ Beschreibung
boundingBox

BoundingBoxCompassNotation

Das begrenzungsfeld der Position.
buildingNumber

string

Die Gebäudenummer auf der Straße. VERALTET, verwenden Sie stattdessen streetNumber.
country

string

Name des Landes/der Region
countryCode

string

Land (Hinweis: Dies ist ein code aus zwei Buchstaben, kein Name des Landes/der Region.)
countryCodeISO3

string

ISO-Alpha-3-Ländercode
countrySecondarySubdivision

string

County
countrySubdivision

string

Bundesland oder Kanton
countrySubdivisionCode

string

countrySubdivisionCode präfixiert durch countryCode ( countryCode-countrySubdivisionCode ) und der Bindestrich bildet den ISO 3166-2-Code. Beispiele: TX für Texas, SCT für Schottland und ON für Ontario.
countrySubdivisionName

string

Der vollständige Name einer ersten Ebene der Verwaltungshierarchie für Land/Region. Dieses Feld wird nur angezeigt, wenn countrySubdivision in einer gekürzten Form dargestellt wird. Wird nur für die USA, Kanada und Das Vereinigte Königreich unterstützt.
countryTertiarySubdivision

string

Benannter Bereich
crossStreet

string

Der Name der Straße, die gekreuzt wird.
extendedPostalCode

string

Erweiterte Postleitzahl (Verfügbarkeit hängt von der Region ab).
freeformAddress

string

Eine Adresszeile, die gemäß den Formatierungsregeln des Ursprungslandes/der Region eines Ergebnisses oder im Fall eines Landes/einer Region den vollständigen Namen des Landes/der Region formatiert ist.
localName

string

Eine Adresskomponente, die den Namen eines geografischen Bereichs oder Orts darstellt, der mehrere adressierbare Objekte zu Adressierungszwecken gruppiert, ohne eine Verwaltungseinheit zu sein. Dieses Feld wird verwendet, um die freeformAddress -Eigenschaft zu erstellen. localName stellt die Postgemeinde dar. Je nach Standort localName ist der allgemein bekannte Name einer Stadt oder Stadt. Verwenden Sie localName für den allgemein bekannten Namen einer Stadt oder Stadt anstelle von municipality.
municipality

string

Ort/ Ort
Hinweis: municipality stellt die Wohngemeinde dar. Je nach Standort kann sich der municipality Wert vom allgemein bekannten Namen einer Stadt oder Stadt unterscheiden. Für den allgemein bekannten Namen der Stadt wird empfohlen, den localName Wert anstelle des municipality Werts zu verwenden.
municipalitySubdivision

string

Sub/ Super City
neighbourhood

string

Ein Viertel ist ein geografisch lokalisiertes Gebiet innerhalb einer Stadt oder Stadt mit charakteristischen Merkmalen und sozialen Interaktionen zwischen den Bewohnern.
postalCode

string

Postleitzahl / Postleitzahl
routeNumbers

string[]

Die Codes, die verwendet werden, um die Straße eindeutig zu identifizieren
street

string

Der Straßenname. VERALTET, verwenden Sie stattdessen streetName.
streetName

string

Der Straßenname.
streetNameAndNumber

string

Der Straßenname und die Nummer.
streetNumber

string

Die Gebäudenummer auf der Straße.

AddressRanges

Beschreibt den Adressbereich auf beiden Straßenseiten für ein Suchergebnis. Koordinaten für die Anfangs- und Endpositionen des Adressbereichs sind enthalten.

Name Typ Beschreibung
from

LatLongPairAbbreviated

Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.
rangeLeft

string

Adressbereich auf der linken Straßenseite.
rangeRight

string

Adressbereich auf der rechten Straßenseite.
to

LatLongPairAbbreviated

Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.

BatchRequest

Dieser Typ stellt den Anforderungstext für den Batch-Dienst dar.

Name Typ Beschreibung
batchItems

BatchRequestItem[]

Die Liste der zu verarbeitenden Abfragen.

BatchRequestItem

Batch-Anforderungsobjekt

Name Typ Beschreibung
query

string

Dieser Parameter enthält eine Abfragezeichenfolge, die zum Ausführen eines unstrukturierten Geocodierungsvorgangs verwendet wird. Die Abfragezeichenfolge wird zur Verarbeitung wortwörtlich an die Such-API übergeben.

BoundingBox

Der Viewport, der das Ergebnis abdeckt, das durch die koordinaten oben links und unten rechts des Viewports dargestellt wird.

Name Typ Beschreibung
btmRightPoint

LatLongPairAbbreviated

Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.
topLeftPoint

LatLongPairAbbreviated

Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.

BoundingBoxCompassNotation

Das begrenzungsfeld der Position.

Name Typ Beschreibung
entity

Entity

Entitätstypquelle des Begrenzungsrahmens. Bei umgekehrter Geocodierung ist dies immer gleich der Position.
northEast

string

Nord-Ost-Breitengrad, Längengradkoordinate des Begrenzungsrahmens als durch Trennzeichen getrennte Gleitkomma
southWest

string

Südwestlicher Breitengrad, Längengradkoordinate des Begrenzungsrahmens als durch Trennzeichen getrennte Gleitkomma

Brand

Die Marke, die dem POI zugeordnet ist

Name Typ Beschreibung
name

string

Name der Marke

Classification

Die Klassifizierung für den zurückgegebenen POI

Name Typ Beschreibung
code

string

Eigenschaft „code“
names

ClassificationName[]

Namensarray

ClassificationName

Name für die Klassifizierung

Name Typ Beschreibung
name

string

Name-Eigenschaft
nameLocale

string

Name Locale-Eigenschaft

DataSources

Optionaler Abschnitt Referenz-IDs für die Verwendung mit der Get Search Polygon-API.

Name Typ Beschreibung
geometry

Geometry

Informationen über die geometrische Form des Ergebnisses. Nur vorhanden, wenn typ == Geography.

Entity

Entitätstypquelle des Begrenzungsrahmens. Bei umgekehrter Geocodierung ist dies immer gleich der Position.

Name Typ Beschreibung
position

string

Position der Entität

EntryPoint

Der Einstiegspunkt für den zurückgegebenen POI.

Name Typ Beschreibung
position

LatLongPairAbbreviated

Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.
type

EntryPointType

Der Typ des Einstiegspunkts. Der Wert kann entweder Standard oder Nebenwert sein.

EntryPointType

Der Typ des Einstiegspunkts. Der Wert kann entweder Standard oder Nebenwert sein.

Name Typ Beschreibung
main

string

minor

string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.
type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

GeographicEntityType

Geography-Entitätstyp. Nur vorhanden, wenn entityType angefordert wurde und verfügbar ist.

Name Typ Beschreibung
Country

string

Name des Landes/der Region
CountrySecondarySubdivision

string

County
CountrySubdivision

string

Bundesland oder Kanton
CountryTertiarySubdivision

string

Benannter Bereich
Municipality

string

Ort/ Ort
MunicipalitySubdivision

string

Sub/ Super City
Neighbourhood

string

Nachbarschaft
PostalCodeArea

string

Postleitzahl / Postleitzahl

Geometry

Informationen über die geometrische Form des Ergebnisses. Nur vorhanden, wenn typ == Geography.

Name Typ Beschreibung
id

string

Übergeben Sie dies als geometryId an die Get Search Polygon-API, um Geometrieinformationen für dieses Ergebnis abzurufen.

JsonFormat

Das gewünschte Format der Antwort. Nur das json-Format wird unterstützt.

Name Typ Beschreibung
json

string

Das Datenaustauschformat der JavaScript-Objektnotation

LatLongPairAbbreviated

Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.

Name Typ Beschreibung
lat

number

Latitude-Eigenschaft
lon

number

Longitude-Eigenschaft

MatchType

Übereinstimmungstypen für einen Suchvorgang für umgekehrte Adressen.

Name Typ Beschreibung
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Öffnungszeiten für einen POI (Points of Interest).

Name Typ Beschreibung
mode

string

In der Anforderung verwendeter Wert: none oder "nextSevenDays"
timeRanges

OperatingHoursTimeRange[]

Liste der Zeitbereiche für die nächsten 7 Tage

OperatingHoursTime

Stellt ein Datum und eine Uhrzeit dar.

Name Typ Beschreibung
date

string

Stellt das aktuelle Kalenderdatum in der POI-Zeitzone dar, z. B. "2019-02-07".
hour

integer

Stunden sind im 24-Stunden-Format zur Ortszeit eines POI; mögliche Werte sind 0 bis 23.
minute

integer

Minuten liegen in der Ortszeit eines POI; mögliche Werte sind 0 - 59.

OperatingHoursTimeRange

Geöffneter Zeitbereich für einen Tag

Name Typ Beschreibung
endTime

OperatingHoursTime

Der Punkt im Bereich der nächsten 7 Tage, an dem ein bestimmter POI geschlossen wird, oder der Anfang des Bereichs, wenn er vor dem Bereich geschlossen wurde.
startTime

OperatingHoursTime

Der Punkt im Bereich der nächsten 7 Tage, an dem ein bestimmter POI geöffnet wird, oder der Anfang des Bereichs, wenn er vor dem Bereich geöffnet wurde.

PointOfInterest

Details des zurückgegebenen POI, einschließlich Informationen wie Name, Telefon, URL-Adresse und Klassifizierungen.

Name Typ Beschreibung
brands

Brand[]

Markenarray. Der Name der Marke für den zurückgegebenen POI.
categories

string[]

Kategorienarray
categorySet

PointOfInterestCategorySet[]

Die Liste der spezifischsten POI-Kategorien
classifications

Classification[]

Klassifizierungsarray
name

string

Name der POI-Eigenschaft
openingHours

OperatingHours

Öffnungszeiten für einen POI (Points of Interest).
phone

string

Telefonnummern-Eigenschaft
url

string

Website-URL-Eigenschaft

PointOfInterestCategorySet

POI-Kategorie

Name Typ Beschreibung
id

integer

Kategorie-ID

QueryType

Der Typ der zurückgegebenen Abfrage: NEARBY oder NON_NEAR.

Name Typ Beschreibung
NEARBY

string

Search wurde um einen bestimmten Breiten- und Längengrad mit einem definierten Radius durchgeführt.
NON_NEAR

string

Search wurde global durchgeführt, ohne sich auf einen bestimmten Breiten- und Längengrad und keinen definierten Radius zu bewegen.

Response

Das Ergebnis der Abfrage. SearchAddressResult, wenn die Abfrage erfolgreich abgeschlossen wurde, andernfalls ErrorResponse.

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.
results

SearchAddressResultItem[]

Eine Liste mit Search API-Ergebnissen.
summary

SearchSummary

Zusammenfassungsobjekt für eine Search-API-Antwort

ReverseSearchAddressBatchItem

Ein Element, das von Search Anruf des Adress reverse Batch-Diensts zurückgegeben wird.

Name Typ Beschreibung
response

Response

Das Ergebnis der Abfrage. SearchAddressReverseResponse, wenn die Abfrage erfolgreich abgeschlossen wurde, andernfalls ErrorResponse.
statusCode

integer

HTTP-Anforderung status Code.

ReverseSearchAddressBatchProcessResult

Dieses Objekt wird von einem erfolgreichen aufruf des Search Address Reverse Batch-Diensts zurückgegeben.

Name Typ Beschreibung
batchItems

ReverseSearchAddressBatchItem[]

Array mit den Batchergebnissen.
summary

Summary

Zusammenfassung der Ergebnisse für die Batchanforderung

SearchAddressResultItem

Ergebnisobjekt für eine Search API-Antwort.

Name Typ Beschreibung
address

Address

Die Adresse des Ergebnisses
addressRanges

AddressRanges

Beschreibt den Adressbereich auf beiden Straßenseiten für ein Suchergebnis. Koordinaten für die Anfangs- und Endpositionen des Adressbereichs sind enthalten.
dataSources

DataSources

Optionaler Abschnitt Verweisen Sie auf die Geometrie-ID zur Verwendung mit der Get Search Polygon-API.
detourTime

integer

Umleitungszeit in Sekunden. Wird nur für Aufrufe der Search Route-API zurückgegeben.
dist

number

Gerader Linienabstand zwischen dem Ergebnis und der Geobias-Position in Metern.
entityType

GeographicEntityType

Geography-Entitätstyp. Nur vorhanden, wenn entityType angefordert wurde und verfügbar ist.
entryPoints

EntryPoint[]

Array von EntryPoints. Diese beschreiben die Arten von Eingängen, die am Standort verfügbar sind. Der Typ kann "Standard" für Standard Eingänge wie eine Eingangstür oder eine Lobby und "Minor" für Seiten- und Hintertüren sein.
id

string

ID-Eigenschaft
info

string

Informationen zur ursprünglichen Datenquelle des Ergebnisses. Wird für Supportanfragen verwendet.
matchType

MatchType

Informationen zum Übereinstimmungstyp.

Enthält einen der folgenden Werte:

  • AddressPoint
  • HouseNumberRange
  • Straße
poi

PointOfInterest

Details des zurückgegebenen POI, einschließlich Informationen wie Name, Telefon, URL-Adresse und Klassifizierungen.
position

LatLongPairAbbreviated

Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.
score

number

Der Wert innerhalb eines Resultsets, um den relativen Abgleichswert zwischen den Ergebnissen anzugeben. Sie können dies verwenden, um zu bestimmen, dass ergebnis x doppelt so wahrscheinlich so relevant ist wie ergebnis y, wenn der Wert von x 2x dem Wert von y entspricht. Die Werte variieren zwischen Abfragen und sind nur als relativer Wert für ein Resultset gedacht.
type

SearchAddressResultType

Enthält einen der folgenden Werte:

  • POI
  • Straße
  • Gebiet
  • Punktadresse
  • Adressbereich
  • Querstraße
viewport

BoundingBox

Der Viewport, der das Ergebnis abdeckt, das durch die koordinaten oben links und unten rechts des Viewports dargestellt wird.

SearchAddressResultType

Enthält einen der folgenden Werte:

  • POI
  • Straße
  • Gebiet
  • Punktadresse
  • Adressbereich
  • Querstraße
Name Typ Beschreibung
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchSummary

Zusammenfassungsobjekt für eine Search-API-Antwort.

Name Typ Beschreibung
fuzzyLevel

integer

Die maximale Fuzzyebene, die erforderlich ist, um Ergebnisse bereitzustellen.
geoBias

LatLongPairAbbreviated

Angabe, wenn die interne Suchmaschine eine georedundante Verzerrung angewendet hat, um die Rangfolge der Ergebnisse zu verbessern. In einigen Methoden kann dies durch Festlegen der Lat- und lon-Parameter beeinflusst werden, sofern verfügbar. In anderen Fällen ist es rein intern.
limit

integer

Maximale Anzahl von Antworten, die zurückgegeben werden
numResults

integer

Anzahl der Ergebnisse in der Antwort.
offset

integer

Der Startoffset der zurückgegebenen Ergebnisse innerhalb des vollständigen Resultsets.
query

string

Der Abfrageparameter, der zum Erstellen dieser Suchergebnisse verwendet wurde.
queryTime

integer

Der Zeitaufwand für das Auflösen der Abfrage in Millisekunden.
queryType

QueryType

Der Typ der zurückgegebenen Abfrage: NEARBY oder NON_NEAR.
totalResults

integer

Die Gesamtzahl der gefundenen Ergebnisse.

Summary

Zusammenfassung der Ergebnisse für die Batchanforderung

Name Typ Beschreibung
successfulRequests

integer

Anzahl der erfolgreichen Anforderungen im Batch
totalRequests

integer

Gesamtanzahl der Anforderungen im Batch