Search - Get Search Fuzzy
Använd när du behöver en sökbegäran som kan hantera kombinationer av adresser och POI-token.
API:et Get Search Fuzzy
(free form Search), en HTTP-begäran GET
som sömlöst hanterar en kombination av POI-sökning och geokodning. Det är ett kostnadsfritt formulär Search API som hanterar fuzzy av indata som innehåller en kombination av adress- eller POI-token som en kanonisk "enkelradssökning". Den kan också viktas med en sammanhangsbaserad position (lat/lon-par) eller helt begränsas av en koordinat och radie, eller köras mer allmänt utan någon geo-partisk fästpunkt.
Vi rekommenderar starkt att du använder parametern "countrySet" för att endast ange de länder/regioner som programmet behöver täckning för, eftersom standardbeteendet är att söka i hela världen och eventuellt returnera onödiga resultat.
T.ex.: countrySet
=US,FR
En fullständig lista över alla länder/regioner som stöds finns i Search Täckning.
De flesta Search frågor är som standard maxFuzzyLevel
=2 för att få prestanda och minska ovanliga resultat. Den här nya standardinställningen kan åsidosättas efter behov per begäran genom att skicka frågan param maxFuzzyLevel
=3 eller 4.
GET https://atlas.microsoft.com/search/fuzzy/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/fuzzy/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&minFuzzyLevel={minFuzzyLevel}&maxFuzzyLevel={maxFuzzyLevel}&idxSet={idxSet}&brandSet={brandSet}&connectorSet={connectorSet}&entityType={entityType}&view={view}&openingHours=nextSevenDays
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 |
string |
Den tillämpliga frågesträngen (t.ex. "seattle", "pizza"). Kan också anges som en kommaavgränsad sträng som består av latitud följt av longitud (t.ex. "47.641268, -122.125679"). Måste vara korrekt URL-kodad. |
brand
|
query |
string[] |
En kommaavgränsad lista över varumärken som kan användas för att begränsa resultatet till specifika varumärken. Objektordning spelar ingen roll. När flera varumärken tillhandahålls returneras endast resultat som tillhör (minst) en av listan. Varumärken som innehåller ett "" i deras namn bör placeras i citattecken. Användningsexempel: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Komma",Bar |
|
btm
|
query |
string |
Avgränsningsrutans nedre högra position. T.ex. 37.553,-122.453 |
|
category
|
query |
integer[] |
En kommaavgränsad lista över kategoriuppsättnings-ID:t som kan användas för att begränsa resultatet till specifika kategorier av intressepunkter. ID-beställning spelar ingen roll. Maximalt antal
|
|
connector
|
query |
En kommaavgränsad lista över anslutningstyper som kan användas för att begränsa resultatet till elbilsstation som stöder specifika anslutningstyper. Objektordning spelar ingen roll. När flera anslutningstyper tillhandahålls returneras endast resultat som tillhör (minst) en av de angivna listan. Tillgängliga anslutningstyper är:
Användningsexempel: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
||
country
|
query |
string[] |
Kommaavgränsad sträng med lands-/regionkoder, t.ex. FR,ES. Detta begränsar sökningen till de angivna länderna/regionerna |
|
entity
|
query |
Anger den filtreringsnivå som utförs på geografiska områden. Begränsar sökningen efter angivna geografientitetstyper, t.ex. returnerar endast kommun. Det resulterande svaret innehåller geografi-ID och 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:
|
||
extended
|
query |
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. |
||
idx
|
query |
En kommaavgränsad lista över index som ska användas för sökningen. Objektordning spelar ingen roll. Tillgängliga index är: Addr = Interpolation av adressintervall, Geo = Geografiska områden, PAD = Punktadresser, POI = Intressepunkter, Str = Gator, Xstr = Korsgator (korsningar) |
||
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 . |
|
lat
|
query |
number double |
Latitud där resultaten ska vara partiska. T.ex. 37.337 |
|
limit
|
query |
integer |
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 |
|
max
|
query |
integer |
Maximal fuzzinessnivå som ska användas. Standard: 2, minimum: 1 och max: 4
Sökmotorn börjar leta efter en matchning på den nivå som definieras av minFuzzyLevel och slutar söka på den nivå som anges av maxFuzzyLevel. |
|
min
|
query |
integer |
Lägsta fuzzinessnivå som ska användas. Standard: 1, minimum: 1 och max: 4
Sökmotorn börjar leta efter en matchning på den nivå som definieras av minFuzzyLevel och slutar söka på den nivå som anges av maxFuzzyLevel. |
|
ofs
|
query |
integer |
Startar förskjutningen av de returnerade resultaten inom den fullständiga resultatuppsättningen. Standard: 0 |
|
opening
|
query |
Drifttimmar för en INTRESSEPUNKT (intressepunkter). Tillgängligheten för drifttimmar varierar beroende på tillgängliga data. Om det inte godkänns returneras ingen information om öppettiderna. Värde som stöds: nextSevenDays |
||
radius
|
query |
integer |
Radien i meter till för att resultaten ska begränsas till det definierade området |
|
top
|
query |
string |
Avgränsningsrutans övre vänstra position. T.ex. 37.553,-122.453 |
|
typeahead
|
query |
boolean |
Boolean. Om typeahead-flaggan har angetts tolkas frågan som en partiell inmatning och sökningen går in i förutsägelseläge |
|
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 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-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 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.
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 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.
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 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.
Typ:
apiKey
I:
header
Exempel
Search City Seattle
Exempelbegäran
GET https://atlas.microsoft.com/search/fuzzy/json?api-version=1.0&query=seattle&openingHours=nextSevenDays
Exempelsvar
{
"summary": {
"query": "seattle",
"queryType": "NON_NEAR",
"queryTime": 66,
"numResults": 10,
"offset": 0,
"totalResults": 3720,
"fuzzyLevel": 1
},
"results": [
{
"type": "Geography",
"id": "US/GEO/p0/188055",
"score": 2.531,
"entityType": "Municipality",
"address": {
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "Seattle, WA",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.60323,
"lon": -122.33028
},
"viewport": {
"topLeftPoint": {
"lat": 47.7344,
"lon": -122.4594
},
"btmRightPoint": {
"lat": 47.48106,
"lon": -122.22497
}
},
"dataSources": {
"geometry": {
"id": "00005557-4100-3c00-0000-0000596ae8ed"
}
}
},
{
"type": "Geography",
"id": "US/GEO/p0/183911",
"score": 2.382,
"entityType": "Municipality",
"address": {
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countrySubdivisionCode": "WA",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "Seattle, WA",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.55342,
"lon": -122.25007
},
"viewport": {
"topLeftPoint": {
"lat": 47.58995,
"lon": -122.26723
},
"btmRightPoint": {
"lat": 47.5169,
"lon": -122.23291
}
},
"dataSources": {
"geometry": {
"id": "00005557-4100-3c00-0000-00006553f33d"
}
}
},
{
"type": "POI",
"id": "ZA/POI/p0/449288",
"score": 2.226,
"info": "search:ta:710009004165863-ZA",
"poi": {
"name": "Seattle Coffee Co - Groote Kerk Sentrum",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Kloof Street",
"municipalitySubdivision": "Cape Town",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "8001",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Kloof Street, Gardens, City of Cape Town, Western Cape, 8001",
"localName": "Gardens"
},
"position": {
"lat": -33.92917,
"lon": 18.41178
},
"viewport": {
"topLeftPoint": {
"lat": -33.92827,
"lon": 18.4107
},
"btmRightPoint": {
"lat": -33.93007,
"lon": 18.41286
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -33.92907,
"lon": 18.41162
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/449396",
"score": 2.226,
"info": "search:ta:710009004163591-ZA",
"poi": {
"name": "Seattle Coffee Co - Pietermaritzburg",
"phone": "+(27)-(33)-3458486",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "9",
"streetName": "Armitage Road",
"municipalitySubdivision": "Pietermaritzburg City, Pietermaritzburg",
"municipality": "Pietermaritzburg",
"countrySecondarySubdivision": "The Msunduzi",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "3201",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Armitage Road 9, Athlone, The Msunduzi, KwaZulu-Natal, 3201",
"localName": "Athlone"
},
"position": {
"lat": -29.58611,
"lon": 30.37508
},
"viewport": {
"topLeftPoint": {
"lat": -29.58521,
"lon": 30.37405
},
"btmRightPoint": {
"lat": -29.58701,
"lon": 30.37611
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -29.58668,
"lon": 30.37531
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/451868",
"score": 2.226,
"info": "search:ta:710009002195538-ZA",
"poi": {
"name": "Seattle Coffee Co - Bedford Village",
"phone": "+(27)-(84)-5451111",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Van Buuren Road",
"municipalitySubdivision": "Bedfordview",
"municipality": "Germiston",
"countrySecondarySubdivision": "Ekurhuleni",
"countrySubdivisionCode": "Gauteng",
"postalCode": "2007",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Van Buuren Road, Bedfordview, Ekurhuleni, Gauteng, 2007",
"localName": "Bedfordview"
},
"position": {
"lat": -26.18009,
"lon": 28.13544
},
"viewport": {
"topLeftPoint": {
"lat": -26.17919,
"lon": 28.13444
},
"btmRightPoint": {
"lat": -26.18099,
"lon": 28.13644
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -26.18006,
"lon": 28.13636
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/488888",
"score": 2.226,
"info": "search:ta:710009002102639-ZA",
"poi": {
"name": "Seattle Coffee Co - Caltex Starstop Milly's",
"phone": "+(27)-(13)-2560340",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipality": "Wonderfontein",
"countrySecondarySubdivision": "Emakhazeni",
"countrySubdivisionCode": "Mpumalanga",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Wonderfontein, Emakhazeni, Mpumalanga"
},
"position": {
"lat": -25.68842,
"lon": 30.21291
},
"viewport": {
"topLeftPoint": {
"lat": -25.68752,
"lon": 30.21191
},
"btmRightPoint": {
"lat": -25.68932,
"lon": 30.21391
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -25.68913,
"lon": 30.21343
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/489433",
"score": 2.226,
"info": "search:ta:710009002184068-ZA",
"poi": {
"name": "Seattle Coffee Co - Southcoast Mall",
"phone": "+(27)-(39)-3150816",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipalitySubdivision": "Shelly Beach",
"municipality": "Shelly Beach",
"countrySecondarySubdivision": "Hibiscus Coast",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "4265",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265",
"localName": "Shelly Beach"
},
"position": {
"lat": -30.79937,
"lon": 30.40569
},
"viewport": {
"topLeftPoint": {
"lat": -30.79847,
"lon": 30.40464
},
"btmRightPoint": {
"lat": -30.80027,
"lon": 30.40674
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -30.7994,
"lon": 30.40618
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/489976",
"score": 2.226,
"info": "search:ta:710009004261897-ZA",
"poi": {
"name": "Seattle Cofee Co",
"phone": "+(27)-(39)-3150816",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipalitySubdivision": "Shelly Beach",
"municipality": "Shelly Beach",
"countrySecondarySubdivision": "Hibiscus Coast",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "4265",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265",
"localName": "Shelly Beach"
},
"position": {
"lat": -30.79801,
"lon": 30.40557
},
"viewport": {
"topLeftPoint": {
"lat": -30.79711,
"lon": 30.40452
},
"btmRightPoint": {
"lat": -30.79891,
"lon": 30.40662
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -30.79784,
"lon": 30.40523
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/490056",
"score": 2.226,
"info": "search:ta:710009004149612-ZA",
"poi": {
"name": "Seattle Coffee Co - Constantia Village",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Constantia Main Road",
"municipalitySubdivision": "Cape Town",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "7708",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Constantia Main Road, Constantia, City of Cape Town, Western Cape, 7708",
"localName": "Constantia"
},
"position": {
"lat": -34.02087,
"lon": 18.44503
},
"viewport": {
"topLeftPoint": {
"lat": -34.01997,
"lon": 18.44394
},
"btmRightPoint": {
"lat": -34.02177,
"lon": 18.44612
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -34.02017,
"lon": 18.44476
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/494340",
"score": 2.226,
"info": "search:ta:710009004152570-ZA",
"poi": {
"name": "Seattle Coffee Co - Canal Walk Shopping Centre",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Century Boulevard",
"municipalitySubdivision": "Milnerton",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "7441",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Century Boulevard, Century City, City of Cape Town, Western Cape, 7441",
"localName": "Century City"
},
"position": {
"lat": -33.89348,
"lon": 18.5122
},
"viewport": {
"topLeftPoint": {
"lat": -33.89258,
"lon": 18.51112
},
"btmRightPoint": {
"lat": -33.89438,
"lon": 18.51328
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -33.8943,
"lon": 18.51328
}
}
]
}
]
}
Definitioner
Name | Description |
---|---|
Address |
Resultatets adress |
Address |
Beskriver adressintervallet på båda sidor av gatan för ett sökresultat. Koordinater för start- och slutplatserna för adressintervallet ingår. |
Bounding |
Det visningsområde som täcker resultatet som representeras av koordinaterna överst till vänster och längst ned till höger i visningsplatsen. |
Bounding |
Platsens avgränsningsruta. |
Brand |
Det varumärke som är associerat med POI |
Classification |
Klassificeringen för den intressepunkt som returneras |
Classification |
Namn på klassificeringen |
Data |
Valfritt avsnitt. Referens-ID:n för användning med API:et Get Search Polygon. |
Electric |
En kommaavgränsad lista över anslutningstyper som kan användas för att begränsa resultatet till elfordonsstation som stöder specifika anslutningstyper. Objektordning spelar ingen roll. När flera anslutningstyper anges returneras endast resultat som tillhör (minst) en av de angivna listan. Tillgängliga anslutningstyper är:
Användningsexempel: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
Entity |
Entitetstypkälla för avgränsningsrutan. För omvänd geokodning är detta alltid lika med position. |
Entry |
Startpunkten för den POI som returneras. |
Entry |
Typ av startpunkt. Värdet kan vara antingen huvudvärde eller mindre. |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Geographic |
Geografientitetstyp. Finns bara när entityType begärdes och är tillgängligt. |
Geometry |
Information om resultatets geometriska form. Endast tillgänglig om du skriver == Geografi. |
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 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. |
Match |
Matchningstyper för en sökåtgärd med omvänd adress. |
Operating |
Öppettider för en POI (intressepunkter). |
Operating |
Drifttimmar för en INTRESSEPUNKT (intressepunkter). Tillgängligheten för drifttimmar varierar beroende på tillgängliga data. Om det inte godkänns returneras ingen information om öppettiderna. Värde som stöds: nextSevenDays |
Operating |
Representerar ett datum och en tid |
Operating |
Öppet tidsintervall för en dag |
Point |
Information om den returnerade IP-adressen, inklusive information som namn, telefon, URL-adress och klassificeringar. |
Point |
POI-kategori |
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. |
Search |
Det här objektet returneras från ett lyckat Search-anrop. |
Search |
Resultatobjekt för ett Search API-svar. |
Search |
Något av:
|
Search |
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. |
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. |
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 |
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 |
En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon". |
BoundingBox
Det visningsområde som täcker resultatet som representeras av koordinaterna överst till vänster och längst ned till höger i visningsplatsen.
Name | Typ | Description |
---|---|---|
btmRightPoint |
En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon". |
|
topLeftPoint |
En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon". |
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 |
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 |
Namnmatris |
ClassificationName
Namn på klassificeringen
Name | Typ | Description |
---|---|---|
name |
string |
Namnegenskap |
nameLocale |
string |
Namn på språkegenskap |
DataSources
Valfritt avsnitt. Referens-ID:n för användning med API:et Get Search Polygon.
Name | Typ | Description |
---|---|---|
geometry |
Information om resultatets geometriska form. Endast tillgänglig om du skriver == Geografi. |
ElectricVehicleConnector
En kommaavgränsad lista över anslutningstyper som kan användas för att begränsa resultatet till elfordonsstation som stöder specifika anslutningstyper. Objektordning spelar ingen roll. När flera anslutningstyper anges returneras endast resultat som tillhör (minst) en av de angivna listan.
Tillgängliga anslutningstyper är:
-
StandardHouseholdCountrySpecific
- Dessa är standardanslutningar för hushåll för en viss region. De är alla AC enda fas och standarden Spänning och standard Amperage. Se även : Plug & sockettyper – World Standards. -
IEC62196Type1
– Skriv 1 anslutningsapp enligt definitionen i IEC 62196-2-standarden. Kallas även Yazaki efter den ursprungliga tillverkaren eller SAE J1772 efter standarden som först publicerade den. Används främst i kombination med 120V enkel fas eller upp till 240V enfasinfrastruktur. -
IEC62196Type1CCS
– Skriv 1 baserad kombinationskoppling enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 1-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med två ytterligare direktströmkontakter (DC) för att möjliggöra snabb laddning av dc. -
IEC62196Type2CableAttached
– Typ 2-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Tillhandahålls som en kabel och plugg som är ansluten till laddningsplatsen. -
IEC62196Type2Outlet
– Typ 2-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Tillhandahålls som ett uttag som är inställt på laddningspunkten. -
IEC62196Type2CCS
– Skriv 2-baserad kombinationskoppling enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 2-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med två ytterligare direktströmkontakter (DC) för att möjliggöra snabb laddning av dc. -
IEC62196Type3
– Skriv 3-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Även kallad Scame efter den ursprungliga tillverkaren. Används främst i kombination med upp till 240 V enkel fas eller upp till 420 V infrastruktur med tre faser. -
Chademo
- CHAdeMO-anslutningsprogram uppkallat efter en förening som bildats av Tokyo Electric Power Company och industripartners. På grund av detta kallas även TEPCO:s anslutningsprogram. Den stöder snabb DC-laddning. -
IEC60309AC1PhaseBlue
– Industrial Blue Connector är en anslutningsapp som definieras i IEC 60309-standarden. Det kallas ibland för en kombination av standarden, färgen och det faktum att det är en enda fasanslutning. Anslutningsappen har vanligtvis konfigurationen "P+N+E, 6h". -
IEC60309DCWhite
– Industriell vit anslutningsapp är en DC-anslutningsapp som definieras i IEC 60309-standarden. -
Tesla
– Tesla-anslutningsappen är den regionalt specifika Tesla Supercharger-anslutningsappen. Det avser antingen Teslas egenutvecklade anslutningsapp, som ibland kallas Tesla Port mestadels begränsad till Nordamerika eller den modifierade typ 2 (DC över typ 2) i Europa.
Användningsexempel:
connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Name | Typ | Description |
---|---|---|
Chademo |
string |
CHAdeMO-anslutningsprogram uppkallat efter en association som bildats av Tokyo Electric Power Company och industripartners. På grund av detta kallas även TEPCO:s anslutningsprogram. Den stöder snabb DC-laddning. |
IEC60309AC1PhaseBlue |
string |
Industrial Blue Connector är en anslutningsapp som definieras i IEC 60309-standarden. Det kallas ibland för en kombination av standarden, färgen och det faktum att det är en enda fasanslutning. Anslutningsappen har vanligtvis konfigurationen "P+N+E, 6h". |
IEC60309DCWhite |
string |
Industriell vit anslutningsapp är en DC-anslutningsapp som definieras i IEC 60309-standarden. |
IEC62196Type1 |
string |
Skriv 1 anslutningsapp enligt definitionen i IEC 62196-2-standarden. Kallas även Yazaki efter den ursprungliga tillverkaren eller SAE J1772 efter standarden som först publicerade den. Används främst i kombination med 120V enkel fas eller upp till 240V enfasinfrastruktur. |
IEC62196Type1CCS |
string |
Skriv 1-baserad kombinationskoppling enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 1-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med två ytterligare direktströmkontakter (DC) för att möjliggöra snabb laddning av dc. |
IEC62196Type2CCS |
string |
Skriv 2-baserad kombinationskoppling enligt definitionen i IEC 62196-3-standarden. Anslutningsappen baseras på typ 2-anslutningsappen – enligt definitionen i IEC 62196-2-standarden – med två ytterligare direktströmkontakter (DC) för att möjliggöra snabb laddning av dc. |
IEC62196Type2CableAttached |
string |
Typ 2-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Tillhandahålls som en kabel och plugg som är ansluten till laddningsplatsen |
IEC62196Type2Outlet |
string |
Typ 2-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Tillhandahålls som ett uttag som är inställt på laddningspunkten. |
IEC62196Type3 |
string |
Skriv 3-anslutningsapp enligt definitionen i IEC 62196-2-standarden. Även kallad Scame efter den ursprungliga tillverkaren. Används främst i kombination med upp till 240 V enkel fas eller upp till 420 V infrastruktur med tre faser. |
StandardHouseholdCountrySpecific |
string |
Dessa är standardanslutningar för hushåll för en viss region. De är alla AC enda fas och standarden Spänning och standard Amperage. |
Tesla |
string |
Tesla-anslutningsappen är den regionalt specifika Tesla Supercharger-anslutningsappen. Det avser antingen Teslas egenutvecklade anslutningsapp, som ibland kallas Tesla Port mestadels begränsad till Nordamerika eller den modifierade typ 2 (DC över typ 2) i Europa. |
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 |
EntryPoint
Startpunkten för den POI som returneras.
Name | Typ | Description |
---|---|---|
position |
En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon". |
|
type |
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 |
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. |
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änglig 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 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 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 (intressepunkter).
Name | Typ | Description |
---|---|---|
mode |
string |
Värde som används i begäran: none eller "nextSevenDays" |
timeRanges |
Lista över tidsintervall för de kommande 7 dagarna |
OperatingHoursRange
Drifttimmar för en INTRESSEPUNKT (intressepunkter). Tillgängligheten för drifttimmar varierar beroende på tillgängliga data. Om det inte godkänns returneras ingen information om öppettiderna. Värde som stöds: nextSevenDays
Name | Typ | Description |
---|---|---|
nextSevenDays |
string |
Visar drifttimmarna för nästa vecka, med början den aktuella dagen i den lokala tiden för POI. |
OperatingHoursTime
Representerar ett datum och en tid
Name | Typ | Description |
---|---|---|
date |
string |
Representerar aktuellt kalenderdatum i POI-tidszonen, t.ex. "2019-02-07". |
hour |
integer |
Timmar ä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 |
Punkten under de kommande 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 |
Punkten under de kommande 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 POI som returneras. |
categories |
string[] |
Matris för kategorier |
categorySet |
Listan över de mest specifika POI-kategorierna |
|
classifications |
Klassificeringsmatris |
|
name |
string |
Namn på egenskapen POI |
openingHours |
Öppettider för en POI (intressepunkter). |
|
phone |
string |
Telefonnummeregenskap |
url |
string |
Webbplats-URL-egenskap |
PointOfInterestCategorySet
POI-kategori
Name | Typ | Description |
---|---|---|
id |
integer |
Kategori-ID |
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 |
SearchAddressResult
Det här objektet returneras från ett lyckat Search-anrop.
Name | Typ | Description |
---|---|---|
results |
En lista över Search API-resultat. |
|
summary |
Sammanfattningsobjekt för ett Search API-svar |
SearchAddressResultItem
Resultatobjekt för ett Search API-svar.
Name | Typ | 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. |
|
dataSources |
Valfritt avsnitt. Referensgeometri-ID för användning med API:et Get Search Polygon. |
|
detourTime |
integer |
Omvägstid i sekunder. Returneras endast för anrop till API:et Search Längs vägen. |
dist |
number |
Rät linjeavstånd mellan resultatet och geobias plats i meter. |
entityType |
Geografi entitetstyp. Presentera endast när entityType begärdes och är tillgängligt. |
|
entryPoints |
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 |
Information om typen av matchning. Något av:
|
|
poi |
Information om den returnerade IP-adressen, inklusive information som namn, telefon, URL-adress och klassificeringar. |
|
position |
En plats som representeras som en 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 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 |
Något av:
|
|
viewport |
Det visningsområde som täcker resultatet som representeras av koordinaterna överst till vänster och längst ned till höger i visningsplatsen. |
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 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. |