Search - Get Geocoding Batch

Tjänst:: Maps

API-version:: 2026-01-01

Används för att skicka en batch med frågor till API:et för geokodning i en enda begäran.
API:et Get Geocoding Batch är en HTTP-begäran POST som skickar batchar med upp till 100 frågor till API:et för geokodning i en enda begäran.

Skicka synkron Batch-begäran

Synkront API rekommenderas för enkla batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det finns ingen möjlighet att hämta resultatet senare. Synkront API 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/geocode:batch?api-version={api-version}

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

Om du vill skicka geokodningsfrågor använder du en begäran där begärandetexten innehåller matrisen POSTbatchItems i json format och Content-Type rubriken anges till application/json. Här är ett exempel på en begärandetext som innehåller 2 geokodningsfrågor :

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Ett geokodningsobjekt batchItem kan acceptera någon av de geokodnings-URI-parametrar som stöds.

Batchen ska innehålla minst 1 fråga.

Batch-svarsmodell

Batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequests dvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt är av någon av följande typer:

GeocodingResponse – Om frågan har slutförts.
Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

POST {endpoint}/geocode:batch?api-version=2026-01-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Azure Maps-tjänstens värdnamn. Använd `https://atlas.microsoft.com` för Azure publika molnet. För att rikta in dig på en specifik Azure Maps geografi eller ett suveränt moln, se Azure Maps geografisk omfattning.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Specificerar vilket konto som är avsett för användning i kombination med Azure AD:s säkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps management plane Account API. För mer information om hur man använder Microsoft Entra ID säkerhet i Azure Maps, se Hantera autentisering i Azure Maps.
Accept-Language		string	Språk där sökresultat ska returneras. Mer information finns i språk som stöds.

Name

Obligatorisk

Typ

Description

x-ms-client-id

string

Specificerar vilket konto som är avsett för användning i kombination med Azure AD:s säkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps management plane Account API. För mer information om hur man använder Microsoft Entra ID säkerhet i Azure Maps, se Hantera autentisering i Azure Maps.

Accept-Language

string

Språk där sökresultat ska returneras.

Mer information finns i språk som stöds.

Begärandetext

Name	Typ	Description
batchItems	GeocodingBatchRequestItem[]	Geokodningsfrågorna som ska bearbetas i denna omgång. Varje post är en oberoende framåt-geokodningsförfrågan; Tjänsten returnerar en motsvarande post per `GeocodingBatchResponse.batchItems` fråga, i samma ordning.

Svar

Name	Typ	Description
200 OK	GeocodingBatchResponse	Begäran har slutförts.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

200 OK

GeocodingBatchResponse

Begäran har slutförts.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Säkerhet

AadToken

Dessa är Microsoft Entra OAuth 2.0 flöden. När den kombineras med Azure rollbaserad åtkomst kontroll kan den användas för att kontrollera åtkomst till Azure Maps REST-API:er. Azure:s rollbaserade åtkomstkontroller används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller delresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Note

Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et.
Authorization URL är specifik för den offentliga Azure-molninstansen. Suveräna moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer.
Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
https://atlas.microsoft.com/.default

subscription-key

Det här är en delad nyckel som etableras när du Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST API:er. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder konfidentiella klientprogram metod för åtkomst till Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Typ: apiKey
I: header

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll till förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på Map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

A Geocoding Batch API call containing 2 Geocoding queries

Exempelbegäran

HTTP

POST https://atlas.microsoft.com/geocode:batch?api-version=2026-01-01

{
  "batchItems": [
    {
      "addressLine": "15127 NE 24th Street, Redmond, WA 98052",
      "top": 2,
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "query": "Pike Pl",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Exempelsvar

Statuskod:: 200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "High",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "shortName": "WA"
                },
                {
                  "shortName": "King County"
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
              "streetName": "NE 24th St",
              "streetNumber": "15127",
              "addressLine": "15127 NE 24th St"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.138669,
                    47.630359
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.1387383,
                    47.630563
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.138669,
              47.630359
            ]
          },
          "bbox": [
            -122.14631082421619,
            47.62649628242932,
            -122.1310271757838,
            47.634221717570675
          ]
        }
      ]
    },
    {
      "error": {
        "code": "Conflicting Parameters",
        "message": "When 'query' is present, only the following parameters are valid: 'bbox, location, view, top'. 'locality' was passed"
      }
    }
  ]
}

