Search - Get Search Address

Referenz

Service:: Maps

API Version:: 1.0

Dient zum Abrufen von Breiten- und Längengradkoordinaten einer Straßenadresse in einem unstrukturierten oder Abfrageeingabeformat.

Die Get Search Address API ist eine HTTP-Anforderung GET gibt die Breiten- und Längengradkoordinaten zurück, wenn sie als Suchkriterien in einer Straßenadresse oder einem Namen eines Orts übergeben werden.

In vielen Fällen kann der vollständige Suchdienst zu viel sein, für instance, wenn Sie nur an der herkömmlichen Geocodierung interessiert sind. auf Search kann auch exklusiv für die Adresssuche zugegriffen werden. Die Geocodierung erfolgt durch Erreichen des Geocodeendpunkts mit nur der betreffenden Adresse oder Teiladresse. Der Geocodierungssuchindex wird nach allen Daten abgefragt, die über den Daten auf Straßenebene liegen. Es werden keine POIs zurückgegeben. Beachten Sie, dass der Geocoder gegenüber Tippfehlern und unvollständigen Adressen sehr tolerant ist. Es wird auch alles von genauen Straßenadressen oder Straßen oder Kreuzungen sowie von geografischen Regionen auf höherer Ebene wie Stadtzentren, Landkreisen, Bundesstaaten usw. behandeln.

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}

With optional parameters:

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	ResponseFormat	Das gewünschte Format der Antwort. Der Wert kann entweder json oder xml sein.
api-version	query	True	string	Versionsnummer der Azure Maps API.
query	query	True	string	Die zu suchde Adresse (z. B. "1 Microsoft-Weg, Redmond, WA") muss ordnungsgemäß URL-codiert sein.
btmRight	query		string	Rechts unten des Begrenzungsrahmens. Z.B. 37.553,-122.453
countrySet	query		string[]	Durch Trennzeichen getrennte Zeichenfolge von Länder-/Regionscodes, z. B. FR, ES. Dadurch wird die Suche auf die angegebenen Länder/Regionen beschränkt.
entityType	query		GeographicEntityType	Gibt die Ebene der Filterung an, die für Geografische Regionen ausgeführt wird. Schränkt die Suche nach angegebenen geografischen Entitätstypen ein, z. B. nur Gemeinde zurückgeben. Die resultierende Antwort enthält die Geografie-ID sowie den passenden Entitätstyp. Wenn Sie mehrere Entitäten als kommagetrennte Liste angeben, gibt der Endpunkt die "kleinste verfügbare Entität" zurück. Die zurückgegebene Geometrie-ID kann verwendet werden, um die Geometrie dieser Geografie über die Get Search Polygon-API abzurufen. Die folgenden Parameter werden ignoriert, wenn entityType festgelegt wird: Überschrift number returnRoadUse returnSpeedLimit roadUse returnMatchType
extendedPostalCodesFor	query		SearchIndexes[]	Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollen. Verfügbare Indizes sind: Addr = Adressbereiche Geo = Geografien PAD = Punktadressen POI = Points of Interest Str = Straßen XStr = Cross Street (Kreuzungen) Der Wert sollte eine durch Trennzeichen getrennte Liste von Indextypen (in beliebiger Reihenfolge) oder Keine für keine Indizes sein. Standardmäßig sind erweiterte Postleitzahlen für alle Indizes mit Ausnahme von Geo enthalten. Erweiterte Postleitzahlenlisten für Geografische Regionen können recht lang sein, sodass sie bei Bedarf explizit angefordert werden müssen. Anwendungsbeispiele: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Erweiterte Postleitzahl wird als extendedPostalCode-Eigenschaft einer Adresse zurückgegeben. Die Verfügbarkeit ist regionsabhängig.
language	query		string	Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eines der unterstützten IETF-Sprachtags sein, wobei die Groß-/Kleinschreibung nicht beachtet wird. Wenn Daten in der angegebenen Sprache für ein bestimmtes Feld nicht verfügbar sind, wird die Standardsprache verwendet. Weitere Informationen finden Sie unter Unterstützte Sprachen .
lat	query		number double	Breitengrad, in dem die Ergebnisse verzerrt sein sollen. Beispiel: 37.337
limit	query		integer	Maximale Anzahl von Antworten, die zurückgegeben werden. Standard: 10, Minimum: 1 und Maximum: 100
lon	query		number double	Längengrad, bei dem die Ergebnisse verzerrt sein sollen. Beispiel: -121,89
ofs	query		integer	Startoffset der zurückgegebenen Ergebnisse innerhalb des vollständigen Resultsets. Standardwert: 0
radius	query		integer	Der Radius in Metern bis, damit die Ergebnisse auf den definierten Bereich beschränkt werden.
topLeft	query		string	Obere linke Position des Begrenzungsrahmens. Z.B. 37.553,-122.453
typeahead	query		boolean	Boolesch. Wenn das Flag typeahead festgelegt ist, wird die Abfrage als teilbare Eingabe interpretiert, und die Suche wechselt in den Vorhersagemodus.
view	query		LocalizedMapView	Mit dem Parameter View (auch als "Benutzerregion" bezeichnet) können Sie die richtigen Karten für ein bestimmtes Land/eine bestimmte Region für geopolitisch umstrittene Regionen anzeigen. Verschiedene Länder/Regionen haben unterschiedliche Ansichten zu diesen Regionen, und der View-Parameter ermöglicht es Ihrer Anwendung, die Ansicht zu erfüllen, die für das Land/die Region erforderlich ist, in dem/der Ihre Anwendung verwendet wird. Standardmäßig ist der View-Parameter auf "Unified" festgelegt, auch wenn Sie ihn nicht in der Anforderung definiert haben. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den „View“-Parameter für diesen Standort entsprechend festzulegen. Alternativ haben Sie die Möglichkeit, „View=Auto“ festzulegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgibt. Der View-Parameter in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen zur Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten sowie Inhalte von Drittanbietern, auf die Sie über Azure Maps zugreifen dürfen, verfügbar gemacht werden. Beispiel: view=IN. Weitere Informationen und die verfügbaren Ansichten finden Sie unter Unterstützte Ansichten .

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell verwendet werden soll. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Azure Maps-Verwaltungsebenen-API abgerufen werden. Informationen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Antworten

