Delen via


Search - Post Search Inside Geometry

Gebruik dit om zoekopdrachten in vrije vorm uit te voeren in een nog eens een geometrie.

De Post Search Inside Geometry API is een HTTP-verzoek POST waarmee u een zoekopdracht in vrije vorm kunt uitvoeren binnen een enkele geometrie of meerdere geometrieën. De zoekresultaten die binnen de geometrie/geometrieën vallen, worden geretourneerd.

Om de geometrie te verzenden, gebruikt u een POST-verzoek waarbij de aanvraagbody het object bevat dat wordt geometry weergegeven als GeoJSON en de Content-Type-header wordt ingesteld op application/json. De geografische kenmerken waarnaar moet worden gezocht, kunnen worden gemodelleerd als polygoon- en/of cirkelgeometrieën die worden weergegeven met behulp van een van de volgende GeoJSON-typen:

  • GeoJSON-functiecollectie
    Het geometry kan worden weergegeven als een GeoJSON-object FeatureCollection . Dit is de aanbevolen optie als de geometrie zowel polygonen als cirkels bevat. Ze FeatureCollection kunnen maximaal 50 GeoJSON-objecten Feature bevatten. Elk Feature object moet een veelhoek of een cirkel vertegenwoordigen met de volgende voorwaarden:
    • Een Feature object voor de Polygoon-geometrie kan maximaal 50 coördinaten hebben en de eigenschappen moeten leeg zijn.
    • Een Feature object voor de cirkelgeometrie bestaat uit een centrum dat wordt weergegeven met behulp van een GeoJSON-type Point en een straalwaarde (in meters) die moet worden opgegeven in de eigenschappen van het object, samen met de eigenschap subType waarvan de waarde 'Cirkel' moet zijn.

    Zie de voorbeelden voor een voorbeeldweergave FeatureCollection .

  • GeoJSON Meetkunde Collectie
    Het geometry kan worden weergegeven als een GeoJSON-object GeometryCollection . Dit is de aanbevolen optie als de geometrie alleen een lijst met polygonen bevat. Ze GeometryCollection kunnen maximaal 50 GeoJSON-objecten Polygon bevatten. Elk Polygon object kan maximaal 50 coördinaten hebben. Zie de voorbeelden voor een voorbeeldweergave GeometryCollection .

  • GeoJSON-veelhoek
    Het geometry kan worden weergegeven als een GeoJSON-object Polygon . Dit is de aanbevolen optie als de geometrie een enkele veelhoek bevat. Het Polygon object kan maximaal 50 coördinaten hebben. Zie de voorbeelden voor een voorbeeldweergave Polygon .

.

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-parameters

Name In Vereist Type Description
format
path True

ResponseFormat

Gewenste indeling van het antwoord. De waarde kan json- of xml-zijn.

api-version
query True

string

Versienummer van Azure Maps-API.

query
query True

string

De POI-naam die moet worden gezocht (bijvoorbeeld "vrijheidsbeeld", "starbucks", "pizza"). Moet correct zijn gecodeerd met url's.

categorySet
query

integer[]

Een door komma's gescheiden lijst met categorieset-id's die kunnen worden gebruikt om het resultaat te beperken tot specifieke categorieën nuttige plaatsen. Id-volgorde maakt niet uit. Het maximum aantal categorySet waarden dat per aanvraag wordt ondersteund, is 10. Wanneer er meerdere categorie-id's worden opgegeven, worden alleen PO's geretourneerd die deel uitmaken van (ten minste) een van de categorieën uit de opgegeven lijst. De lijst met ondersteunde categorieën kan worden gedetecteerd met behulp van POI Categories API. Gebruiksvoorbeelden:

  • categorySet=7315 (Zoekpunten van categorie Restaurant)

  • categorySet=7315025.7315017 (Zoekpunten van de categorie Italiaans of Frans Restaurant)

extendedPostalCodesFor
query

SearchIndexes[]

Indexen waarvoor uitgebreide postcodes in de resultaten moeten worden opgenomen.

Beschikbare indexen zijn:

Addr = Adresbereiken

Geo- = Geografische gebieden

PAD = Puntadressen

POI = Nuttige plaatsen

Str = Straten

XStr = Kruisstraten (kruispunten)

De waarde moet een door komma's gescheiden lijst met indextypen (in willekeurige volgorde) of Geen voor geen indexen.

Uitgebreide postcodes zijn standaard opgenomen voor alle indexen behalve Geo. Uitgebreide postcodelijsten voor geografische gebieden kunnen behoorlijk lang zijn, zodat ze expliciet moeten worden aangevraagd wanneer dat nodig is.

Gebruiksvoorbeelden:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=Geen

Uitgebreide postcode wordt geretourneerd als een extendedPostalCode eigenschap van een adres. Beschikbaarheid is regioafhankelijk.

idxSet
query