Definitioner

Name	Description
Address	Adressen till en geokodad eller autokompletterad föreslagen plats, omfördelad till strukturerade fält. Glesa är normalt: endast de fält som den upplösta enheten tillhandahåller fylls i. Till exempel förekommer `streetName` och `streetNumber` endast för gatunivåadresser, och `intersection` endast för vägkorsningsresultat.
AddressAdminDistrictsItem	En administrativ underavdelning som innehåller en adress. Till exempel en delstat, provins eller län. Returneras som en post i moderarrayen `Address.adminDistricts` , där poster är ordnade från grovast till finast.
AddressCountryRegion	Det land eller den region som innehåller adressen, identifierad med dess visningsnamn och ISO 3166-1 Alpha-2 landskod. Båda fälten kan utelämnas i ett givet svar.
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Azure REST API-riktlinjer - https://aka.ms/AzureRestApiGuidelines#handling-errors.
CalculationMethodEnum	Den metod som användes för att beräkna geokodpunkten.
ConfidenceEnum	Den konfidensnivå som resultatet av den geokodade platsen är en matchning. Använd detta värde tillsammans med matchkoderna för att få mer fullständig information om matchen. Förtroendet för en geokodad plats baseras på många faktorer, inklusive den geokodade platsens relativa betydelse och användarens plats, om det specificeras.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
FeatureCollectionEnum	Objekttypen `GeoJSON` som används vid roten till framgångsrika svar från framåtriktad geokodning, omvänd geokodning och autokomplettering (inklusive deras batchvarianter). Det enda värdet är `FeatureCollection`, enligt definitionen i RFC 7946. `Get Polygon` är det enda undantaget: dess svarsrot är en `GeoJSON Feature`, se `FeatureTypeEnum`.
FeaturesItem	En enda post i `features` matrisen av en `GeocodingResponse`, som överensstämmer med `GeoJSON Feature` objektets form. Representerar en geokodad plats: strukturerad data på `properties`, en representativ koordinat på `geometry`, och en valfri begränsningsruta på `bbox`.
FeaturesItemProperties	Nyttolasten `properties` för en funktion i en `GeocodingResponse`. Innehåller entitetstyp och matchningskvalitetsindikatorer för den geokodade platsen, dess tolkade adresskomponenter och en eller flera geokodpunkter som fäster platsen vid specifika koordinater.
FeatureTypeEnum	Objekttypen `GeoJSON` för `Feature` objekt. Taggar varje post inom arrayen `features` av ett `FeatureCollection` svar (geokodning, omvänd geokodning, autokomplettering) och visas vid roten av svaret `Get Polygon` . Det enda värdet är `Feature`, enligt definitionen i RFC 7946.
GeocodePointsItem	En geokodpunkt för en plats: en koordinat plus metadata som beskriver hur punkten beräknades (`calculationMethod`) och vad den passar bäst för (`usageTypes`). En enda funktion returnerar vanligtvis separat `Display` och `Route` pekar ut så att uppringare kan välja den som passar uppgiften.
GeocodingBatchRequestBody	Begärandet för operationen `Get Geocoding Batch` . Bär en eller flera individuella geokodningsfrågor — mellan 1 och 100, inklusive — som tjänsten bearbetar som ett enda samtal och returnerar som en parallell `batchItems` array på `GeocodingBatchResponse`.
GeocodingBatchRequestItem	En geokodningsfråga inuti en `GeocodingBatchRequestBody.batchItems` array. Varje objekt är en oberoende framåt-geokodningsförfrågan som motsvarar ett enda anrop till `Get Geocoding`, uttryckt som fält snarare än URL-frågeparametrar. Platsen kan tillhandahållas antingen som en fri sträng `query` eller som de strukturerade fälten nedan (`addressLine`, `locality`, `countryRegion`, nivåerna `adminDistrict` , `postalCode`); dessa två inmatningslägen utesluter varandra — när `query` sätts ignoreras de strukturerade fälten.
GeocodingBatchResponse	Den lyckade responskroppen returnerades med `Get Geocoding Batch`. Bär en `summary` av hur många av de inskickade frågorna som lyckades plus en `batchItems` array som innehåller en svarspost per fråga i förfrågan, i samma ordning som begäranarrayen `batchItems` .
GeocodingBatchResponseItem	En enda post inom `GeocodingBatchResponse.batchItems`, som bär resultatet av en av frågorna från motsvarande `GeocodingBatchRequestBody.batchItems` post. Lyckade frågor visar sina geokodade `features` här i samma form som `GeocodingResponse`; misslyckade frågor visar istället diagnostisk information via `error` . Exakt en av `features` eller `error` fylls i per post.
GeocodingBatchResponseSummary	Innehåller aggregerade räkningar för ett `Get Geocoding Batch` svar: storleken på den inskickade batchen och hur många av dess frågor som bearbetades framgångsrikt. Används som typen av `GeocodingBatchResponse.summary`.
GeoJsonObjectType	Anger `GeoJSON` typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.
GeoJsonPoint	En giltig `GeoJSON Point` geometrityp. Mer information finns i RFC 7946.
Intersection	Korsningsdetaljer för en adress är avslutade som en vägkorsning — hörnet där två eller flera namngivna gator möts. Fylls endast när den lösta enheten är en `RoadIntersection`; föräldern `Address.intersection` utelämnas annars.
MatchCodesEnum	Ett matchningskodsvärde som anger hur geokodningstjänsten producerade ett visst platsresultat. Fältet `matchCodes` på en funktion är en array av dessa värden; kombinera dem med `confidence` och `type` för att utvärdera matchningskvalitet.
UsageTypeEnum	Den avsedda användningen för en geokodpunkt. En geokodpunkt som tjänsten returnerar bär en eller flera användningstyper som visar hur en klientapplikation ska använda punkten: till exempel att visa platsen på en karta jämfört med att styra ett fordon dit.