Name	Typ	Beschreibung
200 OK	SearchAddressResult	OK
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung in Azure 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 einem 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.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

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.
ist Authorization URL 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 verwendeter Schlüssel, der beim Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API bereitgestellt wird.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: 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 für den Zugriff auf Azure Maps REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

SAS Token

Dies ist 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 für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

Search detail address 15127 NE 24th Street, Redmond, WA 98052

Sample Request

HTTP

GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052

Sample Response

Status code:: 200

{
  "summary": {
    "query": "15127 NE 24th Street, Redmond, WA 98052",
    "queryType": "NON_NEAR",
    "queryTime": 58,
    "numResults": 1,
    "offset": 0,
    "totalResults": 1,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/19173426",
      "score": 14.51,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "980525544",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15127 NE 24th St, Redmond, WA 980525544",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6308,
        "lon": -122.1385
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6317,
          "lon": -122.13983
        },
        "btmRightPoint": {
          "lat": 47.6299,
          "lon": -122.13717
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6315,
            "lon": -122.13852
          }
        }
      ]
    }
  ]
}

Definitionen

Name	Beschreibung
Address	Die Adresse des Ergebnisses
AddressRanges	Beschreibt den Adressbereich auf beiden Seiten der Straße für ein Suchergebnis. Koordinaten für die Start- und Endpositionen des Adressbereichs sind enthalten.
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.
LatLongPairAbbreviated	Eine Position, die als Breiten- und Längengrad mit den kurznamen "lat" & "lon" dargestellt wird.
LocalizedMapView	Mit dem Parameter View (auch als "Benutzerregion" bezeichnet) können Sie die richtigen Karten für ein bestimmtes Land/eine bestimmte Region für geopolitisch umstrittene Regionen anzeigen. Verschiedene Länder/Regionen haben unterschiedliche Ansichten zu diesen Regionen, und der View-Parameter ermöglicht es Ihrer Anwendung, die Ansicht zu erfüllen, die für das Land/die Region erforderlich ist, in dem/der Ihre Anwendung verwendet wird. Standardmäßig ist der View-Parameter auf "Unified" festgelegt, auch wenn Sie ihn nicht in der Anforderung definiert haben. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den „View“-Parameter für diesen Standort entsprechend festzulegen. Alternativ haben Sie die Möglichkeit, „View=Auto“ festzulegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgibt. Der View-Parameter in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen zur Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten sowie Inhalte von Drittanbietern, auf die Sie über Azure Maps zugreifen dürfen, verfügbar gemacht werden. Beispiel: view=IN. Weitere Informationen und die verfügbaren Ansichten finden Sie unter Unterstützte Ansichten .
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.
ResponseFormat	Gewünschtes Format der Antwort. Der Wert kann entweder json oder xml sein.
SearchAddressResult	Dieses Objekt wird von einer erfolgreichen Search-Aufrufe 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
SearchIndexes	Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollten. Verfügbare Indizes sind: Addr = Adressbereiche Geo = Geographie PAD = Punktadressen POI = Points of Interest Str = Straßen XStr = Cross Street (Kreuzungen) Der Wert sollte eine durch Kommage getrennte Liste von Indextypen (in beliebiger Reihenfolge) oder Keine für keine Indizes sein. Standardmäßig sind erweiterte Postleitzahlen für alle Indizes mit Ausnahme von Geo enthalten. Erweiterte Postleitzahlenlisten für Geografische Regionen können recht lang sein, sodass sie bei Bedarf explizit angefordert werden müssen. Anwendungsbeispiele: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Erweiterte Postleitzahl wird als extendedPostalCode-Eigenschaft einer Adresse zurückgegeben. Die Verfügbarkeit ist regionsabhängig.
SearchSummary	Zusammenfassungsobjekt für eine Search-API-Antwort.

