Search - Get Search Address

Referens

Tjänst:: Maps

API-version:: 1.0

Använd för att hämta koordinater för latitud och longitud för en gatuadress i ett ostrukturerat format eller frågeindataformat.

Get Search Address-API:et är en HTTP-GET begäran returnerar latitud- och longitudkoordinaterna när de skickas i en gatuadress eller ett namn på en plats som sökvillkor.

I många fall kan den fullständiga söktjänsten vara för mycket, till exempel om du bara är intresserad av traditionell geokodning. Du kan också söka efter adresssökning exklusivt. Geokodningen utförs genom att träffa geokodslutpunkten med bara adressen eller den partiella adressen i fråga. Indexet för geokodningssökning efterfrågas för allt över gatunivådata. Inga POIs returneras. Observera att geokodaren är mycket tolerant mot stavfel och ofullständiga adresser. Det kommer också att hantera allt från exakta gatuadresser eller gatuadresser eller korsningar samt geografiska områden på högre nivå som stadskärnor, län, stater osv.

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

Med valfria parametrar:

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&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	string	Adressen som ska sökas efter (t.ex. "1 Microsoft way, Redmond, WA"), måste vara korrekt URL-kodad.
btmRight	query		string	Avgränsningsrutans nedre högra position. T.ex. 37.553,-122.453
countrySet	query		string[]	Kommaavgränsad sträng med lands-/regionkoder, t.ex. FR,ES. Detta begränsar sökningen till de angivna länderna/regionerna
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
extendedPostalCodesFor	query		SearchIndexes[]	Index för vilka utökade postnummer ska ingå i resultaten. Tillgängliga index är: Addr = Adressintervall Geo = Geographies PAD = punktadresser POI = Intressanta platser Str = Gator XStr = Korsgator (korsningar) Värdet ska vara en kommaavgränsad lista över indextyper (i valfri ordning) eller Ingen för inga index. Som standard ingår utökade postnummer för alla index utom Geo. Utökade postnummerlistor för geografiska områden kan vara ganska långa, så de måste uttryckligen begäras när det behövs. Användningsexempel: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Utökat postnummer returneras som en extendedPostalCode- egenskap för en adress. Tillgängligheten är regionberoende.
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.
lat	query		number (double)	Latitud där resultaten ska vara partiska. T.ex. 37.337
limit	query		integer minimum: 1 maximum: 100	Maximalt antal svar som ska returneras. Standard: 10, minimum: 1 och max: 100
lon	query		number (double)	Longitud där resultaten ska vara partiska. T.ex. -121,89
ofs	query		integer minimum: 0 maximum: 1900	Startförskjutning av de returnerade resultaten inom den fullständiga resultatuppsättningen. Standard: 0
radius	query		integer	Radien i meter till för att resultaten ska begränsas till det definierade området
topLeft	query		string	Avgränsningsrutans övre vänstra position. T.ex. 37.553,-122.453
typeahead	query		boolean	Boolesk. Om typeahead-flaggan har angetts tolkas frågan som en partiell indata och sökningen går in i förutsägelseläge
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	SearchAddressResult	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

Search detail address 15127 NE 24th Street, Redmond, WA 98052

Exempelbegäran

HTTP

GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052

Exempelsvar

Statuskod:: 200

{
  "summary": {
    "query": "15127 NE 24th Street, Redmond, WA 98052",
    "queryType": "NON_NEAR",
    "queryTime": 58,
    "numResults": 1,
    "offset": 0,
    "totalResults": 1,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/19173426",
      "score": 14.51,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "980525544",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15127 NE 24th St, Redmond, WA 980525544",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6308,
        "lon": -122.1385
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6317,
          "lon": -122.13983
        },
        "btmRightPoint": {
          "lat": 47.6299,
          "lon": -122.13717
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6315,
            "lon": -122.13852
          }
        }
      ]
    }
  ]
}

Definitioner

