Search - Post Search Inside Geometry
Wird verwendet, um freie Formularsuchen innerhalb einer weiteren Geometrie durchzuführen.
Bei der Post Search Inside Geometry API handelt es sich um eine HTTP-Anforderung POST , mit der Sie eine Freiformsuche innerhalb einer einzelnen Geometrie oder mehrerer Geometrien durchführen können. Die Suchergebnisse, die innerhalb der Geometrie(n) liegen, werden zurückgegeben.
Um die Geometrie zu senden, verwenden Sie eine POST-Anforderung, bei der der Anforderungstext das Objekt enthält, das geometry als GeoJSON dargestellt wird, und der Content-Type-Header auf application/json festgelegt wird. Die zu durchsuchenden geographischen Features können als Polygon- und/oder Kreisgeometrien modelliert werden, die mit einem der folgenden GeoJSON-Typen dargestellt werden:
-
GeoJSON FeatureCollection
Dasgeometrykann als GeoJSON-ObjektFeatureCollectiondargestellt werden. Diese Option wird empfohlen, wenn die Geometrie sowohl Polygone als auch Kreise enthält. SieFeatureCollectionkönnen bis zu 50 GeoJSON-ObjekteFeatureenthalten. JedesFeatureObjekt sollte entweder ein Polygon oder einen Kreis mit den folgenden Bedingungen darstellen:- Ein
FeatureObjekt für die Polygon-Geometrie kann bis zu 50 Koordinaten haben, und seine Eigenschaften müssen leer sein. - Ein
FeatureObjekt für die Kreisgeometrie besteht aus einem Mittelpunkt , der mit einem GeoJSON-TypPointdargestellt wird, und einem Radiuswert (in Metern), der in den Eigenschaften des Objekts zusammen mit der subType-Eigenschaft angegeben werden muss, deren Wert "Kreis" sein sollte.
In den Beispielen finden Sie eine BeispieldarstellungFeatureCollection. - Ein
-
GeoJSON GeometryCollection
Dasgeometrykann als GeoJSON-ObjektGeometryCollectiondargestellt werden. Diese Option wird empfohlen, wenn die Geometrie nur eine Liste von Polygonen enthält. SieGeometryCollectionkönnen bis zu 50 GeoJSON-ObjektePolygonenthalten. JedesPolygonObjekt kann bis zu 50 Koordinaten haben. In den Beispielen finden Sie eine BeispieldarstellungGeometryCollection. -
GeoJSON-Polygon
Dasgeometrykann als GeoJSON-ObjektPolygondargestellt werden. Dies ist die empfohlene Option, wenn die Geometrie ein einzelnes Polygon enthält. DasPolygonObjekt kann bis zu 50 Koordinaten haben. In den Beispielen finden Sie eine BeispieldarstellungPolygon.
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}&limit={limit}&language={language}&categorySet={categorySet}&extendedPostalCodesFor={extendedPostalCodesFor}&idxSet={idxSet}&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", "pizza"). Muss ordnungsgemäß URL-codiert sein. |
|
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
|
|
|
extended
|
query |
Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollen. Verfügbare Indizes sind: Addr = Adressbereiche Geo- = Regionen PAD = Punktadressen POI = Interessante Punkte Str = Straßen XStr = Cross Street (Kreuzungen) Der Wert sollte eine durch Trennzeichen getrennte Liste von Indextypen (in beliebiger Reihenfolge) oder None ohne Indizes sein. Standardmäßig sind erweiterte Postleitzahlen für alle Indizes mit Ausnahme von Geo enthalten. Erweiterte Postleitzahlenlisten für Regionen können recht lang sein, sodass sie bei Bedarf explizit angefordert werden müssen. Anwendungsbeispiele: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Adresse,POI extendedPostalCodesFor=Keine Erweiterte Postleitzahl wird als extendedPostalCode Eigenschaft einer Adresse zurückgegeben. Verfügbarkeit ist regionsabhängig. |
||
|
idx
|
query |
Eine durch Trennzeichen getrennte Liste von Indizes, die für die Suche verwendet werden sollen. Artikelbestellung spielt keine Rolle. Verfügbare Indizes sind: Addr = Adressbereich Interpolation, Geo = Geographie, PAD = Punktadressen, POI = Interessante Punkte, Str = Straßen, Xstr = Straßen (Kreuzungen) |
||
|
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. |
|
|
limit
|
query |
integer minimum: 1maximum: 100 |
Maximale Anzahl von Antworten, die zurückgegeben werden. Standard: 10, Minimum: 1 und maximal: 100 |
|
|
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 |
||
|
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. |
Anforderungstext
| Name | Typ | Beschreibung |
|---|---|---|
| geometry | GeoJsonObject: |
Ein gültiges |
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 burger joints inside a geometry represented as a GeoJSON GeometryCollection type
Beispielanforderung
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=burger&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
-122.43576049804686,
37.7524152343544
],
[
-122.43301391601562,
37.70660472542312
],
[
-122.36434936523438,
37.712059855877314
],
[
-122.43576049804686,
37.7524152343544
]
]
]
},
{
"type": "Polygon",
"coordinates": [
[
[
-123.43576049804686,
37.7524152343544
],
[
-123.43301391601562,
37.70660472542312
],
[
-123.36434936523438,
37.712059855877314
],
[
-123.43576049804686,
37.7524152343544
]
]
]
}
]
}
}
Beispiel für eine Antwort
{
"summary": {
"query": "burger",
"queryType": "NON_NEAR",
"queryTime": 21,
"numResults": 2,
"offset": 0,
"totalResults": 4,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "9P2i9inRyndAA-_V40J8oA",
"score": 2.0041828156,
"info": "search:ta:840061003419653-US",
"poi": {
"name": "Burger Joint",
"phone": "+1 415-349-4331",
"categorySet": [
{
"id": 7315015
}
],
"categories": [
"fast food",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "fast food"
}
]
}
]
},
"address": {
"streetNumber": "167",
"streetName": "Leland Avenue",
"municipality": "San Francisco",
"neighbourhood": "Visitacion Valley",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-2844",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.712228,
"lon": -122.407022
},
"viewport": {
"topLeftPoint": {
"lat": 37.71313,
"lon": -122.40816
},
"btmRightPoint": {
"lat": 37.71133,
"lon": -122.40589
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.71241,
"lon": -122.40693
}
}
]
},
{
"type": "POI",
"id": "hkr-N07YS6Gv2dOciQ9lwA",
"score": 2.0041515827,
"info": "search:ta:840067000526682-US",
"poi": {
"name": "Sound of Burgers",
"categorySet": [
{
"id": 7315
}
],
"categories": [
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "167",
"streetName": "Leland Avenue",
"municipality": "San Francisco",
"neighbourhood": "Visitacion Valley",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivision": "CA",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-2844",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.712228,
"lon": -122.407022
},
"viewport": {
"topLeftPoint": {
"lat": 37.71313,
"lon": -122.40816
},
"btmRightPoint": {
"lat": 37.71133,
"lon": -122.40589
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.71241,
"lon": -122.40693
}
}
]
}
]
}
Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type
Beispielanforderung
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.143035,
47.653536
],
[
-122.187164,
47.617556
],
[
-122.114981,
47.570599
],
[
-122.132756,
47.654009
],
[
-122.143035,
47.653536
]
]
]
},
"properties": {}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.126986,
47.639754
]
},
"properties": {
"subType": "Circle",
"radius": 100
}
}
]
}
}
Beispiel für eine Antwort
{
"summary": {
"query": "pizza",
"queryType": "NON_NEAR",
"queryTime": 34,
"numResults": 2,
"offset": 0,
"totalResults": 21,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "-UuwTye4GGsea4KmCLvoqQ",
"score": 2.1455535889,
"info": "search:ta:840537000108972-US",
"poi": {
"name": "Biryani & Pizza House",
"categorySet": [
{
"id": 7315036
}
],
"categories": [
"pizza",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "pizza"
}
]
}
]
},
"address": {
"streetNumber": "15025",
"streetName": "Northeast 24th Street",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countrySubdivision": "WA",
"countrySubdivisionName": "Washington",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "98052-5531",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15025 Northeast 24th Street, Redmond, WA 98052",
"localName": "Redmond"
},
"position": {
"lat": 47.630786,
"lon": -122.139302
},
"viewport": {
"topLeftPoint": {
"lat": 47.63169,
"lon": -122.14064
},
"btmRightPoint": {
"lat": 47.62989,
"lon": -122.13797
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63079,
"lon": -122.13931
}
},
{
"type": "main",
"position": {
"lat": 47.63147,
"lon": -122.13935
}
}
]
},
{
"type": "POI",
"id": "7r095LCcCSkdoGoeLcnvsQ",
"score": 2.1454992294,
"info": "search:ta:840537000103468-US",
"poi": {
"name": "Pagliacci Pizza",
"categorySet": [
{
"id": 7315036
}
],
"url": "www.pagliacci.com/",
"categories": [
"pizza",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "pizza"
}
]
}
],
"openingHours": {
"mode": "nextSevenDays",
"timeRanges": [
{
"startTime": {
"date": "2024-03-14",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-14",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-17",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-17",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-18",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-18",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-19",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-19",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-20",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-20",
"hour": 11,
"minute": 0
}
}
]
}
},
"address": {
"streetNumber": "15238",
"streetName": "Bel Red Road",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countrySubdivision": "WA",
"countrySubdivisionName": "Washington",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"extendedPostalCode": "98007-3815",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15238 Bel Red Road, Bellevue, WA 98007",
"localName": "Bellevue"
},
"position": {
"lat": 47.628008,
"lon": -122.13646
},
"viewport": {
"topLeftPoint": {
"lat": 47.62891,
"lon": -122.13779
},
"btmRightPoint": {
"lat": 47.62711,
"lon": -122.13513
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6283,
"lon": -122.13611
}
}
]
}
]
}
Search for subs joints inside a geometry represented as a GeoJSON Polygon type
Beispielanforderung
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=subs&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.43576049804686,
37.7524152343544
],
[
-122.43301391601562,
37.70660472542312
],
[
-122.36434936523438,
37.712059855877314
],
[
-122.43576049804686,
37.7524152343544
]
]
]
}
}
Beispiel für eine Antwort
{
"summary": {
"query": "subs",
"queryType": "NON_NEAR",
"queryTime": 42,
"numResults": 2,
"offset": 0,
"totalResults": 5,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "HOIWGiNwVv0z6bF8MO3EbA",
"score": 2.1455111504,
"info": "search:ta:840069009512242-US",
"poi": {
"name": "Adams Grub Truck",
"phone": "+1 415-307-8844",
"categorySet": [
{
"id": 7315042
}
],
"categories": [
"restaurant",
"sandwich"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "sandwich"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "1465",
"streetName": "Carroll Avenue",
"municipality": "San Francisco",
"neighbourhood": "Bayview",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94124",
"extendedPostalCode": "94124-3604",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1465 Carroll Avenue, San Francisco, CA 94124",
"localName": "San Francisco"
},
"position": {
"lat": 37.72328,
"lon": -122.39091
},
"viewport": {
"topLeftPoint": {
"lat": 37.72418,
"lon": -122.39205
},
"btmRightPoint": {
"lat": 37.72238,
"lon": -122.38977
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.72348,
"lon": -122.39073
}
}
]
},
{
"type": "POI",
"id": "bXbc0QxTRlkSo8GnU7EU-Q",
"score": 2.1454677582,
"info": "search:ta:840061001992959-US",
"poi": {
"name": "SUBWAY San Francisco San Francisco",
"phone": "+1 415-657-9898",
"brands": [
{
"name": "SUBWAY"
}
],
"categorySet": [
{
"id": 7315042
}
],
"categories": [
"restaurant",
"sandwich"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "sandwich"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
],
"openingHours": {
"mode": "nextSevenDays",
"timeRanges": [
{
"startTime": {
"date": "2024-03-13",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-13",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-14",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-14",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-15",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-15",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-16",
"hour": 9,
"minute": 0
},
"endTime": {
"date": "2024-03-16",
"hour": 21,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-17",
"hour": 9,
"minute": 0
},
"endTime": {
"date": "2024-03-17",
"hour": 21,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-18",
"hour": 8,
"minute": 0
},
"endTime": {
"date": "2024-03-18",
"hour": 20,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-19",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-19",
"hour": 21,
"minute": 30
}
}
]
}
},
"address": {
"streetNumber": "2599",
"streetName": "San Bruno Avenue",
"municipality": "San Francisco",
"neighbourhood": "Portola",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivision": "CA",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-1504",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "2599 San Bruno Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.729004,
"lon": -122.403956
},
"viewport": {
"topLeftPoint": {
"lat": 37.7299,
"lon": -122.40509
},
"btmRightPoint": {
"lat": 37.7281,
"lon": -122.40282
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.72892,
"lon": -122.40414
}
}
]
}
]
}
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. |
| 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. |
|
Geo |
Ein gültiger |
|
Geo |
Ein gültiger |
|
Geo |
Ein gültiges |
|
Geo |
Ein gültiger |
|
Geo |
Ein gültiger |
|
Geo |
Ein gültiger |
|
Geo |
Ein gültiger |
|
Geo |
Ein gültiger |
|
Geo |
Ein gültiger |
|
Geo |
Ein gültiger |
| 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 |
|
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 |
Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollen. Verfügbare Indizes sind: Addr = Adressbereiche Geo- = Regionen PAD = Punktadressen POI = Interessante Punkte Str = Straßen XStr = Cross Street (Kreuzungen) Der Wert sollte eine durch Trennzeichen getrennte Liste von Indextypen (in beliebiger Reihenfolge) oder None ohne Indizes sein. Standardmäßig sind erweiterte Postleitzahlen für alle Indizes mit Ausnahme von Geo enthalten. Erweiterte Postleitzahlenlisten für Regionen können recht lang sein, sodass sie bei Bedarf explizit angefordert werden müssen. Anwendungsbeispiele: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Adresse,POI extendedPostalCodesFor=Keine Erweiterte Postleitzahl wird als extendedPostalCode Eigenschaft einer Adresse zurückgegeben. Verfügbarkeit ist regionsabhängig. |
|
Search |
Dieser Typ stellt den Anforderungstext für den Such-Inside Geometry-Dienst dar. |
|
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. |
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 |
GeoJsonFeature
Ein gültiger GeoJSON Feature Objekttyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| featureType |
string |
Der Typ des Features. Der Wert hängt vom Datenmodell ab, zu dem das aktuelle Feature gehört. Einige Datenmodelle weisen möglicherweise einen leeren Wert auf. |
| geometry | GeoJsonGeometry: |
Ein gültiges |
| id |
string |
Bezeichner für das Feature. |
| type |
string:
Feature |
Gibt den |
GeoJsonFeatureCollection
Ein gültiger GeoJSON FeatureCollection Objekttyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| features |
Enthält eine Liste gültiger |
|
| type |
string:
Feature |
Gibt den |
GeoJsonGeometry
Ein gültiges GeoJSON Geometry-Objekt. Der Typ muss einer der sieben gültigen GeoJSON-Geometrietypen sein : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon und GeometryCollection. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| type |
Geo |
Gibt den |
GeoJsonGeometryCollection
Ein gültiger GeoJSON GeometryCollection Objekttyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| geometries | GeoJsonGeometry[]: |
Enthält eine Liste gültiger |
| type |
string:
Geometry |
Gibt den |
GeoJsonLineString
Ein gültiger GeoJSON LineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| coordinates |
number[] (double) |
Koordinaten für die |
| type |
string:
Line |
Gibt den |
GeoJsonMultiLineString
Ein gültiger GeoJSON MultiLineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| coordinates |
number[] (double) |
Koordinaten für die |
| type |
string:
Multi |
Gibt den |
GeoJsonMultiPoint
Ein gültiger GeoJSON MultiPoint Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| coordinates |
number[] (double) |
Koordinaten für die |
| type |
string:
Multi |
Gibt den |
GeoJsonMultiPolygon
Ein gültiger GeoJSON MultiPolygon Objekttyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| coordinates |
number[] (double) |
Enthält eine Liste gültiger |
| type |
string:
Multi |
Gibt den |
GeoJsonPoint
Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| coordinates |
number[] (double) |
Ein |
| type |
string:
Point |
Gibt den |
GeoJsonPolygon
Ein gültiger GeoJSON Polygon Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| coordinates |
number[] (double) |
Koordinaten für den geometrietyp |
| type |
string:
Polygon |
Gibt den |
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 |
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 |
SearchIndexes
Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollen.
Verfügbare Indizes sind:
Addr = Adressbereiche
Geo- = Regionen
PAD = Punktadressen
POI = Interessante Punkte
Str = Straßen
XStr = Cross Street (Kreuzungen)
Der Wert sollte eine durch Trennzeichen getrennte Liste von Indextypen (in beliebiger Reihenfolge) oder None ohne Indizes sein.
Standardmäßig sind erweiterte Postleitzahlen für alle Indizes mit Ausnahme von Geo enthalten. Erweiterte Postleitzahlenlisten für Regionen können recht lang sein, sodass sie bei Bedarf explizit angefordert werden müssen.
Anwendungsbeispiele:
extendedPostalCodesFor=POI
extendedPostalCodesFor=PAD,Adresse,POI
extendedPostalCodesFor=Keine
Erweiterte Postleitzahl wird als extendedPostalCode Eigenschaft einer Adresse zurückgegeben. Verfügbarkeit ist regionsabhängig.
| Wert | Beschreibung |
|---|---|
| Addr | |
| Geo | |
| PAD | |
| POI | |
| Str | |
| Xstr |
SearchInsideGeometryRequest
Dieser Typ stellt den Anforderungstext für den Such-Inside Geometry-Dienst dar.
| Name | Typ | Beschreibung |
|---|---|---|
| geometry | GeoJsonObject: |
Ein gültiges |
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. |