Address

Objekt

Adressen till en geokodad eller autokompletterad föreslagen plats, omfördelad till strukturerade fält. Glesa är normalt: endast de fält som den upplösta enheten tillhandahåller fylls i. Till exempel förekommer streetName och streetNumber endast för gatunivåadresser, och intersection endast för vägkorsningsresultat.

Name	Typ	Description
addressLine	string	Den första raden i adressen, vanligtvis gatunamn och nummer. Till exempel `"15127 NE 24th St"`.
adminDistricts	AddressAdminDistrictsItem[]	De administrativa underavdelningarna som innehåller adressen, ordnade från grovast till finast. Den första posten är vanligtvis den första ordningens underindelning (såsom en amerikansk delstat eller en kanadensisk provins); Efterföljande poster täcker finare indelningar där landet, beroendelandet eller regionen definierar dem (såsom ett län på index 1).
countryRegion	AddressCountryRegion	Landet eller regionen som innehåller adressen, med dess visningsnamn och ISO 3166-1 Alpha-2 landskod.
formattedAddress	string	Hela adressen återgavs som en enda mänskligt läsbar sträng, där komponenterna fogades enligt konventionerna i adressens land eller region. Exempel: `"15127 NE 24th St, Redmond, WA 98052"`.
intersection	Intersection	De korsande gatuuppgifterna för adressen, fyllda när den upplösta enheten är en `RoadIntersection` (såsom hörnet av två namngivet gator).
locality	string	Platsen adressen tillhör: vanligtvis en stad, ort eller by. Till exempel: `"Redmond"`.
neighborhood	string	Det namngivna området inom området, när ett sådant identifieras.
postalCode	string	Postnumret för adressen, när det definieras. Exempel: `"98052"`.
streetName	string	Gatunamnskomponenten i adressen, när den lösta enheten är en gatunivåadress. Exempel: `"NE 24th St"`.
streetNumber	string	Hus- eller byggnadsnumret på gatan, när den lösta enheten är en gatunivåadress. Exempel: `"15127"`.

AddressAdminDistrictsItem

Objekt

En administrativ underavdelning som innehåller en adress. Till exempel en delstat, provins eller län. Returneras som en post i moderarrayen Address.adminDistricts , där poster är ordnade från grovast till finast.

Name	Typ	Description
name	string	Det fullständiga namnet på bostadsområdet. Till exempel `"Washington"` för en amerikansk delstat eller `"King County"` för ett län.
shortName	string	Den korta eller förkortade formen av underavdelningsnamnet, när ett sådant definieras. Till exempel `"WA"` för en amerikansk delstat. Finare indelningar har ofta ingen distinkt kortform, i vilket fall `shortName` upprepas `name` (såsom `"King County"`).

AddressCountryRegion

Objekt

