Search - Post Search Along Route

  • Referenz
Service:
Maps
API Version:
1.0

Verwenden Sie mit , um eine Fuzzysuche nach POIs entlang einer angegebenen Route durchzuführen.

Die Post Search Along Route API ist eine HTTP-Anforderung POST , mit der Sie eine Fuzzysuche nach POIs entlang einer angegebenen Route durchführen können. Diese Suche wird eingeschränkt, indem das maxDetourTime einschränkende Measure angegeben wird.

Zum Senden der Routenpunkte verwenden Sie eine POST Anforderung, bei der der Anforderungstext das route als GeoJSON LineString Typ dargestellte Objekt enthält und der Content-Type Header auf application/jsonfestgelegt wird. Jeder Routenpunkt in route wird als GeoJSON Position Typ dargestellt, d. h. als Array, auf dem der Längengrad vom Breitengrad und dem Höhenwert ignoriert wird. Die route sollte mindestens 2 Routenpunkte enthalten.

Es ist möglich, dass die ursprüngliche Route geändert wird, einige punkte werden möglicherweise übersprungen. Wenn die Route, die den gefundenen Punkt durchläuft, schneller als der ursprüngliche ist, ist der detourTime Wert in der Antwort negativ.

POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}
With optional parameters: 
POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}&limit={limit}&brandSet={brandSet}&categorySet={categorySet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays

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.
maxDetourTime
 query True

integer

Maximale Umleitungszeit des Point of Interest in Sekunden. Maximaler Wert ist 3600 Sekunden
query
 query True

string

Der POI-Name, nach dem gesucht werden soll (z. B. "Freiheitsstatue", "Starbucks", "Pizza"). Muss ordnungsgemäß URL-codiert sein.
brandSet
 query

string[]

Eine durch Trennzeichen getrennte Liste von Markennamen, die verwendet werden können, um das Ergebnis auf bestimmte Marken zu beschränken. Die Reihenfolge der Elemente ist unerheblich. Wenn mehrere Marken bereitgestellt werden, werden nur Ergebnisse zurückgegeben, die (mindestens) zu einer der bereitgestellten Liste gehören. Marken, die ein "," in ihrem Namen enthalten, sollten in Anführungszeichen gesetzt werden.

Anwendungsbeispiele:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Kommma",Bar
categorySet
 query

integer[]

Eine durch Trennzeichen getrennte Liste von Kategoriegruppen-IDs, die verwendet werden können, um das Ergebnis auf bestimmte Points of Interest-Kategorien zu beschränken. Die ID-Reihenfolge spielt keine Rolle. Die maximale Anzahl von Werten, die categorySet pro Anforderung unterstützt werden, ist 10. Wenn mehrere Kategoriebezeichner bereitgestellt werden, werden nur POIs zurückgegeben, die (mindestens) zu einer der Kategorien aus der angegebenen Liste gehören. Die Liste der unterstützten Kategorien kann mithilfe der POI-Kategorien-API ermittelt werden. Anwendungsbeispiele:

  • categorySet=7315 (Search Points of Interest aus der Kategorie Restaurant)

  • categorySet=7315025,7315017 (Search Points of Interest der Kategorie entweder italienisches oder französisches Restaurant)
connectorSet
 query

ElectricVehicleConnector[]

Eine durch Trennzeichen getrennte Liste von Verbindertypen, die verwendet werden können, um das Ergebnis auf die Elektrische Fahrzeugstation zu beschränken, die bestimmte Verbindertypen unterstützt. Die Reihenfolge der Elemente ist unerheblich. Wenn mehrere Connectortypen bereitgestellt werden, werden nur Ergebnisse zurückgegeben, die (mindestens) zu einem der bereitgestellten Liste gehören.

Folgende Connectortypen sind verfügbar:

  • StandardHouseholdCountrySpecific - Dies sind die Standard-Haushaltsconnectors für eine bestimmte Region. Sie sind alle ac einphasig und die Standardspannung und Standard-Stromerage. Siehe auch: Steckdosentypen & – Weltstandards.
  • IEC62196Type1 - Typ-1-Stecker, wie in der NORM IEC 62196-2 definiert. Auch Yazaki nach dem originalen Hersteller oder SAE J1772 nach dem Standard genannt, der es zuerst veröffentlicht hat. Wird meist in Kombination mit einer 120V-Einphaseninfrastruktur oder einer einphasigen Infrastruktur mit bis zu 240 V verwendet.
  • IEC62196Type1CCS - Typ-1-basierter Kombinationsstecker, wie im IEC 62196-3-Standard definiert. Der Stecker basiert auf dem Typ-1-Stecker – wie in der NORM IEC 62196-2 definiert – mit zwei zusätzlichen Gleichstromkontakten, um das Schnelle Laden von Gleichstrom zu ermöglichen.
  • IEC62196Type2CableAttached - Typ-2-Verbinder, wie in der IEC 62196-2-Norm definiert. Wird als Kabel und Stecker am Ladepunkt bereitgestellt.
  • IEC62196Type2Outlet - Typ-2-Verbinder, wie in der IEC 62196-2-Norm definiert. Wird als Steckdose im Ladepunkt bereitgestellt.
  • IEC62196Type2CCS - Typ-2-basierter Kombinationsstecker, wie im IEC 62196-3-Standard definiert. Der Stecker basiert auf dem Typ-2-Stecker – wie in der NORM IEC 62196-2 definiert – mit zwei zusätzlichen Gleichstromkontakten, um das Schnelle Laden von Gleichstrom zu ermöglichen.
  • IEC62196Type3 - Typ-3-Verbinder, wie in der IEC 62196-2-Norm definiert. Auch Scame nach dem originalen Hersteller genannt. Meist in Kombination mit bis zu 240 V einphasigen oder bis zu 420 V dreiphasigen Infrastruktur.
  • Chademo - CHAdeMO-Verbinder benannt nach einer Vereinigung, die von der Tokyo Electric Power Company und Industriepartnern gegründet wurde. Aus diesem Grund wird auch als TEPCO-Connector bezeichnet. Es unterstützt schnelle Dc-Ladevorgänge.
  • IEC60309AC1PhaseBlue - Industrial Blue-Verbinder ist eine in der IEC 60309-Norm definierte Verbinder. Es wird irgendwann als eine Kombination aus dem Standard, der Farbe und der Tatsache bezeichnet, dass es sich um einen einstufigen Verbinder handelt. Der Connector verfügt in der Regel über die Konfiguration "P+N+E, 6h".
  • IEC60309DCWhite - Industrial White-Verbinder ist ein gleichgestellter Stecker, der im IEC 60309-Standard definiert ist.
  • Tesla - Der Tesla-Connector ist der regional spezifische Tesla Supercharger Connector. Das heißt, es bezieht sich entweder auf den proprietären Connector von Tesla, manchmal auch als Tesla Port bezeichnet, der in Europa meist auf Nordamerika beschränkt ist, oder auf den modifizierten Typ 2 (DC über Typ 2).

Anwendungsbeispiele:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
limit
 query

integer

Maximale Anzahl von Antworten, die zurückgegeben werden. Der Standardwert ist 10. Maximaler Wert ist 20
openingHours
 query

OperatingHoursRange

Betriebsstunden für einen POI (Points of Interest). Die Verfügbarkeit der Betriebsstunden variiert je nach verfügbaren Daten. Wenn sie nicht bestanden wird, werden keine Öffnungszeiteninformationen zurückgegeben. Unterstützter Wert: nextSevenDays
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 geopolitisch umstrittene Regionen anzeigen. Unterschiedliche Länder/Regionen haben unterschiedliche Ansichten dieser Regionen, und der Parameter View ermöglicht es Ihrer Anwendung, die für das Land/die Region, das/die/die Ihre Anwendung bereitstellen wird, erforderlich zu erfüllen. Standardmäßig ist der View-Parameter 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 „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 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
route

GeoJsonLineString

Ein gültiger GeoJSON LineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

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. 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.
  • 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 for burger joints along a route

Sample Request

POST https://atlas.microsoft.com/search/alongRoute/json?api-version=1.0&query=burger&maxDetourTime=1000&limit=2&openingHours=nextSevenDays

{
  "route": {
    "type": "LineString",
    "coordinates": [
      [
        -122.143035,
        47.653536
      ],
      [
        -122.187164,
        47.617556
      ],
      [
        -122.114981,
        47.570599
      ],
      [
        -122.132756,
        47.654009
      ]
    ]
  }
}

Sample Response

Status code:
200 
{
  "summary": {
    "query": "burger",
    "queryType": "NON_NEAR",
    "queryTime": 394,
    "numResults": 2,
    "offset": 0,
    "totalResults": 2,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/8596348",
      "score": 3.104,
      "dist": 1754.9604168059973,
      "info": "search:ta:840531000465150-US",
      "poi": {
        "name": "BURGER KING",
        "phone": "+(1)-(425)-7467508",
        "brands": [
          {
            "name": "BURGER KING"
          }
        ],
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "url": "www.burgerking.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "14620",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Crossroads, Bellevue",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98007",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "14620 NE 24th St, Bellevue, WA 98007",
        "localName": "Bellevue",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.63188,
        "lon": -122.14462
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.63278,
          "lon": -122.14595
        },
        "btmRightPoint": {
          "lat": 47.63098,
          "lon": -122.14329
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.63155,
            "lon": -122.14462
          }
        }
      ],
      "detourTime": -55
    },
    {
      "type": "POI",
      "id": "US/POI/p0/8596112",
      "score": 3.111,
      "dist": 161.17565489389224,
      "info": "search:ta:840531000465149-US",
      "poi": {
        "name": "BURGER KING",
        "phone": "+(1)-(425)-4535775",
        "brands": [
          {
            "name": "BURGER KING"
          }
        ],
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "url": "www.burgerking.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "11723",
        "streetName": "NE 8th St",
        "municipalitySubdivision": "Willburton, Bellevue",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98005",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "11723 NE 8th St, Bellevue, WA 98005",
        "localName": "Bellevue",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61683,
        "lon": -122.18338
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61773,
          "lon": -122.18471
        },
        "btmRightPoint": {
          "lat": 47.61593,
          "lon": -122.18205
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61723,
            "lon": -122.1834
          }
        }
      ],
      "detourTime": 12
    }
  ]
}

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 umschließende 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.
ElectricVehicleConnector

