Search - Get Search Address

Referenz

Dienst:: Maps

API-Version:: 1.0

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

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

In vielen Fällen ist der vollständige Suchdienst möglicherweise zu viel, z. B. wenn Sie nur an herkömmlicher Geocodierung interessiert sind. Auf die Suche kann auch ausschließlich nach Adressen zugegriffen werden. Die Geocodierung erfolgt durch Klicken auf den Geocode-Endpunkt mit nur der adresse oder teilweisen Adresse. Der Geocodierungssuchindex wird für alles über den Daten auf Straßenebene abgefragt. Es werden keine POIs zurückgegeben. Beachten Sie, dass der Geocoder sehr tolerant von Tippfehlern und unvollständigen Adressen ist. Es wird auch alles von genauen Straßenadressen oder Straßen oder Kreuzungen sowie von höheren Regionen wie Stadtzentren, Landkreisen, Staaten usw. behandeln.

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

Mit optionalen Parametern:

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	Gewünschtes 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 Adresse, nach der gesucht werden soll (z. B. "1 Microsoft Way, Redmond, WA"), muss ordnungsgemäß URL-codiert sein.
btmRight	query		string	Untere rechte Position des umgebenden Felds. 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 Regionen ausgeführt wird. Schränkt die Suche nach bestimmten Geografischen Entitätstypen ein, z. B. nur Gemeinde zurückgeben. Die resultierende Antwort enthält die Geografie-ID sowie den übereinstimmenden Entitätstyp. Wenn Sie mehrere Entitäten als durch Trennzeichen getrennte 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 Get Search Polygon API abzurufen. Die folgenden Parameter werden ignoriert, wenn entityType festgelegt wird: Überschrift Zahl 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- = Regionen PAD = Punktadressen POI = Interessante Punkte Str = Straßen XStr = Cross Street (Kreuzungen) Der Wert sollte eine durch Trennzeichen getrennte Liste von Indextypen (in beliebiger Reihenfolge) oder None ohne Indizes sein. Standardmäßig sind erweiterte Postleitzahlen für alle Indizes mit Ausnahme von Geo enthalten. Erweiterte Postleitzahlenlisten für 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. Verfügbarkeit ist regionsabhängig.
language	query		string	Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eine der unterstützten IETF-Sprachtags sein, Groß-/Kleinschreibung wird nicht beachtet. 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ützten Sprachen.
lat	query		number (double)	Breitengrad, in dem Ergebnisse voreingenommen werden sollen. Z. B. 37.337
limit	query		integer minimum: 1 maximum: 100	Maximale Anzahl von Antworten, die zurückgegeben werden. Standard: 10, Minimum: 1 und maximal: 100
lon	query		number (double)	Längengrad, in dem ergebnisse voreingenommen werden sollen. Z. B. -121.89
ofs	query		integer minimum: 0 maximum: 1900	Starten des Offsets der zurückgegebenen Ergebnisse innerhalb des vollständigen Resultsets. Standard: 0
radius	query		integer	Der Radius in Metern, bis die Ergebnisse auf den definierten Bereich beschränkt werden sollen
topLeft	query		string	Obere linke Position des umgebenden Felds. Z. B. 37.553,-122.453
typeahead	query		boolean	Boolesch. Wenn das Typeahead-Flag festgelegt ist, wird die Abfrage als Teileingabe interpretiert, und die Suche wechselt in den Vorhersagemodus.
view	query		LocalizedMapView	Mit dem Parameter "View" (auch als Parameter "Benutzerregion" bezeichnet) können Sie die richtigen Karten für ein bestimmtes Land/eine bestimmte Region für geopolitische umstrittene Regionen anzeigen. Unterschiedliche Länder/Regionen haben unterschiedliche Ansichten solcher Regionen, und der Parameter "View" ermöglicht Ihrer Anwendung die Einhaltung der vom Land/der Region benötigten Ansicht, die Ihre Anwendung bedient. Der Parameter "View" ist standardmäßig auf "Unified" festgelegt, auch wenn Sie ihn in der Anforderung nicht definiert haben. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den Parameter "View" für diesen Speicherort korrekt festzulegen. Alternativ können Sie "View=Auto" festlegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgegeben werden. Der Parameter "View" in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen bezüglich der Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten und Inhalte von Drittanbietern, die Sie für den Zugriff über Azure Maps autorisiert haben, verfügbar gemacht werden. Beispiel: view=IN. Weitere Informationen finden Sie unter Unterstützten Ansichten und die verfügbaren Ansichten.

