Search - Get Search Address Structured

Referens

Service:: Maps

API Version:: 1.0

Använd för att hämta latitud- och longitudkoordinater för en gatuadress i ett ostrukturerat format eller frågeindataformat.
API:et Get Search Address Structured (Structured Address Geocoding) är en HTTP-begäran GET som returnerar latitud- och longitudkoordinater för en gatuadress i ett ostrukturerat format eller frågeindataformat.

Sökindexet för geokodning efterfrågas för allt över gatunivådata. Inga POI:er returneras. Observera att geokodaren är mycket tolerant mot skrivfel och ofullständiga adresser. Det kommer också att hantera allt från exakta gatuadresser eller gatu- eller korsningar samt geografiska områden på högre nivå som stadskärnor, län, stater etc.

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

With optional parameters:

GET https://atlas.microsoft.com/search/address/structured/{format}?api-version=1.0&language={language}&countryCode={countryCode}&limit={limit}&ofs={ofs}&streetNumber={streetNumber}&streetName={streetName}&crossStreet={crossStreet}&municipality={municipality}&municipalitySubdivision={municipalitySubdivision}&countryTertiarySubdivision={countryTertiarySubdivision}&countrySecondarySubdivision={countrySecondarySubdivision}&countrySubdivision={countrySubdivision}&postalCode={postalCode}&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.
countryCode	query	True	string	2- eller 3-bokstaven ISO3166-1 lands- /regionkoddelen av en adress. T.ex. USA.
countrySecondarySubdivision	query		string	Land/region för den strukturerade adressen
countrySubdivision	query		string	Indelningsdelen för land/region i en adress
countryTertiarySubdivision	query		string	Det namngivna området för den strukturerade adressen
crossStreet	query		string	Korsgatans namn för den strukturerade adressen
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
extendedPostalCodesFor	query		SearchIndexes[]	Index för vilka utökade postnummer ska ingå i resultaten. Tillgängliga index är: Addr = Adressintervall Geo = geografiska områden PAD = punktadresser POI = Orienteringspunkter Str = Gator XStr = Korsgator (korsningar) Värdet ska vara en kommaavgränsad lista över indextyper (i valfri ordning) eller Ingen utan 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å 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 .
limit	query		integer	Maximalt antal svar som ska returneras. Standard: 10, minimum: 1 och max: 100
municipality	query		string	Kommundelen av en adress
municipalitySubdivision	query		string	Kommundelsdelen (sub/superstad) för den strukturerade adressen
ofs	query		integer	Startar förskjutningen av de returnerade resultaten inom den fullständiga resultatuppsättningen. Standard: 0
postalCode	query		string	Postnummerdelen av en adress
streetName	query		string	Gatunamndelen av en adress
streetNumber	query		string	Gatunummerdelen av en adress
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	SearchAddressResult	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

Search address in Redmond, WA in structured form

Sample Request

HTTP

GET https://atlas.microsoft.com/search/address/structured/json?api-version=1.0&countryCode=US&streetNumber=15127&streetName=NE%2024th%20Street&municipality=Redmond&postalCode=98052

Sample Response

Status code:: 200

