Search - Get Search Address Reverse

Referentie

Service:: Maps

API-versie:: 1.0

Gebruik deze functie om een adres en locatiegegevens op te halen uit breedtegraad- en lengtegraadcoördinaten.
De Get Search Address Reverse-API is en http-GET-aanvraag die een adres of locatie retourneert wanneer de coördinaten voor breedte- en lengtegraad zijn opgegeven.

Soms moet u een coördinaat (bijvoorbeeld: 37.786505, -122.3862) omzetten in een begrijpelijk adres voor mensen. Meestal is dit nodig bij het bijhouden van toepassingen waar u een GPS-feed ontvangt van het apparaat of de asset en wilt weten welk adres de coördinaat zich bevindt. Dit eindpunt retourneert adresgegevens voor een bepaalde coördinaat.

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

Met optionele parameters:

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}&language={language}&returnSpeedLimit={returnSpeedLimit}&heading={heading}&radius={radius}&number={number}&returnRoadUse={returnRoadUse}&roadUse={roadUse}&allowFreeformNewline={allowFreeformNewline}&returnMatchType={returnMatchType}&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	number[]	De toepasselijke query die is opgegeven als een door komma's gescheiden tekenreeks die is samengesteld door breedtegraad gevolgd door lengtegraad, bijvoorbeeld '47,641268,-125679'.
allowFreeformNewline	query		boolean	Opmaak van nieuwe regels in het opgemaakte adres. Indien waar, bevat het adres nieuwe regels. Als dit onwaar is, worden nieuwe regels geconverteerd naar komma'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
heading	query		integer minimum: -360 maximum: 360	De richtingsrichting van het voertuig in graden, voor het reizen langs een segment van de weg. 0 is Noord, 90 is Oost, enzovoort, waarden variëren van -360 tot 360. De precisie kan maximaal één decimaalteken bevatten
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.
number	query		string	Straatnummer als een tekenreeks. Als er een getal wordt verzonden in combinatie met de aanvraag, kan het antwoord de zijkant van de straat (links/rechts) en ook een verschuivingspositie voor dat nummer bevatten
radius	query		integer	De straal in meters totdat de resultaten worden beperkt tot het gedefinieerde gebied
returnMatchType	query		boolean	Neem informatie op over het type overeenkomst dat de geocoder heeft bereikt in het antwoord.
returnRoadUse	query		boolean	Booleaans. De matrix voor weggebruik inschakelen voor omgekeerde geocodes op straatniveau
returnSpeedLimit	query		boolean	Booleaans. Het retourneren van de geplaatste snelheidslimiet inschakelen
roadUse	query		RoadUseType[]	Om omgekeerde geocodes te beperken tot een bepaald type weggebruik. De matrix voor weggebruik voor omgekeerde geocodes kan een of meer van LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet zijn
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	ReverseSearchAddressResult	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

Searches addresses for coordinates 37.337,-121.89

Voorbeeldaanvraag

HTTP

GET https://atlas.microsoft.com/search/address/reverse/json?api-version=1.0&query=37.337,-121.89

Voorbeeldrespons

Statuscode:: 200

{
  "summary": {
    "queryTime": 5,
    "numResults": 1
  },
  "addresses": [
    {
      "address": {
        "streetNumber": "31",
        "routeNumbers": [],
        "streetName": "N 2nd St",
        "streetNameAndNumber": "31 N 2nd St",
        "countryCode": "US",
        "countrySubdivisionCode": "CA",
        "countrySubdivisionName": "California",
        "municipality": "San Jose",
        "postalCode": "95113",
        "country": "United States of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "31 N 2nd St, San Jose CA 95113",
        "extendedPostalCode": "951131217"
      },
      "position": "37.337090,-121.889820"
    }
  ]
}

Definities

Name	Description
Address	Het adres van het resultaat
BoundingBoxCompassNotation	Het begrenzingsvak van de locatie.
Entity	Bron van entiteitstype van het begrenzingsvak. Voor omgekeerde geocodering is dit altijd gelijk aan positie.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GeographicEntityType	Entiteitstype Geografie. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.
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.
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.
ReverseSearchAddressResult	Dit object wordt geretourneerd vanuit een geslaagde aanroep adresomkering zoeken
ReverseSearchAddressResultItem	Resultaatobject voor een omgekeerd antwoord van het zoekadres
RoadUseType	Beschrijft het mogelijke gebruik van een weg.
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.

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

Entity

Inventarisatie

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

Waarde	Description
position	Positieentiteit

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

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

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

ReverseSearchAddressResult

Object

Dit object wordt geretourneerd vanuit een geslaagde aanroep adresomkering zoeken

Name	Type	Description
addresses	ReverseSearchAddressResultItem[]	Adressenmatrix
summary	SearchSummary	Samenvattingsobject voor een omgekeerd antwoord van het zoekadres

ReverseSearchAddressResultItem

Object

Resultaatobject voor een omgekeerd antwoord van het zoekadres

Name	Type	Description
address	Address	Het adres van het resultaat
matchType	MatchType	Informatie over het type overeenkomst. Een van de volgende: AddressPoint HouseNumberRange Straat
position	string	Positieeigenschap in de vorm van {latitude},{longitude}"
roadUse	RoadUseType[]	Beschrijft het mogelijke gebruik van een weg.

RoadUseType

Inventarisatie

Beschrijft het mogelijke gebruik van een weg.

Waarde	Description
Arterial
LimitedAccess
LocalStreet
Ramp
Rotary
Terminal

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.

Delen via

Search - Get Search Address Reverse

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

AADToken

Bereiken

subscription-key

SAS Token

Voorbeelden

Searches addresses for coordinates 37.337,-121.89

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Address

BoundingBoxCompassNotation

Entity

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

LatLongPairAbbreviated

LocalizedMapView

MatchType

QueryType

ResponseFormat

ReverseSearchAddressResult

ReverseSearchAddressResultItem

RoadUseType

SearchSummary

Aanvullende resources