Address

Die Adresse des Ergebnisses

Name	Typ	Beschreibung
boundingBox	BoundingBoxCompassNotation	Das umschließende Feld der Position.
buildingNumber	string	Die Gebäudenummer auf der Straße. VERALTET, verwenden Sie stattdessen streetNumber.
country	string	Land-/Regionsname
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 abgekürzter Form dargestellt wird. Nur für DIE USA, Kanada und Vereinigtes 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 Gebiets darstellt, der mehrere adressierbare Objekte zu Adressierungszwecken gruppiert, ohne eine Verwaltungseinheit zu sein. Dieses Feld wird verwendet, um die `freeformAddress` Eigenschaft zu erstellen. `localName` vertritt die Postgemeinde. Je nach Standort `localName` ist der allgemein bekannte Name einer Stadt oder Stadt. Verwenden Sie `localName` für den allgemein bekannten Namen einer Stadt anstelle von `municipality`.
municipality	string	Stadt / Ort Hinweis: `municipality` stellt die Wohngemeinde dar. Je nach Standort kann sich der `municipality` Wert vom allgemein bekannten Namen einer 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 Einwohnern.
postalCode	string	Postleitzahl / Postleitzahl
routeNumbers	string[]	Die Zur eindeutigen Identifizierung der Straße verwendeten Codes
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 Seiten der Straße für ein Suchergebnis. Koordinaten für die Start- und Endpositionen des Adressbereichs sind enthalten.

Name	Typ	Beschreibung
from	LatLongPairAbbreviated	Eine Position, die als Breiten- und Längengrad mit den kurznamen "lat" & "lon" dargestellt wird.
rangeLeft	string	Adressbereich auf der linken Straßenseite.
rangeRight	string	Adressbereich auf der rechten Straßenseite.
to	LatLongPairAbbreviated	Eine Position, die als Breiten- und Längengrad mit den kurznamen "lat" & "lon" dargestellt wird.

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	Eine Position, die als Breiten- und Längengrad mit den kurznamen "lat" & "lon" dargestellt wird.
topLeftPoint	LatLongPairAbbreviated	Eine Position, die als Breiten- und Längengrad mit den 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 zur geometrischen Form des Ergebnisses. Nur vorhanden, wenn der Typ == Geography eingibt.

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	Eine Position, die als Breiten- und Längengrad mit den kurznamen "lat" & "lon" dargestellt wird.
type	EntryPointType	Der Typ des Einstiegspunkts. Der Wert kann entweder Standard oder nebenwertig 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	Land-/Regionsname
CountrySecondarySubdivision	string	County
CountrySubdivision	string	Bundesland oder Kanton
CountryTertiarySubdivision	string	Benannter Bereich
Municipality	string	Stadt / 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.

LatLongPairAbbreviated

Eine Position, die als Breiten- und Längengrad mit den kurznamen "lat" & "lon" dargestellt wird.

Name	Typ	Beschreibung
lat	number	Latitude-Eigenschaft
lon	number	Längengradeigenschaft

LocalizedMapView

Mit dem Parameter View (auch als "Benutzerregion" bezeichnet) können Sie die richtigen Karten für ein bestimmtes Land/eine bestimmte Region für geopolitisch umstrittene Regionen anzeigen. Verschiedene Länder/Regionen haben unterschiedliche Ansichten zu diesen Regionen, und der View-Parameter ermöglicht es Ihrer Anwendung, die Ansicht zu erfüllen, die für das Land/die Region erforderlich ist, in dem/der Ihre Anwendung verwendet wird. Standardmäßig ist der View-Parameter auf "Unified" festgelegt, auch wenn Sie ihn nicht in der Anforderung definiert haben. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den „View“-Parameter für diesen Standort entsprechend festzulegen. Alternativ haben Sie die Möglichkeit, „View=Auto“ festzulegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgibt. Der View-Parameter in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen zur Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten sowie Inhalte von Drittanbietern, auf die Sie über Azure Maps zugreifen dürfen, verfügbar gemacht werden. Beispiel: view=IN.