SearchIndexes[]

Een door komma's gescheiden lijst met indexen die moeten worden gebruikt voor de zoekopdracht. Artikelvolgorde maakt niet uit. Beschikbare indexen zijn: Addr = Adresbereikinterpolatie, Geo = Geografische gebieden, PAD = Puntadressen, POI = Nuttige plaatsen, Str = Straten, Xstr = Kruisstraten (snijpunten)

language
query

string

Taal waarin zoekresultaten moeten worden geretourneerd. Moet een van de ondersteunde IETF-taaltags zijn, niet hoofdlettergevoelig. Wanneer gegevens in de opgegeven taal niet beschikbaar zijn voor een specifiek veld, wordt de standaardtaal gebruikt.

Raadpleeg ondersteunde talen voor meer informatie.

limit
query

integer

minimum: 1
maximum: 100

Maximum aantal antwoorden dat wordt geretourneerd. Standaard: 10, minimaal: 1 en maximum: 100

openingHours
query

OperatingHoursRange

Uren van gebruik voor een POI (nuttige plaatsen). De beschikbaarheid van de operationele uren varieert op basis van de beschikbare gegevens. Als dit niet wordt doorgegeven, worden er geen openingstijden geretourneerd. Ondersteunde waarde: nextSevenDays

view
query

LocalizedMapView

Met de parameter Weergave (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten weergeven voor een bepaald land/bepaalde regio voor geopolitieke betwiste regio's. Verschillende landen/regio's hebben verschillende weergaven van dergelijke regio's en met de parameter Weergave kan uw toepassing voldoen aan de weergave die vereist is voor het land/de regio die uw toepassing levert. Standaard is de weergaveparameter ingesteld op Unified, zelfs als u deze niet hebt gedefinieerd in de aanvraag. Het is uw verantwoordelijkheid om de locatie van uw gebruikers te bepalen en vervolgens de parameter Weergave correct in te stellen voor die locatie. U kunt ook 'View=Auto' instellen, waarmee de kaartgegevens worden geretourneerd op basis van het IP-adres van de aanvraag. De parameter View in Azure Maps moet worden gebruikt in overeenstemming met toepasselijke wetten, waaronder die met betrekking tot toewijzing, van het land/de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden die u gemachtigd bent om toegang te krijgen via Azure Maps beschikbaar worden gesteld. Voorbeeld: view=IN.

Raadpleeg ondersteunde weergaven voor meer informatie en om de beschikbare weergaven te bekijken.

Aanvraagkoptekst

Name Vereist Type Description
x-ms-client-id

string

Geeft het account aan dat bedoeld is voor gebruik met het Microsoft Entra ID-beveiligingsmodel. Deze unieke id voor het Azure Maps-account kan worden verkregen uit de account-API van het Azure Maps-beheervlak. Zie Verificatie beheren in Azure Maps voor meer informatie over het gebruik van Microsoft Entra ID-beveiliging in Azure Maps.

Aanvraagbody

Name Type Description
geometry GeoJsonObject:

Een geldig GeoJSON-object. Raadpleeg RFC 7946- voor meer informatie.

Antwoorden

Name Type Description
200 OK

SearchAddressResult

OK

Other Status Codes

ErrorResponse

Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0 Flows. Wanneer deze is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang aan te wijzen tot een of meer Azure Maps-resourceaccounts of subresources. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.

Notitie

  • Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Maps Management-API.
  • De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties.
  • Het op rollen gebaseerde toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
  • Gebruik van de Azure Maps Web SDK maakt configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.
  • Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u Een Azure Maps-account maken in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze worden uitgegeven.

Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type
Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type
Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Voorbeeldaanvraag

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
            ]
          ]
        ]
      }
    ]
  }
}

Voorbeeldrespons

{
  "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

Voorbeeldaanvraag

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
        }
      }
    ]
  }
}

Voorbeeldrespons

{
  "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

Voorbeeldaanvraag

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
        ]
      ]
    ]
  }
}

Voorbeeldrespons

{
  "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
          }
        }
      ]
    }
  ]
}

Definities

Name Description
Address

Het adres van het resultaat.

AddressRanges

Beschrijft het adresbereik aan beide zijden van de straat voor een zoekresultaat. Coördinaten voor de begin- en eindlocaties van het adresbereik worden opgenomen.

BoundingBox

De viewport die het resultaat bedekt dat wordt weergegeven door de coördinaten linksboven en rechtsonder van de viewport.

BoundingBoxCompassNotation

Het begrenzingsvak van de locatie.

Brand

Het merk dat is gekoppeld aan de POI

Classification

De classificatie voor de POI die wordt geretourneerd

ClassificationName

Naam voor de classificatie

DataSources

Optionele sectie. Referentie-id's voor gebruik met de Get Search Polygon API.

Entity

Bron van entiteitstype van het begrenzingsvak. Voor omgekeerde geocodering is dit altijd gelijk aan positie.