Det land eller den region som innehåller adressen, identifierad med dess visningsnamn och ISO 3166-1 Alpha-2 landskod. Båda fälten kan utelämnas i ett givet svar.

Name	Typ	Description
ISO	string	ISO 3166-1 Alpha-2 landskod för landet eller regionen. Till exempel `"US"` för United States, eller `"GB"` för Storbritannien.
name	string	Landets eller regionens visningsnamn. Till exempel `"United States"`.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Azure REST API-riktlinjer - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

CalculationMethodEnum

Uppräkning

Den metod som användes för att beräkna geokodpunkten.

Värde	Description
Interpolation	Geokodpunkten matchades med en punkt på en väg med hjälp av interpolation.
InterpolationOffset	Geokodpunkten matchades med en punkt på en väg med hjälp av interpolering med en extra förskjutning för att flytta punkten till sidan av gatan.
Parcel	Geokodpunkten matchades med mitten av ett paket.
Rooftop	Geokodpunkten matchades med taket på en byggnad.

ConfidenceEnum

Uppräkning

Den konfidensnivå som resultatet av den geokodade platsen är en matchning. Använd detta värde tillsammans med matchkoderna för att få mer fullständig information om matchen.

Förtroendet för en geokodad plats baseras på många faktorer, inklusive den geokodade platsens relativa betydelse och användarens plats, om det specificeras.

Värde Description

High

Värde	Description
High	Om konfidensen är inställd `High`på hittades en eller flera starka matchningar. Matchningar med flera `High` konfidenser sorteras i rangordnad ordning efter betydelse när det är tillämpligt. Landmärken är till exempel viktiga, men det har inte adresser. Om en förfrågan innehåller en plats eller en vy kan rangordningen ändras därefter. Till exempel returnerar en platssökning för "Paris" både "Paris, Frankrike" och "Paris, TX" med säkerhet `High` . "Paris, Frankrike" rankas alltid först på grund av betydelse, om inte användarens plats indikerar att användaren befinner sig i eller mycket nära Paris, TX, eller om kartvyn visar att användaren söker i det området.
Medium	I vissa situationer kanske den returnerade matchningen inte är på samma nivå som den information som anges i begäran. En begäran kan till exempel ange adressinformation och geokodtjänsten kanske bara kan matcha ett postnummer. I detta fall, om geokodtjänsten har förtroende för att postnumret matchar datan, sätts konfidensen till `Medium` och matchningskoden sätts till `UpHierarchy` för att indikera att tjänsten inte kunde matcha all information och var tvungen att söka uppåt. Om platsinformationen i frågan är tvetydig och det inte finns någon ytterligare information för att rangordna platserna (till exempel användarens plats eller platsens relativa betydelse) anges konfidensen till `Medium`. Till exempel kan en platssökning på "148th Ave, Bellevue" ge både "148th Ave SE" och "148th Ave NE" med `Medium` säkerhet. Om platsinformationen i frågan inte ger tillräckligt med information för att geokoda en viss plats kan ett mindre exakt platsvärde returneras och konfidensen anges till `Medium`. Till exempel, om en adress anges men en träff inte hittas för husnumret, kan geokodresultatet med en `RoadBlock` entitetstyp returneras.
Low	Lågt självförtroende i matchen.

Om konfidensen är inställd Highpå hittades en eller flera starka matchningar. Matchningar med flera High konfidenser sorteras i rangordnad ordning efter betydelse när det är tillämpligt. Landmärken är till exempel viktiga, men det har inte adresser.

Om en förfrågan innehåller en plats eller en vy kan rangordningen ändras därefter. Till exempel returnerar en platssökning för "Paris" både "Paris, Frankrike" och "Paris, TX" med säkerhet High . "Paris, Frankrike" rankas alltid först på grund av betydelse, om inte användarens plats indikerar att användaren befinner sig i eller mycket nära Paris, TX, eller om kartvyn visar att användaren söker i det området.

Medium

I vissa situationer kanske den returnerade matchningen inte är på samma nivå som den information som anges i begäran. En begäran kan till exempel ange adressinformation och geokodtjänsten kanske bara kan matcha ett postnummer. I detta fall, om geokodtjänsten har förtroende för att postnumret matchar datan, sätts konfidensen till Medium och matchningskoden sätts till UpHierarchy för att indikera att tjänsten inte kunde matcha all information och var tvungen att söka uppåt.