Weitere Informationen und die verfügbaren Ansichten finden Sie unter Unterstützte Ansichten .

Name	Typ	Beschreibung
AE	string	Vereinigte Arabische Emirate (arabische Ansicht)
AR	string	Argentinien (argentinische Ansicht)
Auto	string	Gibt die Kartendaten basierend auf der IP-Adresse der Anforderung zurück.
BH	string	Bahrain (arabische Ansicht)
IN	string	Indien (indische Ansicht)
IQ	string	Irak (arabische Ansicht)
JO	string	Jordanien (arabische Ansicht)
KW	string	Kuwait (arabische Ansicht)
LB	string	Libanon (arabische Ansicht)
MA	string	Marokko (marokkanische Ansicht)
OM	string	Oman (arabische Ansicht)
PK	string	Pakistan (pakistanische Ansicht)
PS	string	Palästinensische Autonomiegebiete (arabische Ansicht)
QA	string	Katar (arabische Ansicht)
SA	string	Saudi-Arabien (arabische Ansicht)
SY	string	Syrien (arabische Ansicht)
Unified	string	Einheitliche Ansicht (andere)
YE	string	Jemen (arabische Ansicht)

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 in der Ortszeit eines POI; mögliche Werte sind 0 bis 23.
minute	integer	Die Minuten liegen in der Ortszeit eines POI; mögliche Werte sind 0 bis 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	Telefonnummerneigenschaft
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 eine Verzerrung auf einen bestimmten Breiten- und Längengrad und keinen definierten Radius zu haben.

ResponseFormat

Gewünschtes Format der Antwort. Der Wert kann entweder json oder xml sein.

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation
xml	string	The Extensible Markup Language

SearchAddressResult

Dieses Objekt wird von einer erfolgreichen Search-Aufrufe zurückgegeben.

Name	Typ	Beschreibung
results	SearchAddressResultItem[]	Eine Liste mit Search API-Ergebnissen.
summary	SearchSummary	Zusammenfassungsobjekt für eine Search-API-Antwort

SearchAddressResultItem

Ergebnisobjekt für eine Search API-Antwort.

Name	Typ	Beschreibung
address	Address	Die Adresse des Ergebnisses
addressRanges	AddressRanges	Beschreibt den Adressbereich auf beiden Seiten der Straße für ein Suchergebnis. Koordinaten für die Start- und Endpositionen des Adressbereichs sind enthalten.
dataSources	DataSources	Optionaler Abschnitt Referenzgeometrie-ID zur Verwendung mit der Get Search Polygon-API.
detourTime	integer	Umleitungszeit in Sekunden. Wird nur für Aufrufe der Search-API für entlang der Route zurückgegeben.
dist	number	Gerader Abstand 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 Typ der Übereinstimmung. 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	Eine Position, die als Breiten- und Längengrad mit den kurznamen "lat" & "lon" dargestellt wird.
score	number	Der Wert innerhalb eines Resultsets, um die relative Übereinstimmungsbewertung zwischen den Ergebnissen anzugeben. Mit dieser Option können Sie bestimmen, dass ergebnis x doppelt so wahrscheinlich ist, dass es so relevant ist wie das Ergebnis y, wenn der Wert von x 2x der Wert von y ist. Die Werte variieren zwischen Abfragen und sind nur als relativer Wert für ein Resultset gemeint.
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

SearchIndexes

Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollten.

Verfügbare Indizes sind:

Addr = Adressbereiche

Geo = Geographie

PAD = Punktadressen

POI = Points of Interest

Str = Straßen

XStr = Cross Street (Kreuzungen)

Der Wert sollte eine durch Kommage getrennte Liste von Indextypen (in beliebiger Reihenfolge) oder Keine für keine Indizes sein.

Standardmäßig sind erweiterte Postleitzahlen für alle Indizes mit Ausnahme von Geo enthalten. Erweiterte Postleitzahlenlisten für Geografische Regionen können recht lang sein, sodass sie bei Bedarf explizit angefordert werden müssen.

Anwendungsbeispiele:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Erweiterte Postleitzahl wird als extendedPostalCode-Eigenschaft einer Adresse zurückgegeben. Die Verfügbarkeit ist regionsabhängig.

Name	Typ	Beschreibung
Addr	string
Geo	string
PAD	string
POI	string
Str	string
Xstr	string

SearchSummary

Zusammenfassungsobjekt für eine Search-API-Antwort.

Name	Typ	Beschreibung
fuzzyLevel	integer	Die maximale Fuzzy-Ebene, die für die Bereitstellung von Ergebnissen erforderlich ist.
geoBias	LatLongPairAbbreviated	Hinweis, wenn die interne Suchmaschine eine geografische Verzerrung angewendet hat, um das Ranking 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	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.