Anforderungsheader

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

Antworten

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

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

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 Kartenverwaltung API erworben werden.
Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen.
Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
Die Verwendung des Azure Maps Web SDK ermöglicht das konfigurationsbasierte Einrichten einer Anwendung für mehrere Anwendungsfälle.
Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

subscription-key

Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.

Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

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

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

Typ: apiKey
In: header

Beispiele

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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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 Anfangs- 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 umgebende Feld 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 umgebenden Felds. Bei umgekehrter Geocodierung ist dies immer gleich Position.
EntryPoint	Der Einstiegspunkt für den poi, der zurückgegeben wird.
EntryPointType	Der Typ des Einstiegspunkts. Der Wert kann entweder Haupt- oder nebensein.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
GeographicEntityType	Entitätstyp "Geographie". Nur vorhanden, wenn entityType angefordert wurde und verfügbar ist.
Geometry	Informationen zur geometrischen Form des Ergebnisses. Nur vorhanden, wenn Typ == Geografie.
LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird.
LocalizedMapView	Mit dem Parameter "View" (auch als Parameter "Benutzerregion" bezeichnet) können Sie die richtigen Karten für ein bestimmtes Land/eine bestimmte Region für geopolitische umstrittene Regionen anzeigen. Unterschiedliche Länder/Regionen haben unterschiedliche Ansichten solcher Regionen, und der Parameter "View" ermöglicht Ihrer Anwendung die Einhaltung der vom Land/der Region benötigten Ansicht, die Ihre Anwendung bedient. Der Parameter "View" ist standardmäßig auf "Unified" festgelegt, auch wenn Sie ihn in der Anforderung nicht definiert haben. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den Parameter "View" für diesen Speicherort korrekt festzulegen. Alternativ können Sie "View=Auto" festlegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgegeben werden. Der Parameter "View" in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen bezüglich der Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten und Inhalte von Drittanbietern, die Sie für den Zugriff über Azure Maps autorisiert haben, verfügbar gemacht werden. Beispiel: view=IN. Weitere Informationen finden Sie unter Unterstützten Ansichten und die verfügbaren Ansichten.
MatchType	Übereinstimmungstypen für einen Suchvorgang für umgekehrte Adressen.
OperatingHours	Öffnungszeiten für einen POI (Interessante Punkte).
OperatingHoursTime	Stellt ein Datum und eine Uhrzeit dar.
OperatingHoursTimeRange	Öffnungszeitbereich für einen Tag
PointOfInterest	Details zu den 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 erfolgreichen Suchaufrufen zurückgegeben.
SearchAddressResultItem	Result-Objekt für eine Such-API-Antwort.
SearchAddressResultType	Enthält einen der folgenden Werte: POI Straße Geografie Punktadresse Adressbereich Querstraße
SearchIndexes	Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollen. Verfügbare Indizes sind: Addr = Adressbereiche Geo- = Regionen PAD = Punktadressen POI = Interessante Punkte Str = Straßen XStr = Cross Street (Kreuzungen) Der Wert sollte eine durch Trennzeichen getrennte Liste von Indextypen (in beliebiger Reihenfolge) oder None ohne Indizes sein. Standardmäßig sind erweiterte Postleitzahlen für alle Indizes mit Ausnahme von Geo enthalten. Erweiterte Postleitzahlenlisten für 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. Verfügbarkeit ist regionsabhängig.
SearchSummary	Summary-Objekt für eine Such-API-Antwort.

Address

Objekt

Die Adresse des Ergebnisses