Om platsinformationen i frågan är tvetydig och det inte finns någon ytterligare information för att rangordna platserna (till exempel användarens plats eller platsens relativa betydelse) anges konfidensen till Medium. Till exempel kan en platssökning på "148th Ave, Bellevue" ge både "148th Ave SE" och "148th Ave NE" med Medium säkerhet.

Om platsinformationen i frågan inte ger tillräckligt med information för att geokoda en viss plats kan ett mindre exakt platsvärde returneras och konfidensen anges till Medium. Till exempel, om en adress anges men en träff inte hittas för husnumret, kan geokodresultatet med en RoadBlock entitetstyp returneras.

Low

Lågt självförtroende i matchen.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

FeatureCollectionEnum

Uppräkning

Objekttypen GeoJSON som används vid roten till framgångsrika svar från framåtriktad geokodning, omvänd geokodning och autokomplettering (inklusive deras batchvarianter). Det enda värdet är FeatureCollection, enligt definitionen i RFC 7946. Get Polygon är det enda undantaget: dess svarsrot är en GeoJSON Feature, se FeatureTypeEnum.

Värde	Description
FeatureCollection	Objekttypen `GeoJSON FeatureCollection` . Förekommer som roten till varje framgångsrik geokodning, omvänd geokodning och autokompletteringsrespons. `Get Polygon` använder istället en `Feature` rot.

FeaturesItem

Objekt

En enda post i features matrisen av en GeocodingResponse, som överensstämmer med GeoJSON Feature objektets form. Representerar en geokodad plats: strukturerad data på properties, en representativ koordinat på geometry, och en valfri begränsningsruta på bbox.

Name	Typ	Description
bbox	number[] (double)	Den minsta axeljusterade rektangeln som innehåller funktionens geometri, i WGS 84 longitud-/latitudordning. Kodad enligt `[westLon, southLat, eastLon, northLat]`RFC 7946, avsnitt 5.
geometry	GeoJsonPoint	Den primära `GeoJSON Point` representerar den geokodade platsen, med koordinater i WGS 84 longitud/latitudordning.
id	string	En valfri tjänstetilldelad identifierare för funktionen, när en sådan finns tillgänglig.
properties	FeaturesItemProperties	Strukturerad data om den geokodade platsen, inklusive dess enhetstyp, matchningskvalitetsindikatorer, adresskomponenter och en eller flera geokodpunkter.
type	FeatureTypeEnum	Objekttypen `GeoJSON` . Alltid `Feature`, som definierat i RFC 7946.

FeaturesItemProperties

Objekt

Nyttolasten properties för en funktion i en GeocodingResponse. Innehåller entitetstyp och matchningskvalitetsindikatorer för den geokodade platsen, dess tolkade adresskomponenter och en eller flera geokodpunkter som fäster platsen vid specifika koordinater.

Name	Typ	Description
address	Address	Adressen till den geokodade platsen, uppdelad i strukturerade fält som ort, postnummer, land/region och (när tillgängligt) gatunamn och nummer.
confidence	ConfidenceEnum	Hur starkt den geokodade platsen stämmer överens med begäran. Använd detta `matchCodes` för en komplett bild av matchkvaliteten. Se `ConfidenceEnum` för värdelistan och de faktorer som påverkar betyget.
geocodePoints	GeocodePointsItem[]	En eller flera geokodpunkter för platsen, var och en markerad med hur den härleds (`calculationMethod`) och vad den passar bäst för (`usageTypes`). Till exempel `Display` för visuell placering på en karta, eller `Route` för användning som navigationsdestination.
matchCodes	MatchCodesEnum[]	Hur geokodningstjänsten producerade detta resultat i förhållande till frågan: en direkt matchning vid den begärda specificiteten (`Good`), en av flera kandidater (`Ambiguous`), eller en fallback till en mindre exakt nivå i den geografiska hierarkin (`UpHierarchy`). Flera värden kan finnas. Till exempel indikerar en `Ambiguous` plus-parning `UpHierarchy` att tjänsten inte kunde matcha den begärda specificiteten och hittade flera matchningar på en grövre nivå. Se `MatchCodesEnum` för beskrivningar per värde; kombinera med `confidence` för en komplett bild av matchningskvaliteten.
type	string	Den enhetstyp som den geokodade platsen har löst upp sig till. En av: , , , , , `PopulatedPlace`, `Postcode1AdminDivision1`, , `AdminDivision2`, eller `CountryRegion`. `NeighborhoodRoadIntersectionRoadBlockAddress`

