Search - Post Search Fuzzy Batch
Gebruik om een batch query's te verzenden naar de Search Fuzzy API in één asynchrone aanvraag.
De Post Search Fuzzy Batch
API is een HTTP-aanvraag POST
waarmee batches query's worden verzonden naar Search Fuzzy-API in één asynchrone aanroep. U kunt Search Fuzzy Batch-API aanroepen om asynchroon (asynchroon) of synchroon (sync) uit te voeren. Met de asynchrone API kan de aanroeper maximaal 10.000 query's batches uitvoeren en de API synchroniseren tot 100 query's.
Synchrone batchaanvraag verzenden
De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batch-items zijn berekend en is het niet mogelijk om de resultaten later op te halen. De synchrone API retourneert een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batch-items is beperkt tot 100 voor deze API.
POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
Asynchrone batchaanvraag verzenden
De asynchrone API is geschikt voor het verwerken van grote volumes van relatief complexe zoekaanvragen
- Hiermee kunnen resultaten in een afzonderlijke aanroep worden opgehaald (meerdere downloads zijn mogelijk).
- De asynchrone API is geoptimaliseerd voor betrouwbaarheid en er wordt geen time-out verwacht.
- Het aantal batch-items is beperkt tot 10.000 voor deze API.
Wanneer u een aanvraag doet met behulp van een asynchrone aanvraag, retourneert de service standaard een 202-antwoordcode samen met een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet regelmatig worden gecontroleerd totdat de antwoordgegevens of foutinformatie beschikbaar zijn. De asynchrone antwoorden worden 14 dagen opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze na de verloopperiode wordt gebruikt.
Houd er rekening mee dat een asynchrone batchaanvraag een langdurige bewerking is. Hier volgt een typische reeks bewerkingen:
- Client verzendt een Search Fuzzy Batch-aanvraag
POST
naar Azure Maps.
POST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0&subscription-key={subscription-key}
De server reageert met een van de volgende opties:
HTTP
202 Accepted
- Batch-aanvraag is geaccepteerd.HTTP
Error
: er is een fout opgetreden bij het verwerken van uw Batch-aanvraag. Dit kan een400 Bad Request
of een andereError
statuscode zijn.Als de batchaanvraag is geaccepteerd, bevat de
Location
header in het antwoord de URL voor het downloaden van de resultaten van de batchaanvraag. Deze status-URI ziet er als volgt uit:
GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
- Client verzendt een
GET
aanvraag op de download-URL die in stap 3 is verkregen om de batchresultaten te downloaden.
POST-hoofdtekst voor Batch-aanvraag
Voor het verzenden van de zoekopdracht fuzzy query's gebruikt u een POST
aanvraag waarbij de aanvraagbody de batchItems
matrix in json
indeling bevat en de Content-Type
header wordt ingesteld op application/json
. Hier volgt een voorbeeld van een aanvraagbody met 5 fuzzy zoekopdrachten :
{
"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"}
]
}
Een fuzzy zoekopdracht in een batch is slechts een gedeeltelijke URL zonder het protocol, de basis-URL, het pad, de API-versie en de abonnementssleutel. Het kan elk van de ondersteunde fuzzyURI-parameters voor zoeken accepteren. De tekenreekswaarden in de zoekquery moeten op de juiste manier worden ge escaped (bijvoorbeeld " teken moet worden ge escaped met \ ) en moeten ook correct zijn gecodeerd met URL's.
Met de asynchrone API kan de aanroeper maximaal 10.000 query's batches uitvoeren en de API synchroniseren tot 100 query's. De batch moet ten minste één query bevatten.
Asynchrone batchresultaten downloaden
Als u de asynchrone batchresultaten wilt downloaden, verzendt u een GET
aanvraag naar het eindpunt van de batchdownload. Deze download-URL kan worden verkregen uit de Location
header van een geslaagde POST
batchaanvraag en ziet er als volgt uit:
https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
Dit is de gebruikelijke volgorde van bewerkingen voor het downloaden van de batchresultaten:
Client verzendt een
GET
aanvraag met behulp van de download-URL.De server reageert met een van de volgende opties:
HTTP
202 Accepted
: Batch-aanvraag is geaccepteerd, maar wordt nog steeds verwerkt. Probeer het over enige tijd opnieuw.HTTP
200 OK
: Batch-aanvraag is verwerkt. De antwoordtekst bevat alle batchresultaten.
Batch-antwoordmodel
De geretourneerde gegevensinhoud is vergelijkbaar voor asynchrone en synchronisatieaanvragen. Wanneer u de resultaten van een asynchrone batchaanvraag downloadt en de batch is verwerkt, bevat de antwoordtekst het batchantwoord. Dit batchantwoord bevat een summary
onderdeel dat aangeeft totalRequests
dat deel uitmaakt van de oorspronkelijke batchaanvraag en successfulRequests
dat wil gezegd query's die met succes zijn uitgevoerd. Het batchantwoord bevat ook een batchItems
matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems
bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's die in de batchaanvraag zijn verzonden. Elk item in batchItems
bevat statusCode
en response
velden. Elk response
in batchItems
heeft een van de volgende typen:
SearchAddressResult
- Als de query is voltooid.Error
- Als de query is mislukt. Het antwoord bevat in dit geval eencode
en eenmessage
.
Hier volgt een voorbeeld van een Batch-antwoord met het resultaat 2 geslaagd en 1 mislukt :
{
"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/json?api-version=1.0
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
format
|
path | True |
Gewenste indeling van het antwoord. Alleen |
|
api-version
|
query | True |
string |
Versienummer van Azure Maps API. |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
x-ms-client-id |
string |
Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID beveiliging wilt gebruiken in Azure Maps raadpleegt u de volgende artikelen voor hulp. |
Aanvraagbody
Name | Type | Description |
---|---|---|
batchItems |
De lijst met te verwerken query's. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
202 Accepted |
Alleen ondersteund voor asynchrone aanvragen. Aanvraag geaccepteerd: de aanvraag is geaccepteerd voor verwerking. Gebruik de URL in de Locatieheader om de resultaten opnieuw te proberen of te openen. Headers Location: string |
|
Other Status Codes |
Er is een onverwachte fout opgetreden. |
Beveiliging
AADToken
Dit zijn de Microsoft Entra OAuth 2.0-stromen. Wanneer het is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure, kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.
Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.
Notitie
- Voor deze beveiligingsdefinitie is het gebruik van de
x-ms-client-id
header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API . - De
Authorization URL
is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. - Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
- Het gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.
- Zie overzicht van Microsoft identity platform voor meer informatie over Microsoft identity platform.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account maakt in de Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.
Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.
Voor openbaar beschikbare toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.
Type:
apiKey
In:
query
SAS Token
Dit is een Shared Access Signature-token dat is gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.
Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.
Type:
apiKey
In:
header
Voorbeelden
A Search Fuzzy Batch API call containing 5 Search Fuzzy API queries
Sample Request
POST https://atlas.microsoft.com/search/fuzzy/batch/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"
}
]
}
Sample Response
{
"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
}
}
Operation-Location: URL to download the results of the long-running batch request.
Definities
Name | Description |
---|---|
Address |
Het adres van het resultaat |
Address |
Beschrijft het adresbereik aan beide zijden van de straat voor een zoekresultaat. Coördinaten voor de begin- en eindlocatie van het adresbereik worden opgenomen. |
Batch |
Dit type vertegenwoordigt de aanvraagbody voor de Batch-service. |
Batch |
Batchaanvraagobject |
Bounding |
De viewport die het resultaat bedekt dat wordt vertegenwoordigd door de coördinaten linksboven en rechtsonder van de viewport. |
Bounding |
Het begrenzingsvak van de locatie. |
Brand |
Het merk dat is gekoppeld aan de POI |
Classification |
De classificatie voor de POI die wordt geretourneerd |
Classification |
Naam voor de classificatie |
Data |
Optionele sectie. Referentie-id's voor gebruik met de Get Search Polygon-API. |
Entity |
Bron van entiteitstype van het begrenzingsvak. Voor reverse-geocodering is dit altijd gelijk aan positie. |
Entry |
Het toegangspunt voor de POI die wordt geretourneerd. |
Entry |
Het type toegangspunt. De waarde kan main of minor zijn. |
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
De foutdetails. |
Error |
Foutreactie |
Geographic |
Type geografie-entiteit. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is. |
Geometry |
Informatie over de geometrische vorm van het resultaat. Alleen aanwezig als u == Geografie typt. |
Json |
Gewenste indeling van het antwoord. Alleen |
Lat |
Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'. |
Match |
Typen overeenkomsten voor een omgekeerde adreszoekbewerking. |
Operating |
Openingstijden voor een POI (Nuttige plaatsen). |
Operating |
Vertegenwoordigt een datum en tijd |
Operating |
Open tijdsbereik voor een dag |
Point |
Details van de geretourneerde POI, inclusief informatie zoals de naam, telefoon, URL-adres en classificaties. |
Point |
POI-categorie |
Query |
Het type query dat wordt geretourneerd: IN DE BUURT of NON_NEAR. |
Response |
Het resultaat van de query. SearchAddressResult als de query is voltooid, errorresponse anders. |
Search |
Een item dat is geretourneerd door Search Adres Batch-serviceaanroep. |
Search |
Dit object wordt geretourneerd na een geslaagde Search Adres Batch-serviceoproep. |
Search |
Resultaatobject voor een Search API-antwoord. |
Search |
Een van de volgende:
|
Search |
Samenvattingsobject voor een Search API-antwoord. |
Summary |
Samenvatting van de resultaten voor de batchaanvraag |
Address
Het adres van het resultaat
Name | Type | Description |
---|---|---|
boundingBox |
Het begrenzingsvak van de locatie. |
|
buildingNumber |
string |
Het nummer van het gebouw op straat. AFGESCHAFT, gebruik in plaats daarvan streetNumber. |
country |
string |
land/regionaam |
countryCode |
string |
Land (opmerking: dit is een code van twee letters, geen land-/regionaam.) |
countryCodeISO3 |
string |
ISO alfa-3-landcode |
countrySecondarySubdivision |
string |
Graafschap |
countrySubdivision |
string |
Staat of provincie |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
De volledige naam van een eerste niveau van de land-/regiobeheerhiërarchie. Dit veld wordt alleen weergegeven als countrySubdivision in een verkorte vorm wordt weergegeven. Alleen ondersteund voor de VS, Canada en het Verenigd Koninkrijk. |
countryTertiarySubdivision |
string |
Benoemd gebied |
crossStreet |
string |
De naam van de straat die wordt gekruist. |
extendedPostalCode |
string |
Uitgebreide postcode (beschikbaarheid is afhankelijk van de regio). |
freeformAddress |
string |
Een adresregel die is opgemaakt volgens de opmaakregels van het land/de regio van herkomst van een resultaat, of, in het geval van een land/regio, de volledige land-/regionaam. |
localName |
string |
Een adresonderdeel dat de naam van een geografisch gebied of een plaats vertegenwoordigt die meerdere adresseerbare objecten groepeert voor adresseringsdoeleinden, zonder dat het een beheereenheid is. Dit veld wordt gebruikt om de |
municipality |
string |
Plaats /plaats |
municipalitySubdivision |
string |
Sub-/superstad |
neighbourhood |
string |
Een Wijk is een geografisch gelokaliseerd gebied binnen een stad of stad met onderscheidende kenmerken en sociale interacties tussen inwoners. |
postalCode |
string |
Postcode |
routeNumbers |
string[] |
De codes die worden gebruikt om de straat ondubbelzinnig te identificeren |
street |
string |
De straatnaam. AFGESCHAFT, gebruikt u in plaats daarvan streetName. |
streetName |
string |
De straatnaam. |
streetNameAndNumber |
string |
De straatnaam en het nummer. |
streetNumber |
string |
Het nummer van het gebouw op straat. |
AddressRanges
Beschrijft het adresbereik aan beide zijden van de straat voor een zoekresultaat. Coördinaten voor de begin- en eindlocatie van het adresbereik worden opgenomen.
Name | Type | Description |
---|---|---|
from |
Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'. |
|
rangeLeft |
string |
Adresbereik aan de linkerkant van de straat. |
rangeRight |
string |
Adresbereik aan de rechterkant van de straat. |
to |
Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'. |
BatchRequest
Dit type vertegenwoordigt de aanvraagbody voor de Batch-service.
Name | Type | Description |
---|---|---|
batchItems |
De lijst met query's die moeten worden verwerkt. |
BatchRequestItem
Batchaanvraagobject
Name | Type | Description |
---|---|---|
query |
string |
Deze parameter bevat een queryreeks die wordt gebruikt om een ongestructureerde geocoderingsbewerking uit te voeren. De queryreeks wordt exacte bewoordingen doorgegeven aan de zoek-API voor verwerking. |
BoundingBox
De viewport die het resultaat bedekt dat wordt vertegenwoordigd door de coördinaten linksboven en rechtsonder van de viewport.
Name | Type | Description |
---|---|---|
btmRightPoint |
Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'. |
|
topLeftPoint |
Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'. |
BoundingBoxCompassNotation
Het begrenzingsvak van de locatie.
Name | Type | Description |
---|---|---|
entity |
Bron van entiteitstype van het begrenzingsvak. Voor reverse-geocodering is dit altijd gelijk aan positie. |
|
northEast |
string |
Noord-oosten breedtegraad, lengtecoördinaat van het begrenzingsvak als door komma's gescheiden vlotters |
southWest |
string |
Zuidwestelijke breedtegraad, lengtecoördinaat van het begrenzingsvak als door komma's gescheiden vlotters |
Brand
Het merk dat is gekoppeld aan de POI
Name | Type | Description |
---|---|---|
name |
string |
Naam van het merk |
Classification
De classificatie voor de POI die wordt geretourneerd
Name | Type | Description |
---|---|---|
code |
string |
Code-eigenschap |
names |
Namenmatrix |
ClassificationName
Naam voor de classificatie
Name | Type | Description |
---|---|---|
name |
string |
Naameigenschap |
nameLocale |
string |
Naamlandinstelling eigenschap |
DataSources
Optionele sectie. Referentie-id's voor gebruik met de Get Search Polygon-API.
Name | Type | Description |
---|---|---|
geometry |
Informatie over de geometrische vorm van het resultaat. Alleen aanwezig als u == Geografie typt. |
Entity
Bron van entiteitstype van het begrenzingsvak. Voor reverse-geocodering is dit altijd gelijk aan positie.
Name | Type | Description |
---|---|---|
position |
string |
Positie-entiteit |
EntryPoint
Het toegangspunt voor de POI die wordt geretourneerd.
Name | Type | Description |
---|---|---|
position |
Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'. |
|
type |
Het type toegangspunt. De waarde kan main of minor zijn. |
EntryPointType
Het type toegangspunt. De waarde kan main of minor zijn.
Name | Type | Description |
---|---|---|
main |
string |
|
minor |
string |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
Name | Type | Description |
---|---|---|
info |
object |
De aanvullende informatie. |
type |
string |
Het type aanvullende informatie. |
ErrorDetail
De foutdetails.
Name | Type | Description |
---|---|---|
additionalInfo |
De fout aanvullende informatie. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
GeographicEntityType
Type geografie-entiteit. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.
Name | Type | Description |
---|---|---|
Country |
string |
land/regionaam |
CountrySecondarySubdivision |
string |
Graafschap |
CountrySubdivision |
string |
Staat of provincie |
CountryTertiarySubdivision |
string |
Benoemd gebied |
Municipality |
string |
Plaats /plaats |
MunicipalitySubdivision |
string |
Sub-/superstad |
Neighbourhood |
string |
Buurt |
PostalCodeArea |
string |
Postcode |
Geometry
Informatie over de geometrische vorm van het resultaat. Alleen aanwezig als u == Geografie typt.
Name | Type | Description |
---|---|---|
id |
string |
Geef deze door als geometryId aan de API Get Search Polygon om geometriegegevens voor dit resultaat op te halen. |
JsonFormat
Gewenste indeling van het antwoord. Alleen json
de indeling wordt ondersteund.
Name | Type | Description |
---|---|---|
json |
string |
LatLongPairAbbreviated
Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
Name | Type | Description |
---|---|---|
lat |
number |
De eigenschap Breedtegraad |
lon |
number |
De eigenschap Lengtegraad |
MatchType
Typen overeenkomsten voor een omgekeerde adreszoekbewerking.
Name | Type | Description |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
OperatingHours
Openingstijden voor een POI (Nuttige plaatsen).
Name | Type | Description |
---|---|---|
mode |
string |
Waarde die in de aanvraag wordt gebruikt: none of 'nextSevenDays' |
timeRanges |
Lijst met tijdsbereiken voor de komende 7 dagen |
OperatingHoursTime
Vertegenwoordigt een datum en tijd
Name | Type | Description |
---|---|---|
date |
string |
Geeft de huidige kalenderdatum in poi-tijdzone aan, bijvoorbeeld '02-2019-07'. |
hour |
integer |
Uren zijn in de 24-uursnotatie in de lokale tijd van een POI; mogelijke waarden zijn 0 - 23. |
minute |
integer |
Minuten bevinden zich in de lokale tijd van een POI; mogelijke waarden zijn 0 - 59. |
OperatingHoursTimeRange
Open tijdsbereik voor een dag
Name | Type | Description |
---|---|---|
endTime |
Het punt in de komende 7 dagen wanneer een bepaalde POI wordt gesloten, of het begin van het bereik als het vóór het bereik gesloten was. |
|
startTime |
Het punt in de komende 7 dagen waarop een bepaalde POI wordt geopend, of het begin van het bereik als het vóór het bereik werd geopend. |
PointOfInterest
Details van de geretourneerde POI, inclusief informatie zoals de naam, telefoon, URL-adres en classificaties.
Name | Type | Description |
---|---|---|
brands |
Brand[] |
Merken matrix. De naam van het merk voor de POI die wordt geretourneerd. |
categories |
string[] |
Categorieënmatrix |
categorySet |
De lijst met de meest specifieke POI-categorieën |
|
classifications |
Classificatiematrix |
|
name |
string |
Naam van de eigenschap POI |
openingHours |
Openingstijden voor een POI (Nuttige plaatsen). |
|
phone |
string |
Eigenschap Telefoonnummer |
url |
string |
Website-URL-eigenschap |
PointOfInterestCategorySet
POI-categorie
Name | Type | Description |
---|---|---|
id |
integer |
Categorie-id |
QueryType
Het type query dat wordt geretourneerd: IN DE BUURT of NON_NEAR.
Name | Type | Description |
---|---|---|
NEARBY |
string |
Search is uitgevoerd rond een bepaalde breedtegraad en lengtegraad met een gedefinieerde radius |
NON_NEAR |
string |
Search is wereldwijd uitgevoerd, zonder bevooroordeeld te zijn naar een bepaalde breedte- en lengtegraad, en geen gedefinieerde radius |
Response
Het resultaat van de query. SearchAddressResult als de query is voltooid, errorresponse anders.
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
|
results |
Een lijst met Search API-resultaten. |
|
summary |
Samenvattingsobject voor een Search API-antwoord |
SearchAddressBatchItem
Een item dat is geretourneerd door Search Adres Batch-serviceaanroep.
Name | Type | Description |
---|---|---|
response |
Het resultaat van de query. SearchAddressResult als de query is voltooid, errorresponse anders. |
|
statusCode |
integer |
Statuscode van HTTP-aanvraag. |
SearchAddressBatchProcessResult
Dit object wordt geretourneerd na een geslaagde Search Adres Batch-serviceoproep.
Name | Type | Description |
---|---|---|
batchItems |
Matrix met de batchresultaten. |
|
summary |
Samenvatting van de resultaten voor de batchaanvraag |
SearchAddressResultItem
Resultaatobject voor een Search API-antwoord.
Name | Type | Description |
---|---|---|
address |
Het adres van het resultaat |
|
addressRanges |
Beschrijft het adresbereik aan beide zijden van de straat voor een zoekresultaat. Coördinaten voor de begin- en eindlocatie van het adresbereik worden opgenomen. |
|
dataSources |
Optionele sectie. Referentiegeometrie-id voor gebruik met de Get Search Polygon-API. |
|
detourTime |
integer |
Omleidingstijd in seconden. Alleen geretourneerd voor aanroepen naar de API Search Langs route. |
dist |
number |
Rechte lijnafstand tussen het resultaat en de geobias-locatie in meters. |
entityType |
Type geografie-entiteit. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is. |
|
entryPoints |
Matrix van entrypoints. Deze beschrijven de soorten ingangen die beschikbaar zijn op de locatie. Het type kan 'hoofd' zijn voor hoofdingangen zoals een voordeur, of een lobby, en 'minor' voor zij- en achterdeuren. |
|
id |
string |
Id-eigenschap |
info |
string |
Informatie over de oorspronkelijke gegevensbron van het resultaat. Wordt gebruikt voor ondersteuningsaanvragen. |
matchType |
Informatie over het type overeenkomst. Een van de volgende:
|
|
poi |
Details van de geretourneerde POI, inclusief informatie zoals de naam, telefoon, URL-adres en classificaties. |
|
position |
Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'. |
|
score |
number |
De waarde binnen een resultatenset om de relatieve overeenkomende score tussen resultaten aan te geven. U kunt dit gebruiken om te bepalen dat resultaat x twee keer zo relevant is als resultaat y als de waarde van x 2x de waarde van y is. De waarden variëren per query en zijn alleen bedoeld als een relatieve waarde voor één resultatenset. |
type |
Een van de volgende:
|
|
viewport |
De viewport die het resultaat bedekt dat wordt vertegenwoordigd door de coördinaten linksboven en rechtsonder van de viewport. |
SearchAddressResultType
Een van de volgende:
- POI
- Straat
- Geografie
- Puntadres
- Adresbereik
- Kruisstraat
Name | Type | Description |
---|---|---|
Address Range |
string |
|
Cross Street |
string |
|
Geography |
string |
|
POI |
string |
|
Point Address |
string |
|
Street |
string |
SearchSummary
Samenvattingsobject voor een Search API-antwoord.
Name | Type | Description |
---|---|---|
fuzzyLevel |
integer |
Het maximale fuzzy-niveau dat is vereist om resultaten op te geven. |
geoBias |
Indicatie wanneer de interne zoekmachine een georuimtelijke bias heeft toegepast om de rangschikking van resultaten te verbeteren. In sommige methoden kan dit worden beïnvloed door de lat- en lon-parameters in te stellen, indien beschikbaar. In andere gevallen is het puur intern. |
|
limit |
integer |
Maximum aantal antwoorden dat wordt geretourneerd |
numResults |
integer |
Het aantal resultaten in het antwoord. |
offset |
integer |
De begin offset van de geretourneerde Resultaten binnen de volledige resultatenset. |
query |
string |
De queryparameter die is gebruikt om deze zoekresultaten te produceren. |
queryTime |
integer |
Tijd die is besteed aan het oplossen van de query, in milliseconden. |
queryType |
Het type query dat wordt geretourneerd: IN DE BUURT of NON_NEAR. |
|
totalResults |
integer |
Het totale aantal gevonden resultaten. |
Summary
Samenvatting van de resultaten voor de batchaanvraag
Name | Type | Description |
---|---|---|
successfulRequests |
integer |
Aantal geslaagde aanvragen in de batch |
totalRequests |
integer |
Totaal aantal aanvragen in de batch |