Search

  • Referentie
Service:
Maps
API Version:
1.0

Operations

Get Search Address

Adres geocoderen

Van toepassing op: prijscategorie S0 en S1.

In veel gevallen is de volledige zoekservice mogelijk te veel, bijvoorbeeld als u alleen geïnteresseerd bent in traditionele geocoderen. Zoeken kan ook worden gebruikt om adressen uitsluitend op te zoeken. De geocoderen wordt uitgevoerd door het eindpunt van de geocode te raken met alleen het adres of gedeeltelijke adres in kwestie. De zoekindex voor geocoderen wordt opgevraagd voor alles boven de gegevens op straatniveau. Er worden geen POIs geretourneerd. Houd er rekening mee dat de geocoder zeer tolerant is ten opzichte van typfouten en onvolledige adressen. Ook wordt alles verwerkt, van exacte adressen of straat- of snijpunten tot geografische gebieden op een hoger niveau, zoals stadscentra, regio's, staten, enzovoort.
Get Search Address Reverse

Omgekeerde geocode naar een adres

Van toepassing op: prijscategorie S0 en S1.

Het kan voorkomen dat u een coördinaat (bijvoorbeeld 37.786505, -122.3862) moet vertalen naar een voor mensen begrijpelijk adres. Dit is meestal nodig bij het bijhouden van toepassingen waarbij u een GPS-feed van het apparaat of de asset ontvangt en wilt weten welk adres de coördinaat zich bevindt. Met dit eindpunt worden adresgegevens voor een bepaalde coördinaat retourneren.
Get Search Address Reverse Cross Street

Reverse Geocode naar een cross street

Van toepassing op: prijscategorie S0 en S1.

Het kan voorkomen dat u een coördinaat (bijvoorbeeld 37.786505, -122.3862) moet vertalen naar een voor mensen begrijpelijke cross street. Dit is meestal nodig bij het bijhouden van toepassingen waarbij u een GPS-feed van het apparaat of de asset ontvangt en wilt weten welk adres de coördinaat zich bevindt. Met dit eindpunt worden informatie over de straat voor een bepaalde coördinaat retourneren.
Get Search Address Structured

Geocoderen van gestructureerde adressen

Van toepassing op: prijscategorie S0 en S1.

Azure Address Geocoding kan ook worden gebruikt om gestructureerde adressen uitsluitend op te zoeken. De zoekindex voor geocoderen wordt opgevraagd voor alles boven de gegevens op straatniveau. Er worden geen POIs geretourneerd. Houd er rekening mee dat de geocoder zeer tolerant is ten opzichte van typfouten en onvolledige adressen. Ook wordt alles verwerkt, van exacte adressen of straat- of snijpunten tot geografische gebieden op een hoger niveau, zoals stadscentra, regio's, staten, enzovoort.
Get Search Fuzzy

Zoeken in vrije vorm

Van toepassing op: prijscategorie S0 en S1.

De standaard-API is Free Form Search, waarmee de meest fuzzy invoer wordt verwerkt voor elke combinatie van adres- of POI-tokens. Deze zoek-API is de canonieke zoekopdracht met één regel. De Free Form Search-API is een naadloze combinatie van nuttige plaatsen zoeken en geocoderen. De API kan ook worden gewogen met een contextuele positie (lat./lon. paar), of volledig beperkt door een coördinaat en radius, of het kan over het algemeen worden uitgevoerd zonder geo-biasing ankerpunt.

We raden u ten zeerste aan de parameter countrySet te gebruiken om alleen de landen op te geven waarvoor uw toepassing dekking nodig heeft, omdat het standaardgedrag is om de hele wereld te doorzoeken, waardoor mogelijk onnodige resultaten worden weergegeven.

Bijvoorbeeld: countrySet =US,FR

Zie Dekking zoeken voor een volledige lijst met alle ondersteunde landen.

De meeste Search-query's zijn maxFuzzyLevel standaard ingesteld op =2 om prestaties te verkrijgen en ongebruikelijke resultaten te verminderen. Deze nieuwe standaardwaarde kan naar behoefte per aanvraag worden overschrijven door de queryparam maxFuzzyLevel =3 of 4 door te geven.
Get Search Nearby

