Delen via


Search - Post Search Inside Geometry

Gebruik om zoekopdrachten in vrije vorm uit te voeren in nog meer geometrieën.

De Post Search Inside Geometry API is en HTTP POST request that allows you to perform a free form search inside a single geometry or multiple geometries. The search results that fall inside the geometry/geometries will be returned.<br><br>To send the geometry you will use a POST-geometrieobject represented as arequest where the request body will contain theGeoJSON-inhoudstypetoepassingtype and theheader will be set to/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following GeoJSON-geometrie GeoJSON-functieCollectiontypes:<ul><li>**GeoJSON FeatureCollection** <br>Thecan contain a max of 50object. This is the recommended option if the geometry contains both Polygons and Circles. Thecan be represented as aGeoJSON-functiefunctieobject should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>Aobject for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>Aobjects. EachFunctiefunctie GeoJSON-puntfunctieCollectiongeometriecan be represented as atype and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.</li></ul><br> Please see the Examples section below for a samplerepresentation.<br><br></li><li>**GeoJSON GeometryCollection**<br>Theobject for the Circle geometry is composed of a _center_ represented using aGeoJSON GeometrieCollection GeometryCollectionobject. This is the recommended option if the geometry contains a list of Polygons only. TheGeometryCollectioncan contain a max of 50GeoJSON Polygonobjects. Eachobject can have a max of 50 coordinates. Please see the Examples section below for a sampleGeometryCollectionrepresentation.<br><br></li><li>**GeoJSON Polygon**<br>Thegeometrycan be represented as aobject. This is the recommended option if the geometry contains a single Polygon. Theobject can have a max of 50 coordinates. Please see the Examples section below for a sampleVeelhoekweergave.

.

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. 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'). De URL moet correct zijn gecodeerd.

categorySet
query

integer[]

Een door komma's gescheiden lijst met categorie-id's die kunnen worden gebruikt om het resultaat te beperken tot specifieke Points of Interest-categorieën. Id-volgorde maakt niet uit. Het maximum aantal categorySet ondersteunde waarden per aanvraag is 10. Wanneer er meerdere categorie-id's worden opgegeven, worden alleen POI'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 DE API VOOR POI-categorieën . Gebruiksvoorbeelden:

  • categorySet=7315 (Search Nuttige plaatsen uit de categorie Restaurant)

  • categorySet=7315025,7315017 (Search Nuttige plaatsen van de categorie Italiaans of Frans restaurant)

extendedPostalCodesFor
query

SearchIndexes[]

Indexen waarvoor uitgebreide postcodes moeten worden opgenomen in de resultaten.

Beschikbare indexen zijn:

Addr = Adresbereiken

Geo = Geografische gebieden

PAD = puntadressen

POI = Nuttige plaatsen

Str = Straten

XStr = Dwarsstraten (kruispunten)

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

Standaard worden uitgebreide postcodes opgenomen voor alle indexen behalve Geo. Uitgebreide postcodelijsten voor geografische gebieden kunnen vrij lang zijn, dus ze moeten expliciet worden aangevraagd wanneer dat nodig is.

Gebruiksvoorbeelden:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Uitgebreide postcode wordt geretourneerd als een eigenschap extendedPostalCode 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 = Interpolatie adresbereik, Geo = Geografische gebieden, PAD = Puntadressen, POI = Nuttige plaatsen, Str = Straten, Xstr = Dwarsstraten (kruispunten)

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

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

openingHours
query

OperatingHoursRange

Openingstijden van een POI (Points of Interest). De beschikbaarheid van de bedrijfsuren is afhankelijk van de beschikbare gegevens. Indien niet doorgegeven, wordt er geen informatie over 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 of 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 gaat bedienen. De parameter Weergave is standaard 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 Weergave in Azure Maps moet worden gebruikt in overeenstemming met de toepasselijke wetgeving, met inbegrip van die met betrekking tot toewijzing, van het land of de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden waartoe u toegang hebt via Azure Maps beschikbaar wordt 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

Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID beveiliging wilt gebruiken in Azure Maps raadpleegt u de volgende artikelen voor hulp.

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-stromen. Wanneer het 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 tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. 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 verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notitie

  • Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API .
  • De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties.
  • Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
  • Het gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.
  • Zie overzicht van Microsoft identity platform voor meer informatie over 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 maakt in de 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 zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken 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 is gemaakt op basis van de SAS-bewerking List 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 om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering 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 eindlocatie van het adresbereik worden opgenomen.