EntryPoint

Het ingangspunt voor de POI die wordt geretourneerd.

EntryPointType

Het type toegangspunt. De waarde kan hoofd- of kleinezijn.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

GeographicEntityType

Entiteitstype Geografie. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.

GeoJsonFeature

Een geldig GeoJSON Feature objecttype. Raadpleeg RFC 7946- voor meer informatie.

GeoJsonFeatureCollection

Een geldig GeoJSON FeatureCollection objecttype. Raadpleeg RFC 7946- voor meer informatie.

GeoJsonGeometry

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946- voor meer informatie.

GeoJsonGeometryCollection

Een geldig GeoJSON GeometryCollection objecttype. Raadpleeg RFC 7946- voor meer informatie.

GeoJsonLineString

Een geldig GeoJSON LineString geometrietype. Raadpleeg RFC 7946- voor meer informatie.

GeoJsonMultiLineString

Een geldig GeoJSON MultiLineString geometrietype. Raadpleeg RFC 7946- voor meer informatie.

GeoJsonMultiPoint

Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946- voor meer informatie.

GeoJsonMultiPolygon

Een geldig GeoJSON MultiPolygon objecttype. Raadpleeg RFC 7946- voor meer informatie.

GeoJsonPoint

Een geldig GeoJSON Point geometrietype. Raadpleeg RFC 7946- voor meer informatie.

GeoJsonPolygon

Een geldig GeoJSON Polygon geometrietype. Raadpleeg RFC 7946- voor meer informatie.

Geometry

Informatie over de geometrische vorm van het resultaat. Alleen aanwezig als type == Geografie.

LatLongPairAbbreviated

Een locatie die wordt weergegeven als breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

LocalizedMapView

