Delen via

Search - Get Search Address

  • Referentie
Service:
Maps
API-versie:
1.0

Gebruik om de breedte- en lengtegraadcoördinaten van een adres op te halen in een ongestructureerde indeling voor invoer of query's.

De Get Search Address API is een HTTP-aanvraag GET die de breedte- en lengtegraadcoördinaten retourneert wanneer een adres of plaatsnaam als zoekcriterium wordt doorgegeven.

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

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. 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-manier, Redmond, WA'), moet correct zijn gecodeerd met de URL.
btmRight
 query

string

Positie rechtsonder van het begrenzingsvak. Bijvoorbeeld 37.553,-122.453
countrySet
 query

string[]

Door komma's gescheiden tekenreeks van 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 wordt de zoekopdracht voor opgegeven typen geografische entiteiten beperkt, bijvoorbeeld alleen een gemeente retourneren. Het resulterende antwoord bevat de geografische id en het overeenkomende entiteitstype. Als u meer dan één entiteit opgeeft als een door komma's gescheiden lijst, retourneert het eindpunt de 'kleinste entiteit beschikbaar'. Geretourneerde geometrie-id kan worden gebruikt om de geometrie van die geografie op te halen via get Search polygon-API. De volgende parameters worden genegeerd wanneer entityType is ingesteld:

  • Rubriek
  • getal
  • returnRoadUse
  • returnSpeedLimit
  • roadUse
  • returnMatchType
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 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 bevooroordeeld moeten zijn. Bijvoorbeeld 37.337
limit
 query

integer

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

number

double

Lengtegraad waarbij de resultaten bevooroordeeld moeten zijn. Bijvoorbeeld -121,89
ofs
 query

integer

Verschuiving starten van de geretourneerde resultaten binnen de volledige resultatenset. Standaardinstelling: 0
radius
 query

integer

De straal in meters tot om de resultaten te beperken tot het gedefinieerde gebied
topLeft
 query

string

Positie linksboven van het begrenzingsvak. Bijvoorbeeld 37.553,-122.453
typeahead
 query

boolean

Booleaanse. Als de vlag typeahead is ingesteld, wordt de query geïnterpreteerd als een gedeeltelijke invoer en wordt de zoekactie in de voorspellende modus geactiveerd
view
 query

LocalizedMapView

Met de parameter View (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten voor een bepaald land/regio weergeven voor geopolitiek betwiste regio's. Verschillende landen/regio's hebben verschillende weergaven van dergelijke regio's en met de weergaveparameter kan uw toepassing voldoen aan de weergave die is vereist voor het land/de regio die uw toepassing gaat bedienen. De parameter View 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 weergaveparameter 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 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.

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

Voorbeeldaanvraag

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 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 het 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.
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 View (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten voor een bepaald land/regio weergeven voor geopolitiek betwiste regio's. Verschillende landen/regio's hebben verschillende weergaven van dergelijke regio's en met de weergaveparameter kan uw toepassing voldoen aan de weergave die is vereist voor het land/de regio die uw toepassing gaat bedienen. De parameter View 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 weergaveparameter 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 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 (Points of Interest).
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. De 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 = Kruisstraten (kruispunten)

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

Uitgebreide postcodes worden standaard opgenomen voor alle indexen, met uitzondering van geografische gegevens. 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 extendedPostalCode-eigenschap van een adres. Beschikbaarheid is regioafhankelijk.
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 het entiteitstype van het begrenzingsvak. Voor reverse-geocodering is dit altijd gelijk aan positie.
northEast

string

Noordoostelijke 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

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

Entity

Bron van het 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

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 View (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten voor een bepaald land/regio weergeven voor geopolitiek betwiste regio's. Verschillende landen/regio's hebben verschillende weergaven van dergelijke regio's en met de weergaveparameter kan uw toepassing voldoen aan de weergave die is vereist voor het land/de regio die uw toepassing gaat bedienen. De parameter View 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 weergaveparameter 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 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 toewijzingsgegevens 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 (Points of Interest).

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

OperatingHoursTime

Vertegenwoordigt een datum en tijd

Name Type Description
date

string

Geeft de huidige kalenderdatum in poi-tijdzone aan, bijvoorbeeld '02-2019-07'.
hour

integer

Uren zijn in de 24-uursnotatie 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

Open tijdsbereik voor een dag

Name Type Description
endTime

OperatingHoursTime

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

OperatingHoursTime

Het punt in het komende 7 dagenbereik waarop een bepaalde POI wordt geopend, of het begin van het bereik als deze vóór het bereik is 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. De 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
  • Kruisstraat
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 = Kruisstraten (kruispunten)

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

Uitgebreide postcodes worden standaard opgenomen voor alle indexen, met uitzondering van geografische gegevens. 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 extendedPostalCode-eigenschap van een adres. Beschikbaarheid is regioafhankelijk.

Name Type Description
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

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