Eine durch Trennzeichen getrennte Liste von Verbindertypen, die verwendet werden können, um das Ergebnis auf die Elektrische Fahrzeugstation zu beschränken, die bestimmte Verbindertypen unterstützt. Die Reihenfolge der Elemente ist unerheblich. Wenn mehrere Connectortypen bereitgestellt werden, werden nur Ergebnisse zurückgegeben, die (mindestens) zu einem der bereitgestellten Liste gehören.

Folgende Connectortypen sind verfügbar:

  • StandardHouseholdCountrySpecific - Dies sind die Standard-Haushaltsconnectors für eine bestimmte Region. Sie sind alle ac einphasig und die Standardspannung und Standard-Stromerage. Siehe auch: Steckdosentypen & – Weltstandards.
  • IEC62196Type1 - Typ-1-Stecker, wie in der NORM IEC 62196-2 definiert. Auch Yazaki nach dem originalen Hersteller oder SAE J1772 nach dem Standard genannt, der es zuerst veröffentlicht hat. Wird meist in Kombination mit einer 120V-Einphaseninfrastruktur oder einer einphasigen Infrastruktur mit bis zu 240 V verwendet.
  • IEC62196Type1CCS - Typ-1-basierter Kombinationsstecker, wie im IEC 62196-3-Standard definiert. Der Stecker basiert auf dem Typ-1-Stecker – wie in der NORM IEC 62196-2 definiert – mit zwei zusätzlichen Gleichstromkontakten, um das Schnelle Laden von Gleichstrom zu ermöglichen.
  • IEC62196Type2CableAttached - Typ-2-Verbinder, wie in der IEC 62196-2-Norm definiert. Wird als Kabel und Stecker am Ladepunkt bereitgestellt.
  • IEC62196Type2Outlet - Typ-2-Verbinder, wie in der IEC 62196-2-Norm definiert. Wird als Steckdose im Ladepunkt bereitgestellt.
  • IEC62196Type2CCS - Typ-2-basierter Kombinationsstecker, wie im IEC 62196-3-Standard definiert. Der Stecker basiert auf dem Typ-2-Stecker – wie in der NORM IEC 62196-2 definiert – mit zwei zusätzlichen Gleichstromkontakten, um das Schnelle Laden von Gleichstrom zu ermöglichen.
  • IEC62196Type3 - Typ-3-Verbinder, wie in der IEC 62196-2-Norm definiert. Auch Scame nach dem originalen Hersteller genannt. Meist in Kombination mit bis zu 240 V einphasigen oder bis zu 420 V dreiphasigen Infrastruktur.
  • Chademo - CHAdeMO-Verbinder benannt nach einer Vereinigung, die von der Tokyo Electric Power Company und Industriepartnern gegründet wurde. Aus diesem Grund wird auch als TEPCO-Connector bezeichnet. Es unterstützt schnelle Dc-Ladevorgänge.
  • IEC60309AC1PhaseBlue - Industrial Blue-Verbinder ist eine in der IEC 60309-Norm definierte Verbinder. Es wird irgendwann als eine Kombination aus dem Standard, der Farbe und der Tatsache bezeichnet, dass es sich um einen einstufigen Verbinder handelt. Der Connector verfügt in der Regel über die Konfiguration "P+N+E, 6h".
  • IEC60309DCWhite - Industrial White-Verbinder ist ein gleichgestellter Stecker, der im IEC 60309-Standard definiert ist.
  • Tesla - Der Tesla-Connector ist der regional spezifische Tesla Supercharger Connector. Das heißt, es bezieht sich entweder auf den proprietären Connector von Tesla, manchmal auch als Tesla Port bezeichnet, der in Europa meist auf Nordamerika beschränkt ist, oder auf den modifizierten Typ 2 (DC über Typ 2).

