Search - Get Reverse Geocoding
Gebruik om adres- en locatiegegevens op te halen uit lengte- en breedtegraadcoördinaten.
De Get Reverse Geocoding
API is een HTTP-aanvraag GET
die wordt gebruikt om een coördinaat (bijvoorbeeld: 37.786505, -122.3862) om te zetten in een voor mensen begrijpelijk adres. Handig bij het bijhouden van toepassingen waarbij u een GPS-feed van het apparaat of activum ontvangt en het adres wilt weten dat is gekoppeld aan de coördinaten. Dit eindpunt retourneert adresgegevens voor een bepaalde coördinaat.
GET https://atlas.microsoft.com/reverseGeocode?api-version=2023-06-01&coordinates={coordinates}
GET https://atlas.microsoft.com/reverseGeocode?api-version=2023-06-01&coordinates={coordinates}&resultTypes={resultTypes}&view={view}
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Versienummer van Azure Maps-API. |
coordinates
|
query | True |
number[] |
De coördinaten van de locatie waarvan u de geocode wilt omkeren. Voorbeeld: &coördinaten=lon,lat |
result
|
query |
Geef entiteitstypen op die u in het antwoord wilt opnemen. Alleen de typen die u opgeeft, worden geretourneerd. Als het punt niet kan worden toegewezen aan de entiteitstypen die u opgeeft, wordt er geen locatie-informatie geretourneerd in het antwoord. De standaardwaarde is alle mogelijke entiteiten. Een door komma's gescheiden lijst met entiteitstypen die zijn geselecteerd in de volgende opties.
Deze entiteitstypen worden geordend van de meest specifieke entiteit naar de minst specifieke entiteit. Wanneer entiteiten van meer dan één entiteitstype worden gevonden, wordt alleen de meest specifieke entiteit geretourneerd. Als u bijvoorbeeld Address en AdminDistrict1 opgeeft als entiteitstypen en entiteiten zijn gevonden voor beide typen, wordt alleen de gegevens van de adresentiteit geretourneerd in het antwoord. |
||
view
|
query |
string |
Een tekenreeks die een ISO 3166-1 Alpha-2-regio-/landcode vertegenwoordigt. Hierdoor worden geopolitieke betwiste grenzen en labels gewijzigd, zodat deze overeenkomen met de opgegeven gebruikersregio. De parameter View is standaard ingesteld op 'Auto', zelfs als u deze niet hebt gedefinieerd in de aanvraag. 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 Azure AD-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps-beheervlak Account-API. Als u Azure AD-beveiliging in Azure Maps wilt gebruiken, raadpleegt u de volgende artikelen voor hulp. |
|
Accept-Language |
string |
Taal waarin zoekresultaten moeten worden geretourneerd. Raadpleeg Ondersteunde talen voor meer informatie. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK Media Types: "application/geo+json" |
|
Other Status Codes |
Er is een onverwachte fout opgetreden. Media Types: "application/geo+json" |
Beveiliging
AADToken
Dit zijn de Microsoft Entra OAuth 2.0-stromen . Wanneer het wordt gekoppeld met 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-resourceaccounts 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.
- Met het gebruik van de Azure Maps Web SDK kunt u een toepassing op basis van configuratie instellen voor meerdere gebruiksvoorbeelden.
- 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 bij het maken van een Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Met deze sleutel is elke toepassing gemachtigd voor toegang tot alle REST API's. Met andere woorden, deze kunnen momenteel worden behandeld als hoofdsleutels voor het account waarvoor ze zijn uitgegeven.
Voor openbaar beschikbare toepassingen wordt aanbevolen om server-naar-servertoegang van Azure Maps REST API's te gebruiken, waar deze sleutel veilig kan worden opgeslagen.
Type:
apiKey
In:
header
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 point -122.138681, 47.630358
Voorbeeldaanvraag
GET https://atlas.microsoft.com/reverseGeocode?api-version=2023-06-01&coordinates=-122.138681,47.630358
Voorbeeldrespons
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King County"
}
],
"formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
"locality": "Redmond",
"postalCode": "98052",
"addressLine": "15127 NE 24th St"
},
"type": "Address",
"confidence": "Medium",
"matchCodes": [
"Good"
],
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-122.138681,
47.630358
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display"
]
},
{
"geometry": {
"type": "Point",
"coordinates": [
-122.1386787,
47.6302179
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Route"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-122.138681,
47.630358
]
},
"bbox": [
-122.14632282407,
47.626495282429325,
-122.13103917593001,
47.63422071757068
]
}
]
}
Definities
Name | Description |
---|---|
Address |
Het adres van het resultaat |
Admin |
De naam van de onderverdeling in het land of de regio voor een adres. Dit element wordt doorgaans behandeld als de administratieve onderverdeling van de eerste orde, maar in sommige gevallen bevat het ook de tweede, derde of vierde onderverdeling in een land, afhankelijkheid of regio. |
Calculation |
De methode die is gebruikt om het geocodepunt te berekenen. |
Confidence |
Het betrouwbaarheidsniveau dat het resultaat van de gegecodeerde locatie overeenkomt. Gebruik deze waarde met de overeenkomstcode om te bepalen of er meer volledige informatie over de overeenkomst is. Het vertrouwen van een gegecodeerde locatie is gebaseerd op veel factoren, waaronder het relatieve belang van de gegecodeerde locatie en de locatie van de gebruiker, indien opgegeven. |
Country |
|
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
De foutdetails. |
Error |
Foutreactie |
Feature |
Het type van een FeatureCollection-object moet FeatureCollection zijn. |
Features |
|
Feature |
Het type van een functie moet Functie zijn. |
Geocode |
Een verzameling geocodepunten die verschillen in de wijze waarop ze zijn berekend en het voorgestelde gebruik. |
Geocoding |
Dit object wordt geretourneerd na een geslaagde geocoderingsoproep |
Geo |
Een geldig |
Intersection |
Het adres van het resultaat. |
Match |
Een of meer overeenkomende codewaarden die het geocoderingsniveau voor elke locatie in het antwoord vertegenwoordigen. Een geocodeerde locatie met overeenkomende codes van Op dezelfde manier impliceert een geocodeerde locatie met overeenkomende codes van De mogelijke waarden zijn:
|
Properties | |
Reverse |
Geef entiteitstypen op die u in het antwoord wilt opnemen. Alleen de typen die u opgeeft, worden geretourneerd. Als het punt niet kan worden toegewezen aan de entiteitstypen die u opgeeft, wordt er geen locatie-informatie geretourneerd in het antwoord. De standaardwaarde is alle mogelijke entiteiten. Een door komma's gescheiden lijst met entiteitstypen die zijn geselecteerd in de volgende opties.
Deze entiteitstypen worden geordend van de meest specifieke entiteit naar de minst specifieke entiteit. Wanneer entiteiten van meer dan één entiteitstype worden gevonden, wordt alleen de meest specifieke entiteit geretourneerd. Als u bijvoorbeeld Address en AdminDistrict1 opgeeft als entiteitstypen en entiteiten zijn gevonden voor beide typen, wordt alleen de gegevens van de adresentiteit geretourneerd in het antwoord. |
Usage |
Het beste gebruik voor het geocodepunt.
Elk geocodepunt wordt gedefinieerd als een |
Address
Het adres van het resultaat
Name | Type | Description |
---|---|---|
addressLine |
string |
Adresregel met straatnaam en nummer |
adminDistricts |
De naam van de onderverdeling in het land of de regio voor een adres. Dit element wordt doorgaans behandeld als de administratieve onderverdeling van de eerste orde, maar in sommige gevallen bevat het ook de tweede, derde of vierde onderverdeling in een land, afhankelijkheid of regio. |
|
countryRegion | ||
formattedAddress |
string |
De eigenschap Opgemaakt adres |
intersection |
Het adres van het resultaat. |
|
locality |
string |
localiteitseigenschap |
neighborhood |
string |
buurteigenschap |
postalCode |
string |
Eigenschap Postcode |
AdminDistricts
De naam van de onderverdeling in het land of de regio voor een adres. Dit element wordt doorgaans behandeld als de administratieve onderverdeling van de eerste orde, maar in sommige gevallen bevat het ook de tweede, derde of vierde onderverdeling in een land, afhankelijkheid of regio.
Name | Type | Description |
---|---|---|
name |
string |
De naam voor het bijbehorende adminDistrict-veld, Voor adminDistrict[0], kan dit de volledige naam van de staat zijn, zoals Washington, For adminDistrict[1]. Dit kan de volledige naam van de county zijn |
shortName |
string |
De korte naam voor het bijbehorende adminDistrict-veld, Voor adminDistrict[0], dit kan een korte naam van de staat zijn, zoals WA, Voor adminDistrict[1], dit kan de korte naam van de provincie zijn |
CalculationMethodEnum
De methode die is gebruikt om het geocodepunt te berekenen.
Name | Type | Description |
---|---|---|
Interpolation |
string |
Het geocodepunt is gekoppeld aan een punt op een weg met behulp van interpolatie. |
InterpolationOffset |
string |
Het geocodepunt is gekoppeld aan een punt op een weg met behulp van interpolatie met een extra verschuiving om het punt naar de kant van de straat te verplaatsen. |
Parcel |
string |
Het geocodepunt is gekoppeld aan het midden van een pakket. |
Rooftop |
string |
Het geocodepunt is gekoppeld aan het dak van een gebouw. |
ConfidenceEnum
Het betrouwbaarheidsniveau dat het resultaat van de gegecodeerde locatie overeenkomt. Gebruik deze waarde met de overeenkomstcode om te bepalen of er meer volledige informatie over de overeenkomst is.
Het vertrouwen van een gegecodeerde locatie is gebaseerd op veel factoren, waaronder het relatieve belang van de gegecodeerde locatie en de locatie van de gebruiker, indien opgegeven.
Name | Type | Description |
---|---|---|
High |
string |
Als de betrouwbaarheid is ingesteld op Als een aanvraag een locatie of een weergave bevat, kan de rangschikking op de juiste wijze worden gewijzigd. Een locatiequery voor 'Parijs' retourneert bijvoorbeeld 'Parijs, Frankrijk' en 'Parijs, TX' beide met |
Low |
string |
|
Medium |
string |
In sommige gevallen is de geretourneerde overeenkomst mogelijk niet hetzelfde niveau als de informatie in de aanvraag. Een aanvraag kan bijvoorbeeld adresgegevens opgeven en de geocodeservice kan mogelijk alleen overeenkomen met een postcode. Als de geocodeservice er in dit geval zeker van is dat de postcode overeenkomt met de gegevens, wordt de betrouwbaarheid ingesteld op Als de locatiegegevens in de query dubbelzinnig zijn en er geen aanvullende informatie is om de locaties te rangschikken (zoals de locatie van de gebruiker of het relatieve belang van de locatie), wordt de betrouwbaarheid ingesteld op Als de locatiegegevens in de query onvoldoende informatie bieden om een specifieke locatie te geocoderen, kan een minder nauwkeurige locatiewaarde worden geretourneerd en wordt de betrouwbaarheid ingesteld op |
CountryRegion
Name | Type | Description |
---|---|---|
ISO |
string |
ISO van land/regio |
name |
string |
naam van land/regio |
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 |
Aanvullende informatie over de fout. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
FeatureCollectionEnum
Het type van een FeatureCollection-object moet FeatureCollection zijn.
Name | Type | Description |
---|---|---|
FeatureCollection |
string |
FeaturesItem
Name | Type | Description |
---|---|---|
bbox |
number[] |
Begrenzingsvak. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946 voor meer informatie. |
geometry |
Een geldig |
|
id |
string |
Id voor geretourneerde functie |
properties | ||
type |
Het type van een functie moet Functie zijn. |
FeatureTypeEnum
Het type van een functie moet Functie zijn.
Name | Type | Description |
---|---|---|
Feature |
string |
GeocodePoints
Een verzameling geocodepunten die verschillen in de wijze waarop ze zijn berekend en het voorgestelde gebruik.
Name | Type | Description |
---|---|---|
calculationMethod |
De methode die is gebruikt om het geocodepunt te berekenen. |
|
geometry |
Een geldig |
|
usageTypes |
Het beste gebruik voor het geocodepunt.
Elk geocodepunt wordt gedefinieerd als een |
GeocodingResponse
Dit object wordt geretourneerd na een geslaagde geocoderingsoproep
Name | Type | Description |
---|---|---|
features | ||
nextLink |
string |
De is de koppeling naar de volgende pagina van de geretourneerde functies. Als het de laatste pagina is, geen dit veld. |
type |
Het type van een FeatureCollection-object moet FeatureCollection zijn. |
GeoJsonPoint
Een geldig GeoJSON Point
geometrietype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
bbox |
number[] |
Begrenzingsvak. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946 voor meer informatie. |
coordinates |
number[] |
A |
type |
string:
Point |
Hiermee geeft u het |
Intersection
Het adres van het resultaat.
Name | Type | Description |
---|---|---|
baseStreet |
string |
Primaire straat voor de locatie. |
displayName |
string |
Volledige naam van het snijpunt. |
intersectionType |
string |
Type snijpunt. |
secondaryStreet1 |
string |
De eerste kruisende straat. |
secondaryStreet2 |
string |
Indien van toepassing, de tweede kruisende straat. |
MatchCodesEnum
Een of meer overeenkomende codewaarden die het geocoderingsniveau voor elke locatie in het antwoord vertegenwoordigen.
Een geocodeerde locatie met overeenkomende codes van Good
en Ambiguous
betekent bijvoorbeeld dat er meer dan één geocodelocatie is gevonden voor de locatie-informatie en dat de geocodeservice geen zoekhiërarchie heeft om een overeenkomst te vinden.
Op dezelfde manier impliceert een geocodeerde locatie met overeenkomende codes van Ambiguous
en UpHierarchy
dat er geen geocodelocatie kon worden gevonden die overeenkomt met alle opgegeven locatiegegevens. Daarom moest de geocodeservice de hiërarchie opzoeken en meerdere overeenkomsten op dat niveau vinden. Een voorbeeld van een Ambiguous
en UpHierarchy
resultaat is wanneer u volledige adresgegevens opgeeft, maar de geocodeservice geen overeenkomst voor het adres kan vinden en in plaats daarvan informatie retourneert voor meer dan één RoadBlock-waarde.
De mogelijke waarden zijn:
Good
: de locatie heeft slechts één overeenkomst of alle geretourneerde overeenkomsten worden beschouwd als sterke overeenkomsten. Een query voor New York retourneert bijvoorbeeld verschillende goede overeenkomsten.
Ambiguous
: De locatie is een van de mogelijke overeenkomsten. Wanneer u bijvoorbeeld een query uitvoert op het adres 128 Main St., kan het antwoord twee locaties retourneren voor 128 North Main St. en 128 South Main St. omdat er onvoldoende informatie is om te bepalen welke optie u moet kiezen.
UpHierarchy
: De locatie vertegenwoordigt een verplaatsing omhoog in de geografische hiërarchie. Dit gebeurt wanneer er geen overeenkomst voor de locatieaanvraag is gevonden, waardoor een minder nauwkeurig resultaat wordt geretourneerd. Als er bijvoorbeeld geen overeenkomst voor het aangevraagde adres kan worden gevonden, kan een overeenkomstcode van UpHierarchy
met het entiteitstype RoadBlock worden geretourneerd.
Name | Type | Description |
---|---|---|
Ambiguous |
string |
|
Good |
string |
|
UpHierarchy |
string |
Properties
Name | Type | Description |
---|---|---|
address |
Het adres van het resultaat |
|
confidence |
Het betrouwbaarheidsniveau dat het resultaat van de gegecodeerde locatie overeenkomt. Gebruik deze waarde met de overeenkomstcode om te bepalen of er meer volledige informatie over de overeenkomst is. Het vertrouwen van een gegecodeerde locatie is gebaseerd op veel factoren, waaronder het relatieve belang van de gegecodeerde locatie en de locatie van de gebruiker, indien opgegeven. |
|
geocodePoints |
Een verzameling geocodepunten die verschillen in de wijze waarop ze zijn berekend en het voorgestelde gebruik. |
|
matchCodes |
Een of meer overeenkomende codewaarden die het geocoderingsniveau voor elke locatie in het antwoord vertegenwoordigen. Een geocodeerde locatie met overeenkomende codes van Op dezelfde manier impliceert een geocodeerde locatie met overeenkomende codes van De mogelijke waarden zijn:
|
|
type |
string |
Een van de volgende:
|
ReverseGeocodingResultTypeEnum
Geef entiteitstypen op die u in het antwoord wilt opnemen. Alleen de typen die u opgeeft, worden geretourneerd. Als het punt niet kan worden toegewezen aan de entiteitstypen die u opgeeft, wordt er geen locatie-informatie geretourneerd in het antwoord. De standaardwaarde is alle mogelijke entiteiten. Een door komma's gescheiden lijst met entiteitstypen die zijn geselecteerd in de volgende opties.
- Adres
- Buurt
- PopulatedPlace
- Postcode1
- AdminDivision1
- AdminDivision2
- CountryRegion
Deze entiteitstypen worden geordend van de meest specifieke entiteit naar de minst specifieke entiteit. Wanneer entiteiten van meer dan één entiteitstype worden gevonden, wordt alleen de meest specifieke entiteit geretourneerd. Als u bijvoorbeeld Address en AdminDistrict1 opgeeft als entiteitstypen en entiteiten zijn gevonden voor beide typen, wordt alleen de gegevens van de adresentiteit geretourneerd in het antwoord.
Name | Type | Description |
---|---|---|
Address |
string |
|
AdminDivision1 |
string |
|
AdminDivision2 |
string |
|
CountryRegion |
string |
|
Neighborhood |
string |
|
PopulatedPlace |
string |
|
Postcode1 |
string |
UsageTypeEnum
Het beste gebruik voor het geocodepunt.
Elk geocodepunt wordt gedefinieerd als een Route
punt, een Display
punt of beide.
Gebruik Route
punten als u een route naar de locatie maakt. Gebruik Display
punten als u de locatie op een kaart weergeeft. Als de locatie bijvoorbeeld een park is, kan een Route
punt een ingang van het park opgeven waar u met een auto kunt binnenkomen en een Display
punt kan een punt zijn dat het midden van het park aangeeft.
Name | Type | Description |
---|---|---|
Display |
string |
|
Route |
string |