Search - Post Search Fuzzy Batch Sync
Använd för att skicka en batch med frågor till Search Fuzzy API i en enda synkron begäran.
API:et Post Search Fuzzy Batch är en HTTP-begäran POST som skickar batchar med frågor till Search Fuzzy API i ett enda synkront anrop. Du kan anropa Post Search Fuzzy Batch API för att köra antingen asynkront (asynkront) eller synkront (synkronisering). Med asynkront API kan anroparen batcha upp till 10 000 frågor och synkronisera API:et med upp till 100 frågor.
Skicka synkron Batch-begäran
Det synkrona API:et rekommenderas för förenklade batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten beräknas och det finns ingen möjlighet att hämta resultaten senare. Det synkrona API:et returnerar ett timeout-fel (ett 408-svar) om begäran tar längre tid än 60 sekunder. Antalet batchobjekt är begränsat till 100 för det här API:et.
POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
Skicka asynkron Batch-begäran
Det asynkrona API:et är lämpligt för bearbetning av stora volymer av relativt komplexa sökbegäranden
- Det gör det möjligt att hämta resultat i ett separat anrop (flera nedladdningar är möjliga).
- Det asynkrona API:et är optimerat för tillförlitlighet och förväntas inte överskrida tidsgränsen.
- Antalet batchobjekt är begränsat till 10 000 för det här API:et.
När du gör en begäran med hjälp av en asynkron begäran returnerar tjänsten som standard en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. De asynkrona svaren lagras i 14 dagar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter förfalloperioden.
Observera att en asynkron batchbegäran är en tidskrävande åtgärd. Här är en typisk sekvens med åtgärder:
- Klienten skickar en Search Fuzzy Batch-begäran
POSTtill Azure Maps.
POST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0&subscription-key={subscription-key}
Servern svarar med något av följande:
HTTP
202 Accepted– Batch-begäran har accepterats.HTTP
Error– Ett fel uppstod när Batch-begäran bearbetades. Detta kan antingen vara en400 Bad Requesteller någon annanErrorstatuskod.Om batchbegäran har accepterats
Locationinnehåller rubriken i svaret URL:en för att ladda ned resultatet av batchbegäran. Den här status-URI:n ser ut så här:
GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
- Klienten skickar en begäran om nedladdnings-URL:en
GETsom hämtades i steg 3 för att ladda ned batchresultatet.
POST-brödtext för Batch-begäran
Om du vill skicka fuzzy-sökfrågorna använder du en POST begäran där begärandetexten innehåller matrisen batchItems i json format och Content-Type rubriken anges till application/json. Här är ett exempel på en begärandetext som innehåller 5 fuzzy-sökfrågor :
{
"batchItems": [
{"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"},
{"query": "?query=Statue Of Liberty&limit=2"},
{"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"},
{"query": "?query=Space Needle"},
{"query": "?query=pizza&limit=10"}
]
}
En fuzzy-sökfråga i en batch är bara en partiell URL utan protokollet, bas-URL:en, sökvägen, api-versionen och prenumerationsnyckeln. Den kan acceptera någon av de URI-parametrar för sökning som stöds. Strängvärdena i fuzzy-frågan för sökningen måste vara korrekt undantagna (t.ex. " tecknet ska vara undantaget med \ ) och det bör också vara korrekt URL-kodat.
Med asynkront API kan anroparen batcha upp till 10 000 frågor och synkronisera API:et med upp till 100 frågor, och batchen bör innehålla minst 1 fråga.
Ladda ned asynkrona batchresultat
Om du vill ladda ned asynkrona batchresultat skickar du en GET begäran till batchnedladdningsslutpunkten. Den här nedladdnings-URL:en kan hämtas från rubriken för Location en lyckad POST batchbegäran och ser ut så här:
https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
Här är den typiska åtgärdssekvensen för att ladda ned batchresultatet:
Klienten skickar en
GETbegäran med hjälp av nedladdnings-URL:en.Servern svarar med något av följande:
HTTP
202 Accepted– Batch-begäran accepterades men bearbetas fortfarande. Försök igen om en stund.HTTP
200 OK– Batch-begäran har bearbetats. Svarstexten innehåller alla batchresultat.
Batch-svarsmodell
Det returnerade datainnehållet liknar asynkroniserings- och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran, om batchen har slutfört bearbetningen, innehåller svarstexten batchsvaret. Det här batchsvaret innehåller en summary komponent som anger totalRequests som var en del av den ursprungliga batchbegäran, dvs successfulRequests. frågor som har körts korrekt. Batchsvaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran.
batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode och response fält. Varje response in batchItems är av någon av följande typer:
SearchAddressResult– Om frågan har slutförts.Error– Om frågan misslyckades. Svaret innehåller encodeoch enmessagei det här fallet.
Här är ett exempel på batchsvar med 2 lyckade och 1 misslyckade resultat:
{
"summary": {
"successfulRequests": 2,
"totalRequests": 3
},
"batchItems": [
{
"statusCode": 200,
"response":
{
"summary": {
"query": "atm"
},
"results": [
{
"type": "POI",
"poi": {
"name": "ATM at Wells Fargo"
},
"address": {
"country": "United States Of America",
"freeformAddress": "3240 157th Ave NE, Redmond, WA 98052"
}
}
]
}
},
{
"statusCode": 200,
"response":
{
"summary": {
"query": "statue of liberty"
},
"results": [
{
"type": "POI",
"poi": {
"name": "Statue of Liberty"
},
"address": {
"country": "United States Of America",
"freeformAddress": "New York, NY 10004"
}
}
]
}
},
{
"statusCode": 400,
"response":
{
"error":
{
"code": "400 BadRequest",
"message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
}
}
}
]
}
POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0URI-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
format
|
path | True |
Önskat format för svaret. Endast |
|
|
api-version
|
query | True |
string |
Versionsnummer för Azure Maps API. |
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. |
Begärandetext
| Name | Typ | Description |
|---|---|---|
| batchItems |
Listan över frågor som ska bearbetas. |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Tidsgräns: Det tog längre tid att slutföra begäran än den maximala tid som definierats i API:et. |
|
| 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-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.
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
A Sync Search Fuzzy Batch API call containing 5 Search Fuzzy API queries
Exempelbegäran
POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0
{
"batchItems": [
{
"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"
},
{
"query": "?query=Statue Of Liberty&limit=2"
},
{
"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"
}
]
}
Exempelsvar
{
"batchItems": [
{
"statusCode": 200,
"response": {
"summary": {
"query": "atm",
"queryType": "NON_NEAR",
"queryTime": 5,
"numResults": 5,
"offset": 0,
"totalResults": 262,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.639769,
"lon": -122.128362
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/3656546",
"score": 2.671,
"dist": 1336.1815386162032,
"info": "search:ta:840539002005905-US",
"poi": {
"name": "US Bank ATM-MONEYPASS",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "14808",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "14808 NE 24th St, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63229,
"lon": -122.14232
},
"viewport": {
"topLeftPoint": {
"lat": 47.63319,
"lon": -122.14365
},
"btmRightPoint": {
"lat": 47.63139,
"lon": -122.14099
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.63154,
"lon": -122.1423
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/8673325",
"score": 2.671,
"dist": 1206.8488178244172,
"info": "search:ta:840539002022072-US",
"poi": {
"name": "US Bank ATM NATIONAL ASSOCIATION",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "15000",
"streetName": "Northeast 24Th Street",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525522",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15000 Northeast 24Th Street, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63265,
"lon": -122.14052
},
"viewport": {
"topLeftPoint": {
"lat": 47.63355,
"lon": -122.14185
},
"btmRightPoint": {
"lat": 47.63175,
"lon": -122.13919
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14056
}
},
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14058
}
},
{
"type": "main",
"position": {
"lat": 47.63156,
"lon": -122.14048
}
},
{
"type": "main",
"position": {
"lat": 47.6324,
"lon": -122.13938
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/2736315",
"score": 2.671,
"dist": 864.7591776519859,
"info": "search:ta:840539002187855-US",
"poi": {
"name": "US Bank ATM-MONEYPASS",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "15521",
"streetName": "Bel Red Rd",
"municipalitySubdivision": "Redmond, Northeast Bellevue, Bellevue",
"municipality": "Redmond, Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525501",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15521 Bel Red Rd, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63259,
"lon": -122.1328
},
"viewport": {
"topLeftPoint": {
"lat": 47.63349,
"lon": -122.13413
},
"btmRightPoint": {
"lat": 47.63169,
"lon": -122.13147
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.63255,
"lon": -122.13275
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/3656412",
"score": 2.67,
"dist": 2140.198538580941,
"info": "search:ta:840539001998867-US",
"poi": {
"name": "US Bank ATM NATIONAL ASSOCIATION",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1128",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62069,
"lon": -122.13213
},
"viewport": {
"topLeftPoint": {
"lat": 47.62159,
"lon": -122.13346
},
"btmRightPoint": {
"lat": 47.61979,
"lon": -122.1308
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62069,
"lon": -122.13236
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/2736876",
"score": 2.67,
"dist": 2140.198538580941,
"info": "search:ta:840539001396789-US",
"poi": {
"name": "US Bank ATM",
"phone": "+(1)-(800)-8722657",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"url": "www.usbank.com",
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1128",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62069,
"lon": -122.13213
},
"viewport": {
"topLeftPoint": {
"lat": 47.62159,
"lon": -122.13346
},
"btmRightPoint": {
"lat": 47.61979,
"lon": -122.1308
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62069,
"lon": -122.13236
}
}
]
}
]
}
},
{
"statusCode": 200,
"response": {
"summary": {
"query": "statue of liberty",
"queryType": "NON_NEAR",
"queryTime": 37,
"numResults": 2,
"offset": 0,
"totalResults": 18,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/9189660",
"score": 6.942,
"info": "search:ta:840369001174316-US",
"poi": {
"name": "Statue of Liberty",
"categorySet": [
{
"id": 7376003
}
],
"classifications": [
{
"code": "IMPORTANT_TOURIST_ATTRACTION",
"names": [
{
"nameLocale": "en-US",
"name": "monument"
},
{
"nameLocale": "en-US",
"name": "important tourist attraction"
}
]
}
]
},
"address": {
"municipalitySubdivision": "New York",
"municipality": "New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "New York, NY 10004",
"localName": "New York",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.68955,
"lon": -74.04483
},
"viewport": {
"topLeftPoint": {
"lat": 40.69045,
"lon": -74.04602
},
"btmRightPoint": {
"lat": 40.68865,
"lon": -74.04364
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.69001,
"lon": -74.04683
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/3264566",
"score": 6.942,
"info": "search:ta:840019000670588-US",
"poi": {
"name": "Statue of Liberty",
"phone": "+(1)-(205)-9700251",
"categorySet": [
{
"id": 7376003
}
],
"url": "www.1bsa.org",
"classifications": [
{
"code": "IMPORTANT_TOURIST_ATTRACTION",
"names": [
{
"nameLocale": "en-US",
"name": "important tourist attraction"
}
]
}
]
},
"address": {
"streetNumber": "516",
"streetName": "Liberty Pkwy",
"municipalitySubdivision": "Vestavia Hills",
"municipality": "Vestavia Hills, Birmingham",
"countrySecondarySubdivision": "Jefferson",
"countryTertiarySubdivision": "Leeds",
"countrySubdivisionCode": "AL",
"postalCode": "35242",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "516 Liberty Pkwy, Vestavia Hills, AL 35242",
"localName": "Vestavia Hills",
"countrySubdivisionName": "Alabama"
},
"position": {
"lat": 33.48234,
"lon": -86.70719
},
"viewport": {
"topLeftPoint": {
"lat": 33.48324,
"lon": -86.70827
},
"btmRightPoint": {
"lat": 33.48144,
"lon": -86.70611
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 33.48129,
"lon": -86.7065
}
}
]
}
]
}
},
{
"statusCode": 200,
"response": {
"summary": {
"query": "starbucks",
"queryType": "NON_NEAR",
"queryTime": 35,
"numResults": 10,
"offset": 0,
"totalResults": 17,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.639769,
"lon": -122.128362
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/153678",
"score": 2.671,
"dist": 1206.8488178244172,
"info": "search:ta:840531000006554-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8695816",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15000",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525522",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15000 NE 24th St, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63265,
"lon": -122.14052
},
"viewport": {
"topLeftPoint": {
"lat": 47.63355,
"lon": -122.14185
},
"btmRightPoint": {
"lat": 47.63175,
"lon": -122.13919
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14056
}
},
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14058
}
},
{
"type": "main",
"position": {
"lat": 47.63156,
"lon": -122.14048
}
},
{
"type": "main",
"position": {
"lat": 47.6324,
"lon": -122.13938
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/152316",
"score": 2.67,
"dist": 2315.294397491255,
"info": "search:ta:840539000484552-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-6436471",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/store/15097",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15600",
"streetName": "NE 8th St",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98008",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15600 NE 8th St, Bellevue, WA 98008",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61896,
"lon": -122.12945
},
"viewport": {
"topLeftPoint": {
"lat": 47.61986,
"lon": -122.13078
},
"btmRightPoint": {
"lat": 47.61806,
"lon": -122.12812
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.619,
"lon": -122.12945
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167545",
"score": 2.67,
"dist": 1979.2222952267998,
"info": "search:ta:840539001950429-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-7470690",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "1350",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1350 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62212,
"lon": -122.13179
},
"viewport": {
"topLeftPoint": {
"lat": 47.62302,
"lon": -122.13312
},
"btmRightPoint": {
"lat": 47.62122,
"lon": -122.13046
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62213,
"lon": -122.13236
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/168519",
"score": 2.67,
"dist": 2490.3337046455963,
"info": "search:ta:840539001015090-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-4556500",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "https://www.starbucks.com/store-locator/store/15901",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "1645",
"streetName": "140th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98005",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1645 140th Ave NE, Bellevue, WA 98005",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62626,
"lon": -122.15487
},
"viewport": {
"topLeftPoint": {
"lat": 47.62716,
"lon": -122.1562
},
"btmRightPoint": {
"lat": 47.62536,
"lon": -122.15354
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62645,
"lon": -122.15446
}
},
{
"type": "minor",
"position": {
"lat": 47.62579,
"lon": -122.15377
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/152428",
"score": 2.668,
"dist": 3529.7080738812224,
"info": "search:ta:840539001033722-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-3789496",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "180",
"streetName": "148th Ave SE",
"municipalitySubdivision": "West Lake Hills, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "180 148th Ave SE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.60901,
"lon": -122.14
},
"viewport": {
"topLeftPoint": {
"lat": 47.60991,
"lon": -122.14133
},
"btmRightPoint": {
"lat": 47.60811,
"lon": -122.13867
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.60901,
"lon": -122.14008
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167147",
"score": 2.668,
"dist": 3479.393294615887,
"info": "search:ta:840539000326896-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8619198",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "7425",
"streetName": "166th Ave NE",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980526288",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "7425 166th Ave NE, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67055,
"lon": -122.12001
},
"viewport": {
"topLeftPoint": {
"lat": 47.67145,
"lon": -122.12135
},
"btmRightPoint": {
"lat": 47.66965,
"lon": -122.11867
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.67069,
"lon": -122.11889
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/153695",
"score": 2.667,
"dist": 3622.441074618729,
"info": "search:ta:840531000006551-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8822881",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/store/15022",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "7625",
"streetName": "170th Ave NE",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980520910",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "7625 170th Ave NE, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67086,
"lon": -122.11392
},
"viewport": {
"topLeftPoint": {
"lat": 47.67176,
"lon": -122.11526
},
"btmRightPoint": {
"lat": 47.66996,
"lon": -122.11258
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.67073,
"lon": -122.1135
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167420",
"score": 2.667,
"dist": 3818.293513029088,
"info": "search:ta:840539000640782-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8853323",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "17246",
"streetName": "Redmond Way",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980524403",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "17246 Redmond Way, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67174,
"lon": -122.10976
},
"viewport": {
"topLeftPoint": {
"lat": 47.67264,
"lon": -122.1111
},
"btmRightPoint": {
"lat": 47.67084,
"lon": -122.10842
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6706,
"lon": -122.11026
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/153686",
"score": 2.666,
"dist": 4009.922205147074,
"info": "search:ta:840531000006548-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8859590",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15738",
"streetName": "Redmond Way Pad 3 Redmond Center",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980523873",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15738 Redmond Way Pad 3 Redmond Center, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67583,
"lon": -122.12877
},
"viewport": {
"topLeftPoint": {
"lat": 47.67673,
"lon": -122.13011
},
"btmRightPoint": {
"lat": 47.67493,
"lon": -122.12743
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.67456,
"lon": -122.12887
}
},
{
"type": "main",
"position": {
"lat": 47.67668,
"lon": -122.12829
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/168511",
"score": 2.666,
"dist": 3987.80992387863,
"info": "search:ta:840531000006669-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8818265",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "6617",
"streetName": "132Nd Ave Ne Bridle Trails Shopping Center",
"municipalitySubdivision": "Kirkland, Bridle Trails",
"municipality": "Kirkland",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98033",
"extendedPostalCode": "980338234",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "6617 132Nd Ave Ne Bridle Trails Shopping Center, Kirkland, WA 98033",
"localName": "Kirkland",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.66514,
"lon": -122.16599
},
"viewport": {
"topLeftPoint": {
"lat": 47.66604,
"lon": -122.16733
},
"btmRightPoint": {
"lat": 47.66424,
"lon": -122.16465
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.666,
"lon": -122.16669
}
},
{
"type": "minor",
"position": {
"lat": 47.66553,
"lon": -122.16405
}
}
]
}
]
}
}
],
"summary": {
"successfulRequests": 3,
"totalRequests": 3
}
}{
"error": {
"code": "408 Timeout",
"message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
}
}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. |
|
Batch |
Den här typen representerar begärandetexten för Batch-tjänsten. |
|
Batch |
Batch-begärandeobjekt |
|
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. |
| 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. |
|
Json |
Önskat format för svaret. Endast |
|
Lat |
En plats som representeras som latitud och longitud med kortnamnen "lat" & "lon". |
|
Match |
Matchningstyper för en sökåtgärd med omvänd adress. |
|
Operating |
Öppettider för en POI (intressepunkter). |
|
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 |
Den typ av fråga som returneras: NÄRLIGGANDE eller NON_NEAR. |
| Response |
Resultatet av frågan. SearchAddressResult om frågan har slutförts, ErrorResponse annars. |
|
Search |
Ett objekt som returneras från Search Batch-tjänstanrop för adress. |
|
Search |
Det här objektet returneras från ett lyckat Search Batch-tjänstanrop för adress. |
|
Search |
Resultatobjekt för ett Search API-svar. |
|
Search |
Något av:
|
|
Search |
Sammanfattningsobjekt för ett Search API-svar. |
| Summary |
Sammanfattning av resultatet för batchbegäran |
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". |
BatchRequest
Den här typen representerar begärandetexten för Batch-tjänsten.
| Name | Typ | Description |
|---|---|---|
| batchItems |
Listan över frågor som ska bearbetas. |
BatchRequestItem
Batch-begärandeobjekt
| Name | Typ | Description |
|---|---|---|
| query |
string |
Den här parametern innehåller en frågesträng som används för att utföra en ostrukturerad geokodningsåtgärd. Frågesträngen skickas ordagrant till sök-API:et för bearbetning. |
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. |
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 |
Den ytterligare informationen. |
| type |
string |
Ytterligare informationstyp. |
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 |
Stad/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. |
JsonFormat
Önskat format för svaret. Endast json format stöds.
| Name | Typ | Description |
|---|---|---|
| json |
string |
LatLongPairAbbreviated
En plats som representeras som latitud och longitud med kortnamnen "lat" & "lon".
| Name | Typ | Description |
|---|---|---|
| lat |
number |
Latitude-egenskap |
| lon |
number |
Longitudegenskap |
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 |
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 |
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
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 |
Response
Resultatet av frågan. SearchAddressResult om frågan har slutförts, ErrorResponse annars.
| Name | Typ | Description |
|---|---|---|
| error |
Felobjektet. |
|
| results |
En lista över Search API-resultat. |
|
| summary |
Sammanfattningsobjekt för ett Search API-svar |
SearchAddressBatchItem
Ett objekt som returneras från Search Batch-tjänstanrop för adress.
| Name | Typ | Description |
|---|---|---|
| response |
Resultatet av frågan. SearchAddressResult om frågan har slutförts, ErrorResponse annars. |
|
| statusCode |
integer |
Statuskod för HTTP-begäran. |
SearchAddressBatchProcessResult
Det här objektet returneras från ett lyckat Search Batch-tjänstanrop för adress.
| Name | Typ | Description |
|---|---|---|
| batchItems |
Matris som innehåller batchresultatet. |
|
| summary |
Sammanfattning av resultatet för batchbegäran |
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 |
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 |
Geografientitetstyp. Finns bara när entityType begärdes och är tillgängligt. |
|
| entryPoints |
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 |
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 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 |
Något av:
|
|
| viewport |
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 |
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 |
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 |
Den typ av fråga som returneras: NÄRLIGGANDE eller NON_NEAR. |
|
| totalResults |
integer |
Det totala antalet resultat som hittades. |
Summary
Sammanfattning av resultatet för batchbegäran
| Name | Typ | Description |
|---|---|---|
| successfulRequests |
integer |
Antal lyckade begäranden i batchen |
| totalRequests |
integer |
Totalt antal begäranden i batchen |