FeatureTypeEnum

Uppräkning

Objekttypen GeoJSON för Feature objekt. Taggar varje post inom arrayen features av ett FeatureCollection svar (geokodning, omvänd geokodning, autokomplettering) och visas vid roten av svaret Get Polygon . Det enda värdet är Feature, enligt definitionen i RFC 7946.

Värde	Description
Feature	Objekttypen `GeoJSON Feature` . Förekommer på varje funktion inuti ett `FeatureCollection` svar, och vid roten av svaret `Get Polygon` .

GeocodePointsItem

Objekt

En geokodpunkt för en plats: en koordinat plus metadata som beskriver hur punkten beräknades (calculationMethod) och vad den passar bäst för (usageTypes). En enda funktion returnerar vanligtvis separat Display och Route pekar ut så att uppringare kan välja den som passar uppgiften.

Name	Typ	Description
calculationMethod	CalculationMethodEnum	Hur poängen beräknades. Till exempel fastsatt på taket av en byggnad eller interpolerad längs en vägens mittlinje. Se `CalculationMethodEnum` för värdelistan.
geometry	GeoJsonPoint	Koordinaten för denna geokodpunkt är en `GeoJSON Point`, med värden i WGS 84 longitud/latitud ordning.
usageTypes	UsageTypeEnum[]	Vad geokodpunkten är bäst lämpad för — `Display` för visuell placering på en karta eller `Route` som en ruttmålsdestination. En poäng kan ha båda. Se `UsageTypeEnum` för detaljer per värde, inklusive hur varje är positionerad för egenskaper med icke-trivial omfattning.

GeocodingBatchRequestBody

Objekt

Begärandet för operationen Get Geocoding Batch . Bär en eller flera individuella geokodningsfrågor — mellan 1 och 100, inklusive — som tjänsten bearbetar som ett enda samtal och returnerar som en parallell batchItems array på GeocodingBatchResponse.

Name	Typ	Description
batchItems	GeocodingBatchRequestItem[]	Geokodningsfrågorna som ska bearbetas i denna omgång. Varje post är en oberoende framåt-geokodningsförfrågan; Tjänsten returnerar en motsvarande post per `GeocodingBatchResponse.batchItems` fråga, i samma ordning.

GeocodingBatchRequestItem

Objekt

En geokodningsfråga inuti en GeocodingBatchRequestBody.batchItems array. Varje objekt är en oberoende framåt-geokodningsförfrågan som motsvarar ett enda anrop till Get Geocoding, uttryckt som fält snarare än URL-frågeparametrar. Platsen kan tillhandahållas antingen som en fri sträng query eller som de strukturerade fälten nedan (addressLine, locality, countryRegion, nivåerna adminDistrict , postalCode); dessa två inmatningslägen utesluter varandra — när query sätts ignoreras de strukturerade fälten.