Name	Description
Address	Resultatets adress
AddressRanges	Beskriver adressintervallet på båda sidor av gatan för ett sökresultat. Koordinater för start- och slutplatserna för adressintervallet ingår.
BoundingBox	Det visningsområde som täcker resultatet som representeras av koordinaterna överst till vänster och längst ned till höger i visningsområdet.
BoundingBoxCompassNotation	Avgränsningsrutan för platsen.
Brand	Det varumärke som är associerat med POI
Classification	Klassificeringen för den POI som returneras
ClassificationName	Namn på klassificeringen
DataSources	Valfritt avsnitt. Referens-ID:n för användning med API:et Get Search Polygon.
Entity	Entitetstypkälla för avgränsningsrutan. För omvänd geokodning är detta alltid lika med position.
EntryPoint	Startpunkten för den POI som returneras.
EntryPointType	Typ av startpunkt. Värdet kan vara antingen eller mindre.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
GeographicEntityType	Geografientitetstyp. Presentera endast när entityType begärdes och är tillgängligt.
Geometry	Information om resultatets geometriska form. Presentera endast om du skriver == Geografi.
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.
OperatingHours	Öppettider för en POI (intressepunkter).
OperatingHoursTime	Representerar ett datum och en tid
OperatingHoursTimeRange	Öppet tidsintervall för en dag
PointOfInterest	Information om den returnerade IP-adressen, inklusive information som namn, telefon, URL-adress och klassificeringar.
PointOfInterestCategorySet	POI-kategori
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-.
SearchAddressResult	Det här objektet returneras från ett lyckat sökanrop.
SearchAddressResultItem	Resultatobjekt för ett api-svar för sökning.
SearchAddressResultType	En av: Intressepunkt Gata Geografi Punktadress Adressintervall Tvärs över gatan
SearchIndexes	Index för vilka utökade postnummer ska ingå i resultaten. Tillgängliga index är: Addr = Adressintervall Geo = Geographies PAD = punktadresser POI = Intressanta platser Str = Gator XStr = Korsgator (korsningar) Värdet ska vara en kommaavgränsad lista över indextyper (i valfri ordning) eller Ingen för inga index. Som standard ingår utökade postnummer för alla index utom Geo. Utökade postnummerlistor för geografiska områden kan vara ganska långa, så de måste uttryckligen begäras när det behövs. Användningsexempel: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Utökat postnummer returneras som en extendedPostalCode- egenskap för en adress. Tillgängligheten är regionberoende.
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.

AddressRanges

Objekt

Beskriver adressintervallet på båda sidor av gatan för ett sökresultat. Koordinater för start- och slutplatserna för adressintervallet ingår.

Name	Typ	Description
from	LatLongPairAbbreviated	En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
rangeLeft	string	Adressintervall till vänster på gatan.
rangeRight	string	Adressintervall på höger sida av gatan.
to	LatLongPairAbbreviated	En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".

BoundingBox

Objekt

Det visningsområde som täcker resultatet som representeras av koordinaterna överst till vänster och längst ned till höger i visningsområdet.

Name	Typ	Description
btmRightPoint	LatLongPairAbbreviated	En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
topLeftPoint	LatLongPairAbbreviated	En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".

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

Brand

Objekt

Det varumärke som är associerat med POI

Name	Typ	Description
name	string	Namnet på varumärket

Classification

Objekt

Klassificeringen för den POI som returneras

Name	Typ	Description
code	string	Kodegenskap
names	ClassificationName[]	Namnmatris

ClassificationName

Objekt

Namn på klassificeringen

Name	Typ	Description
name	string	Namnegenskap
nameLocale	string	Namn på språkegenskap

DataSources

Objekt

Valfritt avsnitt. Referens-ID:n för användning med API:et Get Search Polygon.

Name	Typ	Description
geometry	Geometry	Information om resultatets geometriska form. Presentera endast om du skriver == Geografi.

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

EntryPoint

Objekt

Startpunkten för den POI som returneras.

Name	Typ	Description
position	LatLongPairAbbreviated	En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
type	EntryPointType	Typ av startpunkt. Värdet kan vara antingen eller mindre.

EntryPointType

Uppräkning

Typ av startpunkt. Värdet kan vara antingen eller mindre.

Värde	Description
main
minor

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

Geometry

Objekt

Information om resultatets geometriska form. Presentera endast om du skriver == Geografi.

Name	Typ	Description
id	string	Skicka detta som geometriId till api:et Get Search Polygon för att hämta geometriinformation för det här resultatet.

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

OperatingHours

Objekt

Öppettider för en POI (intressepunkter).

Name	Typ	Description
mode	string	Värde som används i begäran: ingen eller "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Lista över tidsintervall för de kommande 7 dagarna

OperatingHoursTime

Objekt

Representerar ett datum och en tid

Name	Typ	Description
date	string	Representerar aktuellt kalenderdatum i tidszonen POI, t.ex. "2019-02-07".
hour	integer	Timmarna är i 24-timmarsformatet i den lokala tiden för en POI; möjliga värden är 0–23.
minute	integer	Minuter är i den lokala tiden för en POI; möjliga värden är 0–59.

OperatingHoursTimeRange

Objekt

Öppet tidsintervall för en dag

Name	Typ	Description
endTime	OperatingHoursTime	Punkten inom de kommande 7 dagarnas intervall när en viss POI stängs, eller början av intervallet om den stängdes före intervallet.
startTime	OperatingHoursTime	Punkten under de kommande 7 dagarnas intervall när en viss POI öppnas, eller början av intervallet om den öppnades före intervallet.

