Search

  • Referens
Service:
Maps
API Version:
1.0

Operations

Get Search Address

Hantera geokodning

Gäller för prisnivåerna : S0 och S1.

I många fall kan den fullständiga söktjänsten vara för mycket, till exempel om du bara är intresserad av traditionell geokodning. Du kan även söka efter adresssökning exklusivt. Geokodningen utförs genom att nå geokodningsslutpunkten med bara adressen eller den partiella adressen i fråga. Sökindexet för geokodning efterfrågas efter allt över data på gatunivå. Inga IO:er returneras. Observera att geokodaren är mycket tolerant för skrivfel och ofullständiga adresser. Den hanterar också allt från exakta gatuadresser eller gatuadresser eller vägkorsningar samt geografiska områden på högre nivå, till exempel stadscentraler, greviteter, delstater osv.
Get Search Address Reverse

Omvänd geokodning till en adress

Gäller för prisnivåerna : S0 och S1.

Det kan finnas tillfällen när du behöver översätta en koordinat (exempel: 37,786505, -122.3862) till en gatuadress som människor förstår. Oftast behövs detta i spårningsprogram där du får ett GPS-flöde från enheten eller tillgången och vill veta vilken adress där koordinaten finns. Den här slutpunkten returnerar adressinformation för en viss koordinat.
Get Search Address Reverse Cross Street

Omvänd geokodning till en cross street

Gäller för prisnivåerna : S0 och S1.

Det kan finnas tillfällen när du behöver översätta en koordinat (exempel: 37,786505, -122.3862) till en mänsklig begriplig kors gata. Oftast behövs detta i spårningsprogram där du får ett GPS-flöde från enheten eller tillgången och vill veta vilken adress där koordinaten finns. Den här slutpunkten returnerar information om gatukorsning för en viss koordinat.
Get Search Address Structured

Strukturerade adressgeokodning

Gäller för prisnivåerna : S0 och S1.

Geokodning av Azure-adresser kan också användas för strukturerad adressurrering exklusivt. Sökindexet för geokodning efterfrågas efter allt över data på gatunivå. Inga IO:er returneras. Observera att geokodaren är mycket tolerant mot skrivfel och ofullständiga adresser. Den hanterar också allt från exakta gatuadresser eller gatuadresser eller vägkorsningar samt geografiska områden på högre nivå, till exempel stadscentraler, greviteter, delstater osv.
Get Search Fuzzy

Sökning i fritt formulär

Gäller för prisnivåerna : S0 och S1.

Det grundläggande standard-API:et är Free Form Search som hanterar den mest otydliga indatahanteringen av alla kombinationer av adress- eller POI-token. Det här sök-API:et är den kanoniska "enkelradssökningen". API:et för kostnadsfri formulärsökning är en sömlös kombination av POI-sökning och geokodning. API:et kan också viktas med en sammanhangsberoende position (lat./lon. par), eller helt begränsad av en koordinat och radie, eller så kan den köras mer allmänt utan någon geo-biasande fästpunkt.

Vi rekommenderar starkt att du använder parametern "countrySet" för att endast ange de länder som ditt program behöver täckning för, eftersom standardbeteendet är att söka i hela världen, vilket potentiellt returnerar onödiga resultat.

T.ex.: countrySet =US,FR

En fullständig lista över alla länder som stöds finns i Sök täckning.

De flesta sökfrågor har som maxFuzzyLevel standard =2 för att få bättre prestanda och även minska ovanliga resultat. Den nya standardinställningen kan åsidosättas efter behov per begäran genom att skicka frågeparamen maxFuzzyLevel =3 eller 4.
Get Search Nearby

Sökning i närheten

Gäller för prisnivåerna : S0 och S1.

Om du har ett användningsfall för att endast hämta POI-resultat runt en viss plats kan sökmetoden i närheten vara det rätta valet. Den här slutpunkten returnerar endast POI-resultat och tar inte med en sökfrågeparameter.
Get Search POI

Hämta POI efter namn

Gäller för prisnivåerna : S0 och S1.