Anwendungsbeispiele:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Entity

Entitätstypquelle des Begrenzungsrahmens. Für die Reverse-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 nebenwertig 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.
GeoJsonLineString

Ein gültiger GeoJSON LineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
Geometry

Informationen zur geometrischen Form des Ergebnisses. Nur vorhanden, wenn der Typ == Geography eingibt.
LatLongPairAbbreviated

Eine Position, die als Breiten- und Längengrad mit den 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 geopolitisch umstrittene Regionen anzeigen. Unterschiedliche Länder/Regionen haben unterschiedliche Ansichten dieser Regionen, und der Parameter View ermöglicht es Ihrer Anwendung, die für das Land/die Region, das/die/die Ihre Anwendung bereitstellen wird, erforderlich zu erfüllen. Standardmäßig ist der View-Parameter 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 „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).
OperatingHoursRange

Betriebsstunden für einen POI (Points of Interest). Die Verfügbarkeit der Betriebsstunden variiert je nach verfügbaren Daten. Wenn sie nicht bestanden wird, werden keine Öffnungszeiteninformationen zurückgegeben. Unterstützter Wert: nextSevenDays
OperatingHoursTime

Stellt ein Datum und eine Uhrzeit dar.
OperatingHoursTimeRange

Offener 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

Das gewünschte 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
SearchAlongRouteRequest