BoundingBox

De viewport die het resultaat bedekt dat wordt vertegenwoordigd 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 reverse-geocodering is dit altijd gelijk aan positie.

EntryPoint

Het toegangspunt voor de POI die wordt geretourneerd.

EntryPointType

Het type toegangspunt. De waarde kan main of minor zijn.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

GeographicEntityType

Type geografie-entiteit. 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 u == Geografie typt.

LatLongPairAbbreviated

Een locatie die wordt weergegeven als een 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 of 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 gaat bedienen. De parameter Weergave is standaard 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 Weergave in Azure Maps moet worden gebruikt in overeenstemming met de toepasselijke wetgeving, met inbegrip van die met betrekking tot toewijzing, van het land of de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden waartoe u toegang hebt via Azure Maps beschikbaar wordt gesteld. Voorbeeld: view=IN.

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

MatchType

Typen overeenkomsten voor een omgekeerde adreszoekbewerking.

OperatingHours

Openingstijden voor een POI (Nuttige plaatsen).

OperatingHoursRange

Openingstijden van een POI (Points of Interest). De beschikbaarheid van de bedrijfsuren is afhankelijk van de beschikbare gegevens. Indien niet doorgegeven, wordt er geen informatie over openingstijden geretourneerd. Ondersteunde waarde: nextSevenDays

OperatingHoursTime

Vertegenwoordigt een datum en tijd

OperatingHoursTimeRange

Open tijdsbereik voor een dag

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.

ResponseFormat

Gewenste indeling van het antwoord. Waarde kan json of xml zijn.

SearchAddressResult

Dit object wordt geretourneerd na een geslaagde Search aanroepen.

SearchAddressResultItem

Resultaatobject voor een Search API-antwoord.

SearchAddressResultType

Een van de volgende:

  • POI
  • Straat
  • Geografie
  • Puntadres
  • Adresbereik
  • Kruisstraat
SearchIndexes

Indexen waarvoor uitgebreide postcodes moeten worden opgenomen in de resultaten.

Beschikbare indexen zijn:

Addr = Adresbereiken

Geo = Geografische gebieden

PAD = puntadressen

POI = Nuttige plaatsen

Str = Straten

XStr = Dwarsstraten (kruispunten)

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

Standaard worden uitgebreide postcodes opgenomen voor alle indexen behalve Geo. Uitgebreide postcodelijsten voor geografische gebieden kunnen vrij lang zijn, dus ze moeten expliciet worden aangevraagd wanneer dat nodig is.

Gebruiksvoorbeelden:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

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

SearchInsideGeometryRequest

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

SearchSummary

Samenvattingsobject voor een Search API-antwoord.

Address

Het adres van het resultaat

Name Type Description
boundingBox

BoundingBoxCompassNotation

Het begrenzingsvak van de locatie.

buildingNumber

string

Het nummer van het gebouw op straat. AFGESCHAFT, gebruik in plaats daarvan streetNumber.

country

string

land/regionaam

countryCode

string

Land (opmerking: dit is een code van twee letters, geen land-/regionaam.)

countryCodeISO3

string

ISO alfa-3-landcode

countrySecondarySubdivision

string

Graafschap

countrySubdivision

string

Staat of provincie

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.

countrySubdivisionName

string

De volledige naam van een eerste niveau van de land-/regiobeheerhiërarchie. Dit veld wordt alleen weergegeven als countrySubdivision in een verkorte vorm wordt weergegeven. Alleen ondersteund voor de VS, Canada en het Verenigd Koninkrijk.

countryTertiarySubdivision

string

Benoemd gebied

crossStreet

string

De naam van de straat die wordt gekruist.

extendedPostalCode

string

Uitgebreide postcode (beschikbaarheid is afhankelijk van de regio).

freeformAddress

string

Een adresregel die is opgemaakt volgens de opmaakregels van het land/de 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 van een geografisch gebied of een plaats vertegenwoordigt die meerdere adresseerbare objecten groepeert voor adresseringsdoeleinden, zonder dat het een beheereenheid is. Dit veld wordt gebruikt om de freeformAddress eigenschap te bouwen. localName vertegenwoordigt de post gemeente. Afhankelijk van de locatie is localName de algemeen bekende naam van een stad of stad. Voor de algemeen bekende naam van een stad of stad gebruikt localName u in plaats van municipality.

municipality

string