Name	Typ	Standardvärde	Description
addressLine	string		Adressens gatulinje, vanligtvis gatunamn och nummer, eller någon annan officiell gatunivåadress. Ignoreras när `query` det är satt.
adminDistrict	string		Den första ordningens administrativa underindelning (såsom en stat eller provins) anges som namn eller kortkod. Till exempel `"WA"` för Washington. Ignoreras när `query` det är satt.
adminDistrict2	string		Den andra ordningens administrativa underindelning (såsom ett län). Till exempel `"King"` för King County. Ignoreras när `query` det är satt.
adminDistrict3	string		Den tredje ordningens administrativa underindelning (såsom distrikt, församling eller kommun), där landet, beroendet eller regionen definierar en. Ignoreras när `query` det är satt.
bbox	number[] (double)		En begränsningsruta som begränsar sökningen till ett rektangulärt geografiskt område. Kodad enligt `[westLon, southLat, eastLon, northLat]` WGS 84 längd-/latitudordning, med varje sida från ungefär `0.00001` grader (~1 meter) upp till hela den globala utbredningen (`-180, -90` till `180, 90`).
coordinates	number[] (double)		En punkt på jorden, kodad i `[longitude, latitude]` WGS 84-ordning, används för att vinkla resultaten mot användarens position. När resultaten närmar sig denna punkt tillhandahålls är de vanligtvis mer relevanta för användaren.
countryRegion	string		En ISO 3166-1 Alpha-2 region/landkod som begränsar sökningen till ett enskilt land eller en region. Till exempel `"FR"` för Frankrike. Ignoreras när `query` det är satt.
locality	string		Adressens lokala (stad, ort eller by) komponent. Till exempel `"Seattle"`. Ignoreras när `query` det är satt.
optionalId	string		En valfri identifierare som tillhandahålls av uppringaren ekade tillbaka på den matchande svarsposten som `GeocodingBatchResponseItem.optionalId`. Användbart för att korrelera svar på förfrågningar med en stabil applikationsidentifierare istället för att enbart förlita sig på arraypositionen.
postalCode	string		Postnummerkomponenten på adressen. Ignoreras när `query` det är satt.
query	string		En fri sträng som beskriver platsen för geokod, vanligtvis en adress eller ett landmärkesnamn. När de är satta ignoreras de strukturerade platsfälten nedanför (`addressLine`, `locality`, `countryRegion`, nivåerna `adminDistrict` , `postalCode`) borta.
top	integer (int32) minimum: 1 maximum: 20	5	Det maximala antalet geokodade resultat returnerades för denna fråga. Standardinställning till 5; Minimum 1, max 20.
view	string	auto	En ISO 3166-1 Alpha-2 region-/landkod som identifierar den region vars geopolitiska syn ska tillämpas på omtvistade gränser och etiketter i svaret. Som standard är `"auto"`, som väljer vyn baserat på begärandets ursprung. Se Stödda vyer för tillgängliga värden.

GeocodingBatchResponse

Objekt

Den lyckade responskroppen returnerades med Get Geocoding Batch. Bär en summary av hur många av de inskickade frågorna som lyckades plus en batchItems array som innehåller en svarspost per fråga i förfrågan, i samma ordning som begäranarrayen batchItems .

Name	Typ	Description
batchItems	GeocodingBatchResponseItem[]	Resultaten per fråga i batchen. Varje post motsvarar positionsmässigt begäransteckningen vid samma arrayindex i `GeocodingBatchRequestBody.batchItems`. Poster med `error` fyllda representerar frågor som misslyckades; poster med `features` fyllda representerar frågor som lyckades.
nextLink	string	Innehåller URL:en för att hämta nästa resultatsida om svaret är paginerat. Detta är användbart när svaret är för stort för att besvaras i ett enda samtal, vilket gör att användare kan navigera genom flera sidor med resultat.
summary	GeocodingBatchResponseSummary	Aggregerade räkningar för batchen som en helhet, det totala antalet inskickade frågor och hur många av dem som slutfördes framgångsrikt.

GeocodingBatchResponseItem

Objekt

En enda post inom GeocodingBatchResponse.batchItems, som bär resultatet av en av frågorna från motsvarande GeocodingBatchRequestBody.batchItems post. Lyckade frågor visar sina geokodade features här i samma form som GeocodingResponse; misslyckade frågor visar istället diagnostisk information via error . Exakt en av features eller error fylls i per post.

Name	Typ	Description
error	ErrorDetail	Diagnostisk information för en fråga som misslyckades i batchen, felspåret per post kompletterar framgångsvägen på `features`. Befolkades endast när inlägget misslyckades; se `ErrorDetail` för per-fel-formen.
features	FeaturesItem[]	Arrayen av `GeoJSON Feature` objekt geokodad för denna batch-posts fråga. Varje `Feature` representerar en enda geokodad plats med detaljer exponerade via `properties` och dess primära koordinat via `geometry`. Fylldes endast när insatsen lyckades.
nextLink	string	Innehåller URL:en för att hämta nästa resultatsida om svaret är paginerat. Detta är användbart när svaret är för stort för att besvaras i ett enda samtal, vilket gör att användare kan navigera genom flera sidor med resultat.
optionalId	string	Den uppringarens identifierare ekade tillbaka från motsvarande `GeocodingBatchRequestItem.optionalId`. Fylldes endast när förfråganen angav en. Användbart för applikationsbaserad korrelation när arraypositionen inte är tillräcklig.
type	FeatureCollectionEnum	Objekttypen `GeoJSON` i detta inläggs framgångskropp. Alltid `FeatureCollection`, som definierat i RFC 7946. Fylldes endast när insatsen lyckades.

GeocodingBatchResponseSummary

