Search - Get Search Address

Service:

Maps

API-versie:

1.0

Hiermee kunt u coördinaten voor breedtegraad en lengtegraad van een adres in een ongestructureerde indeling of queryinvoerindeling ophalen.

De Get Search Address-API is een HTTP-GET-aanvraag retourneert de coördinaten voor de breedtegraad en lengtegraad wanneer ze worden doorgegeven in een adres of naam van een plaats als zoekcriteria.

In veel gevallen kan de volledige zoekservice te veel zijn, bijvoorbeeld als u alleen geïnteresseerd bent in traditionele geocodering. Zoeken kan ook uitsluitend worden geopend voor adreszoekopdrachten. De geocodering wordt uitgevoerd door het geocode-eindpunt te bereiken met alleen het adres of gedeeltelijke adres in kwestie. De zoekindex voor geocodering wordt opgevraagd voor alles boven de gegevens op straatniveau. Er worden geen PO's geretourneerd. Houd er rekening mee dat de geocoder zeer tolerant is voor typefouten en onvolledige adressen. Het behandelt ook alles van exacte straatadressen of straat- of kruispunten, evenals geografische gebieden op een hoger niveau, zoals stadscentra, provincies, staten, enzovoort.

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}

Met optionele parameters:

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}

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	Het adres waarnaar moet worden gezocht (bijvoorbeeld '1 Microsoft way, Redmond, WA'), moet correct zijn gecodeerd met url's.
btmRight	query		string	Rechtsonder van het begrenzingsvak. Bijvoorbeeld 37,553,-122,453
countrySet	query		string[]	Door komma's gescheiden reeks land-/regiocodes, bijvoorbeeld FR,ES. Hierdoor wordt de zoekopdracht beperkt tot de opgegeven landen/regio's
entityType	query		GeographicEntityType	Hiermee geeft u het filterniveau op dat wordt uitgevoerd op geografische gebieden. Hiermee beperkt u de zoekopdracht naar de opgegeven typen geografieentiteiten, bijvoorbeeld om alleen de gemeente te retourneren. Het resulterende antwoord bevat de geografische id en het entiteitstype dat overeenkomt. Als u meer dan één entiteit opgeeft als een door komma's gescheiden lijst, retourneert het eindpunt de kleinste entiteit die beschikbaar is. Geretourneerde geometrie-id kan worden gebruikt om de geometrie van die geografie op te halen via Zoek veelhoek ophalen API. De volgende parameters worden genegeerd wanneer entityType is ingesteld: kop nummer returnRoadUse returnSpeedLimit roadUse returnMatchType
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=None Uitgebreide postcode wordt geretourneerd als een extendedPostalCode eigenschap van een adres. Beschikbaarheid is regioafhankelijk.
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.
lat	query		number (double)	Breedtegraad waar de resultaten moeten worden vooroordelen. Bijvoorbeeld 37.337
limit	query		integer minimum: 1 maximum: 100	Maximum aantal antwoorden dat wordt geretourneerd. Standaard: 10, minimaal: 1 en maximum: 100
lon	query		number (double)	Lengtegraad waar de resultaten moeten worden vooroordelen. Bijvoorbeeld -121.89
ofs	query		integer minimum: 0 maximum: 1900	Beginverschil van de geretourneerde resultaten in de volledige resultatenset. Standaardwaarde: 0
radius	query		integer	De straal in meters totdat de resultaten worden beperkt tot het gedefinieerde gebied
topLeft	query		string	Linksboven in het begrenzingsvak. Bijvoorbeeld 37,553,-122,453
typeahead	query		boolean	Booleaans. Als de vlag typeahead is ingesteld, wordt de query geïnterpreteerd als gedeeltelijke invoer en wordt de zoekopdracht in de voorspellende modus weergegeven
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	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 Account-API van het Azure Maps-beheervlak. Zie de volgende artikelen voor hulp voor het gebruik van Microsoft Entra ID-beveiliging in Azure Maps.

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 detail address 15127 NE 24th Street, Redmond, WA 98052

Voorbeeldaanvraag

HTTP

GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052

Voorbeeldrespons

Statuscode:

200

