Search - Get Search Address Reverse Cross Street

Gebruik om informatie over de locatie van een dwarsstraat op te halen uit de coördinaten van de breedtegraad en lengtegraad.

De Get Search Address Reverse Cross Street API is een HTTP-aanvraag GET die de dichtstbijzijnde dwarsstraat retourneert wanneer de breedte- en lengtegraadcoördinaten worden opgegeven. Het kan gebeuren dat u een coördinaat (bijvoorbeeld: 37.786505, -122.3862) moet omzetten in een voor mensen begrijpelijke dwarsstraat. Meestal is dit nodig bij het bijhouden van toepassingen waarbij u een GPS-feed van het apparaat of asset ontvangt en wilt weten welk adres de coördinaat zich bevindt. Dit eindpunt retourneert kruislingse informatie voor een bepaalde coördinaat.

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-parameters

Name In Vereist Type Description
format
path True

ResponseFormat

Gewenste indeling van het antwoord. 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,-122,125679'.

heading
query

integer

De richtingsrichting van het voertuig in graden, voor 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 decimaal zijn

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.

limit
query

integer

Maximum aantal antwoorden dat wordt geretourneerd. Standaard: 10, minimaal: 1 en maximum: 100

radius
query

integer

De straal in meters tot om de resultaten te beperken tot het gedefinieerde gebied

view
query

LocalizedMapView

Met de parameter Weergave (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten weergeven voor een bepaald land of 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 gaat bedienen. De parameter Weergave is standaard 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 Weergave in Azure Maps moet worden gebruikt in overeenstemming met de toepasselijke wetgeving, met inbegrip van die met betrekking tot toewijzing, van het land of de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden waartoe u toegang hebt via Azure Maps beschikbaar wordt 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 Azure Maps beheervlak Account-API. Als u Microsoft Entra ID beveiliging wilt gebruiken in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Antwoorden

Name Type Description
200 OK

ReverseSearchCrossStreetAddressResult

OK

Other Status Codes

ErrorResponse

Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. Wanneer het 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 tot een of meer Azure Maps resourceaccount 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.
  • Het gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.
  • Zie overzicht van Microsoft identity platform voor meer informatie over Microsoft identity platform.

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

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account maakt in de 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 zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken 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 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 address of the nearest intersection/crossroad

Sample Request

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

Sample Response

{
  "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"
    }
  ]
}

Definities

Name Description
Address

Het adres van het resultaat

BoundingBoxCompassNotation

Het begrenzingsvak van de locatie.

Entity

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

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

LatLongPairAbbreviated

Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

LocalizedMapView