Plaats /plaats
Opmerking: municipality vertegenwoordigt de woongemeente. 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 stad wordt voorgesteld dat de localName waarde wordt gebruikt in plaats van de municipality waarde.

municipalitySubdivision

string

Sub-/superstad

neighbourhood

string

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

postalCode

string

Postcode

routeNumbers

string[]

De codes die worden gebruikt om de straat ondubbelzinnig te identificeren

street

string

De straatnaam. AFGESCHAFT, gebruikt u in plaats daarvan streetName.

streetName

string

De straatnaam.

streetNameAndNumber

string

De straatnaam en het nummer.

streetNumber

string

Het nummer van het gebouw op straat.

AddressRanges

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

Name Type Description
from

LatLongPairAbbreviated

Een locatie die wordt weergegeven als een 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 een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

BoundingBox

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

Name Type Description
btmRightPoint

LatLongPairAbbreviated

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

topLeftPoint

LatLongPairAbbreviated

Een locatie die wordt weergegeven als een 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 reverse-geocodering is dit altijd gelijk aan positie.

northEast

string

Noord-oosten breedtegraad, lengtecoördinaat van het begrenzingsvak als door komma's gescheiden vlotters

southWest

string

Zuidwestelijke breedtegraad, lengtecoördinaat van het begrenzingsvak als door komma's gescheiden vlotters

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

Naamlandinstelling eigenschap

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 u == Geografie typt.

Entity

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

Name Type Description
position

string

Positie-entiteit

EntryPoint

Het toegangspunt voor de POI die wordt geretourneerd.

Name Type Description
position

LatLongPairAbbreviated

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

type

EntryPointType

Het type toegangspunt. De waarde kan main of minor zijn.

EntryPointType

Het type toegangspunt. De waarde kan main of minor zijn.

Name Type Description
main

string

minor

string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout 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

Type geografie-entiteit. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.

Name Type Description
Country

string

land/regionaam

CountrySecondarySubdivision

string

Graafschap

CountrySubdivision

string

Staat of provincie

CountryTertiarySubdivision

string

Benoemd gebied

Municipality

string

Plaats /plaats

MunicipalitySubdivision

string

Sub-/superstad

Neighbourhood

string

Buurt

PostalCodeArea

string

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 op. 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 op. 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 op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, 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. Houd er rekening mee dat coördinaten in GeoJSON in de volgorde x, y (lengtegraad, breedtegraad) staan.

type string:

GeometryCollection

Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, 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[]

Coördinaten voor de GeoJson LineString geometrie.

type string:

LineString

Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, 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[]

Coördinaten voor de GeoJson MultiLineString geometrie.

type string:

MultiLineString

Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, 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[]

Coördinaten voor de GeoJson MultiPoint geometrie.

type string:

MultiPoint

Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, 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[]

Bevat een lijst met geldige GeoJSON Polygon objecten. Houd er rekening mee dat coördinaten in GeoJSON in de volgorde x, y (lengtegraad, breedtegraad) staan.

type string:

MultiPolygon

Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, 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[]

A 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 op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, 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[]

Coördinaten voor het GeoJson Polygon geometrietype.

type string:

Polygon

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

Geometry

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

Name Type Description
id

string

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

LatLongPairAbbreviated

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

Name Type Description
lat

number

De eigenschap Breedtegraad

lon

number

De eigenschap Lengtegraad

LocalizedMapView