Dieser Typ stellt den Anforderungstext für den Search Entlang der Route dar.
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 umschließende Feld der Position.

Name Typ Beschreibung
entity

Entity

Entitätstypquelle des Begrenzungsrahmens. Für die Reverse-Geocodierung ist dies immer gleich der Position.
northEast

string

Nördliche Breite, Längengradkoordinate des Begrenzungsrahmens als kommagetrennte Gleitkomma
southWest

string

Südwestlicher Breitengrad, Längengradkoordinate des Begrenzungsrahmens als kommagetrennte Floats

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.

ElectricVehicleConnector

Eine durch Trennzeichen getrennte Liste von Verbindertypen, die verwendet werden können, um das Ergebnis auf die Elektrische Fahrzeugstation zu beschränken, die bestimmte Verbindertypen unterstützt. Die Reihenfolge der Elemente ist unerheblich. Wenn mehrere Connectortypen bereitgestellt werden, werden nur Ergebnisse zurückgegeben, die (mindestens) zu einem der bereitgestellten Liste gehören.

Folgende Connectortypen sind verfügbar:

  • StandardHouseholdCountrySpecific - Dies sind die Standard-Haushaltsconnectors für eine bestimmte Region. Sie sind alle ac einphasig und die Standardspannung und Standard-Stromerage. Siehe auch: Steckdosentypen & – Weltstandards.
  • IEC62196Type1 - Typ-1-Stecker, wie in der NORM IEC 62196-2 definiert. Auch Yazaki nach dem originalen Hersteller oder SAE J1772 nach dem Standard genannt, der es zuerst veröffentlicht hat. Wird meist in Kombination mit einer 120V-Einphaseninfrastruktur oder einer einphasigen Infrastruktur mit bis zu 240 V verwendet.
  • IEC62196Type1CCS - Typ-1-basierter Kombinationsstecker, wie im IEC 62196-3-Standard definiert. Der Stecker basiert auf dem Typ-1-Stecker – wie in der NORM IEC 62196-2 definiert – mit zwei zusätzlichen Gleichstromkontakten, um das Schnelle Laden von Gleichstrom zu ermöglichen.
  • IEC62196Type2CableAttached - Typ-2-Verbinder, wie in der IEC 62196-2-Norm definiert. Wird als Kabel und Stecker am Ladepunkt bereitgestellt.
  • IEC62196Type2Outlet - Typ-2-Verbinder, wie in der IEC 62196-2-Norm definiert. Wird als Steckdose im Ladepunkt bereitgestellt.
  • IEC62196Type2CCS - Typ-2-basierter Kombinationsstecker, wie im IEC 62196-3-Standard definiert. Der Stecker basiert auf dem Typ-2-Stecker – wie in der NORM IEC 62196-2 definiert – mit zwei zusätzlichen Gleichstromkontakten, um das Schnelle Laden von Gleichstrom zu ermöglichen.
  • IEC62196Type3 - Typ-3-Verbinder, wie in der IEC 62196-2-Norm definiert. Auch Scame nach dem originalen Hersteller genannt. Meist in Kombination mit bis zu 240 V einphasigen oder bis zu 420 V dreiphasigen Infrastruktur.
  • Chademo - CHAdeMO-Verbinder benannt nach einer Vereinigung, die von der Tokyo Electric Power Company und Industriepartnern gegründet wurde. Aus diesem Grund wird auch als TEPCO-Connector bezeichnet. Es unterstützt schnelle Dc-Ladevorgänge.
  • IEC60309AC1PhaseBlue - Industrial Blue-Verbinder ist eine in der IEC 60309-Norm definierte Verbinder. Es wird irgendwann als eine Kombination aus dem Standard, der Farbe und der Tatsache bezeichnet, dass es sich um einen einstufigen Verbinder handelt. Der Connector verfügt in der Regel über die Konfiguration "P+N+E, 6h".
  • IEC60309DCWhite - Industrial White-Verbinder ist ein gleichgestellter Stecker, der im IEC 60309-Standard definiert ist.
  • Tesla - Der Tesla-Connector ist der regional spezifische Tesla Supercharger Connector. Das heißt, es bezieht sich entweder auf den proprietären Connector von Tesla, manchmal auch als Tesla Port bezeichnet, der in Europa meist auf Nordamerika beschränkt ist, oder auf den modifizierten Typ 2 (DC über Typ 2).