Zoeken in de buurt

Van toepassing op: prijscategorie S0 en S1.

Als u een use-case hebt voor het alleen ophalen van POI-resultaten rond een specifieke locatie, kan de zoekmethode in de buurt de juiste keuze zijn. Met dit eindpunt worden alleen POI-resultaten retourneren en wordt geen zoekqueryparameter gebruikt.
Get Search POI

Nuttige plaatsen op naam krijgen

Van toepassing op: prijscategorie S0 en S1.

Met Nuttige plaatsen zoeken kunt u nuttige plaatsen op naam aanvragen. Zoeken ondersteunt aanvullende queryparameters, zoals taal en filterresultaten op interessegebied, op basis van land of begrensingsvak. Met het eindpunt worden alleen POI-resultaten retourneren die overeenkomen met de queryreeks. Het antwoord bevat NUTTIGEPLAATSgegevens, zoals adres, coördinaatlocatie en categorie.
Get Search POI Category

Nuttige plaatsen per categorie krijgen

Van toepassing op: prijscategorie S0 en S1.

Met Nuttige plaatsen (POI) Category Search kunt u POI-resultaten van de opgegeven categorie aanvragen. Met Zoeken kunt u query's uitvoeren op IO's van één categorie tegelijk. Eindpunt retourneert alleen POI-resultaten die zijn gecategoriseerd zoals opgegeven. De respons bevat nuttige plaatsen, zoals adres, coördinaatlocatie en classificatie.
Get Search POI Category Tree Preview

Categoriestructuur voor nuttige plaatsen krijgen

Van toepassing op: prijscategorie S0 en S1.

Poi Category API biedt een volledige lijst met ondersteunde POI-categorieën (Points of Interest) en subcategorieën, samen met hun vertalingen en synoniemen. De geretourneerde inhoud kan worden gebruikt om zinvollere resultaten te bieden via andere Search Service-API's, zoals Get Search POI.
Get Search Polygon

Veelhoek krijgen

Van toepassing op: Prijscategorie S1.

Met de get Polygon-service kunt u de geometriegegevens aanvragen, zoals een plaats- of landoverzicht voor een set entiteiten, die eerder zijn opgehaald uit een Onlinezoekaanvraag in GeoJSON-indeling. De geometrie-id wordt geretourneerd in het object dataSources onder 'geometrie' en 'id' in een zoekadres of fuzzy aanroep zoeken.

Houd er rekening mee dat elke geometrie-id die wordt opgehaald van een onlinezoekpunt een beperkte levensduur heeft. De client mag geometrie-id's niet opslaan in permanente opslag voor latere verwijzing, omdat de stabiliteit van deze id's lange tijd niet wordt gegarandeerd. Naar verwachting wordt binnen enkele minuten na de aanvraag bij de onlinezoekmethode die de id heeft opgegeven, een aanvraag naar de methode Polygon gedaan. De service staat batchaanvragen toe tot 20 id's.
Post Search Address Batch

Batch-API voor zoekadressen

Van toepassing op: Prijscategorie S1.

De Batch-API voor zoekadressen verzendt batches met query's naar de Api voor zoekadressen met slechts één API-aanroep. U kunt batch-API voor zoekadressen aanroepen om asynchroon (asynchroon) of synchroon (synchroniseren) uit te voeren. Met de asynchrone API kan de aanroeper maximaal 10.000 query's batchen en api's synchroniseren tot maximaal 100 query's.

Synchrone Batch-aanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batchitems zijn berekend en is het niet mogelijk om de resultaten later op te halen. De synchrone API retourneren een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batchitems is beperkt tot 100 voor deze API.

POST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Asynchrone Batch-aanvraag verzenden

De asynchrone API is geschikt voor het verwerken van grote hoeveelheden 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 niet verwacht dat er een time-out is.
  • Het aantal batchitems is beperkt tot 10.000 voor deze API.

Wanneer u een aanvraag indient met behulp van een async-aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. De asynchrone antwoorden worden 14 dagen opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.

