Dela via

Search - Get Search Address Reverse

  • Referens
Tjänst:
Maps
API-version:
1.0

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

Det kan finnas tillfällen då du behöver översätta en koordinat (exempel: 37.786505, -122.3862) till en mänsklig begriplig gatuadress. 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}
Med valfria parametrar: 
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 det är falskt konverteras nya raderna till kommatecken.
entityType
 query

GeographicEntityType

Anger vilken nivå av filtrering som utförs på geografiska områden. Begränsar sökningen efter angivna geografiska entitetstyper, 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. Returnerat geometri-ID kan användas för att hämta geometrin för geografin via Get Search Polygon API. Följande parametrar ignoreras när entityType anges:

  • överskrift
  • nummer
  • returnRoadUse
  • returnSpeedLimit
  • roadUse
  • returnMatchType
heading
 query

integer

minimum: -360
maximum: 360

Fordonets riktning i grader för att färdas längs ett vägsegment. 0 är Norr, 90 är öst och så vidare, värden sträcker sig 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å angivet språk 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 in 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 har uppnått i svaret.
returnRoadUse
 query

boolean

Boolesk. Aktivera retur av väganvändningsmatrisen för omvända geokoder på gatunivå
returnSpeedLimit
 query

boolean

Boolesk. Så här aktiverar du retur av den anlagda hastighetsgränsen
roadUse
 query

RoadUseType[]

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 över sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som programmet 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 platsen för dina användare och ange sedan view-parametern korrekt för den platsen. Du kan också 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äkerhetsmodellen. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar för vägledning.

Svar

Name Typ Description
200 OK

ReverseSearchAddressResult

OK
Other Status Codes

ErrorResponse

Ett oväntat fel uppstod.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll 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 ett eller flera Azure Maps-resurskonton 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 till 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.

Anmärkning

  • Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hantering-API:et.
  • Authorization URL är specifik 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-hanteringsplan via Azure-portalen, 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 Översikt över Microsofts identitetsplattform.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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 Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.

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

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

Typ: apiKey
I: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, 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 till 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 återgivningsmissbruket och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Searches addresses for coordinates 37.337,-121.89

Exempelbegäran

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

Exempelsvar

Statuskod:
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

Avgränsningsrutan för platsen.
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. Presentera endast när entityType begärdes och är tillgängligt.
LatLongPairAbbreviated

En plats som representeras som en 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 över sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som programmet 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 platsen för dina användare och ange sedan view-parametern korrekt för den platsen. Du kan också 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 för omvänd adress.
QueryType

Den typ av fråga som returneras: NEARBY 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 omvänd anrop till sökadress
ReverseSearchAddressResultItem

Resultatobjekt för omvänd svarssökningsadress
RoadUseType

Beskriver möjliga användningar av en väg.
SearchSummary

Sammanfattningsobjekt för ett api-svar för sökning.

Address

Objekt

Resultatets adress

Name Typ Description
boundingBox

BoundingBoxCompassNotation

Avgränsningsrutan för platsen.
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 KODEN ISO 3166-2. 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 endast om countrySubdivision visas i ett förkortat formulär. 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 lokal plats som grupperar flera adresserbara objekt i adresseringssyfte, utan att vara en administrativ enhet. Det här fältet används för att skapa egenskapen freeformAddress. localName representerar postkommunen. Beroende på platsen är localName 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

Stad/Stad
Obs! municipality representerar bostadskommunen. Beroende på plats kan värdet för municipality skilja sig från det allmänt kända namnet på en stad eller stad. För det allmänt kända namnet på staden eller staden föreslås det att det localName värdet ska användas i stället för det municipality värdet.
municipalitySubdivision

string

Sub/Super City
neighbourhood

string

Ett grannskap är ett geografiskt lokaliserat område inom en stad eller stad med distinkta egenskaper och sociala interaktioner mellan invånare.
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

Objekt