Objekt

Innehåller aggregerade räkningar för ett Get Geocoding Batch svar: storleken på den inskickade batchen och hur många av dess frågor som bearbetades framgångsrikt. Används som typen av GeocodingBatchResponse.summary.

Name	Typ	Description
successfulRequests	integer (int32)	Antalet frågor i batchen som bearbetades framgångsrikt — de vars svarspost i `GeocodingBatchResponse.batchItems` innehåller `features` istället för `error`.
totalRequests	integer (int32)	Det totala antalet inskickade frågor i batchen. Subtrahera `successfulRequests` för att härleda antalet misslyckade frågor.

GeoJsonObjectType

Uppräkning

Anger GeoJSON typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

Värde	Description
Point	`GeoJSON Point` geometri.
MultiPoint	`GeoJSON MultiPoint` geometri.
LineString	`GeoJSON LineString` geometri.
MultiLineString	`GeoJSON MultiLineString` geometri.
Polygon	`GeoJSON Polygon` geometri.
MultiPolygon	`GeoJSON MultiPolygon` geometri.
GeometryCollection	`GeoJSON GeometryCollection` geometri.
Feature	`GeoJSON Feature` objekt.
FeatureCollection	`GeoJSON FeatureCollection` objekt.

GeoJsonPoint

Objekt

En giltig GeoJSON Point geometrityp. Mer information finns i RFC 7946.

Name	Typ	Description
bbox	number[] (double)	Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946.
coordinates	number[] (double)	En `Position` är en matris med tal med två eller flera element. De första två elementen är longitud och latitud, just i den ordningen. Altitude/Elevation är ett valfritt tredje element. Mer information finns i RFC 7946.
type	string: Point	Anger `GeoJSON` typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

Intersection

Objekt

Korsningsdetaljer för en adress är avslutade som en vägkorsning — hörnet där två eller flera namngivna gator möts. Fylls endast när den lösta enheten är en RoadIntersection; föräldern Address.intersection utelämnas annars.

Name	Typ	Description
baseStreet	string	Den primära gatan i korsningen — vanligtvis gatan som adressnumret refererar till.
displayName	string	Ett människoläsbart namn för korsningen som kombinerar korsningsgatorna, såsom `"5th Avenue & Main Street"`.
intersectionType	string	En kort etikett som beskriver formen på skärningen. Till exempel att skilja en plankorsning från en planskild överfart som en bro eller viadukt.
secondaryStreet1	string	Den första korsgatan som möts `baseStreet` vid korsningen.
secondaryStreet2	string	Den andra korsgatan vid korsningen, när en sådan finns där. Befolkad endast vid korsningar med tre eller fler gator.

MatchCodesEnum

Uppräkning

Ett matchningskodsvärde som anger hur geokodningstjänsten producerade ett visst platsresultat. Fältet matchCodes på en funktion är en array av dessa värden; kombinera dem med confidence och type för att utvärdera matchningskvalitet.

Värde	Description
Good	Geokodningstjänsten producerade denna kandidat utan att bredda frågan: resultatet matchar frågan vid den specificitet som efterfrågades.
Ambiguous	Platsen är en av flera möjliga matchningar. Till exempel, när man söker efter gatuadressen "128 Main St.", kan svaret returnera två platser för "128 North Main St." och "128 South Main St." eftersom det inte finns tillräckligt med information för att avgöra vilket alternativ som ska väljas.
UpHierarchy	Platsen representerar en klänga i den geografiska hierarkin. Detta inträffar när en matchning för platsbegäran inte hittades, så ett mindre exakt resultat returneras.

UsageTypeEnum

Uppräkning

Den avsedda användningen för en geokodpunkt. En geokodpunkt som tjänsten returnerar bär en eller flera användningstyper som visar hur en klientapplikation ska använda punkten: till exempel att visa platsen på en karta jämfört med att styra ett fordon dit.

Värde	Description
Display	Geokodpunkten är lämplig för att visa platsen på en karta. För en funktion med icke-trivial omfattning (såsom en park eller byggnad) är punkten `Display` vanligtvis nära objektets visuella centrum.
Route	Geokodpunkten är lämplig som destination för en rutt. För en funktion med icke-trivial omfattning (såsom en park eller byggnad) placeras punkten `Route` vanligtvis vid en fordonstillgänglig ingång snarare än vid det visuella centrumet.