Houd er rekening mee dat asynchrone batchaanvraag een langlopende aanvraag is. Hier is een typische reeks bewerkingen:

  1. Client verzendt een Batch-aanvraag voor POST het zoekadres naar Azure Kaarten

  2. 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 een of 400 Bad Request een andere Error statuscode zijn.

  3. Als de batchaanvraag is geaccepteerd, bevat de header in het antwoord de URL om de resultaten van de Location batchaanvraag te downloaden. Deze status-URI ziet er als volgt uit:

    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Client geeft een GET aanvraag uit op de download-URL die is verkregen in stap 3 om de batchresultaten te downloaden.

POST-body voor Batch-aanvraag

Als u de zoekadresquery's wilt verzenden, gebruikt u een aanvraag waarbij de aanvraagtekst de matrix in indeling bevat en de POST header wordt ingesteld op batchItems json Content-Type application/json . Hier is een voorbeeld van een aanvraag met 5 zoekadresquery's:

{
    "batchItems": [
        {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"},
        {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"},
        {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"},
        {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"},
        {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"}
    ]
}

Een zoekadresquery in een batch is slechts een gedeeltelijke URL zonder het protocol, de basis-URL, het pad, de API-versie en de abonnementssleutel. De URI-parametersvoor ondersteunde zoekadressen kunnen worden geaccepteerd. De tekenreekswaarden in de zoekadresquery moeten een escape-teken hebben (bijvoorbeeld ' teken moet worden gese escapet met ) en moet ook correct \ url-gecodeerd zijn.

Met de asynchrone API kan de aanroeper maximaal 10.000 query's batchen en api's synchroniseren tot maximaal 100 query's. De batch moet ten minste één query bevatten.

Asynchrone batchresultaten downloaden

Als u de asynsync-batchresultaten wilt downloaden, moet u een GET aanvraag indienen bij het batch-download-eindpunt. Deze download-URL kan worden verkregen via de header van een geslaagde batchaanvraag en Location ziet er als volgt POST uit:

https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Hier is de typische volgorde van bewerkingen voor het downloaden van de batchresultaten:

  1. Client verzendt een GET aanvraag met behulp van de download-URL.

  2. De server reageert met een van de volgende opties:

    HTTP: 202 Accepted Batch-aanvraag is geaccepteerd, maar wordt nog verwerkt. Probeer het over enige tijd opnieuw.

    HTTP: 200 OK Batch-aanvraag is verwerkt. De antwoord-body bevat alle batchresultaten.

Batch-responsmodel

De geretourneerde gegevensinhoud is vergelijkbaar voor asynchrone en synchronisatieaanvragen. Wanneer u de resultaten van een asynsync batchaanvraag downloadt en de batch is verwerkt, bevat de antwoord-body het batch-antwoord. Deze batchreactie bevat een onderdeel dat aangeeft dat deel uitmaakte van de oorspronkelijke batchaanvraag en dat wil zeggen query's summary die met succes zijn totalRequests successfulRequests uitgevoerd. Het batch-antwoord 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 zijn verzonden in de batchaanvraag. Elk item in batchItems bevat de velden en statusCode response . Elke response in heeft een van de volgende batchItems typen:

  • SearchAddressResponse - Als de query is voltooid.

  • Error - Als de query is mislukt. Het antwoord bevat in code dit geval een en een message .

Hier is een batch-voorbeeldreactie met 2 geslaagd en 1 mislukt resultaat:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "one microsoft way redmond wa 98052"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.63989,
                            "lon": -122.12509
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "pike pl seattle wa 98101"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.60963,
                            "lon": -122.34215
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
Post Search Address Reverse Batch

Search Address Reverse Batch API

Van toepassing op: Prijscategorie S1.

De Batch-API voor zoekadressen verzendt batches met query's naar De omgekeerde API voor zoekadressen met slechts één API-aanroep. U kunt de Search Address Reverse Batch-API aanroepen om asynchroon (asynchroon) of synchroon (synchronisatie) uit te voeren. Met de asynchrone API kan de aanroeper maximaal 10.000 query's batchen en api's synchroniseren tot maximaal 100 query's.

Synchrone Batch-aanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batchitems zijn berekend en is het niet mogelijk om de resultaten later op te halen. De synchrone API retourneren een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batchitems is beperkt tot 100 voor deze API.

POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Asynchrone Batch-aanvraag verzenden

De asynchrone API is geschikt voor het verwerken van grote hoeveelheden 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 niet verwacht dat er een time-out is.
  • Het aantal batchitems is beperkt tot 10.000 voor deze API.

Wanneer u een aanvraag indient met behulp van een async-aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. De asynchrone antwoorden worden 14 dagen opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.

Houd er rekening mee dat asynchrone batchaanvraag een langlopende aanvraag is. Hier is een typische reeks bewerkingen:

  1. Client verzendt een Batch-aanvraag voor het POST zoekadres naar Azure Kaarten

  2. 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 een of 400 Bad Request een andere Error statuscode zijn.

  3. Als de batchaanvraag is geaccepteerd, bevat de header in het antwoord de URL om de resultaten van de Location batchaanvraag te downloaden. Deze status-URI ziet er als volgt uit:

    GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Client geeft een GET aanvraag uit op de download-URL die is verkregen in stap 3 om de batchresultaten te downloaden.

POST-body voor Batch-aanvraag

Als u de omgekeerde query's voor het zoekadres wilt verzenden, gebruikt u een aanvraag waarbij de aanvraagtekst de matrix in indeling bevat en POST de header wordt ingesteld op batchItems json Content-Type application/json . Hier is een voorbeeld van een aanvraag body met 5 zoekadres omgekeerde query's:

{
    "batchItems": [
        {"query": "?query=48.858561,2.294911"},
        {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
        {"query": "?query=47.621028,-122.348170"},
        {"query": "?query=43.722990,10.396695"},
        {"query": "?query=40.750958,-73.982336"}
    ]
}

Een omgekeerde query voor een zoekadres in een batch is slechts een gedeeltelijke URL zonder het protocol, de basis-URL, het pad, de API-versie en de abonnementssleutel. Het kan een van de ondersteunde reverse URI-parametersvoor zoekadressen accepteren. De tekenreekswaarden in de omgekeerde query van het zoekadres moeten een escape-teken hebben (bijvoorbeeld ' teken moet worden gese escapet met ) en moet ook correct \ url-gecodeerd zijn.

Met de asynchrone API kan de aanroeper maximaal 10.000 query's batchen en api's synchroniseren tot maximaal 100 query's. De batch moet ten minste één query bevatten.

Asynchrone batchresultaten downloaden

Als u de asynsync-batchresultaten wilt downloaden, moet u een GET aanvraag indienen bij het batch-download-eindpunt. Deze download-URL kan worden verkregen via de header van een geslaagde batchaanvraag en Location ziet er als volgt POST uit:

https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Hier is de typische volgorde van bewerkingen voor het downloaden van de batchresultaten:

  1. Client verzendt een GET aanvraag met behulp van de download-URL.

  2. De server reageert met een van de volgende opties:

    HTTP: 202 Accepted Batch-aanvraag is geaccepteerd, maar wordt nog verwerkt. Probeer het over enige tijd opnieuw.

    HTTP: 200 OK Batch-aanvraag is verwerkt. De antwoord-body bevat alle batchresultaten.

Batch-responsmodel

De geretourneerde gegevensinhoud is vergelijkbaar voor asynchrone en synchronisatieaanvragen. Wanneer u de resultaten van een asynsync batchaanvraag downloadt en de batch is verwerkt, bevat de antwoord-body het batch-antwoord. Deze batchreactie bevat een onderdeel dat aangeeft dat deel uitmaakte van de oorspronkelijke batchaanvraag en dat wil zeggen query's summary die met succes zijn totalRequests successfulRequests uitgevoerd. Het batch-antwoord 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 zijn verzonden in de batchaanvraag. Elk item in batchItems bevat de velden en statusCode response . Elke response in heeft een van de volgende batchItems typen:

  • SearchAddressReverseResponse - Als de query is voltooid.

  • Error - Als de query is mislukt. Het antwoord bevat in code dit geval een en een message .

Hier is een batch-voorbeeldreactie met 2 geslaagd en 1 mislukt resultaat:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 11
                },
                "addresses": [
                    {
                        "address": {
                            "country": "France",
                            "freeformAddress": "Avenue Anatole France, 75007 Paris"
                        },
                        "position": "48.858490,2.294820"
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 1
                },
                "addresses": [
                    {
                        "address": {
                            "country": "United States of America",
                            "freeformAddress": "157th Pl NE, Redmond WA 98052"
                        },
                        "position": "47.640470,-122.129430"
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
Post Search Along Route

Van toepassing op: prijscategorie S0 en S1.

Met het eindpunt Zoeken langs route kunt u fuzzy zoeken naar IDE's langs een opgegeven route. Deze zoekopdracht wordt beperkt door de beperkende maxDetourTime meting op te geven.

Als u de routepunten wilt verzenden, gebruikt u een aanvraag waarbij de aanvraagtekst het object bevat dat wordt weergegeven als een type en POST de header wordt ingesteld op route GeoJSON LineString Content-Type application/json . Elk routepunt in wordt weergegeven als een type, dat wil zeggen een matrix waarin de lengtegraadwaarde wordt gevolgd door de breedtegraadwaarde en de route GeoJSON Position hoogtewaarde wordt genegeerd. De route moet ten minste twee routepunten bevatten.

Het is mogelijk dat de oorspronkelijke route wordt gewijzigd. Sommige punten kunnen worden overgeslagen. Als de route die het gevonden punt passeert sneller is dan de oorspronkelijke route, is de detourTime waarde in het antwoord negatief.
Post Search Fuzzy Batch

Fuzzy Batch-API zoeken

Van toepassing op: Prijscategorie S1.

De Batch-API voor zoekadressen verzendt batches met query's naar De fuzzy API doorzoeken met slechts één API-aanroep. U kunt fuzzy Batch-API voor zoekadressen aanroepen om asynchroon (asynchroon) of synchroon (synchroniseren) uit te voeren. Met de asynchrone API kan de aanroeper maximaal 10.000 query's batchen en api's synchroniseren tot maximaal 100 query's.

Synchrone Batch-aanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batchitems zijn berekend en is het niet mogelijk om de resultaten later op te halen. De synchrone API retourneren een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batchitems 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 Batch-aanvraag verzenden

De asynchrone API is geschikt voor het verwerken van grote hoeveelheden 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 niet verwacht dat er een time-out is.
  • Het aantal batchitems is beperkt tot 10.000 voor deze API.

Wanneer u een aanvraag indient met behulp van een async-aanvraag, retourneert de service standaard een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet periodiek worden gecontroleerd totdat de antwoordgegevens of foutgegevens beschikbaar zijn. De asynchrone antwoorden worden 14 dagen opgeslagen. De omleidings-URL retourneert een 404-antwoord als deze wordt gebruikt na de verloopperiode.

Houd er rekening mee dat asynchrone batchaanvraag een langlopende aanvraag is. Hier is een typische reeks bewerkingen:

  1. Client verzendt een Batch-aanvraag voor POST het zoekadres naar Azure Kaarten

  2. 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 een of 400 Bad Request een andere Error statuscode zijn.

  3. Als de batchaanvraag is geaccepteerd, bevat de header in het antwoord de URL om de resultaten van de Location batchaanvraag te downloaden. 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}
  1. Client geeft een GET aanvraag uit op de download-URL die is verkregen in stap 3 om de batchresultaten te downloaden.

POST-body voor Batch-aanvraag

Als u de fuzzy zoekquery's wilt verzenden, gebruikt u een aanvraag waarin de aanvraagtekst de matrix in indeling bevat en de POST header wordt ingesteld op batchItems json Content-Type application/json . Hier is een voorbeeld van een aanvraag met 5 fuzzy zoekquery's:

{
    "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. Alle ondersteunde fuzzy URI-parametersvoor zoeken kunnen worden geaccepteerd. De tekenreekswaarden in de fuzzy zoekquery moeten een goede escape-teken krijgen (bijvoorbeeld ' teken moet worden gesluisd met ) en moet ook correct \ url-gecodeerd zijn.

Met de asynchrone API kan de aanroeper maximaal 10.000 query's batchen en api's synchroniseren tot maximaal 100 query's. De batch moet ten minste één query bevatten.

Asynchrone batchresultaten downloaden

Als u de asynsync-batchresultaten wilt downloaden, moet u een GET aanvraag indienen bij het batch-download-eindpunt. Deze download-URL kan worden verkregen via de header van een geslaagde batchaanvraag en Location ziet er als volgt POST uit:

https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Hier is de typische volgorde van bewerkingen voor het downloaden van de batchresultaten:

  1. Client verzendt een GET aanvraag met behulp van de download-URL.

  2. De server reageert met een van de volgende opties:

    HTTP: 202 Accepted Batch-aanvraag is geaccepteerd, maar wordt nog verwerkt. Probeer het over enige tijd opnieuw.

    HTTP: 200 OK Batch-aanvraag is verwerkt. De antwoord-body bevat alle batchresultaten.

Batch-responsmodel

De geretourneerde gegevensinhoud is vergelijkbaar voor asynchrone en synchronisatieaanvragen. Wanneer u de resultaten van een asynsync batchaanvraag downloadt en de batch is verwerkt, bevat de antwoord-body het batch-antwoord. Deze batchreactie bevat een onderdeel dat aangeeft dat deel uitmaakte van de oorspronkelijke batchaanvraag en dat wil zeggen query's summary die met succes zijn totalRequests successfulRequests uitgevoerd. Het batch-antwoord 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 zijn verzonden in de batchaanvraag. Elk item in batchItems bevat de velden en statusCode response . Elke response in heeft een van de volgende batchItems typen:

  • SearchFuzzyResponse - Als de query is voltooid.

  • Error - Als de query is mislukt. Het antwoord bevat in code dit geval een en een message .

Hier is een batch-voorbeeldreactie met 2 geslaagd en 1 mislukt resultaat:

{
    "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 Search Inside Geometry

Van toepassing op: prijscategorie S0 en S1.

Met het eindpunt Zoekgeometrie kunt u een zoekopdracht in vrije vorm uitvoeren binnen één geometrie of veel van deze. De zoekresultaten die binnen de geometrie/geometrieën vallen, worden geretourneerd.

Als u de geometrie wilt verzenden, gebruikt u een aanvraag waarbij de aanvraagtekst het object bevat dat wordt weergegeven als een type en de POST header wordt ingesteld op geometry GeoJSON Content-Type application/json . De geografische kenmerken die moeten worden doorzocht, kunnen worden gemodelleerd als polygoon- en/of cirkelgeometrische elementen met behulp van een van de volgende GeoJSON typen:

  • GeoJSON FeatureCollection
    De geometry kan worden weergegeven als een GeoJSON FeatureCollection -object. Dit is de aanbevolen optie als de geometrie zowel Veelhoeken als Cirkels bevat. De FeatureCollection mag maximaal 50 objecten GeoJSON Feature bevatten. Elk Feature object moet een veelhoek of een cirkel met de volgende voorwaarden vertegenwoordigen:
    • Een Feature object voor de polygoongeometrie kan maximaal 50 coördinaten hebben en de eigenschappen ervan moeten leeg zijn.
    • Een object voor de cirkelgeometrie bestaat uit een midden dat wordt weergegeven met behulp van een type en een Feature GeoJSON Point radiuswaarde (in meters) die moet worden opgegeven in de eigenschappen van het object, samen met de eigenschap subType waarvan de waarde Cirkel moet zijn.

    Zie de sectie Voorbeelden hieronder voor een FeatureCollection voorbeeldweergave.

  • GeoJSON GeometryCollection
    De geometry kan worden weergegeven als een GeoJSON GeometryCollection -object. Dit is de aanbevolen optie als de geometrie alleen een lijst met veelhoeken bevat. De GeometryCollection mag maximaal 50 objecten GeoJSON Polygon bevatten. Elk Polygon object kan maximaal 50 coördinaten hebben. Zie de sectie Voorbeelden hieronder voor een GeometryCollection voorbeeldweergave.

  • GeoJSON Polygon
    De geometry kan worden weergegeven als een GeoJSON Polygon -object. Dit is de aanbevolen optie als de geometrie één veelhoek bevat. Het Polygon object kan maximaal 50 coördinaten hebben. Zie de sectie Voorbeelden hieronder voor een Polygon voorbeeldweergave.

.