Search - Get Search Address Reverse

Referens

Service:: Maps

API Version:: 1.0

Använd för att hämta information om gatuadress och plats från latitud- och longitudkoordinater.
API:et Get Search Address Reverse är och HTTP-begäran GET som returnerar en gatuadress eller plats vid angivna latitud- och longitudkoordinater.

Det kan finnas tillfällen när du behöver översätta en koordinat (exempel: 37.786505, -122.3862) till en gatuadress som är begriplig för människor. Oftast behövs detta för att spåra program där du får ett GPS-flöde från enheten eller tillgången och vill veta vilken adress där koordinaten finns. Den här slutpunkten returnerar adressinformation för en viss koordinat.

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

With optional 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-parametrar

Name	I	Obligatorisk	Typ	Description
format	path	True	ResponseFormat	Önskat format för svaret. Värdet kan vara antingen json eller xml.
api-version	query	True	string	Versionsnummer för Azure Maps API.
query	query	True	number[]	Den tillämpliga frågan som anges som en kommaavgränsad sträng som består av latitud följt av longitud, t.ex. "47.641268,-122.125679".
allowFreeformNewline	query		boolean	Format för nya streck i den formaterade adressen. Om det är sant innehåller adressen nya raderingar. Om värdet är falskt konverteras nya raderna till kommatecken.
entityType	query		GeographicEntityType	Anger den filtreringsnivå som utförs på geografiska områden. Begränsar sökningen efter angivna geografientitetstyper, t.ex. returnera endast kommun. Det resulterande svaret innehåller geografi-ID:t samt den entitetstyp som matchas. Om du anger mer än en entitet som en kommaavgränsad lista returnerar slutpunkten den minsta tillgängliga entiteten. Det returnerade geometri-ID:t kan användas för att hämta geometrin i det geografiska området via Api:et Get Search Polygon. Följande parametrar ignoreras när entityType anges: Rubrik antal returnRoadUse returnSpeedLimit roadUse returnMatchType
heading	query		integer	Fordonets riktningsriktning i grader, för att färdas längs ett vägsegment. 0 är Nord, 90 är Öst och så vidare, värden från -360 till 360. Precisionen kan innehålla upp till en decimal
language	query		string	Språk där sökresultat ska returneras. Bör vara en av IETF-språktaggar som stöds, skiftlägesokänsliga. När data på det angivna språket inte är tillgängliga för ett visst fält används standardspråket. Mer information finns i Språk som stöds .
number	query		string	Gatunummer som en sträng. Om ett nummer skickas tillsammans med begäran kan svaret innehålla sidan av gatan (vänster/höger) och även en förskjutningsposition för det talet
radius	query		integer	Radien i meter till för att resultaten ska begränsas till det definierade området
returnMatchType	query		boolean	Inkludera information om vilken typ av matchning som geokodaren uppnår i svaret.
returnRoadUse	query		boolean	Boolean. Aktivera retur av väganvändningsmatrisen för omvända geokoder på gatunivå
returnSpeedLimit	query		boolean	Boolean. Så här aktiverar du retur av den anlagda hastighetsgränsen
roadUse	query		RoadUseType[]	För att begränsa omvända geokoder till en viss typ av väganvändning. Väganvändningsmatrisen för omvända geokoder kan vara en eller flera av LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet
view	query		LocalizedMapView	Med parametern Visa (kallas även parametern "användarregion" kan du visa rätt kartor för ett visst land/en viss region för geopolitiskt omtvistade regioner. Olika länder/regioner har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som ditt program kommer att betjäna. Som standard är view-parametern inställd på "Unified" även om du inte har definierat den i begäran. Det är ditt ansvar att fastställa användarnas plats och sedan ange parametern Visa korrekt för den platsen. Alternativt kan du välja att ange "View=Auto", som returnerar kartdata baserat på IP-adressen för begäran. Parametern Visa i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och andra data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt. Exempel: view=IN. Mer information finns i Vyer som stöds och för att se tillgängliga vyer.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps hanteringsplans konto-API. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Svar

Name	Typ	Description
200 OK	ReverseSearchAddressResult	OK
Other Status Codes	ErrorResponse	Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Anteckning

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API :et.
Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer.
Den rollbaserade Åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
Mer information om Microsofts identitetsplattform finns i Microsofts identitetsplattform översikt.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Det här är en delad nyckel som etableras när du skapar ett Azure Maps-konto i Azure Portal eller använder PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de utfärdas i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruk och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

Searches addresses for coordinates 37.337,-121.89

Sample Request

HTTP

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

Sample Response

Status code:: 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"
    }
  ]
}

Definitioner