Avgränsningsrutan för platsen.

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änsningslådan som kommaavgränsade flyttal
southWest

string

Sydvästlig latitud, longitudkoordinat för avgränsningslådan som kommaavgränsade flyttal

Entity

Uppräkning

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

Värde Description
position

Position entitet

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.
type

string

Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Objekt

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

GeographicEntityType

Uppräkning

Geografientitetstyp. Presentera endast när entityType begärdes och är tillgängligt.

Värde Description
Country

namn på land/region
CountrySecondarySubdivision

Län
CountrySubdivision

Delstat eller provins
CountryTertiarySubdivision

Namngivet område
Municipality

Stad/Stad
MunicipalitySubdivision

Sub/Super City
Neighbourhood

Grannskap
PostalCodeArea

Postnummer/postnummer

LatLongPairAbbreviated

Objekt

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

Name Typ Description
lat

number (double)

Latitude-egenskap
lon

number (double)

Longitudegenskap

LocalizedMapView

Uppräkning

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 över sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som programmet 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 platsen för dina användare och ange sedan view-parametern korrekt för den platsen. Du kan också 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.

Värde Description
AE

Förenade Arabemiraten (arabisk vy)
AR

Argentina (argentinsk vy)
Auto

Returnera kartdata baserat på IP-adressen för begäran.
BH

Bahrain (arabisk vy)
IN

Indien (indisk vy)
IQ

Irak (arabisk vy)
JO

Jordanien (arabisk vy)
KW

Kuwait (arabisk vy)
LB

Libanon (arabisk vy)
MA

Marocko (marockansk vy)
OM

Oman (arabisk vy)
PK

Pakistan (pakistansk vy)
PS

Palestinska myndigheten (arabisk vy)
QA

Qatar (arabisk vy)
SA

Saudiarabien (arabisk vy)
SY

Syrien (arabisk vy)
Unified

Enhetlig vy (andra)
YE

Jemen (arabisk vy)

MatchType

Uppräkning

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

Värde Description
AddressPoint
HouseNumberRange
Street

QueryType

Uppräkning

Den typ av fråga som returneras: NEARBY eller NON_NEAR.

Värde Description
NEARBY

Sökningen utfördes runt en viss latitud och longitud med en definierad radie
NON_NEAR

Sökningen utfördes globalt, utan bias till en viss latitud och longitud, och ingen definierad radie

ResponseFormat

Uppräkning

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

Värde Description
json

JavaScript-objekt notationens datautbytesformat
xml

Det utökningsbara markupspråket

ReverseSearchAddressResult

Objekt

Det här objektet returneras från ett lyckat omvänd anrop till sökadress

Name Typ Description
addresses

ReverseSearchAddressResultItem[]

Matris för adresser
summary

SearchSummary

Sammanfattningsobjekt för omvänd svarssökningsadress

ReverseSearchAddressResultItem

Objekt

Resultatobjekt för omvänd svarssökningsadress

Name Typ Description
address

Address

Resultatets adress
matchType

MatchType

Information om typen av matchning.

En av:

  • AddressPoint
  • HouseNumberRange
  • Gata
position

string

Placera egenskapen i form av {latitude},{longitude}"
roadUse

RoadUseType[]

Beskriver möjliga användningar av en väg.

RoadUseType

Uppräkning

Beskriver möjliga användningar av en väg.

Värde Description
Arterial
LimitedAccess
LocalStreet
Ramp
Rotary
Terminal

SearchSummary

Objekt

Sammanfattningsobjekt för ett api-svar för sökning.

Name Typ Description
fuzzyLevel

integer

Den maximala fuzzy-nivå som krävs för att ge resultat.
geoBias

LatLongPairAbbreviated

Indikation när den interna sökmotorn har tillämpat en geospatial bias för att förbättra resultatordningen. I vissa metoder kan detta påverkas genom att ange parametrarna lat och lon 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: NEARBY eller NON_NEAR.
totalResults

integer

Det totala antalet resultat som hittades.