Met de parameter Weergave (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten weergeven voor een bepaald land of 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 gaat bedienen. De parameter Weergave is standaard 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 Weergave in Azure Maps moet worden gebruikt in overeenstemming met de toepasselijke wetgeving, met inbegrip van die met betrekking tot toewijzing, van het land of de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden waartoe u toegang hebt via Azure Maps beschikbaar wordt gesteld. Voorbeeld: view=IN.

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

Name Type Description
AE

string

Verenigde Arabische Emiraten (Arabische weergave)

AR

string

Argentinië (Argentijnse weergave)

Auto

string

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

BH

string

Bahrein (Arabische weergave)

IN

string

India (Indiase weergave)

IQ

string

Irak (Arabische weergave)

JO

string

Jordanië (Arabische weergave)

KW

string

Koeweit (Arabische weergave)

LB

string

Libanon (Arabische weergave)

MA

string

Marokko (Marokkaanse weergave)

OM

string

Oman (Arabische weergave)

PK

string

Pakistan (Pakistaanse weergave)

PS

string

Palestijnse Autoriteit (Arabische weergave)

QA

string

Qatar (Arabische weergave)

SA

string

Saoedi-Arabië (Arabische weergave)

SY

string

Syrië (Arabische weergave)

Unified

string

Geïntegreerde weergave (overige)

YE

string

Jemen (Arabische weergave)

MatchType

Typen overeenkomsten voor een omgekeerde adreszoekbewerking.

Name Type Description
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Openingstijden voor een POI (Nuttige plaatsen).

Name Type Description
mode

string

Waarde die in de aanvraag wordt gebruikt: none of 'nextSevenDays'

timeRanges

OperatingHoursTimeRange[]

Lijst met tijdsbereiken voor de komende 7 dagen

OperatingHoursRange

Openingstijden van een POI (Points of Interest). De beschikbaarheid van de bedrijfsuren is afhankelijk van de beschikbare gegevens. Indien niet doorgegeven, wordt er geen informatie over openingstijden geretourneerd. Ondersteunde waarde: nextSevenDays

Name Type Description
nextSevenDays

string

Toont de openingstijden 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 poi-tijdzone, bijvoorbeeld "2019-02-07".

hour

integer

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

minute

integer

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

OperatingHoursTimeRange

Open tijdsbereik voor een dag

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 gesloten was.

startTime

OperatingHoursTime

Het punt in de komende 7 dagen waarop 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[]

Merken matrix. 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

Website-URL-eigenschap

PointOfInterestCategorySet

POI-categorie

Name Type Description
id

integer

Categorie-id

QueryType

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

Name Type Description
NEARBY

string

Search is uitgevoerd rond een bepaalde breedtegraad en lengtegraad met een gedefinieerde radius

NON_NEAR

string

Search is wereldwijd uitgevoerd, zonder bevooroordeeld te zijn naar een bepaalde breedte- en lengtegraad, en geen gedefinieerde radius

ResponseFormat

Gewenste indeling van het antwoord. Waarde kan json of xml zijn.

Name Type Description
json

string

De JavaScript Object Notation Data Interchange-indeling

xml

string

De uitbreidbare opmaaktaal

SearchAddressResult

Dit object wordt geretourneerd na een geslaagde Search aanroepen.

Name Type Description
results

SearchAddressResultItem[]

Een lijst met Search API-resultaten.

summary

SearchSummary

Samenvattingsobject voor een Search API-antwoord

SearchAddressResultItem

Resultaatobject voor een Search API-antwoord.

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 eindlocatie 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 API Search Langs route.

dist

number

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

entityType

GeographicEntityType

Type geografie-entiteit. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.

entryPoints

EntryPoint[]

Matrix van entrypoints. 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 'minor' 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:

  • AddressPoint
  • HouseNumberRange
  • 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 een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

score

number

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

type

SearchAddressResultType

Een van de volgende:

  • POI
  • Straat
  • Geografie
  • Puntadres
  • Adresbereik
  • Straat kruisen
viewport

BoundingBox

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

SearchAddressResultType

Een van de volgende:

  • POI
  • Straat
  • Geografie
  • Puntadres
  • Adresbereik
  • Kruisstraat
Name Type Description
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchIndexes

Indexen waarvoor uitgebreide postcodes moeten worden opgenomen in de resultaten.

Beschikbare indexen zijn:

Addr = Adresbereiken

Geo = Geografische gebieden

PAD = puntadressen

POI = Nuttige plaatsen

Str = Straten

XStr = Dwarsstraten (kruispunten)

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

Standaard worden uitgebreide postcodes opgenomen voor alle indexen behalve Geo. Uitgebreide postcodelijsten voor geografische gebieden kunnen vrij lang zijn, dus ze moeten expliciet worden aangevraagd wanneer dat nodig is.

Gebruiksvoorbeelden:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

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

Name Type Description
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

SearchInsideGeometryRequest

Dit type vertegenwoordigt de aanvraagtekst 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 Search API-antwoord.

Name Type Description
fuzzyLevel

integer

Het maximale fuzzy-niveau dat is vereist om resultaten op te geven.

geoBias

LatLongPairAbbreviated

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

limit

integer

Maximum aantal antwoorden dat wordt geretourneerd

numResults

integer

Het aantal resultaten in het antwoord.

offset

integer

De begin offset van de geretourneerde Resultaten binnen de volledige resultatenset.

query

string

De queryparameter die is gebruikt om deze zoekresultaten te produceren.

queryTime

integer

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

queryType

QueryType

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

totalResults

integer

Het totale aantal gevonden resultaten.