Met de parameter View (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten voor een bepaald land/regio weergeven voor geopolitiek betwiste regio's. Verschillende landen/regio's hebben verschillende weergaven van dergelijke regio's en met de weergaveparameter kan uw toepassing voldoen aan de weergave die is vereist voor het land/de regio die uw toepassing gaat bedienen. De parameter View is standaard 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 weergaveparameter 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 de toepasselijke wetgeving, met inbegrip van die met betrekking tot toewijzing, van het land of de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden waartoe u toegang hebt via Azure Maps beschikbaar wordt gesteld. Voorbeeld: view=IN.

Raadpleeg Ondersteunde weergaven voor meer informatie en om de beschikbare weergaven te bekijken.

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.

ReverseSearchCrossStreetAddressResult

Dit object wordt geretourneerd na een geslaagde Search adres omgekeerde crossstreet-aanroep

ReverseSearchCrossStreetAddressResultItem

Resultaatobject voor een Search-antwoord op omgekeerde kruising

SearchSummary

Samenvattingsobject voor een Search API-antwoord.

Address

Het adres van het resultaat

Name Type Description
boundingBox

BoundingBoxCompassNotation

Het begrenzingsvak van de locatie.

buildingNumber

string

Het nummer van het gebouw op straat. AFGESCHAFT, gebruik in plaats daarvan streetNumber.

country

string

land/regionaam

countryCode

string

Land (opmerking: dit is een code van twee letters, geen land-/regionaam.)

countryCodeISO3

string

ISO alfa-3-landcode

countrySecondarySubdivision

string

Graafschap

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 land-/regiobeheerhiërarchie. Dit veld wordt alleen weergegeven als countrySubdivision in een verkorte vorm wordt weergegeven. Alleen ondersteund voor de VS, 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 van een geografisch gebied of een plaats vertegenwoordigt die meerdere adresseerbare objecten groepeert voor adresseringsdoeleinden, zonder dat het een beheereenheid is. Dit veld wordt gebruikt om de freeformAddress eigenschap te bouwen. localName vertegenwoordigt de post gemeente. Afhankelijk van de locatie is localName de algemeen bekende naam van een stad of stad. Voor de algemeen bekende naam van een stad of stad gebruikt localName u in plaats van municipality.

municipality

string

Plaats /plaats
Opmerking: municipality vertegenwoordigt de woongemeente. 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-/superstad

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

routeNumbers

string[]

De codes die worden gebruikt om de straat ondubbelzinnig te identificeren

street

string

De straatnaam. AFGESCHAFT, gebruikt u in plaats daarvan streetName.

streetName

string

De straatnaam.

streetNameAndNumber

string

De straatnaam en het nummer.

streetNumber

string

Het nummer van het gebouw op straat.

BoundingBoxCompassNotation

Het begrenzingsvak van de locatie.

Name Type Description
entity

Entity

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

northEast

string

Noordoostelijke 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

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

Name Type Description
position

string

Positie-entiteit

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

ErrorAdditionalInfo[]

De fout aanvullende informatie.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

LatLongPairAbbreviated

Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

Name Type Description
lat

number

De eigenschap Breedtegraad

lon

number

De eigenschap Lengtegraad

LocalizedMapView

Met de parameter View (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten voor een bepaald land/regio weergeven voor geopolitiek betwiste regio's. Verschillende landen/regio's hebben verschillende weergaven van dergelijke regio's en met de weergaveparameter kan uw toepassing voldoen aan de weergave die is vereist voor het land/de regio die uw toepassing gaat bedienen. De parameter View is standaard 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 weergaveparameter 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 de toepasselijke wetgeving, met inbegrip van die met betrekking tot toewijzing, van het land of de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden waartoe u toegang hebt via Azure Maps beschikbaar wordt gesteld. Voorbeeld: view=IN.

Raadpleeg Ondersteunde weergaven voor meer informatie en om de beschikbare weergaven te bekijken.

Name Type Description
AE

string

Verenigde Arabische Emiraten (Arabische weergave)

AR

string

Argentinië (Argentijnse weergave)

Auto

string

Retourneer de toewijzingsgegevens op basis van het IP-adres van de aanvraag.

BH

string

Bahrein (Arabische weergave)

IN

string

India (Indiase weergave)

IQ

string

Irak (Arabische weergave)

JO

string

Jordanië (Arabische weergave)

KW

string

Koeweit (Arabische weergave)

LB

string

Libanon (Arabische weergave)

MA

string

Marokko (Marokkaanse weergave)

OM

string

Oman (Arabische weergave)

PK

string

Pakistan (Pakistaanse weergave)

PS

string

Palestijnse Autoriteit (Arabische weergave)

QA

string

Qatar (Arabische weergave)

SA

string

Saoedi-Arabië (Arabische weergave)

SY

string

Syrië (Arabische weergave)

Unified

string

Geïntegreerde weergave (overige)

YE

string

Jemen (Arabische weergave)

QueryType

Het type query dat wordt geretourneerd: IN DE BUURT of NON_NEAR.

Name Type Description
NEARBY

string

Search is uitgevoerd rond een bepaalde breedtegraad en lengtegraad met een gedefinieerde radius

NON_NEAR

string

Search is wereldwijd uitgevoerd, zonder bevooroordeeld te zijn naar een bepaalde breedte- en lengtegraad, en geen gedefinieerde radius

ResponseFormat

Gewenste indeling van het antwoord. De waarde kan json of xml zijn.

Name Type Description
json

string

De JavaScript Object Notation Data Interchange-indeling

xml

string

De uitbreidbare opmaaktaal

ReverseSearchCrossStreetAddressResult

Dit object wordt geretourneerd na een geslaagde Search adres omgekeerde crossstreet-aanroep

Name Type Description
addresses

ReverseSearchCrossStreetAddressResultItem[]

Adressenmatrix

summary

SearchSummary

Samenvattingsobject voor een antwoord op omgekeerde kruising van Search-adres

ReverseSearchCrossStreetAddressResultItem

Resultaatobject voor een Search-antwoord op omgekeerde kruising

Name Type Description
address

Address

Het adres van het resultaat

position

string

De eigenschap Position in de vorm van {latitude},{longitude}"

SearchSummary

Samenvattingsobject voor een Search API-antwoord.

Name Type Description
fuzzyLevel

integer

Het maximale fuzzy-niveau dat is vereist om resultaten op te geven.

geoBias

LatLongPairAbbreviated

Indicatie wanneer de interne zoekmachine een georuimtelijke bias heeft toegepast om de rangschikking van resultaten te verbeteren. In sommige methoden kan dit worden beïnvloed door de lat- en lon-parameters in te stellen, indien beschikbaar. In andere gevallen is het puur intern.

limit

integer

Maximum aantal antwoorden dat wordt geretourneerd

numResults

integer

Het aantal resultaten in het antwoord.

offset

integer

De begin offset van de geretourneerde Resultaten binnen 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.