Name	Description
Address	Resultatets adress
BoundingBoxCompassNotation	Platsens avgränsningsruta.
Entity	Entitetstypkälla för avgränsningsrutan. För omvänd geokodning är detta alltid lika med position.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
GeographicEntityType	Geografientitetstyp. Finns bara när entityType begärdes och är tillgängligt.
LatLongPairAbbreviated	En plats som representeras som latitud och longitud med kortnamnen "lat" & "lon".
LocalizedMapView	Med parametern Visa (kallas även parametern "användarregion" kan du visa rätt kartor för ett visst land/en viss region för geopolitiskt omtvistade regioner. Olika länder/regioner har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som ditt program kommer att betjäna. Som standard är view-parametern inställd på "Unified" även om du inte har definierat den i begäran. Det är ditt ansvar att fastställa användarnas plats och sedan ange parametern Visa korrekt för den platsen. Alternativt kan du välja att ange "View=Auto", som returnerar kartdata baserat på IP-adressen för begäran. Parametern Visa i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och andra data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt. Exempel: view=IN. Mer information finns i Vyer som stöds och för att se tillgängliga vyer.
MatchType	Matchningstyper för en sökåtgärd med omvänd adress.
QueryType	Den typ av fråga som returneras: NÄRLIGGANDE eller NON_NEAR.
ResponseFormat	Önskat format för svaret. Värdet kan vara antingen json eller xml.
ReverseSearchAddressResult	Det här objektet returneras från ett lyckat Search anrop till omvänd adress
ReverseSearchAddressResultItem	Resultatobjekt för omvänd Search-adresssvar
RoadUseType	Beskriver möjliga användningsområden för en väg.
SearchSummary	Sammanfattningsobjekt för ett Search API-svar.

Address

Resultatets adress

Name	Typ	Description
boundingBox	BoundingBoxCompassNotation	Platsens avgränsningsruta.
buildingNumber	string	Byggnadens nummer på gatan. INAKTUELL, använd streetNumber i stället.
country	string	namn på land/region
countryCode	string	Land (Obs! Det här är en kod med två bokstäver, inte ett namn på land/region.)
countryCodeISO3	string	ISO alfa-3 landskod
countrySecondarySubdivision	string	Län
countrySubdivision	string	Delstat eller provins
countrySubdivisionCode	string	`countrySubdivisionCode` prefixet av `countryCode` ( countryCode-countrySubdivisionCode ) och bindestrecket utgör ISO 3166-2-koden. Exempel: TX för Texas, SCT för Skottland och ON för Ontario.
countrySubdivisionName	string	Det fullständiga namnet på en första nivå i den administrativa hierarkin för land/region. Det här fältet visas bara om countrySubdivision presenteras i ett förkortat format. Stöds endast för USA, Kanada och Storbritannien.
countryTertiarySubdivision	string	Namngivet område
crossStreet	string	Namnet på gatan som korsas.
extendedPostalCode	string	Utökat postnummer (tillgängligheten är beroende av regionen).
freeformAddress	string	En adressrad formaterad enligt formateringsreglerna för ett resultats ursprungsland/region, eller, om det gäller ett land/en region, dess fullständiga namn på land/region.
localName	string	En adresskomponent som representerar namnet på ett geografiskt område eller en lokalitet som grupperar flera adresserbara objekt i adresseringssyfte, utan att vara en administrativ enhet. Det här fältet används för att skapa `freeformAddress` egenskapen . `localName` representerar postkommunen. Beroende på platsen `localName` , är det allmänt kända namnet på en stad eller stad. För det allmänt kända namnet på en stad eller stad använder du `localName` i stället för `municipality`.
municipality	string	Ort/stad Obs! `municipality` Representerar bostadskommunen. Beroende på plats `municipality` kan värdet skilja sig från det allmänt kända namnet på en stad eller stad. För det allmänt kända namnet på orten föreslår vi att `localName` värdet används i stället för värdet `municipality` .
municipalitySubdivision	string	Sub / Super City
neighbourhood	string	En stadsdel är ett geografiskt lokaliserat område inom en stad eller stad med särskiljande egenskaper och sociala interaktioner mellan invånarna.
postalCode	string	Postnummer/postnummer
routeNumbers	string[]	De koder som används för att entydigt identifiera gatan
street	string	Gatunamnet. INAKTUELL, använd streetName i stället.
streetName	string	Gatunamnet.
streetNameAndNumber	string	Gatunamnet och numret.
streetNumber	string	Byggnadens nummer på gatan.

BoundingBoxCompassNotation

Platsens avgränsningsruta.

Name	Typ	Description
entity	Entity	Entitetstypkälla för avgränsningsrutan. För omvänd geokodning är detta alltid lika med position.
northEast	string	Nordostlig latitud, longitudkoordinat för avgränsningsrutan som kommaavgränsade flyttal
southWest	string	Sydvästlig latitud, longitudkoordinat för avgränsningsrutan som kommaavgränsade flyttal

Entity

Entitetstypkälla för avgränsningsrutan. För omvänd geokodning är detta alltid lika med position.

Name	Typ	Description
position	string	Placeringsentitet

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

GeographicEntityType

Geografientitetstyp. Finns bara när entityType begärdes och är tillgängligt.

Name	Typ	Description
Country	string	namn på land/region
CountrySecondarySubdivision	string	Län
CountrySubdivision	string	Delstat eller provins
CountryTertiarySubdivision	string	Namngivet område
Municipality	string	Ort/stad
MunicipalitySubdivision	string	Sub / Super City
Neighbourhood	string	Grannskapet
PostalCodeArea	string	Postnummer/postnummer

LatLongPairAbbreviated

En plats som representeras som latitud och longitud med kortnamnen "lat" & "lon".

Name	Typ	Description
lat	number	Latitude-egenskap
lon	number	Longitudegenskap

LocalizedMapView

Med parametern Visa (kallas även parametern "användarregion" kan du visa rätt kartor för ett visst land/en viss region för geopolitiskt omtvistade regioner. Olika länder/regioner har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som ditt program kommer att betjäna. Som standard är view-parametern inställd på "Unified" även om du inte har definierat den i begäran. Det är ditt ansvar att fastställa användarnas plats och sedan ange parametern Visa korrekt för den platsen. Alternativt kan du välja att ange "View=Auto", som returnerar kartdata baserat på IP-adressen för begäran. Parametern Visa i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och andra data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt. Exempel: view=IN.

Mer information finns i Vyer som stöds och för att se tillgängliga vyer.

Name	Typ	Description
AE	string	Förenade Arabemiraten (arabisk vy)
AR	string	Argentina (argentinsk vy)
Auto	string	Returnera kartdata baserat på IP-adressen för begäran.
BH	string	Bahrain (arabisk vy)
IN	string	Indien (indisk vy)
IQ	string	Irak (arabisk vy)
JO	string	Jordanien (arabisk vy)
KW	string	Kuwait (arabisk vy)
LB	string	Libanon (arabisk vy)
MA	string	Marocko (marockansk vy)
OM	string	Oman (arabisk vy)
PK	string	Pakistan (pakistansk vy)
PS	string	Palestinska myndigheten (arabisk vy)
QA	string	Qatar (arabisk vy)
SA	string	Saudiarabien (arabisk vy)
SY	string	Syrien (arabisk vy)
Unified	string	Enhetlig vy (andra)
YE	string	Jemen (arabisk vy)

MatchType

Matchningstyper för en sökåtgärd med omvänd adress.

Name	Typ	Description
AddressPoint	string
HouseNumberRange	string
Street	string

QueryType

Den typ av fråga som returneras: NÄRLIGGANDE eller NON_NEAR.

Name	Typ	Description
NEARBY	string	Search utfördes runt en viss latitud och longitud med en definierad radie
NON_NEAR	string	Search utfördes globalt, utan bias till en viss latitud och longitud, och ingen definierad radie

ResponseFormat

Önskat format för svaret. Värdet kan vara antingen json eller xml.

Name	Typ	Description
json	string	Datautbytesformat för JavaScript-objektnotation
xml	string	Utökningsbart markeringsspråk

ReverseSearchAddressResult

Det här objektet returneras från ett lyckat Search anrop till omvänd adress

Name	Typ	Description
addresses	ReverseSearchAddressResultItem[]	Matris för adresser
summary	SearchSummary	Sammanfattningsobjekt för omvänd Search adresssvar

ReverseSearchAddressResultItem

Resultatobjekt för omvänd Search-adresssvar

Name	Typ	Description
address	Address	Resultatets adress
matchType	MatchType	Information om typen av matchning. Något av: AddressPoint HouseNumberRange Gata
position	string	Egenskapen Position i form av "{latitude},{longitude}"
roadUse	RoadUseType[]	Beskriver möjliga användningsområden för en väg.

RoadUseType

Beskriver möjliga användningsområden för en väg.

Name	Typ	Description
Arterial	string
LimitedAccess	string
LocalStreet	string
Ramp	string
Rotary	string
Terminal	string

SearchSummary

Sammanfattningsobjekt för ett Search API-svar.

Name	Typ	Description
fuzzyLevel	integer	Den maximala fuzzy-nivå som krävs för att tillhandahålla resultat.
geoBias	LatLongPairAbbreviated	Indikation när den interna sökmotorn har tillämpat en geospatial bias för att förbättra resultatrankningen. I vissa metoder kan detta påverkas genom att ange lat- och lon-parametrarna där det är tillgängligt. I andra fall är det rent internt.
limit	integer	Maximalt antal svar som ska returneras
numResults	integer	Antal resultat i svaret.
offset	integer	Startförskjutningen för de returnerade resultaten i den fullständiga resultatuppsättningen.
query	string	Frågeparametern som användes för att skapa dessa sökresultat.
queryTime	integer	Tid som ägnas åt att lösa frågan, i millisekunder.
queryType	QueryType	Den typ av fråga som returneras: NÄRLIGGANDE eller NON_NEAR.
totalResults	integer	Det totala antalet resultat som hittades.