Name	Typ	Beschreibung
boundingBox	BoundingBoxCompassNotation	Das umgebende Feld der Position.
buildingNumber	string	Die Gebäudenummer auf der Straße. Verwenden Sie stattdessen "streetNumber" ALS VERALTET.
country	string	Name des Landes/der Region
countryCode	string	Land (Hinweis: Dies ist ein aus zwei Buchstaben bestehender Code, kein Name eines Landes/einer Region.)
countryCodeISO3	string	ISO-Alpha-3-Ländercode
countrySecondarySubdivision	string	Bezirk
countrySubdivision	string	Bundesland oder Provinz
countrySubdivisionCode	string	`countrySubdivisionCode` präfixiert von `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 verwaltungstechnischen Hierarchie der ersten Ebene des Landes/der Region. Dieses Feld wird nur angezeigt, wenn countrySubdivision in einem abgekürzten Formular dargestellt wird. Wird nur für USA, Kanada und Großbritannien unterstützt.
countryTertiarySubdivision	string	Benannter Bereich
crossStreet	string	Der Name der Straße, die durchquert wird.
extendedPostalCode	string	Erweiterte Postleitzahl (Verfügbarkeit hängt von der Region ab).
freeformAddress	string	Eine Adresszeile, die gemäß den Formatierungsregeln des Ursprungslandes/der Herkunftsregion 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 Gebiets oder gebietsschemas darstellt, das mehrere adressierbare Objekte zu Adresszwecken gruppiert, ohne eine administrative Einheit zu sein. Dieses Feld wird verwendet, um die `freeformAddress`-Eigenschaft zu erstellen. `localName` stellt die Postgemeinde dar. Je nach Standort ist `localName` der allgemein bekannte Name einer Stadt oder Stadt. Verwenden Sie für den allgemein bekannten Namen einer Stadt oder Stadt `localName` anstelle von `municipality`.
municipality	string	Stadt / Stadt 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 oder 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 unverwechselbaren Merkmalen und sozialen Interaktionen zwischen Einwohnern.
postalCode	string	Postleitzahl / Postleitzahl
routeNumbers	string[]	Die Codes, die verwendet werden, um die Straße eindeutig zu identifizieren
street	string	Der Straßenname. Verwenden Sie stattdessen "streetName" ALS VERALTET.
streetName	string	Der Straßenname.
streetNameAndNumber	string	Der Straßenname und die Nummer.
streetNumber	string	Die Gebäudenummer auf der Straße.

AddressRanges

Objekt

Beschreibt den Adressbereich auf beiden Seiten der Straße 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 kurznamen "lat" & "lon" dargestellt wird.
rangeLeft	string	Adressbereich auf der linken Seite der Straße.
rangeRight	string	Adressbereich auf der rechten Seite der Straße.
to	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird.

BoundingBox

Objekt

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 kurznamen "lat" & "lon" dargestellt wird.
topLeftPoint	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird.

BoundingBoxCompassNotation

Objekt

Das umgebende Feld der Position.

Name	Typ	Beschreibung
entity	Entity	Entitätstypquelle des umgebenden Felds. Bei umgekehrter Geocodierung ist dies immer gleich Position.
northEast	string	North-east latitude,longitude coordinate of the bounding box as comma-separated floats
southWest	string	Süd-West-Breitengrad,Längengradkoordinate des Begrenzungsfelds als kommagetrennte Floats

Brand

Objekt

Die Marke, die dem POI zugeordnet ist

Name	Typ	Beschreibung
name	string	Name der Marke

Classification

Objekt

Die Klassifizierung für den zurückgegebenen POI

Name	Typ	Beschreibung
code	string	Code-Eigenschaft
names	ClassificationName[]	Namensarray

ClassificationName

Objekt

Name für die Klassifizierung

Name	Typ	Beschreibung
name	string	Name-Eigenschaft
nameLocale	string	Name Locale-Eigenschaft

DataSources

Objekt

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 Typ == Geografie.

Entity

Enumeration

Entitätstypquelle des umgebenden Felds. Bei umgekehrter Geocodierung ist dies immer gleich Position.

Wert	Beschreibung
position	Positionsentität

EntryPoint

Objekt

Der Einstiegspunkt für den poi, der zurückgegeben wird.

Name	Typ	Beschreibung
position	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird.
type	EntryPointType	Der Typ des Einstiegspunkts. Der Wert kann entweder Haupt- oder nebensein.

EntryPointType

Enumeration

Der Typ des Einstiegspunkts. Der Wert kann entweder Haupt- oder nebensein.

Wert	Beschreibung
main
minor

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GeographicEntityType

Enumeration

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

Wert	Beschreibung
Country	Name des Landes/der Region
CountrySecondarySubdivision	Bezirk
CountrySubdivision	Bundesland oder Provinz
CountryTertiarySubdivision	Benannter Bereich
Municipality	Stadt / Stadt
MunicipalitySubdivision	Sub / Super City
Neighbourhood	Nachbarschaft
PostalCodeArea	Postleitzahl / Postleitzahl

Geometry

Objekt

Informationen zur geometrischen Form des Ergebnisses. Nur vorhanden, wenn Typ == Geografie.

Name	Typ	Beschreibung
id	string	Übergeben Sie dies als geometryId an die Get Search Polygon API, um Geometrieinformationen für dieses Ergebnis abzurufen.

LatLongPairAbbreviated

Objekt

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

Name	Typ	Beschreibung
lat	number (double)	Latitude-Eigenschaft
lon	number (double)	Longitude-Eigenschaft

LocalizedMapView

Enumeration

Mit dem Parameter "View" (auch als Parameter "Benutzerregion" bezeichnet) können Sie die richtigen Karten für ein bestimmtes Land/eine bestimmte Region für geopolitische umstrittene Regionen anzeigen. Unterschiedliche Länder/Regionen haben unterschiedliche Ansichten solcher Regionen, und der Parameter "View" ermöglicht Ihrer Anwendung die Einhaltung der vom Land/der Region benötigten Ansicht, die Ihre Anwendung bedient. Der Parameter "View" ist standardmäßig auf "Unified" festgelegt, auch wenn Sie ihn in der Anforderung nicht definiert haben. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den Parameter "View" für diesen Speicherort korrekt festzulegen. Alternativ können Sie "View=Auto" festlegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgegeben werden. Der Parameter "View" in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen bezüglich der Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten und Inhalte von Drittanbietern, die Sie für den Zugriff über Azure Maps autorisiert haben, verfügbar gemacht werden. Beispiel: view=IN.

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

Wert	Beschreibung
AE	Vereinigte Arabische Emirate (Arabische Ansicht)
AR	Argentinien (argentinische Ansicht)
Auto	Geben Sie die Kartendaten basierend auf der IP-Adresse der Anforderung zurück.
BH	Bahrain (Arabische Ansicht)
IN	Indien (indischer Blick)
IQ	Irak (Arabische Ansicht)
JO	Jordanien (Arabische Ansicht)
KW	Kuwait (Arabische Ansicht)
LB	Libanon (Arabische Ansicht)
MA	Marokko (marokkanische Ansicht)
OM	Oman (Arabische Ansicht)
PK	Pakistan (Pakistanische Ansicht)
PS	Palästinensische Behörde (Arabische Ansicht)
QA	Katar (Arabische Ansicht)
SA	Saudi-Arabien (Arabische Ansicht)
SY	Syrien (Arabische Ansicht)
Unified	Einheitliche Ansicht (andere)
YE	Jemen (Arabische Ansicht)

MatchType

Enumeration

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

Wert	Beschreibung
AddressPoint
HouseNumberRange
Street

OperatingHours

Objekt

Öffnungszeiten für einen POI (Interessante Punkte).

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

Objekt

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 enthalten; Mögliche Werte sind 0 - 23.
minute	integer	Minuten liegen in der Ortszeit eines POI; Mögliche Werte sind 0 - 59.

OperatingHoursTimeRange

Objekt

Öffnungszeitbereich für einen Tag

Name	Typ	Beschreibung
endTime	OperatingHoursTime	Der Punkt im nächsten 7-Tage-Bereich, an dem ein bestimmter POI geschlossen wird, oder der Anfang des Bereichs, wenn er vor dem Bereich geschlossen wurde.
startTime	OperatingHoursTime	Der Punkt im nächsten 7-Tage-Bereich, an dem ein bestimmter POI geöffnet wird, oder den Anfang des Bereichs, wenn er vor dem Bereich geöffnet wurde.

PointOfInterest

Objekt

Details zu den 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 POI, der zurückgegeben wird.
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 (Interessante Punkte).
phone	string	Telefonnummerneigenschaft
url	string	Website-URL-Eigenschaft

PointOfInterestCategorySet

Objekt

POI-Kategorie

Name	Typ	Beschreibung
id	integer	Kategorie-ID

QueryType

Enumeration

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

Wert	Beschreibung
NEARBY	Die Suche wurde um einen bestimmten Breiten- und Längengrad mit einem definierten Radius durchgeführt.
NON_NEAR	Die Suche wurde global durchgeführt, ohne einen bestimmten Breiten- und Längengrad und keinen definierten Radius voreingenommen zu haben.

ResponseFormat

Enumeration

Gewünschtes Format der Antwort. Der Wert kann entweder JSON- oder XML-sein.

Wert	Beschreibung
json	das JavaScript Object Notation Data Interchange Format
xml	Extensible Markup Language

SearchAddressResult

Objekt

Dieses Objekt wird von erfolgreichen Suchaufrufen zurückgegeben.

Name	Typ	Beschreibung
results	SearchAddressResultItem[]	Eine Liste der Suchergebnisse der Such-API.
summary	SearchSummary	Zusammenfassungsobjekt für eine Such-API-Antwort

SearchAddressResultItem

Objekt

Result-Objekt für eine Such-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 Anfangs- und Endpositionen des Adressbereichs sind enthalten.
dataSources	DataSources	Optionaler Abschnitt. Referenzgeometrie-ID für die Verwendung mit der Get Search Polygon API.
detourTime	integer	Umleitungszeit in Sekunden. Wird nur für Aufrufe der Suchrouten-API zurückgegeben.
dist	number (double)	Gerader Zeilenabstand zwischen dem Ergebnis und der Geobia-Position in Metern.
entityType	GeographicEntityType	Entitätstyp "Geographie". Nur vorhanden, wenn entityType angefordert wurde und verfügbar ist.
entryPoints	EntryPoint[]	Array von EntryPoints. Diese beschreiben die Arten von Eingängen, die an der Lage zur Verfügung stehen. Der Typ kann "Haupt" für Haupteingä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 zu den zurückgegebenen POI, einschließlich Informationen wie Name, Telefon, URL-Adresse und Klassifizierungen.
position	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird.
score	number (double)	Der Wert innerhalb eines Resultsets, der die relative Übereinstimmungsbewertung zwischen den Ergebnissen angibt. Sie können dies verwenden, um zu bestimmen, dass das Ergebnis x doppelt so relevant ist wie 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 gedacht.
type	SearchAddressResultType	Enthält einen der folgenden Werte: POI Straße Geografie 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

Enumeration

Enthält einen der folgenden Werte:

POI
Straße
Geografie
Punktadresse
Adressbereich
Querstraße

Wert	Beschreibung
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchIndexes

Enumeration

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

Verfügbare Indizes sind:

Addr = Adressbereiche

Geo- = Regionen

PAD = Punktadressen

POI = Interessante Punkte

Str = Straßen

XStr = Cross Street (Kreuzungen)

Der Wert sollte eine durch Trennzeichen getrennte Liste von Indextypen (in beliebiger Reihenfolge) oder None ohne Indizes sein.

Standardmäßig sind erweiterte Postleitzahlen für alle Indizes mit Ausnahme von Geo enthalten. Erweiterte Postleitzahlenlisten für 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. Verfügbarkeit ist regionsabhängig.

Wert	Beschreibung
Addr
Geo
PAD
POI
Str
Xstr

SearchSummary

Objekt

Summary-Objekt für eine Such-API-Antwort.

Name	Typ	Beschreibung
fuzzyLevel	integer	Die maximale Fuzzy-Ebene, die zum Bereitstellen von Ergebnissen erforderlich ist.
geoBias	LatLongPairAbbreviated	Angabe, wenn die interne Suchmaschine einen geospatialen Bias 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 sie rein intern.
limit	integer	Maximale Anzahl von Antworten, die zurückgegeben werden
numResults	integer	Die 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 die Auflösung der Abfrage in Millisekunden.
queryType	QueryType	Der Typ der zurückgegebenen Abfrage: NEARBY oder NON_NEAR.
totalResults	integer	Die Gesamtanzahl der gefundenen Ergebnisse.

Freigeben über

Search - Get Search Address

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

AADToken

Bereiche

subscription-key

SAS Token

Beispiele

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

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

LocalizedMapView

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

ResponseFormat

SearchAddressResult

SearchAddressResultItem

SearchAddressResultType

SearchIndexes

SearchSummary

Zusätzliche Ressourcen