Anwendungsbeispiele:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

Name Typ Beschreibung
Chademo

string

CHAdeMO Connector benannt nach einer Vereinigung, die von der Tokyo Electric Power Company und Industriepartnern gegründet wurde. Aus diesem Grund wird auch als TEPCO-Connector bezeichnet. Es unterstützt schnelle Dc-Ladevorgänge.
IEC60309AC1PhaseBlue

string

Industrial Blue-Stecker ist eine in der IEC 60309-Norm definierte Verbindung. Es wird irgendwann als eine Kombination aus dem Standard, der Farbe und der Tatsache bezeichnet, dass es sich um einen einstufigen Verbinder handelt. Der Connector verfügt in der Regel über die Konfiguration "P+N+E, 6h".
IEC60309DCWhite

string

Industrial White-Verbinder ist ein gleichgestellter Stecker, der im IEC 60309-Standard definiert ist.
IEC62196Type1

string

Typ-1-Stecker, wie in der Norm IEC 62196-2 definiert. Auch Yazaki nach dem originalen Hersteller oder SAE J1772 nach dem Standard genannt, der es zuerst veröffentlicht hat. Wird meist in Kombination mit einer 120V-Einphaseninfrastruktur oder einer einphasigen Infrastruktur mit bis zu 240 V verwendet.
IEC62196Type1CCS

string