Med sökning efter platser av intresse (POI) kan du begära POI-resultat efter namn. Sökningen stöder ytterligare frågeparametrar, till exempel språk och filtrering av resultat efter intresseområde som styrs av land eller begränsningsruta. Slutpunkten returnerar endast POI-resultat som matchar frågesträngen. Svaret innehåller POI-information som adress, koordinatplats och kategori.
Get Search POI Category

Hämta POI efter kategori

Gäller för prisnivåerna : S0 och S1.

Med kategorisökning efter platser av intresse (POI) kan du begära POI-resultat från en viss kategori. Med sökning kan du fråga IIS från en kategori i taget. Slutpunkten returnerar endast POI-resultat som kategoriseras som angivna. Svaret innehåller POI-information som adress, koordinatplats och klassificering.
Get Search POI Category Tree Preview

Hämta POI-kategoriträd

Gäller för prisnivåerna : S0 och S1.

API:et för POI-kategorin innehåller en fullständig lista över kategorier och underkategorier av intressepunkter som stöds tillsammans med deras översättningar och synonymer. Det returnerade innehållet kan användas för att ge mer meningsfulla resultat via andra Search Service-API:er, t.ex. Get Search POI.
Get Search Polygon

Hämta Polygon

Gäller för: prisnivån S1.

Med tjänsten Hämta Polygon kan du begära geometridata, till exempel en ort eller en landskontur för en uppsättning entiteter, som tidigare hämtats från en onlinesökningsbegäran i GeoJSON-format. Geometri-ID:t returneras i objektet dataSources under "geometry" och "id" i antingen ett sökadress- eller Search Fuzzy-anrop.

Observera att alla geometri-ID:n som hämtas från en slutpunkt för onlinesökning har en begränsad livslängd. Klienten bör inte lagra geometri-ID:t i beständig lagring för senare hänvisning, eftersom stabiliteten för dessa identifierare inte garanteras under en längre tid. En begäran till Polygon-metoden förväntas göras inom några minuter från begäran till onlinesökningsmetoden som angav ID:t. Tjänsten tillåter batchbegäranden med upp till 20 identifierare.
Post Search Address Batch

Sök efter batch-API:et för adresser

Gäller för: prisnivån S1.

API:et Search Address Batch skickar batchar med frågor till API:et search address med bara ett enda API-anrop. Du kan anropa Search Address Batch API för att antingen köra asynkront (asynkront) eller synkront (synkronisera). Med det asynkrona API:et 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 lätta batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det inte går att hämta resultatet senare. Det synkrona API:et returnerar ett tidsgränsfel (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/address/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 med relativt komplexa sökbegäranden

  • Det gör att resultat kan hämtas i ett separat anrop (flera hämtningar är möjliga).
  • Det asynkrona API:et är optimerat för tillförlitlighet och förväntas inte få någon tidsgräns.
  • 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 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 asynkron batchbegäran är en långvarig begäran. Här är en typisk sekvens med åtgärder:

  1. Klienten skickar en Search Address POST Batch-begäran till Azure Kartor

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Batch-begäran har godkänts.

    HTTP Error – Ett fel uppstod vid bearbetningen av Batch-begäran. Detta kan antingen vara 400 Bad Request en eller någon annan Error statuskod.

  3. Om batchbegäran godkändes innehåller huvudet i svaret URL:en för Location att ladda ned resultatet av batchbegäran. Den här status-URI:en ser ut så här:

    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Klienten skickar en GET begäran om nedladdnings-URL:en som hämtades i steg 3 för att ladda ned batchresultaten.

POST-brödtext för Batch-begäran

Om du vill skicka sökadressfrågor använder du en begäran där begärandetexten innehåller matrisen i format och huvudet anges POST till batchItems json Content-Type application/json . Här är ett exempel på en begärandetext som innehåller 5 sökadressfrågor:

{
    "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"}
    ]
}