Met de parameter Weergave (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten weergeven voor een bepaald land/bepaalde regio voor geopolitieke betwiste regio's. Verschillende landen/regio's hebben verschillende weergaven van dergelijke regio's en met de parameter Weergave kan uw toepassing voldoen aan de weergave die vereist is voor het land/de regio die uw toepassing levert. Standaard is de weergaveparameter ingesteld op Unified, zelfs als u deze niet hebt gedefinieerd in de aanvraag. Het is uw verantwoordelijkheid om de locatie van uw gebruikers te bepalen en vervolgens de parameter Weergave correct in te stellen voor die locatie. U kunt ook 'View=Auto' instellen, waarmee de kaartgegevens worden geretourneerd op basis van het IP-adres van de aanvraag. De parameter View in Azure Maps moet worden gebruikt in overeenstemming met toepasselijke wetten, waaronder die met betrekking tot toewijzing, van het land/de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden die u gemachtigd bent om toegang te krijgen via Azure Maps beschikbaar worden gesteld. Voorbeeld: view=IN.

Raadpleeg ondersteunde weergaven voor meer informatie en om de beschikbare weergaven te bekijken.

MatchType

Typen overeenkomsten voor een zoekbewerking voor omgekeerde adressen.

OperatingHours

Openingstijden voor een POI (nuttige plaatsen).

OperatingHoursRange

Uren van gebruik voor een POI (nuttige plaatsen). De beschikbaarheid van de operationele uren varieert op basis van de beschikbare gegevens. Als dit niet wordt doorgegeven, worden er geen openingstijden geretourneerd. Ondersteunde waarde: nextSevenDays

OperatingHoursTime

Vertegenwoordigt een datum en tijd

OperatingHoursTimeRange

Tijdsbereik voor een dag openen

PointOfInterest

Details van de geretourneerde POI, inclusief informatie zoals de naam, telefoon, URL-adres en classificaties.

PointOfInterestCategorySet

POI-categorie

QueryType

Het type query dat wordt geretourneerd: IN DE BUURT of NON_NEAR.

Belangrijk: Deze eigenschap is verouderd en kan worden weggelaten in de reactie.

ResponseFormat

Gewenste indeling van het antwoord. De waarde kan json- of xml-zijn.

SearchAddressResult

Dit object wordt geretourneerd vanuit een geslaagde zoekopdracht.

SearchAddressResultItem

Resultaatobject voor een antwoord van de zoek-API.

SearchAddressResultType

Een van de volgende:

  • POI
  • Straat
  • Geografie
  • Puntadres
  • Adresbereik
  • Dwars Straat
SearchIndexes

Indexen waarvoor uitgebreide postcodes in de resultaten moeten worden opgenomen.

Beschikbare indexen zijn:

Addr = Adresbereiken

Geo- = Geografische gebieden

PAD = Puntadressen

POI = Nuttige plaatsen

Str = Straten

XStr = Kruisstraten (kruispunten)

De waarde moet een door komma's gescheiden lijst met indextypen (in willekeurige volgorde) of Geen voor geen indexen.

Uitgebreide postcodes zijn standaard opgenomen voor alle indexen behalve Geo. Uitgebreide postcodelijsten voor geografische gebieden kunnen behoorlijk lang zijn, zodat ze expliciet moeten worden aangevraagd wanneer dat nodig is.

Gebruiksvoorbeelden:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=Geen

Uitgebreide postcode wordt geretourneerd als een extendedPostalCode eigenschap van een adres. Beschikbaarheid is regioafhankelijk.

SearchInsideGeometryRequest

Dit type vertegenwoordigt de aanvraagbody voor de Search Inside Geometry-service.

SearchSummary

Samenvattingsobject voor een antwoord van de Zoek-API.

Address

Het adres van het resultaat.

Name Type Description
boundingBox

BoundingBoxCompassNotation

Definieert het begrenzingsvak voor de locatie. Deze eigenschap wordt alleen geretourneerd door de Search Address Reverse-API's. Alle andere zoek-API's retourneren de viewport eigenschap van het SearchAddressResultItem object.

buildingNumber

string

Het gebouwnummer op straat.

Belangrijk: Deze eigenschap is verouderd. Gebruik in plaats daarvan streetNumber.

country

string

De naam van het land/de regio.

countryCode

string

Een alfabetische code van twee letters, gedefinieerd door de ISO 3166-1 Alpha-2-standaard, om een land/regio en afhankelijke gebieden weer te geven.

countryCodeISO3

string

Een alfabetische code van drie letters, gedefinieerd door de ISO 3166-1 Alpha-3 standaard, om een land/regio en afhankelijke gebieden weer te geven.

countrySecondarySubdivision

string

De tweede administratieve indeling binnen een land/regio. Het identificeert een onderverdeling die onder de primaire onderverdeling ligt, zoals een staat of provincie, maar boven kleinere eenheden zoals gemeenten of buurten. Voorbeelden zijn County in de Verenigde Staten en District in het Verenigd Koninkrijk.

countrySubdivision

string

De primaire administratieve indeling binnen een land, zoals een staat of provincie. Het wordt gebruikt om de eerste onderverdeling onder het nationale niveau weer te geven.

countrySubdivisionCode

string

countrySubdivisionCode voorafgegaan door countryCode (countryCode-countrySubdivisionCode) en het afbreekstreepje vormt de ISO 3166-2-code. Voorbeelden: TX voor Texas, SCT voor Schotland en ON voor Ontario.

Deze eigenschap is niet beschikbaar in de Get Search Nearby en Get Search POI API.

countrySubdivisionName

string

Geeft de volledige naam aan van de bestuurlijke indeling op het eerste niveau (zoals staat, provincie of regio) binnen een land of regio. Deze eigenschap is alleen inbegrepen wanneer de countrySubdivision waarde in verkorte vorm wordt gegeven. Momenteel ondersteund door de Verenigde Staten, Canada en het Verenigd Koninkrijk.

countryTertiarySubdivision

string

De administratieve indeling op het derde niveau binnen een land/regio. Het biedt zelfs fijnere granulariteit dan de secundaire onderverdeling (zoals county of district). Voorbeelden zijn gemeenten zoals een stad, dorp, dorp, borough of township en buurten in een kleiner, informeel geografisch gebied binnen een gemeente, zoals Capitol Hill, Green Lake en Wallingford in Seattle.

crossStreet

string

De naam van de straat die wordt gekruist.

Deze eigenschap is alleen beschikbaar in de Get Search Address Reverse Cross Street API.

extendedPostalCode

string

Een uitgebreide postcode verwijst naar een postcodeformaat dat verder gaat dan de standaard set cijfers om een grotere locatieprecisie te bieden. Het wordt vaak gebruikt in systemen zoals de U.S. ZIP+4-code of vergelijkbare uitgebreide formaten in andere landen/regio's. De beschikbaarheid hangt af van de regio.

Niet beschikbaar in de Get Search Address Reverse Cross Street API.

freeformAddress

string

Een adresregel die is opgemaakt volgens de opmaakregels van het land/regio van herkomst van een resultaat, of in het geval van een land/regio, de volledige land-/regionaam.

localName

string

Een adresonderdeel dat de naam vertegenwoordigt van een geografisch gebied of een locatie die meerdere adresseerbare objecten groepeert voor adresseringsdoeleinden, zonder een beheereenheid te zijn. Dit veld wordt gebruikt om de eigenschap freeformAddress te bouwen. localName vertegenwoordigt de post gemeente. Afhankelijk van de locatie is localName de meest bekende naam van een stad of stad. Gebruik voor de algemeen bekende naam van een stad of stad localName in plaats van municipality.

municipality

string

Plaats/stad
Opmerking: municipality vertegenwoordigt de woonstad. Afhankelijk van de locatie kan de municipality waarde afwijken van de algemeen bekende naam van een stad of stad. Voor de algemeen bekende naam van de stad of het dorp wordt voorgesteld om de localName waarde te gebruiken in plaats van de eigen municipality waarde.

municipalitySubdivision

string

Een onderverdeling binnen een gemeente. Het vertegenwoordigt een kleinere administratieve of geografische eenheid binnen een stad, dorp of andere gemeentelijke entiteit.

neighbourhood

string

Een wijk is een geografisch gelokaliseerd gebied binnen een stad of stad met onderscheidende kenmerken en sociale interacties tussen inwoners.

postalCode

string

Een reeks cijfers of letters (of beide) die aan een adres worden toegevoegd om een specifiek geografisch gebied te identificeren. Een postcode is de Amerikaanse versie van een postcode; andere landen/regio's gebruiken andere formaten zoals postcode, pincode en PLZ.

routeNumbers

string[]

De codes werden gebruikt om de straat ondubbelzinnig te identificeren.

Alleen beschikbaar voor de Search Address Reverse-API's.

street

string

De straatnaam.

Belangrijk: Deze eigenschap is verouderd. Gebruik in plaats daarvan streetName.

streetName

string

De straatnaam.

streetNameAndNumber

string

De straatnaam en het nummer.

Alleen beschikbaar voor de Search Address Reverse-API's.

streetNumber

string

Het gebouwnummer op straat.

Niet beschikbaar in de Get Search Address Reverse Cross Street API.

AddressRanges

Beschrijft het adresbereik aan beide zijden van de straat voor een zoekresultaat. Coördinaten voor de begin- en eindlocaties van het adresbereik worden opgenomen.

Name Type Description
from

LatLongPairAbbreviated

Een locatie die wordt weergegeven als breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

rangeLeft

string

Adresbereik aan de linkerkant van de straat.

rangeRight

string

Adresbereik aan de rechterkant van de straat.

to

LatLongPairAbbreviated

Een locatie die wordt weergegeven als breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

BoundingBox

De viewport die het resultaat bedekt dat wordt weergegeven door de coördinaten linksboven en rechtsonder van de viewport.

Name Type Description
btmRightPoint

LatLongPairAbbreviated

Een locatie die wordt weergegeven als breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

topLeftPoint

LatLongPairAbbreviated

Een locatie die wordt weergegeven als breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

BoundingBoxCompassNotation

Het begrenzingsvak van de locatie.

Name Type Description
entity

Entity

Bron van entiteitstype van het begrenzingsvak. Voor omgekeerde geocodering is dit altijd gelijk aan positie.

northEast

string

Noord-oost breedtegraad, lengtegraadcoördinaat van het begrenzingsvak als door komma's gescheiden floats

southWest

string

Zuid-west breedtegraad, lengtegraadcoördinaat van het begrenzingsvak als door komma's gescheiden floats

Brand

Het merk dat is gekoppeld aan de POI

Name Type Description
name

string

Naam van het merk

Classification

De classificatie voor de POI die wordt geretourneerd

Name Type Description
code

string

Code-eigenschap

names

ClassificationName[]

Namenmatrix

ClassificationName

Naam voor de classificatie

Name Type Description
name

string

Naameigenschap

nameLocale

string

Eigenschap Landinstelling naam

DataSources

Optionele sectie. Referentie-id's voor gebruik met de Get Search Polygon API.

Name Type Description
geometry

Geometry

Informatie over de geometrische vorm van het resultaat. Alleen aanwezig als type == Geografie.

Entity

Bron van entiteitstype van het begrenzingsvak. Voor omgekeerde geocodering is dit altijd gelijk aan positie.

Waarde Description
position

Positieentiteit

EntryPoint

Het ingangspunt voor de POI die wordt geretourneerd.

Name Type Description
position

LatLongPairAbbreviated

Een locatie die wordt weergegeven als breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

type

EntryPointType

Het type toegangspunt. De waarde kan hoofd- of kleinezijn.

EntryPointType

Het type toegangspunt. De waarde kan hoofd- of kleinezijn.

Waarde Description
main
minor

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het extra informatietype.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

GeographicEntityType

Entiteitstype Geografie. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.

Waarde Description
Country

land-/regionaam

CountrySubdivision

Staat of provincie

CountrySecondarySubdivision

Provincie

CountryTertiarySubdivision

Benoemd gebied

Municipality

Plaats/stad

MunicipalitySubdivision

Sub/Super City

Neighbourhood

Buurt

PostalCodeArea

Postcode/postcode

GeoJsonFeature

Een geldig GeoJSON Feature objecttype. Raadpleeg RFC 7946- voor meer informatie.

Name Type Description
featureType

string

Het type functie. De waarde is afhankelijk van het gegevensmodel waarvan de huidige functie deel uitmaakt. Sommige gegevensmodellen hebben mogelijk een lege waarde.

geometry GeoJsonGeometry:

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946- voor meer informatie.

id

string

Id voor de functie.

type string:

Feature

Hiermee geeft u het GeoJSON type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonFeatureCollection

Een geldig GeoJSON FeatureCollection objecttype. Raadpleeg RFC 7946- voor meer informatie.

Name Type Description
features

GeoJsonFeature[]

Bevat een lijst met geldige GeoJSON Feature objecten.

type string:

FeatureCollection

Hiermee geeft u het GeoJSON type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonGeometry

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946- voor meer informatie.

Name Type Description
type

GeoJsonObjectType

Hiermee geeft u het GeoJSON type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonGeometryCollection

Een geldig GeoJSON GeometryCollection objecttype. Raadpleeg RFC 7946- voor meer informatie.

Name Type Description
geometries GeoJsonGeometry[]:

Bevat een lijst met geldige GeoJSON geometrieobjecten. Let op dat coördinaten in GeoJSON zich in x, y volgorde (lengtegraad, breedtegraad) bevinden.

type string:

GeometryCollection

Hiermee geeft u het GeoJSON type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonLineString

Een geldig GeoJSON LineString geometrietype. Raadpleeg RFC 7946- voor meer informatie.

Name Type Description
coordinates

number[] (double)

Coördinaten voor de GeoJson LineString geometrie.

type string:

LineString

Hiermee geeft u het GeoJSON type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiLineString

Een geldig GeoJSON MultiLineString geometrietype. Raadpleeg RFC 7946- voor meer informatie.

Name Type Description
coordinates

number[] (double)

Coördinaten voor de GeoJson MultiLineString geometrie.

type string:

MultiLineString

Hiermee geeft u het GeoJSON type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiPoint

Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946- voor meer informatie.

Name Type Description
coordinates

number[] (double)

Coördinaten voor de GeoJson MultiPoint geometrie.

type string:

MultiPoint

Hiermee geeft u het GeoJSON type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonMultiPolygon

Een geldig GeoJSON MultiPolygon objecttype. Raadpleeg RFC 7946- voor meer informatie.

Name Type Description
coordinates

number[] (double)

Bevat een lijst met geldige GeoJSON Polygon objecten. Let op dat coördinaten in GeoJSON zich in x, y volgorde (lengtegraad, breedtegraad) bevinden.

type string:

MultiPolygon

Hiermee geeft u het GeoJSON type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonPoint

Een geldig GeoJSON Point geometrietype. Raadpleeg RFC 7946- voor meer informatie.

Name Type Description
coordinates

number[] (double)

Een Position is een matrix met getallen met twee of meer elementen. De eerste twee elementen zijn lengtegraad en breedtegraad, precies in die volgorde. Hoogte/Hoogte- is een optioneel derde element. Raadpleeg RFC 7946- voor meer informatie.

type string:

Point

Hiermee geeft u het GeoJSON type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

GeoJsonPolygon

Een geldig GeoJSON Polygon geometrietype. Raadpleeg RFC 7946- voor meer informatie.

Name Type Description
coordinates

number[] (double)

Coördinaten voor het type GeoJson Polygon geometrie.

type string:

Polygon

Hiermee geeft u het GeoJSON type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

Geometry

Informatie over de geometrische vorm van het resultaat. Alleen aanwezig als type == Geografie.

Name Type Description
id

string

Geef deze als geometryId door aan de Get Search Polygon API om geometriegegevens voor dit resultaat op te halen.

LatLongPairAbbreviated

Een locatie die wordt weergegeven als breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

Name Type Description
lat

number (double)

De eigenschap Breedtegraad

lon

number (double)

Eigenschap Lengtegraad

LocalizedMapView

Met de parameter Weergave (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten weergeven voor een bepaald land/bepaalde regio voor geopolitieke betwiste regio's. Verschillende landen/regio's hebben verschillende weergaven van dergelijke regio's en met de parameter Weergave kan uw toepassing voldoen aan de weergave die vereist is voor het land/de regio die uw toepassing levert. Standaard is de weergaveparameter ingesteld op Unified, zelfs als u deze niet hebt gedefinieerd in de aanvraag. Het is uw verantwoordelijkheid om de locatie van uw gebruikers te bepalen en vervolgens de parameter Weergave correct in te stellen voor die locatie. U kunt ook 'View=Auto' instellen, waarmee de kaartgegevens worden geretourneerd op basis van het IP-adres van de aanvraag. De parameter View in Azure Maps moet worden gebruikt in overeenstemming met toepasselijke wetten, waaronder die met betrekking tot toewijzing, van het land/de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden die u gemachtigd bent om toegang te krijgen via Azure Maps beschikbaar worden gesteld. Voorbeeld: view=IN.

Raadpleeg ondersteunde weergaven voor meer informatie en om de beschikbare weergaven te bekijken.

Waarde Description
AE

Verenigde Arabische Emiraten (Arabische weergave)

AR

Argentinië (Argentijnse weergave)

BH

Arabisch uitzicht ( Arabisch)

IN

India (Indische weergave)

IQ

Irak (Arabische weergave)

JO

Jordanië (Arabische weergave)

KW

Koeweit (Arabisch uitzicht)

LB

Libanon (Arabische weergave)

MA

Marokko (Marokkaanse weergave)

OM

Oman (Arabische weergave)

PK

Pakistan (Pakistaanse weergave)

PS

Palestijnse Autoriteit (Arabische weergave)

QA

Qatar (Arabische weergave)

SA

Saoedi-Arabië (Arabische weergave)

SY

Syrië (Arabische weergave)

US

Verenigde Staten van Amerika

YE

Jemen (Arabische weergave)

Auto

Retourneert de kaartgegevens op basis van het IP-adres van de aanvraag.

Unified

Geïntegreerde weergave (overige)

MatchType

Typen overeenkomsten voor een zoekbewerking voor omgekeerde adressen.

Waarde Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Openingstijden voor een POI (nuttige plaatsen).

Name Type Description
mode

string

Waarde die wordt gebruikt in de aanvraag: geen of "nextSevenDays"

timeRanges

OperatingHoursTimeRange[]

Lijst met tijdsbereiken voor de komende 7 dagen

OperatingHoursRange

Uren van gebruik voor een POI (nuttige plaatsen). De beschikbaarheid van de operationele uren varieert op basis van de beschikbare gegevens. Als dit niet wordt doorgegeven, worden er geen openingstijden geretourneerd. Ondersteunde waarde: nextSevenDays

Waarde Description
nextSevenDays

Toont de uren van de bewerking voor de volgende week, beginnend met de huidige dag in de lokale tijd van de POI.

OperatingHoursTime

Vertegenwoordigt een datum en tijd

Name Type Description
date

string

Vertegenwoordigt de huidige kalenderdatum in de TIJDZONE van NUTTIGE PLAATSEN, bijvoorbeeld '2019-02-07'.

hour

integer

Uren hebben de indeling van 24 uur in de lokale tijd van een POI; mogelijke waarden zijn 0 - 23.

minute

integer

Minuten bevinden zich in de lokale tijd van een POI; mogelijke waarden zijn 0 - 59.

OperatingHoursTimeRange

Tijdsbereik voor een dag openen

Name Type Description
endTime

OperatingHoursTime

Het punt in de komende 7 dagen wanneer een bepaalde POI wordt gesloten, of het begin van het bereik als het vóór het bereik werd gesloten.

startTime

OperatingHoursTime

Het punt in de komende 7 dagen wanneer een bepaalde POI wordt geopend, of het begin van het bereik als het vóór het bereik werd geopend.

PointOfInterest

Details van de geretourneerde POI, inclusief informatie zoals de naam, telefoon, URL-adres en classificaties.

Name Type Description
brands

Brand[]

Merkenmatrix. De naam van het merk voor de POI die wordt geretourneerd.

categories

string[]

Categorieënmatrix

categorySet

PointOfInterestCategorySet[]

De lijst met de meest specifieke POI-categorieën

classifications

Classification[]

Classificatiematrix

name

string

Naam van de eigenschap POI

openingHours

OperatingHours

Openingstijden voor een POI (nuttige plaatsen).

phone

string

Eigenschap Telefoonnummer

url

string

Url-eigenschap van website

PointOfInterestCategorySet

POI-categorie

Name Type Description
id

integer

Categorie-ID

QueryType

Het type query dat wordt geretourneerd: IN DE BUURT of NON_NEAR.

Belangrijk: Deze eigenschap is verouderd en kan worden weggelaten in de reactie.

Waarde Description
NEARBY

Zoeken werd uitgevoerd rond een bepaalde breedte- en lengtegraad met een gedefinieerde straal.

NON_NEAR

De zoekopdracht is globaal uitgevoerd, zonder een bepaalde breedtegraad en lengtegraad te vertekenen, en geen gedefinieerde radius

ResponseFormat

Gewenste indeling van het antwoord. De waarde kan json- of xml-zijn.

Waarde Description
json

De Notatie Data Interchange-indeling voor JavaScript-objecten

xml

De uitbreidbare opmaaktaal

SearchAddressResult

Dit object wordt geretourneerd vanuit een geslaagde zoekopdracht.

Name Type Description
results

SearchAddressResultItem[]

Een lijst met resultaten van de zoek-API.

summary

SearchSummary

Samenvattingsobject voor een antwoord van de Zoek-API

SearchAddressResultItem

Resultaatobject voor een antwoord van de zoek-API.

Name Type Description
address

Address

Het adres van het resultaat.

addressRanges

AddressRanges

Beschrijft het adresbereik aan beide zijden van de straat voor een zoekresultaat. Coördinaten voor de begin- en eindlocaties van het adresbereik worden opgenomen.

dataSources

DataSources

Optionele sectie. Referentiegeometrie-id voor gebruik met de Get Search Polygon API.

detourTime

integer

Omleidingstijd in seconden. Alleen geretourneerd voor aanroepen naar de Search Along Route-API.

dist

number (double)

Rechte lijnafstand tussen het resultaat en de locatie van geobias in meters.

entityType

GeographicEntityType

Entiteitstype Geografie. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.

entryPoints

EntryPoint[]

Matrix met toegangspunten. Deze beschrijven de soorten ingangen die beschikbaar zijn op de locatie. Het type kan "hoofd" zijn voor hoofdingangen, zoals een voordeur, of een lobby, en "secundair", voor zij- en achterdeuren.

id

string

Id-eigenschap

info

string

Informatie over de oorspronkelijke gegevensbron van het resultaat. Wordt gebruikt voor ondersteuningsaanvragen.

matchType

MatchType

Informatie over het type overeenkomst.

Een van de volgende:

  • Adrespunt
  • HuisGetalBereik
  • Straat
poi

PointOfInterest

Details van de geretourneerde POI, inclusief informatie zoals de naam, telefoon, URL-adres en classificaties.

position

LatLongPairAbbreviated

Een locatie die wordt weergegeven als breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

score

number (double)

De waarde in een resultatenset om de relatieve overeenkomende score tussen de resultaten aan te geven. U kunt dit gebruiken om te bepalen dat resultaat x twee keer zo waarschijnlijk relevant is als resultaat y als de waarde van x 2x de waarde van y is. De waarden variëren tussen query's en zijn alleen bedoeld als een relatieve waarde voor één resultatenset.

Belangrijk: Deze eigenschap is verouderd en kan worden weggelaten in de reactie.

type

SearchAddressResultType

Een van de volgende:

  • POI
  • Straat
  • Geografie
  • Puntadres
  • Adresbereik
  • Dwars Straat
viewport

BoundingBox

De viewport die het resultaat bedekt dat wordt weergegeven door de coördinaten linksboven en rechtsonder van de viewport.

SearchAddressResultType

Een van de volgende:

  • POI
  • Straat
  • Geografie
  • Puntadres
  • Adresbereik
  • Dwars Straat
Waarde Description
POI
Street
Geography
Point Address
Address Range
Cross Street

SearchIndexes

Indexen waarvoor uitgebreide postcodes in de resultaten moeten worden opgenomen.

Beschikbare indexen zijn:

Addr = Adresbereiken

Geo- = Geografische gebieden

PAD = Puntadressen

POI = Nuttige plaatsen

Str = Straten

XStr = Kruisstraten (kruispunten)

De waarde moet een door komma's gescheiden lijst met indextypen (in willekeurige volgorde) of Geen voor geen indexen.

Uitgebreide postcodes zijn standaard opgenomen voor alle indexen behalve Geo. Uitgebreide postcodelijsten voor geografische gebieden kunnen behoorlijk lang zijn, zodat ze expliciet moeten worden aangevraagd wanneer dat nodig is.

Gebruiksvoorbeelden:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=Geen

Uitgebreide postcode wordt geretourneerd als een extendedPostalCode eigenschap van een adres. Beschikbaarheid is regioafhankelijk.

Waarde Description
Addr
Geo
PAD
POI
Str
Xstr

SearchInsideGeometryRequest

Dit type vertegenwoordigt de aanvraagbody voor de Search Inside Geometry-service.

Name Type Description
geometry GeoJsonObject:

Een geldig GeoJSON-object. Raadpleeg RFC 7946- voor meer informatie.

SearchSummary

Samenvattingsobject voor een antwoord van de Zoek-API.

Name Type Description
fuzzyLevel

integer

Het maximale fuzzy niveau dat nodig is om resultaten te leveren.

geoBias

LatLongPairAbbreviated

Indicatie wanneer de interne zoekmachine een georuimtelijke bias heeft toegepast om de rangorde van resultaten te verbeteren. In sommige methoden kan dit worden beïnvloed door de parameters lat en lon in te stellen, indien beschikbaar. In andere gevallen is het puur intern.

limit

integer

Maximum aantal antwoorden dat wordt geretourneerd

numResults

integer

Aantal resultaten in het antwoord.

offset

integer

De beginverschuiving van de geretourneerde resultaten in de volledige resultatenset.

query

string

De queryparameter die is gebruikt om deze zoekresultaten te produceren.

queryTime

integer

Tijd die is besteed aan het oplossen van de query, in milliseconden.

queryType

QueryType

Het type query dat wordt geretourneerd: IN DE BUURT of NON_NEAR.

Belangrijk: Deze eigenschap is verouderd en kan worden weggelaten in de reactie.

totalResults

integer

Het totale aantal gevonden resultaten.