{
  "summary": {
    "query": "15127 98052 ne redmond wa",
    "queryType": "NON_NEAR",
    "queryTime": 57,
    "numResults": 1,
    "offset": 0,
    "totalResults": 34,
    "fuzzyLevel": 1,
    "geoBias": {
      "lat": 47.30129317913035,
      "lon": -120.88247999999997
    }
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/37974392",
      "score": 8.074,
      "dist": 101274.64693865852,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Earlmount, Avondale, Ames Lake, Adelaide",
        "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 98052",
        "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ådet som täcker resultatet som representeras av koordinaterna längst upp till vänster och längst ned till höger i visningsområdet.
BoundingBoxCompassNotation	Platsens avgränsningsruta.
Brand	Det varumärke som är associerat med POI
Classification	Klassificeringen för den intressepunkt 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 INTRESSEPUNKT som returneras.
EntryPointType	Typ av startpunkt. Värdet kan vara antingen huvudvärde eller mindre.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
GeographicEntityType	Geografientitetstyp. Finns bara när entityType begärdes och är tillgängligt.
Geometry	Information om resultatets geometriska form. Endast tillgängligt om du skriver == Geografi.
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.
OperatingHours	Öppettider för en POI (orienteringspunkter).
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: NÄRLIGGANDE 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 Search-anrop.
SearchAddressResultItem	Resultatobjekt för ett Search API-svar.
SearchAddressResultType	Något av: POI 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 = geografiska områden PAD = punktadresser POI = Orienteringspunkter Str = Gator XStr = Korsgator (korsningar) Värdet ska vara en kommaavgränsad lista över indextyper (i valfri ordning) eller Ingen utan 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 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.

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.

Name	Typ	Description
from	LatLongPairAbbreviated	En plats som representeras som 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 latitud och longitud med kortnamnen "lat" & "lon".

BoundingBox

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

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

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

Brand

Det varumärke som är associerat med POI

Name	Typ	Description
name	string	Namnet på varumärket

Classification

Klassificeringen för den intressepunkt som returneras

Name	Typ	Description
code	string	Kodegenskap
names	ClassificationName[]	Namnmatris

ClassificationName

Namn på klassificeringen

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

DataSources

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. Endast tillgängligt om du skriver == Geografi.

Entity

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

Name	Typ	Description
position	string	Placeringsentitet

EntryPoint

Startpunkten för den INTRESSEPUNKT som returneras.

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

EntryPointType

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

Name	Typ	Description
main	string
minor	string

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

Geometry

Information om resultatets geometriska form. Endast tillgängligt om du skriver == Geografi.

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

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

OperatingHours

Öppettider för en POI (orienteringspunkter).

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

OperatingHoursTime

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

Öppet tidsintervall för en dag

Name	Typ	Description
endTime	OperatingHoursTime	Punkten inom de följande 7 dagarna sträcker sig när en viss POI stängs, eller början av intervallet om den stängdes före intervallet.
startTime	OperatingHoursTime	Punkten inom de följande 7 dagarna sträcker sig när en viss POI öppnas, eller början av intervallet om den öppnades före intervallet.

PointOfInterest

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 INTRESSEPUNKT som returneras.
categories	string[]	Matris för kategorier
categorySet	PointOfInterestCategorySet[]	Listan över de mest specifika POI-kategorierna
classifications	Classification[]	Klassificeringsmatris
name	string	Namn på egenskapen POI
openingHours	OperatingHours	Öppettider för en POI (orienteringspunkter).
phone	string	Telefonnummeregenskap
url	string	Url-egenskap för webbplats

PointOfInterestCategorySet

POI-kategori

Name	Typ	Description
id	integer	Kategori-ID

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

SearchAddressResult

Det här objektet returneras från ett lyckat Search-anrop.

Name	Typ	Description
results	SearchAddressResultItem[]	En lista över Search API-resultat.
summary	SearchSummary	Sammanfattningsobjekt för ett Search API-svar

SearchAddressResultItem

Resultatobjekt för ett Search API-svar.

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	Detour tid i sekunder. Returneras endast för anrop till API:et Search Along Route.
dist	number	Rät linjeavstånd mellan resultatet och geobias plats i meter.
entityType	GeographicEntityType	Geografientitetstyp. Finns bara när entityType begärdes och är tillgängligt.
entryPoints	EntryPoint[]	Matris med EntryPoints. De beskriver de typer av ingångar som finns på platsen. Typen kan vara "huvud" 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 supportförfrågningar.
matchType	MatchType	Information om typen av matchning. Något 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 latitud och longitud med kortnamnen "lat" & "lon".
score	number	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 resultatet x är dubbelt så sannolikt att vara så 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	Något av: POI Gata Geografi Punktadress Adressintervall Tvärs över gatan
viewport	BoundingBox	Det visningsområdet som täcker resultatet som representeras av koordinaterna längst upp till vänster och längst ned till höger i visningsområdet.

SearchAddressResultType

Något av:

POI
Gata
Geografi
Punktadress
Adressintervall
Tvärs över gatan

Name	Typ	Description
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchIndexes

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

Tillgängliga index är:

Addr = Adressintervall

Geo = geografiska områden

PAD = punktadresser

POI = Orienteringspunkter

Str = Gator

XStr = Korsgator (korsningar)

Värdet ska vara en kommaavgränsad lista över indextyper (i valfri ordning) eller Ingen utan 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.

Name	Typ	Description
Addr	string
Geo	string
PAD	string
POI	string
Str	string
Xstr	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.

Dela via