Typ 1-basierter Kombinationsstecker, wie im IEC 62196-3-Standard definiert. Der Stecker basiert auf dem Typ-1-Stecker – wie in der NORM IEC 62196-2 definiert – mit zwei zusätzlichen Gleichstromkontakten, um das Schnelle Laden von Gleichstrom zu ermöglichen.
IEC62196Type2CCS

string

Typ 2-basierter Kombinationsstecker, wie im IEC 62196-3-Standard definiert. Der Stecker basiert auf dem Typ-2-Stecker – wie in der NORM IEC 62196-2 definiert – mit zwei zusätzlichen Gleichstromkontakten, um das Schnelle Laden von Gleichstrom zu ermöglichen.
IEC62196Type2CableAttached

string

Typ-2-Stecker, wie in der Norm IEC 62196-2 definiert. Geliefert als Kabel und Stecker am Ladepunkt
IEC62196Type2Outlet

string

Typ-2-Stecker, wie in der Norm IEC 62196-2 definiert. Wird als Steckdose im Ladepunkt bereitgestellt.
IEC62196Type3

string

Typ-3-Stecker, wie in der Norm IEC 62196-2 definiert. Auch Scame nach dem originalen Hersteller genannt. Meist in Kombination mit bis zu 240 V einphasigen oder bis zu 420 V dreiphasigen Infrastruktur.
StandardHouseholdCountrySpecific

string

Dies sind die Standard-Haushaltsconnectors für eine bestimmte Region. Sie sind alle ac einphasig und die Standardspannung und Standard-Stromerage.

Siehe auch: Steckdosentypen & – Weltstandards
Tesla

string

Der Tesla-Connector ist der regional spezifische Tesla Supercharger Connector. Das heißt, es bezieht sich entweder auf den proprietären Connector von Tesla, manchmal auch als Tesla Port bezeichnet, der in Europa meist auf Nordamerika beschränkt ist, oder auf den modifizierten Typ 2 (DC über Typ 2).

Entity

Entitätstypquelle des Begrenzungsrahmens. Für die Reverse-Geocodierung ist dies immer gleich der Position.

Name Typ Beschreibung
position

string

Positionsentitä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 nebenwertig 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

GeoJsonLineString

Ein gültiger GeoJSON LineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
coordinates

number[]

Koordinaten für die GeoJson LineString Geometrie.
type string:

LineString

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

Geometry

Informationen zur geometrischen Form des Ergebnisses. Nur vorhanden, wenn der Typ == Geography eingibt.

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 Parameter "Benutzerregion" bezeichnet) können Sie die richtigen Karten für ein bestimmtes Land/eine bestimmte Region für geopolitisch umstrittene Regionen anzeigen. Unterschiedliche Länder/Regionen haben unterschiedliche Ansichten dieser Regionen, und der Parameter View ermöglicht es Ihrer Anwendung, die für das Land/die Region, das/die/die Ihre Anwendung bereitstellen wird, erforderlich zu erfüllen. Standardmäßig ist der View-Parameter 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 „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 verwendete Wert: none oder "nextSevenDays"
timeRanges

OperatingHoursTimeRange[]

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

OperatingHoursRange

Betriebsstunden für einen POI (Points of Interest). Die Verfügbarkeit der Betriebsstunden variiert je nach verfügbaren Daten. Wenn sie nicht bestanden wird, werden keine Öffnungszeiteninformationen zurückgegeben. Unterstützter Wert: nextSevenDays

Name Typ Beschreibung
nextSevenDays

string

Zeigt die Betriebszeiten für die nächste Woche an, beginnend mit dem aktuellen Tag in der Ortszeit des POI.

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

Offener Zeitbereich für einen Tag

Name Typ Beschreibung
endTime

OperatingHoursTime

Der Punkt in den nächsten 7 Tagen, 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

Das gewünschte Format der Antwort. Der Wert kann entweder json oder xml sein.

Name Typ Beschreibung
json

string

Das Datenaustauschformat der JavaScript-Objektnotation
xml

string

Die erweiterbare Markupsprache

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

SearchAlongRouteRequest

Dieser Typ stellt den Anforderungstext für den Search Entlang der Route dar.

Name Typ Beschreibung
route

GeoJsonLineString

Ein gültiger GeoJSON LineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

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.