En sökadressfråga i en batch är bara en partiell URL utan protokoll, bas-URL, sökväg, API-version och prenumerationsnyckel. Den kan acceptera alla sökadress-URI-parametrar som stöds. Strängvärdena i sökadressfrågan måste vara korrekt rymda (t.ex. " tecknet ska vara rymt med ) och det bör också vara \ korrekt URL-kodat.

Med det asynkrona API:et kan anroparen batcha upp till 10 000 frågor och synkronisera API:er med upp till 100 frågor, och batchen ska innehålla minst 1 fråga.

Ladda ned asynkrona batchresultat

Om du vill ladda ned asynkrona batchresultat utfärdar du GET en begäran till batchnedladdningsslutpunkten. Den här nedladdnings-URL:en kan hämtas Location från rubriken för en lyckad POST batchbegäran och ser ut så här:

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

Här är den typiska sekvensen med åtgärder för att ladda ned batchresultatet:

  1. Klienten skickar en begäran GET med hjälp av nedladdnings-URL:en.

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Batch-begäran godkändes 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 asynkrona begäranden och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran innehåller svarstexten batchsvaret om batchen har bearbetats klart. Det här batchsvaret innehåller en komponent som anger att var en del av den ursprungliga batchbegäran och det vill säga frågor summary totalRequests som har successfulRequests körts korrekt. Batchsvaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItemsinnehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode fälten och response . Varje response in är av någon av följande batchItems typer:

  • SearchAddressResponse – Om frågan har slutförts.

  • Error – Om frågan misslyckades. Svaret innehåller en och code en i det här message fallet.

Här är ett Batch-exempelsvar med 2 lyckade och 1 misslyckade resultat:

{
    "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

API för omvänd batchsökningsadress

Gäller för prisnivån : S1.

Batch-API:et Search Address skickar batchar med frågor till Search Address Reverse API med bara ett enda API-anrop. Du kan anropa API:et Search Address Reverse Batch för att antingen köra asynkront (asynkront) eller synkront (synkronisera). Med det asynkrona API:et kan anroparen batcha upp till 10 000 frågor och synkronisera API:et med upp till 100 frågor.

Skicka synkron batchbegäran

Det synkrona API:et rekommenderas för lätta batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det inte går att hämta resultatet 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/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Skicka en asynkron Batch-begäran

Det asynkrona API:et är lämpligt för bearbetning av stora volymer med relativt komplexa sökbegäranden

  • Det gör det möjligt att hämta resultat i ett separat anrop (flera hämtningar är möjliga).
  • Det asynkrona API:et är optimerat för tillförlitlighet och förväntas inte få någon tidsgräns.
  • 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 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 utgångsperioden.

Observera att asynkron batchbegäran är en långvarig begäran. Här är en typisk sekvens med åtgärder:

  1. Klienten skickar en Batch-begäran om POST sökadress till Azure Kartor

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Batch-begäran har accepterats.

    HTTP Error – Det uppstod ett fel när batchbegäran skulle bearbetas. Detta kan antingen vara 400 Bad Request en eller någon annan Error statuskod.

  3. Om batchbegäran godkändes innehåller huvudet Location i svaret URL:en för att ladda ned resultatet av batchbegäran. Den här status-URI:en ser ut så här:

    GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Klienten skickar en begäran GET om nedladdnings-URL:en som hämtades i steg 3 för att ladda ned batchresultatet.

POST-brödtext för Batch-begäran

Om du vill skicka omvända sökadressfrågor använder du en begäran där begärandetexten innehåller matrisen i format och rubriken anges POST batchItems till json Content-Type application/json . Här är ett exempel på en begärandetext som innehåller 5 omvända sökadressfrågor:

{
    "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"}
    ]
}