PointOfInterest

Objekt

Information om den returnerade IP-adressen, inklusive information som namn, telefon, URL-adress och klassificeringar.

Name	Typ	Description
brands	Brand[]	Matris för varumärken. Namnet på varumärket för DEN POI som returneras.
categories	string[]	Matris för kategorier
categorySet	PointOfInterestCategorySet[]	Listan över de mest specifika POI-kategorierna
classifications	Classification[]	Klassificeringsmatris
name	string	Namn på poi-egenskapen
openingHours	OperatingHours	Öppettider för en POI (intressepunkter).
phone	string	Telefonnummeregenskap
url	string	Webbplats-URL-egenskap

PointOfInterestCategorySet

Objekt

POI-kategori

Name	Typ	Description
id	integer	Kategori-ID

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

SearchAddressResult

Objekt

Det här objektet returneras från ett lyckat sökanrop.

Name	Typ	Description
results	SearchAddressResultItem[]	En lista över SÖKRESULTAT.
summary	SearchSummary	Sammanfattningsobjekt för ett api-svar för sökning

SearchAddressResultItem

Objekt

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

Name	Typ	Description
address	Address	Resultatets adress
addressRanges	AddressRanges	Beskriver adressintervallet på båda sidor av gatan för ett sökresultat. Koordinater för start- och slutplatserna för adressintervallet ingår.
dataSources	DataSources	Valfritt avsnitt. Referensgeometri-ID för användning med api:et Get Search Polygon.
detourTime	integer	Omvägstid i sekunder. Returnerades endast för anrop till API:et Search Along Route.
dist	number (double)	Rät linjeavstånd mellan resultatet och geobiasplatsen i meter.
entityType	GeographicEntityType	Geografientitetstyp. Presentera endast när entityType begärdes och är tillgängligt.
entryPoints	EntryPoint[]	Matris med EntryPoints. De beskriver de typer av ingångar som är tillgängliga på platsen. Typen kan vara "main" för huvudentréer som en ytterdörr, eller en lobby, och "mindre", för sido- och bakdörrar.
id	string	ID-egenskap
info	string	Information om den ursprungliga datakällan för resultatet. Används för supportbegäranden.
matchType	MatchType	Information om typen av matchning. En av: AddressPoint HouseNumberRange Gata
poi	PointOfInterest	Information om den returnerade IP-adressen, inklusive information som namn, telefon, URL-adress och klassificeringar.
position	LatLongPairAbbreviated	En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
score	number (double)	Värdet i en resultatuppsättning som anger den relativa matchningspoängen mellan resultaten. Du kan använda detta för att fastställa att resultat x är dubbelt så sannolikt att vara lika relevant som resultat y om värdet för x är 2x värdet för y. Värdena varierar mellan frågor och är endast avsedda som ett relativt värde för en resultatuppsättning.
type	SearchAddressResultType	En av: Intressepunkt Gata Geografi Punktadress Adressintervall Tvärs över gatan
viewport	BoundingBox	Det visningsområde som täcker resultatet som representeras av koordinaterna överst till vänster och längst ned till höger i visningsområdet.

SearchAddressResultType

Uppräkning

En av:

Intressepunkt
Gata
Geografi
Punktadress
Adressintervall
Tvärs över gatan

Värde	Description
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchIndexes

Uppräkning

Index för vilka utökade postnummer ska ingå i resultaten.

Tillgängliga index är:

Addr = Adressintervall

Geo = Geographies

PAD = punktadresser

POI = Intressanta platser

Str = Gator

XStr = Korsgator (korsningar)

Värdet ska vara en kommaavgränsad lista över indextyper (i valfri ordning) eller Ingen för inga index.

Som standard ingår utökade postnummer för alla index utom Geo. Utökade postnummerlistor för geografiska områden kan vara ganska långa, så de måste uttryckligen begäras när det behövs.

Användningsexempel:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Utökat postnummer returneras som en extendedPostalCode- egenskap för en adress. Tillgängligheten är regionberoende.

Värde	Description
Addr
Geo
PAD
POI
Str
Xstr

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.

Dela via

Search - Get Search Address

URI-parametrar

Begärandehuvud

Svar

Säkerhet

AADToken

Omfattningar

subscription-key

SAS Token

Exempel

Search detail address 15127 NE 24th Street, Redmond, WA 98052

Exempelbegäran

Exempelsvar

Definitioner

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

LocalizedMapView

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

ResponseFormat

SearchAddressResult

SearchAddressResultItem

SearchAddressResultType

SearchIndexes

SearchSummary

Ytterligare resurser