{
  "summary": {
    "query": "15127 NE 24th Street, Redmond, WA 98052",
    "queryType": "NON_NEAR",
    "queryTime": 58,
    "numResults": 1,
    "offset": 0,
    "totalResults": 1,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/19173426",
      "score": 14.51,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "980525544",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15127 NE 24th St, Redmond, WA 980525544",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6308,
        "lon": -122.1385
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6317,
          "lon": -122.13983
        },
        "btmRightPoint": {
          "lat": 47.6299,
          "lon": -122.13717
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6315,
            "lon": -122.13852
          }
        }
      ]
    }
  ]
}

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.
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).
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.
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 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=None Uitgebreide postcode wordt geretourneerd als een extendedPostalCode eigenschap van een adres. Beschikbaarheid is regioafhankelijk.
SearchSummary	Samenvattingsobject voor een antwoord van de Zoek-API.

Address

Object

Het adres van het resultaat

Name	Type	Description
boundingBox	BoundingBoxCompassNotation	Het begrenzingsvak van de locatie.
buildingNumber	string	Het gebouwnummer op straat. AFGESCHAFT, gebruik in plaats daarvan streetNumber.
country	string	land-/regionaam
countryCode	string	Land (Opmerking: dit is een tweeletterige code, geen land-/regionaam.)
countryCodeISO3	string	ISO-alfa-3-landcode
countrySecondarySubdivision	string	Provincie
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 administratieve hiërarchie van landen/regio's. Dit veld wordt alleen weergegeven als countrySubdivision wordt weergegeven in een verkorte vorm. Alleen ondersteund voor DE V.S., 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 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 stad wordt voorgesteld dat de localName waarde wordt gebruikt in plaats van de municipality waarde.
municipalitySubdivision	string	Sub/Super City
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/postcode
routeNumbers	string[]	De codes die worden gebruikt om de straat ondubbelzinnig te identificeren
street	string	De straatnaam. AFGESCHAFT, gebruik in plaats daarvan streetName.
streetName	string	De straatnaam.
streetNameAndNumber	string	De straatnaam en het nummer.
streetNumber	string	Het gebouwnummer op straat.

AddressRanges

Object

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

Object

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

Object

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

Object

Het merk dat is gekoppeld aan de POI

Name	Type	Description
name	string	Naam van het merk

Classification

Object

De classificatie voor de POI die wordt geretourneerd

Name	Type	Description
code	string	Code-eigenschap
names	ClassificationName[]	Namenmatrix

ClassificationName

Object

Naam voor de classificatie

Name	Type	Description
name	string	Naameigenschap
nameLocale	string	Eigenschap Landinstelling naam

DataSources

Object

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

Inventarisatie

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

Waarde	Description
position	Positieentiteit

EntryPoint

Object

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

Inventarisatie

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

Waarde	Description
main
minor

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

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

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GeographicEntityType

Inventarisatie

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

Waarde	Description
Country	land-/regionaam
CountrySecondarySubdivision	Provincie
CountrySubdivision	Staat of provincie
CountryTertiarySubdivision	Benoemd gebied
Municipality	Plaats/stad
MunicipalitySubdivision	Sub/Super City
Neighbourhood	Buurt
PostalCodeArea	Postcode/postcode

Geometry

Object

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

Object

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

Inventarisatie

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)
Auto	Retourneert de kaartgegevens op basis van het IP-adres van de aanvraag.
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)
Unified	Geïntegreerde weergave (overige)
YE	Jemen (Arabische weergave)

MatchType

Inventarisatie

Typen overeenkomsten voor een zoekbewerking voor omgekeerde adressen.

Waarde	Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Object

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

OperatingHoursTime

Object

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

Object

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

Object

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

Object

POI-categorie

Name	Type	Description
id	integer	Categorie-ID

QueryType

Inventarisatie

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

Waarde	Description
NEARBY	De zoekopdracht is uitgevoerd rond een bepaalde breedtegraad en lengtegraad met een gedefinieerde radius
NON_NEAR	De zoekopdracht is globaal uitgevoerd, zonder een bepaalde breedtegraad en lengtegraad te vertekenen, en geen gedefinieerde radius

ResponseFormat

Inventarisatie

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

Object

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

Object

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: 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 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.
type	SearchAddressResultType	Een van de volgende: POI Straat Geografie Puntadres Adresbereik Cross Street
viewport	BoundingBox	De viewport die het resultaat bedekt dat wordt weergegeven door de coördinaten linksboven en rechtsonder van de viewport.

SearchAddressResultType

Inventarisatie

Een van de volgende:

• POI
• Straat
• Geografie
• Puntadres
• Adresbereik
• Cross Street

Waarde	Description
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchIndexes

Inventarisatie

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=None

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

Waarde	Description
Addr
Geo
PAD
POI
Str
Xstr

SearchSummary

Object

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.
totalResults	integer	Het totale aantal gevonden resultaten.