Search - Get Search Address Reverse Cross Street
Använd för att hämta information om platser mellan flera gator från latitud- och longitudkoordinater.
API:et Get Search Address Reverse Cross Street
är en HTTP-begäran GET
som returnerar närmaste korsgata 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 förståelig korsgata. 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 gatuinformation för en viss koordinat.
GET https://atlas.microsoft.com/search/address/reverse/crossStreet/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/address/reverse/crossStreet/{format}?api-version=1.0&query={query}&limit={limit}&heading={heading}&radius={radius}&language={language}&view={view}
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
format
|
path | True |
Ö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". |
heading
|
query |
integer |
Fordonets riktningsriktning 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 . |
|
limit
|
query |
integer |
Maximalt antal svar som ska returneras. Standard: 10, minimum: 1 och maximum: 100 |
|
radius
|
query |
integer |
Radien i meter till för att resultaten ska begränsas till det definierade området |
|
view
|
query |
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 platsen för dina användare och ange sedan 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. 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. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
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 ett 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 ha åtkomstkontroll för specifika API:er och omfång.
Anteckning
- Den här säkerhetsdefinitionen
x-ms-client-id
krä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-hanterings-API :et. -
Authorization URL
är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. - Rollbaserad åtkomstkontroll 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.
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 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 huvudnyckel i det konto som de har utfärdats 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.
Typ:
apiKey
I:
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 säkrare 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
Search address of the nearest intersection/crossroad
Exempelbegäran
GET https://atlas.microsoft.com/search/address/reverse/crossStreet/json?api-version=1.0&query=37.337,-121.89
Exempelsvar
{
"summary": {
"numResults": 1,
"queryTime": 41
},
"addresses": [
{
"address": {
"streetName": "East Santa Clara Street & North 2nd Street",
"crossStreet": "East Santa Clara Street",
"municipalitySubdivision": "San Jose, Downtown San Jose",
"municipality": "San Jose",
"countrySecondarySubdivision": "Santa Clara",
"countryTertiarySubdivision": "San Jose",
"countrySubdivisionCode": "CA",
"postalCode": "95113",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "East Santa Clara Street & North 2nd Street, San Jose, CA 95113",
"countrySubdivisionName": "California"
},
"position": "37.33666,-121.88951"
}
]
}
Definitioner
Name | Description |
---|---|
Address |
Resultatets adress |
Bounding |
Platsens avgränsningsruta. |
Entity |
Entitetstypkälla för avgränsningsrutan. För omvänd geokodning är detta alltid lika med position. |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Lat |
En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon". |
Localized |
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 platsen för dina användare och ange sedan 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. |
Query |
Typen av fråga som returneras: NEARBY eller NON_NEAR. |
Response |
Önskat format för svaret. Värdet kan vara antingen json eller xml. |
Reverse |
Det här objektet returneras från ett lyckat Search Adress omvänd CrossStreet-anrop |
Reverse |
Resultatobjekt för ett svar från Search adress, omvänd korsgata |
Search |
Sammanfattningsobjekt för ett Search API-svar. |
Address
Resultatets adress
Name | Typ | Description |
---|---|---|
boundingBox |
Platsens avgränsningsruta. |
|
buildingNumber |
string |
Byggnadens nummer på gatan. INAKTUELL, använd streetNumber i stället. |
country |
string |
land/regionnamn |
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 |
|
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 för 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 |
municipality |
string |
Stad/Stad |
municipalitySubdivision |
string |
Sub/Super City |
neighbourhood |
string |
Ett grannskap är ett geografiskt lokaliserat område inom en stad eller stad med särpräglade 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
Platsens avgränsningsruta.
Name | Typ | Description |
---|---|---|
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
Entitetstypkälla för avgränsningsrutan. För omvänd geokodning är detta alltid lika med position.
Name | Typ | Description |
---|---|---|
position |
string |
Position entitet |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Ytterligare information. |
type |
string |
Den ytterligare informationstypen. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
LatLongPairAbbreviated
En plats som representeras som en 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 platsen för dina användare och ange sedan 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) |
QueryType
Typen av fråga som returneras: NEARBY 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 |
|
xml |
string |
ReverseSearchCrossStreetAddressResult
Det här objektet returneras från ett lyckat Search Adress omvänd CrossStreet-anrop
Name | Typ | Description |
---|---|---|
addresses |
Matris med adresser |
|
summary |
Sammanfattningsobjekt för ett svar från Search adress, omvänd korsgata |
ReverseSearchCrossStreetAddressResultItem
Resultatobjekt för ett svar från Search adress, omvänd korsgata
Name | Typ | Description |
---|---|---|
address |
Resultatets adress |
|
position |
string |
Egenskapen Position i form av {latitude},{longitude}" |
SearchSummary
Sammanfattningsobjekt för ett Search API-svar.
Name | Typ | Description |
---|---|---|
fuzzyLevel |
integer |
Den maximala fuzzy-nivå som krävs för att ge resultat. |
geoBias |
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 de är tillgängliga. 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 inom 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 |
Typen av fråga som returneras: NEARBY eller NON_NEAR. |
|
totalResults |
integer |
Det totala antalet resultat som hittades. |