En omvänd sökadressfråga i en batch är bara en partiell URL utan protokoll, bas-URL, sökväg, API-version och prenumerationsnyckel. Den kan acceptera någon av de omvända URI-parametrarna för sökadresser som stöds. Strängvärdena i den omvända sökadressfrågan måste vara korrekt rymda (t.ex. " tecknet ska vara rymt med ) och det bör också vara \ korrekt URL-kodat.

Med det asynkrona API:et kan anroparen batcha upp till 10 000 frågor och synkronisera API:er med upp till 100 frågor, och batchen ska innehålla minst 1 fråga.

Ladda ned asynkrona batchresultat

Om du vill ladda ned asynkrona batchresultat utfärdar du GET en begäran till batchnedladdningsslutpunkten. Den här nedladdnings-URL:en kan hämtas Location från rubriken för en lyckad POST batchbegäran och ser ut så här:

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

Här är den typiska sekvensen med åtgärder för att ladda ned batchresultatet:

  1. Klienten skickar en begäran GET med hjälp av nedladdnings-URL:en.

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Batch-begäran godkändes 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 asynkrona begäranden och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran innehåller svarstexten batchsvaret om batchen har bearbetats klart. Det här batchsvaret innehåller en komponent som anger att var en del av den ursprungliga batchbegäran och det vill säga frågor summary totalRequests som har successfulRequests körts korrekt. Batchsvaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItemsinnehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode fälten och response . Varje response in är av någon av följande batchItems typer:

  • SearchAddressReverseResponse – Om frågan har slutförts.

  • Error – Om frågan misslyckades. Svaret innehåller en och code en i det här message fallet.

Här är ett Batch-exempelsvar med 2 lyckade och 1 misslyckade resultat:

{
    "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

Gäller för prisnivåerna : S0 och S1.

Med slutpunkten Sök längs vägen kan du utföra en fuzzy-sökning efter POIs längs en angiven väg. Den här sökningen begränsas genom att ange det maxDetourTime begränsande måttet.

För att skicka vägpunkterna använder du en begäran där begärandetexten innehåller objektet som representeras som en typ och rubriken anges POST route till GeoJSON LineString Content-Type application/json . Varje vägpunkt i representeras som en typ, dvs. en matris där longitudvärdet följs av latitudvärdet och route GeoJSON Position höjdvärdet ignoreras. routebör innehålla minst 2 vägpunkter.

Det är möjligt att den ursprungliga vägen ändras, men vissa punkter kan hoppas över. Om den väg som passerar genom den hittade punkten är snabbare än den ursprungliga, detourTime är värdet i svaret negativt.
Post Search Fuzzy Batch

Sök fuzzy Batch API

Gäller för prisnivån : S1.

Batch-API:et Search Address skickar batchar med frågor till Search Fuzzy API med bara ett enda API-anrop. Du kan anropa Search Address Fuzzy Batch API för att antingen köra asynkront (asynkront) eller synkront (synkronisera). Med det asynkrona API:et kan anroparen batcha upp till 10 000 frågor och synkronisera API:et med upp till 100 frågor.

Skicka synkron batchbegäran

Det synkrona API:et rekommenderas för lätta batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det inte går att hämta resultatet senare. Det synkrona API:et returnerar ett tidsgränsfel (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 med relativt komplexa sökbegäranden

  • Det gör att resultat kan hämtas i ett separat anrop (flera hämtningar är möjliga).
  • Det asynkrona API:et är optimerat för tillförlitlighet och förväntas inte få någon tidsgräns.
  • 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 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 asynkron batchbegäran är en långvarig begäran. Här är en typisk sekvens med åtgärder:

  1. Klienten skickar en Search Address POST Batch-begäran till Azure Kartor

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Batch-begäran har godkänts.

    HTTP Error – Ett fel uppstod vid bearbetningen av Batch-begäran. Detta kan antingen vara 400 Bad Request en eller någon annan Error statuskod.

  3. Om batchbegäran godkändes innehåller huvudet i svaret URL:en för Location att ladda ned resultatet av batchbegäran. Den här status-URI:en ser ut så här:

    GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Klienten skickar en GET begäran om nedladdnings-URL:en som hämtades i steg 3 för att ladda ned batchresultaten.

POST-brödtext för Batch-begäran

Om du vill skicka fuzzy-sökningar använder du en begäran där begärandetexten innehåller matrisen i format och rubriken POST anges till batchItems json Content-Type 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ökning i en batch är bara en partiell URL utan protokoll, bas-URL, sökväg, API-version och prenumerationsnyckel. Den kan acceptera alla fuzzy-URI-parametrar för sökning som stöds. Strängvärdena i fuzzy-sökfrågan måste vara korrekt rymda (t.ex. " tecknet ska vara rymt med ) och det bör också vara \ korrekt URL-kodat.

Med det asynkrona API:et kan anroparen batcha upp till 10 000 frågor och synkronisera API:et med upp till 100 frågor, och batchen ska innehålla minst 1 fråga.

Ladda ned asynkrona batchresultat

Om du vill ladda ned asynkrona batchresultat utfärdar du GET en begäran till batchnedladdningsslutpunkten. Den här nedladdnings-URL:en kan Location hämtas från rubriken för 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 sekvensen med åtgärder för att ladda ned batchresultatet:

  1. Klienten skickar en begäran GET med hjälp av nedladdnings-URL:en.

  2. Servern svarar med något av följande:

    HTTP 202 Accepted – Batch-begäran godkändes 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 asynkrona och synkroniserade begäranden. När du laddar ned resultatet av en asynkron batchbegäran innehåller svarstexten batchsvaret om batchen har slutfört bearbetningen. Det här batchsvaret innehåller en komponent som anger att var en del av den ursprungliga batchbegäran och det vill säga frågor summary totalRequests som har successfulRequests körts korrekt. Batchsvaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItemsinnehåller resultaten i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode fälten och response . Varje response i är av någon av följande batchItems typer:

  • SearchFuzzyResponse – Om frågan har slutförts.

  • Error – Om frågan misslyckades. Svaret innehåller en och code en i det här message fallet.

Här är ett Batch-exempelsvar 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 Search Inside Geometry

Gäller för prisnivåerna : S0 och S1.

Med slutpunkten Sökgeometri kan du utföra en kostnadsfri formulärsökning i en enda geometri eller flera av dem. Sökresultaten som hamnar i geometrin/geometrierna returneras.

För att skicka geometrin använder du en begäran där begärandetexten innehåller objektet som representeras som en typ och huvudet anges POST geometry till GeoJSON Content-Type application/json . De geografiska funktioner som ska genomsökas kan modelleras som Polygon- och/eller Cirkelgeometrier som representeras med någon av följande GeoJSON typer:

  • GeoJSON FeatureCollection
    kan geometry representeras som ett GeoJSON FeatureCollection -objekt. Det här är det rekommenderade alternativet om geometrin innehåller både Polygoner och Cirklar. FeatureCollectionkan innehålla högst 50 GeoJSON Feature objekt. Varje Feature objekt ska representera antingen en Polygon eller en cirkel med följande villkor:
    • Ett Feature objekt för Polygongeometri kan ha högst 50 koordinater och dess egenskaper måste vara tomma.
    • Ett objekt för cirkelgeometrin består av ett center som representeras med hjälp av en typ och ett radievärde (i meter) som måste anges i objektets egenskaper tillsammans med egenskapen subType vars värde ska vara Feature GeoJSON Point "Cirkel".

    En exempelrepresentation finns i avsnittet FeatureCollection Exempel nedan.

  • GeoJSON GeometryCollection
    kan geometry representeras som ett GeoJSON GeometryCollection -objekt. Det här är det rekommenderade alternativet om geometrin endast innehåller en lista över Polygoner. GeometryCollectionkan innehålla högst 50 GeoJSON Polygon objekt. Varje Polygon objekt kan ha högst 50 koordinater. En exempelrepresentation finns i avsnittet GeometryCollection Exempel nedan.

  • GeoJSON Polygon
    kan geometry representeras som ett GeoJSON Polygon -objekt. Det här är det rekommenderade alternativet om geometrin innehåller en enda Polygon. Objektet Polygon kan ha högst 50 koordinater. En exempelrepresentation finns i avsnittet Polygon Exempel nedan.

.