Search - Get Search POI
Wird verwendet, um nach interessanten Orten anhand des Namens zu suchen.
Die Points of Interest (POI) Search-API ist eine HTTP-GET Anforderung, mit der Sie POI-Ergebnisse anhand des Namens anfordern können. Darüber hinaus werden zusätzliche Abfrageparameter wie Sprache und Filterergebnisse nach Interessenbereich unterstützt, der von Land/Region oder Begrenzungsfeld gesteuert wird. Der Endpunkt gibt nur POI-Ergebnisse zurück, die der Abfragezeichenfolge entsprechen. Die Antwort enthält POI-Details wie Adresse, Koordinatenposition und Kategorie.
GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&brandSet={brandSet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
format
|
path | True |
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 |
Der POI-Name, nach dem gesucht werden soll (z. B. "Freiheitsstatue", "Coffee"), muss ordnungsgemäß URL-codiert sein. |
|
brand
|
query |
string[] |
Eine durch Trennzeichen getrennte Liste von Marken, die verwendet werden können, um das Ergebnis auf bestimmte Marken zu beschränken. Artikelbestellung spielt keine Rolle. Wenn mehrere Marken bereitgestellt werden, werden nur Ergebnisse zurückgegeben, die (mindestens) einer der bereitgestellten Liste angehören. Marken, die ein "," in ihrem Namen enthalten, sollten in Anführungszeichen gesetzt werden. Anwendungsbeispiele: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Komma",Bar |
|
|
btm
|
query |
string |
Untere rechte Position des umgebenden Felds. Z. B. 37.553,-122.453 |
|
|
category
|
query |
integer[] |
Eine durch Trennzeichen getrennte Liste von Kategoriesatz-IDs, die verwendet werden können, um das Ergebnis auf bestimmte Kategorien von Interessenspunkten einzuschränken. Die ID-Reihenfolge spielt keine Rolle. Die maximale Anzahl der pro Anforderung unterstützten
|
|
|
connector
|
query |
Eine durch Trennzeichen getrennte Liste von Verbindertypen, die verwendet werden können, um das Ergebnis auf die Elektrofahrzeugstation zu beschränken, die bestimmte Verbindertypen unterstützt. Artikelbestellung spielt keine Rolle. Wenn mehrere Verbindertypen bereitgestellt werden, werden nur Ergebnisse zurückgegeben, die (mindestens) einer der bereitgestellten Listen angehören. Verfügbare Connectortypen sind:
Anwendungsbeispiele: connectorSet=IEC62196Typ2KabelAngeschlossener SteckverbinderSet=IEC62196Typ2Outlet,IEC62196Typ2CableAttached |
||
|
country
|
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. |
|
|
extended
|
query |
Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollen. Verfügbare Indizes sind: POI = Interessante Punkte Der Wert sollte POI- oder Keine sein, um erweiterte Postleitzahlen zu deaktivieren. Standardmäßig sind erweiterte Postleitzahlen enthalten. Anwendungsbeispiele: extendedPostalCodesFor=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: 1maximum: 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: 0maximum: 1900 |
Starten des Offsets der zurückgegebenen Ergebnisse innerhalb des vollständigen Resultsets. Standard: 0 |
|
|
opening
|
query |
Betriebsstunden für einen POI (Interessante Punkte). Die Verfügbarkeit der Betriebsstunden variiert je nach verfügbaren Daten. Wenn sie nicht bestanden ist, werden keine Öffnungszeiteninformationen zurückgegeben. Unterstützter Wert: nextSevenDays |
||
|
radius
|
query |
integer |
Der Radius in Metern, bis die Ergebnisse auf den definierten Bereich beschränkt werden sollen |
|
|
top
|
query |
string |
Obere linke Position des umgebenden Felds. Z. B. 37.553,-122.453 |
|
|
typeahead
|
query |
boolean |
Wenn das Typeahead-Flag gesetzt ist, wird die Abfrage als Teileingabe interpretiert und die Suche wechselt in den prädiktiven Modus. |
|
|
view
|
query |
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 das Konto an, das für die Verwendung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Diese eindeutige ID für das Azure Maps-Konto kann über die Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Weitere Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie unter Verwalten der Authentifizierung in Azure Maps. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
OKAY |
|
| Other Status Codes |
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 URList 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 for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results
Beispielanforderung
GET https://atlas.microsoft.com/search/poi/json?api-version=1.0&query=juice bars&limit=5&lat=47.606038&lon=-122.333345&radius=8046&openingHours=nextSevenDays
Beispiel für eine Antwort
{
"summary": {
"query": "juice bars",
"queryType": "NON_NEAR",
"queryTime": 36,
"numResults": 5,
"offset": 0,
"totalResults": 12,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.606038,
"lon": -122.333345
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/9223158",
"score": 5.664,
"dist": 667.2710170950347,
"info": "search:ta:840539001755244-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-6240804",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "400",
"streetName": "Pine St",
"municipalitySubdivision": "Seattle, Central Business District",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98101",
"extendedPostalCode": "981011628",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "400 Pine St, Seattle, WA 98101",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61138,
"lon": -122.3374
},
"viewport": {
"topLeftPoint": {
"lat": 47.61228,
"lon": -122.33873
},
"btmRightPoint": {
"lat": 47.61048,
"lon": -122.33607
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61134,
"lon": -122.33737
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/9222534",
"score": 5.663,
"dist": 1101.6849025777728,
"info": "search:ta:840539001760125-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-4533785",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "315",
"streetName": "E Pine St",
"municipalitySubdivision": "Seattle, Broadway",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98122",
"extendedPostalCode": "9812200",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "315 E Pine St, Seattle, WA 98122",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61518,
"lon": -122.32768
},
"viewport": {
"topLeftPoint": {
"lat": 47.61608,
"lon": -122.32901
},
"btmRightPoint": {
"lat": 47.61428,
"lon": -122.32635
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61523,
"lon": -122.32768
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/9133689",
"score": 5.659,
"dist": 2649.8700791555398,
"info": "search:ta:840539001339220-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-2820651",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "604",
"streetName": "1st Ave N",
"municipalitySubdivision": "Seattle, Lower Queen Anne",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98109",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "604 1st Ave N, Seattle, WA 98109",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.6247,
"lon": -122.35533
},
"viewport": {
"topLeftPoint": {
"lat": 47.6256,
"lon": -122.35666
},
"btmRightPoint": {
"lat": 47.6238,
"lon": -122.354
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6247,
"lon": -122.3554
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/9131285",
"score": 5.646,
"dist": 5097.757019046541,
"info": "search:ta:840539001743255-US",
"poi": {
"name": "Custom Smoothie & Sports Nutrition",
"phone": "+(1)-(206)-5475522",
"categorySet": [
{
"id": 7315149
}
],
"url": "www.customsmoothie.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "462",
"streetName": "N 34th St",
"municipalitySubdivision": "Seattle, Fremont",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98103",
"extendedPostalCode": "981038600",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "462 N 34th St, Seattle, WA 98103",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.65016,
"lon": -122.35182
},
"viewport": {
"topLeftPoint": {
"lat": 47.65106,
"lon": -122.35315
},
"btmRightPoint": {
"lat": 47.64926,
"lon": -122.35049
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.64991,
"lon": -122.3519
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/9228250",
"score": 5.637,
"dist": 6235.798481758295,
"info": "search:ta:840531000416784-US",
"poi": {
"name": "Jamba Juice",
"phone": "+(1)-(206)-6322060",
"brands": [
{
"name": "Jamba Juice"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.jambajuice.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "4555",
"streetName": "Stone Way N",
"municipalitySubdivision": "Wallingford, Seattle",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98103",
"extendedPostalCode": "981036600",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "4555 Stone Way N, Seattle, WA 98103",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.66179,
"lon": -122.34233
},
"viewport": {
"topLeftPoint": {
"lat": 47.66269,
"lon": -122.34367
},
"btmRightPoint": {
"lat": 47.66089,
"lon": -122.34099
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.66188,
"lon": -122.34211
}
}
]
}
]
}
Definitionen
| Name | Beschreibung |
|---|---|
| Address |
Die Adresse des Ergebnisses. |
|
Address |
Beschreibt den Adressbereich auf beiden Seiten der Straße für ein Suchergebnis. Koordinaten für die Anfangs- und Endpositionen des Adressbereichs sind enthalten. |
|
Bounding |
Der Viewport, der das Ergebnis abdeckt, das durch die koordinaten oben links und unten rechts des Viewports dargestellt wird. |
|
Bounding |
Das umgebende Feld der Position. |
| Brand |
Die Marke, die dem POI zugeordnet ist |
| Classification |
Die Klassifizierung für den zurückgegebenen POI |
|
Classification |
Name für die Klassifizierung |
|
Data |
Optionaler Abschnitt. Referenz-IDs für die Verwendung mit der Get Search Polygon API. |
|
Electric |
Eine durch Trennzeichen getrennte Liste von Verbindertypen, die verwendet werden können, um das Ergebnis auf die Elektrofahrzeugstation zu beschränken, die bestimmte Verbindertypen unterstützt. Artikelbestellung spielt keine Rolle. Wenn mehrere Verbindertypen bereitgestellt werden, werden nur Ergebnisse zurückgegeben, die (mindestens) einer der bereitgestellten Listen angehören. Verfügbare Connectortypen sind:
Anwendungsbeispiele: connectorSet=IEC62196Typ2KabelAngeschlossener SteckverbinderSet=IEC62196Typ2Outlet,IEC62196Typ2CableAttached |
| Entity |
Entitätstypquelle des umgebenden Felds. Bei umgekehrter Geocodierung ist dies immer gleich Position. |
|
Entry |
Der Einstiegspunkt für den poi, der zurückgegeben wird. |
|
Entry |
Der Typ des Einstiegspunkts. Der Wert kann entweder Haupt- oder nebensein. |
|
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
|
Error |
Das Fehlerdetails. |
|
Error |
Fehlerantwort |
|
Geographic |
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. |
|
Lat |
Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird. |
|
Localized |
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. |
|
Match |
Übereinstimmungstypen für einen Suchvorgang für umgekehrte Adressen. |
|
Operating |
Öffnungszeiten für einen POI (Interessante Punkte). |
|
Operating |
Betriebsstunden für einen POI (Interessante Punkte). Die Verfügbarkeit der Betriebsstunden variiert je nach verfügbaren Daten. Wenn sie nicht bestanden ist, werden keine Öffnungszeiteninformationen zurückgegeben. Unterstützter Wert: nextSevenDays |
|
Operating |
Stellt ein Datum und eine Uhrzeit dar. |
|
Operating |
Öffnungszeitbereich für einen Tag |
|
Point |
Details zu den zurückgegebenen POI, einschließlich Informationen wie Name, Telefon, URL-Adresse und Klassifizierungen. |
|
Point |
POI-Kategorie |
|
Point |
Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollen. Verfügbare Indizes sind: POI = Interessante Punkte Der Wert sollte POI- oder Keine sein, um erweiterte Postleitzahlen zu deaktivieren. Standardmäßig sind erweiterte Postleitzahlen enthalten. Anwendungsbeispiele: extendedPostalCodesFor=POI extendedPostalCodesFor=None Erweiterte Postleitzahl wird als extendedPostalCode Eigenschaft einer Adresse zurückgegeben. Verfügbarkeit ist regionsabhängig. |
|
Query |
Der Typ der zurückgegebenen Abfrage: NEARBY oder NON_NEAR. Wichtig: Diese Eigenschaft ist veraltet und kann in der Antwort ausgelassen werden. |
|
Response |
Gewünschtes Format der Antwort. Der Wert kann entweder JSON- oder XML-sein. |
|
Search |
Dieses Objekt wird von erfolgreichen Suchaufrufen zurückgegeben. |
|
Search |
Result-Objekt für eine Such-API-Antwort. |
|
Search |
Enthält einen der folgenden Werte:
|
|
Search |
Summary-Objekt für eine Such-API-Antwort. |
Address
Die Adresse des Ergebnisses.
| Name | Typ | Beschreibung |
|---|---|---|
| boundingBox |
Definiert den Begrenzungsrahmen für die Position. Diese Eigenschaft wird nur von den Search Address Reverse-APIs zurückgegeben. Alle anderen Such-APIs geben die |
|
| buildingNumber |
string |
Die Gebäudenummer auf der Straße.
Wichtig: Diese Eigenschaft ist veraltet. Verwenden Sie stattdessen |
| country |
string |
Der Name des Landes/der Region. |
| countryCode |
string |
Ein zweibuchstabiger alphabetischer Code, definiert durch den ISO 3166-1 Alpha-2-Standard, um ein Land/eine Region und abhängige Gebiete darzustellen. |
| countryCodeISO3 |
string |
Ein dreibuchstabiger alphabetischer Code, definiert durch den ISO 3166-1 Alpha-3-Standard, um ein Land/eine Region und abhängige Gebiete darzustellen. |
| countrySecondarySubdivision |
string |
Die Verwaltungseinteilung der zweiten Ebene innerhalb eines Landes/einer Region. Sie bezeichnet eine Unterteilung, die unterhalb der primären Unterteilung, wie Staat oder Provinz, liegt, aber über kleineren Einheiten wie Gemeinden oder Stadtvierteln. Beispiele sind County in den Vereinigten Staaten und District im Vereinigten Königreich. |
| countrySubdivision |
string |
Die primäre Verwaltungsgliederung innerhalb eines Landes, wie z. B. eines Bundesstaates oder einer Provinz. Er wird verwendet, um die Unterteilung der ersten Ebene unterhalb der nationalen Ebene darzustellen. |
| countrySubdivisionCode |
string |
Diese Eigenschaft ist in der |
| countrySubdivisionName |
string |
Stellt den vollständigen Namen der Verwaltungseinheit der ersten Ebene (wie Staat, Provinz oder Region) innerhalb eines Landes oder einer Region dar. Diese Eigenschaft ist nur dann enthalten, wenn der |
| countryTertiarySubdivision |
string |
Die dritte Verwaltungseinteilung innerhalb eines Landes/einer Region. Sie bietet noch feinere Granularität als die sekundäre Unterteilung (wie County oder District). Beispiele sind Gemeinden wie eine Stadt, Gemeinde, ein Dorf, ein Borough oder eine Gemeinde sowie Stadtteile eines kleineren, informellen geografischen Gebiets innerhalb einer Gemeinde wie Capitol Hill, Green Lake und Wallingford in Seattle. |
| crossStreet |
string |
Der Name der Straße, die durchquert wird. Diese Eigenschaft ist nur in der |
| extendedPostalCode |
string |
Eine erweiterte Postleitzahl bezeichnet ein Postleitzahlenformat, das über den Standardsatz an Ziffern hinausgeht, um eine höhere Standortgenauigkeit zu gewährleisten. Es wird häufig in Systemen wie dem U.S. ZIP+4-Code oder ähnlichen erweiterten Formaten in anderen Ländern/Regionen verwendet. Die Verfügbarkeit hängt von der Region ab. Nicht in der |
| freeformAddress |
string |
Eine Adresszeile, die gemäß den Formatierungsregeln des Landes/der Herkunftsregion eines Ergebnisses formatiert ist oder im Fall eines Landes/Regionals, des vollständigen Land-/Regionsnamens. |
| 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 |
| municipality |
string |
Stadt / Stadt |
| municipalitySubdivision |
string |
Eine Siedlung innerhalb einer Gemeinde. Sie stellt eine kleinere administrative oder geografische Einheit innerhalb einer Stadt, Gemeinde oder einer anderen kommunalen Einheit dar. |
| neighbourhood |
string |
Ein Viertel ist ein geografisch lokalisiertes Gebiet innerhalb einer Stadt oder Stadt mit unverwechselbaren Merkmalen und sozialen Interaktionen zwischen Einwohnern. |
| postalCode |
string |
Eine Reihe von Zahlen oder Buchstaben (oder beides), die einer Adresse hinzugefügt werden, um ein bestimmtes geografisches Gebiet zu identifizieren. Eine Postleitzahl ist die US-Version einer Postleitzahl, andere Länder/Regionen verwenden andere Formate wie Postleitzahl, PIN-Code und PLZ. |
| routeNumbers |
string[] |
Die Codes wurden verwendet, um die Straße eindeutig zu kennzeichnen. Nur für die Search Address Reverse APIs verfügbar. |
| street |
string |
Der Straßenname.
Wichtig: Diese Eigenschaft ist veraltet. Verwenden Sie stattdessen |
| streetName |
string |
Der Straßenname. |
| streetNameAndNumber |
string |
Der Straßenname und die Nummer. Nur für die Search Address Reverse APIs verfügbar. |
| streetNumber |
string |
Die Gebäudenummer auf der Straße. Nicht in der |
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.
| Name | Typ | Beschreibung |
|---|---|---|
| from |
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 |
Ein Ort, der als Breiten- und Längengrad mit 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 |
Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird. |
|
| topLeftPoint |
Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird. |
BoundingBoxCompassNotation
Das umgebende Feld der Position.
| Name | Typ | Beschreibung |
|---|---|---|
| entity |
Entitätstypquelle des umgebenden Felds. Bei umgekehrter Geocodierung ist dies immer gleich Position. |
|
| northEast |
string |
Nordöstlicher Breitengrad, Längengradkoordinate des Begrenzungsrahmens als kommagetrennte Gleitkommazahlen |
| southWest |
string |
Süd-West-Breitengrad,Längengradkoordinate des Begrenzungsfelds 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 |
Code-Eigenschaft |
| names |
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 |
Informationen zur geometrischen Form des Ergebnisses. Nur vorhanden, wenn Typ == Geografie. |
ElectricVehicleConnector
Eine durch Trennzeichen getrennte Liste von Verbindertypen, die verwendet werden können, um das Ergebnis auf die Elektrofahrzeugstation zu beschränken, die bestimmte Verbindertypen unterstützt. Artikelbestellung spielt keine Rolle. Wenn mehrere Verbindertypen bereitgestellt werden, werden nur Ergebnisse zurückgegeben, die (mindestens) einer der bereitgestellten Listen angehören.
Verfügbare Connectortypen sind:
-
StandardHouseholdCountrySpecific- Dies sind die Standard-Haushaltsverbindungen für eine bestimmte Region. Sie sind alle AC-Einzelphasen und die Standardspannung und Standard-Amperage. Siehe auch: Plug & Sockettypen - World Standards. -
IEC62196Type1– Typ 1-Verbinder gemäß der IEC 62196-2-Norm. Auch yazaki nach dem ursprünglichen Hersteller oder SAE J1772 nach dem Standard genannt, der es erstmals veröffentlicht hat. Wird meist in Kombination mit einer 120V-Einzelphasen- oder bis zu 240V-Einzelphaseninfrastruktur verwendet. -
IEC62196Type1CCS– Typ 1-basierter Kombinationsanschluss gemäß der Definition im IEC 62196-3-Standard. Der Verbinder basiert auf dem Typ 1-Verbinder – wie im IEC 62196-2-Standard definiert – mit zwei zusätzlichen Direktstromkontakten (DC), um dc schnelles Aufladen zu ermöglichen. -
IEC62196Type2CableAttached– Typ 2-Verbinder gemäß der IEC 62196-2-Norm. Bereitgestellt als Kabel und Stecker an der Ladestelle angeschlossen. -
IEC62196Type2Outlet– Typ 2-Verbinder gemäß der IEC 62196-2-Norm. Bereitgestellt als Steckdose in den Ladepunkt. -
IEC62196Type2CCS– Typ 2-basierter Kombinationsanschluss gemäß der Definition im IEC 62196-3-Standard. Der Verbinder basiert auf dem Typ 2-Verbinder – wie im IEC 62196-2-Standard definiert – mit zwei zusätzlichen Direktstromkontakten (DC), um dc schnelles Aufladen zu ermöglichen. -
IEC62196Type3– Typ 3-Verbinder gemäß der IEC 62196-2-Norm. Auch als Scame nach dem ursprünglichen Hersteller bezeichnet. Wird meist in Kombination mit bis zu 240V Einzelphasen oder bis zu 420V Dreiphaseninfrastruktur verwendet. -
Chademo- CHAdeMO Connector benannt nach einer Vereinigung, die von der Tokyo Electric Power Company und Industriepartner gegründet wurde. Aus diesem Grund wird auch als TEPCO-Verbinder bezeichnet. Es unterstützt schnelle DC-Ladevorgänge. -
IEC60309AC1PhaseBlue- Industrial Blue Connector ist ein Verbinder, der im IEC 60309-Standard definiert ist. Es wird irgendwann als eine Kombination des Standards, der Farbe und der Tatsache bezeichnet, dass es sich um einen einzelnen Phasenkonnektor handelt. Der Verbinder verfügt in der Regel über die Konfiguration "P+N+E, 6h". -
IEC60309DCWhite- Industrial White Connector ist ein DC-Verbinder, der im IEC 60309-Standard definiert ist. -
Tesla- Der Tesla Connector ist der regional spezifische Tesla Supercharger Connector. D.h. es bezieht sich entweder auf Teslas proprietären Verbinder, manchmal auch als Tesla Port meist auf Nordamerika beschränkt oder der modifizierte Typ 2 (DC over Type 2) in Europa.
Anwendungsbeispiele:
connectorSet=IEC62196Typ2KabelAngeschlossener SteckverbinderSet=IEC62196Typ2Outlet,IEC62196Typ2CableAttached
| Wert | Beschreibung |
|---|---|
| StandardHouseholdCountrySpecific |
Dies sind die standardhaushaltsverbinder für eine bestimmte Region. Sie sind alle AC-Einzelphasen und die Standardspannung und Standard-Amperage. Siehe auch: Plug & Sockettypen - World Standards |
| IEC62196Type1 |
Typ 1-Verbinder gemäß der Definition im IEC 62196-2-Standard. Auch yazaki nach dem ursprünglichen Hersteller oder SAE J1772 nach dem Standard genannt, der es erstmals veröffentlicht hat. Wird meist in Kombination mit einer 120V-Einzelphasen- oder bis zu 240V-Einzelphaseninfrastruktur verwendet. |
| IEC62196Type1CCS |
Typ 1-basierter Kombinationskonnektor gemäß der Definition im IEC 62196-3-Standard. Der Verbinder basiert auf dem Typ 1-Verbinder – wie im IEC 62196-2-Standard definiert – mit zwei zusätzlichen Direktstromkontakten (DC), um dc schnelles Aufladen zu ermöglichen. |
| IEC62196Type2CableAttached |
Typ 2-Verbinder gemäß definition in der IEC 62196-2-Norm. Bereitgestellt als Kabel und Stecker an der Ladestelle |
| IEC62196Type2Outlet |
Typ 2-Verbinder gemäß definition in der IEC 62196-2-Norm. Bereitgestellt als Steckdose in den Ladepunkt. |
| IEC62196Type2CCS |
Typ 2-basierter Kombinationskonnektor gemäß der Definition im IEC 62196-3-Standard. Der Verbinder basiert auf dem Typ 2-Verbinder – wie im IEC 62196-2-Standard definiert – mit zwei zusätzlichen Direktstromkontakten (DC), um dc schnelles Aufladen zu ermöglichen. |
| IEC62196Type3 |
Typ 3-Verbinder gemäß definition in der IEC 62196-2-Norm. Auch als Scame nach dem ursprünglichen Hersteller bezeichnet. Wird meist in Kombination mit bis zu 240V Einzelphasen oder bis zu 420V Dreiphaseninfrastruktur verwendet. |
| Chademo |
CHAdeMO Connector benannt nach einer Vereinigung, die von der Tokyo Electric Power Company und Industriepartnern gebildet wurde. Aus diesem Grund wird auch als TEPCO-Verbinder bezeichnet. Es unterstützt schnelle DC-Ladevorgänge. |
| IEC60309AC1PhaseBlue |
Der Industrial Blue Steckverbinder ist ein Steckverbinder, der in der Norm IEC 60309 definiert ist. Es wird irgendwann als eine Kombination des Standards, der Farbe und der Tatsache bezeichnet, dass es sich um einen einzelnen Phasenkonnektor handelt. Der Verbinder verfügt in der Regel über die Konfiguration "P+N+E, 6h". |
| IEC60309DCWhite |
Industrial White Connector ist ein DC-Verbinder, der im IEC 60309-Standard definiert ist. |
| Tesla |
Der Tesla Connector ist der regional spezifische Tesla Supercharger Connector. D.h. es bezieht sich entweder auf Teslas proprietären Verbinder, manchmal auch als Tesla Port meist auf Nordamerika beschränkt oder der modifizierte Typ 2 (DC over Type 2) in Europa. |
Entity
Entitätstypquelle des umgebenden Felds. Bei umgekehrter Geocodierung ist dies immer gleich Position.
| Wert | Beschreibung |
|---|---|
| position |
Positionsentität |
EntryPoint
Der Einstiegspunkt für den poi, der zurückgegeben wird.
| Name | Typ | Beschreibung |
|---|---|---|
| position |
Ein Ort, der als Breiten- und Längengrad mit kurznamen "lat" & "lon" dargestellt wird. |
|
| type |
Der Typ des Einstiegspunkts. Der Wert kann entweder Haupt- oder nebensein. |
EntryPointType
Der Typ des Einstiegspunkts. Der Wert kann entweder Haupt- oder nebensein.
| Wert | Beschreibung |
|---|---|
| main | |
| minor |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
| Name | Typ | Beschreibung |
|---|---|---|
| info |
object |
Die zusätzlichen Informationen. |
| type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |
GeographicEntityType
Entitätstyp "Geographie". Nur vorhanden, wenn entityType angefordert wurde und verfügbar ist.
| Wert | Beschreibung |
|---|---|
| Country |
Name des Landes/der Region |
| CountrySubdivision |
Bundesland oder Provinz |
| CountrySecondarySubdivision |
Bezirk |
| CountryTertiarySubdivision |
Benannter Bereich |
| Municipality |
Stadt / Stadt |
| MunicipalitySubdivision |
U-Boot / Super Stadt |
| Neighbourhood |
Nachbarschaft |
| PostalCodeArea |
Postleitzahl / Postleitzahl |
Geometry
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
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
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) |
| 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) |
| US |
Vereinigte Staaten von Amerika |
| YE |
Jemen (Arabische Ansicht) |
| Auto |
Geben Sie die Kartendaten basierend auf der IP-Adresse der Anforderung zurück. |
| Unified |
Einheitliche Ansicht (andere) |
MatchType
Übereinstimmungstypen für einen Suchvorgang für umgekehrte Adressen.
| Wert | Beschreibung |
|---|---|
| AddressPoint | |
| HouseNumberRange | |
| Street |
OperatingHours
Öffnungszeiten für einen POI (Interessante Punkte).
| Name | Typ | Beschreibung |
|---|---|---|
| mode |
string |
In der Anforderung verwendeter Wert: none oder "nextSevenDays" |
| timeRanges |
Liste der Zeitbereiche für die nächsten 7 Tage |
OperatingHoursRange
Betriebsstunden für einen POI (Interessante Punkte). Die Verfügbarkeit der Betriebsstunden variiert je nach verfügbaren Daten. Wenn sie nicht bestanden ist, werden keine Öffnungszeiteninformationen zurückgegeben. Unterstützter Wert: nextSevenDays
| Wert | Beschreibung |
|---|---|
| nextSevenDays |
Zeigt die Betriebsstunden 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 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
Öffnungszeitbereich für einen Tag
| Name | Typ | Beschreibung |
|---|---|---|
| endTime |
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 |
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
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 |
Die Liste der spezifischsten POI-Kategorien |
|
| classifications |
Klassifizierungsarray |
|
| name |
string |
Name der POI-Eigenschaft |
| openingHours |
Öffnungszeiten für einen POI (Interessante Punkte). |
|
| phone |
string |
Telefonnummerneigenschaft |
| url |
string |
Website-URL-Eigenschaft |
PointOfInterestCategorySet
POI-Kategorie
| Name | Typ | Beschreibung |
|---|---|---|
| id |
integer |
Kategorie-ID |
PointOfInterestExtendedPostalCodes
Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollen.
Verfügbare Indizes sind:
POI = Interessante Punkte
Der Wert sollte POI- oder Keine sein, um erweiterte Postleitzahlen zu deaktivieren.
Standardmäßig sind erweiterte Postleitzahlen enthalten.
Anwendungsbeispiele:
extendedPostalCodesFor=POI
extendedPostalCodesFor=None
Erweiterte Postleitzahl wird als extendedPostalCode Eigenschaft einer Adresse zurückgegeben. Verfügbarkeit ist regionsabhängig.
| Wert | Beschreibung |
|---|---|
| POI | |
| None |
QueryType
Der Typ der zurückgegebenen Abfrage: NEARBY oder NON_NEAR.
Wichtig: Diese Eigenschaft ist veraltet und kann in der Antwort ausgelassen werden.
| 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
Gewünschtes Format der Antwort. Der Wert kann entweder JSON- oder XML-sein.
| Wert | Beschreibung |
|---|---|
| json | |
| xml |
SearchAddressResult
Dieses Objekt wird von erfolgreichen Suchaufrufen zurückgegeben.
| Name | Typ | Beschreibung |
|---|---|---|
| results |
Eine Liste der Suchergebnisse der Such-API. |
|
| summary |
Zusammenfassungsobjekt für eine Such-API-Antwort |
SearchAddressResultItem
Result-Objekt für eine Such-API-Antwort.
| Name | Typ | 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. |
|
| 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 |
Entitätstyp "Geographie". Nur vorhanden, wenn entityType angefordert wurde und verfügbar ist. |
|
| entryPoints |
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 |
Informationen zum Übereinstimmungstyp. Enthält einen der folgenden Werte:
|
|
| poi |
Details zu den zurückgegebenen POI, einschließlich Informationen wie Name, Telefon, URL-Adresse und Klassifizierungen. |
|
| position |
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. Wichtig: Diese Eigenschaft ist veraltet und kann in der Antwort ausgelassen werden. |
| type |
Enthält einen der folgenden Werte:
|
|
| viewport |
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
- Geografie
- Punktadresse
- Adressbereich
- Querstraße
| Wert | Beschreibung |
|---|---|
| POI | |
| Street | |
| Geography | |
| Point Address | |
| Address Range | |
| Cross Street |
SearchSummary
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 |
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 |
Der Typ der zurückgegebenen Abfrage: NEARBY oder NON_NEAR. Wichtig: Diese Eigenschaft ist veraltet und kann in der Antwort ausgelassen werden. |
|
| totalResults |
integer |
Die Gesamtanzahl der gefundenen Ergebnisse. |