Search - Get Reverse Geocoding Batch
Används för att skicka en batch med frågor till API:et för omvänd geokodning i en enda begäran.
Get Reverse Geocoding Batch-API:et är en HTTP-POST begäran som skickar batchar med upp till 100 frågor till omvänd geokodning API med 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/reverseGeocode:batch?api-version={api-version}
POST-brödtext för Batch-begäran
Om du vill skicka omvänd geokodning frågor använder du en POST begäran där begärandetexten innehåller matrisen batchItems i json format och Content-Type-huvudet anges till application/json. Här är ett exempel på begärandetext som innehåller 2 omvänd geokodning frågor:
{
"batchItems": [
{
"coordinates": [-122.128275, 47.639429],
"resultTypes": ["Address", "PopulatedPlace"]
},
{
"coordinates": [-122.341979399674, 47.6095253501216]
}
]
}
Ett omvänd geokodning batchItem-objekt kan acceptera någon av de omvänd geokodningURI-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 encodeoch enmessagei det här fallet.
POST {endpoint}/reverseGeocode:batch?api-version=2026-01-01
URI-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
|
|
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. |
Begärandetext
| Name | Typ | Description |
|---|---|---|
| batchItems |
Listan över frågor som ska bearbetas. |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Begäran har slutförts. |
|
| Other Status Codes |
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. Varje användare, grupp eller tjänstehuvudperson kan beviljas åtkomst via en inbyggd roll eller en anpassad roll bestående av en eller flera behörigheter för att Azure Maps REST-API:er.\n\nFör att implementera scenarier rekommenderar vi att man tittar på autentiseringskoncept. Sammanfattningsvis erbjuder denna säkerhetsdefinition en lösning för modellering av applikationer via objekt som kan åtkomstkontroll på specifika API:er och scopes.\n\n#### Anteckningar\n* Denna säkerhetsdefinition kräver användning av x-ms-client-id-headern för att ange vilken Azure Maps resurs applikationen begär åtkomst till. Detta kan hämtas från Maps management API.\n* \nAuthorization URL är specifik för den Azure publika molninstansen. Suveräna moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer. \n* \nDen Azure rollbaserade åtkomstkontrollen konfigureras från Azure hanteringsplanet via Azure portal, PowerShell, CLI, Azure-SDK:er eller REST API:er.\n* \nAnvändning av Azure Maps Web SDK möjliggör konfigurationsbaserad installation av en applikation för flera användningsområden.\n* För mer information om Microsofts identitetsplattform, se Microsofts identitetsplattform översikt.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Detta är en delad nyckel som provisioneras när du Skapa ett Azure Maps-konto i Azure-portalen eller med PowerShell, CLI, Azure-SDK:er eller REST API.\n\n Med denna nyckel kan vilken applikation som helst komma åt alla REST API:er. Med andra ord kan denna nyckel användas som en huvudnyckel i det konto där de utfärdas.\n\n För offentligt exponerade applikationer rekommenderar vi att använda konfidentiella klientapplikationer för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras säkert.
Typ:
apiKey
I:
header
SAS Token
Detta är en delad åtkomstsignaturtoken som skapas från List SAS-operationen på Azure Maps-resursen via Azure hanteringsplanet via Azure portal, PowerShell, CLI, Azure-SDK:er eller REST-API:er.\n\n Med denna token är varje applikation auktoriserad att få åtkomst med Azure rollbaserade åtkomstkontroller och finkornig kontroll till utgångsdatum, hastighet och region(er) för användning för den specifika token. Med andra ord kan SAS-token användas för att låta applikationer kontrollera åtkomsten på ett säkrare sätt än den delade nyckeln.\n\n För offentligt exponerade applikationer är vår rekommendation att konfigurera en specifik lista över tillåtna ursprung på Map-kontots resurs för att begränsa renderingsmissbruk och regelbundet förnya SAS-token.
Typ:
apiKey
I:
header
Exempel
A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries
Exempelbegäran
POST {endpoint}/reverseGeocode:batch?api-version=2026-01-01
{
"batchItems": [
{
"coordinates": [
-122.138681,
47.630358
],
"resultTypes": [
"Address",
"PopulatedPlace"
],
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
},
{
"coordinates": [
47.630358,
-122.138681
],
"optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
}
]
}
Exempelsvar
{
"summary": {
"successfulRequests": 1,
"totalRequests": 2
},
"batchItems": [
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"type": "Address",
"confidence": "Medium",
"matchCodes": [
"Good"
],
"address": {
"locality": "Redmond",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King County",
"shortName": "King Co."
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98052",
"formattedAddress": "2267 152nd Ave NE, Redmond, Washington 98052, United States",
"streetName": "152nd Ave NE",
"streetNumber": "2267",
"addressLine": "2267 152nd Ave NE"
},
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-122.128275,
47.639429
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display",
"Route"
]
},
{
"geometry": {
"type": "Point",
"coordinates": [
-122.127028,
47.638545
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Route"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-122.128275,
47.639429
]
},
"bbox": [
-122.1359181505759,
47.63556628242932,
-122.1206318494241,
47.643291717570676
]
}
],
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
},
{
"error": {
"code": "Bad Request",
"message": "The provided coordinates (-122.138681,47.630358) in coordinates field are invalid or out of range"
},
"optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
}
]
}
Definitioner
| Name | Description |
|---|---|
| Address |
Resultatets adress |
|
Address |
Underindelningsnamnet i landet eller regionen för en adress. |
|
Address |
Land eller region med dess namn och ISO-kod. |
|
Azure. |
Felobjektet. |
|
Azure. |
Ett svar som innehåller felinformation. |
|
Azure. |
Ett objekt som innehåller mer specifik information om felet. Enligt Azure REST API-riktlinjer - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
|
Calculation |
Den metod som användes för att beräkna geokodpunkten. |
|
Confidence |
Den konfidensnivå som resultatet av den geokodade platsen är en matchning. Använd det här värdet med matchningskoden för att fastställa mer fullständig information om matchningen. Konfidensen för en geokodad plats baseras på många faktorer, inklusive den relativa betydelsen av den geokodade platsen och användarens plats, om den anges. |
|
Error |
Ytterligare information om resurshanteringsfelet. |
|
Error |
Felinformationen. |
|
Feature |
Anger |
|
Features |
Ett funktionsobjekt. |
|
Features |
Egenskaper hos funktionen. |
|
Feature |
Typen av funktion måste vara Funktion. |
|
Geocode |
En geokodpunkt. |
|
Geocoding |
Det här objektet returneras från ett lyckat Batch-tjänstanrop för geokodning. |
|
Geocoding |
Ett batchsvarsobjekt. |
|
Geocoding |
Sammanfattning av batchbegäran |
|
Geo |
Anger |
|
Geo |
En giltig |
| Intersection |
Resultatets adress. |
|
Match |
Ett enum som representerar matchningskoden. |
|
Result |
Ett enum som representerar resultattypen. |
|
Reverse |
Listan över frågor/begäranden om omvänd geokodning som ska bearbetas. Listan kan innehålla högst 100 frågor och måste innehålla minst 1 fråga. |
|
Reverse |
Batch Query-objekt |
|
Usage |
Ett enum som representerar användningstypen. |
Address
Resultatets adress
| Name | Typ | Description |
|---|---|---|
| addressLine |
string |
AddressLine som innehåller gatunamn och nummer |
| adminDistricts |
Underindelningsnamnet i landet eller regionen för en adress. Det här elementet behandlas vanligtvis som den administrativa underindelningen i första ordningen, men i vissa fall innehåller det även den andra, tredje eller fjärde ordningens underindelning i ett land, beroende eller en region. |
|
| countryRegion |
Land eller region med dess namn och ISO-kod. |
|
| formattedAddress |
string |
Formaterad adressegenskap |
| intersection |
Resultatets adress. |
|
| locality |
string |
Egenskapen Locality |
| neighborhood |
string |
Fastighet i grannskapet |
| postalCode |
string |
Egenskap för postnummer |
| streetName |
string |
Namnet på gatan från formattedAddress |
| streetNumber |
string |
Numret på gatan, om det är tillgängligt, från formattedAddress |
AddressAdminDistrictsItem
Underindelningsnamnet i landet eller regionen för en adress.
| Name | Typ | Description |
|---|---|---|
| name |
string |
Namnet på motsvarande adminDistrict-fält, För adminDistrict[0], kan detta vara fullständigt namn på delstaten, till exempel Washington, For adminDistrict[1], detta kan vara det fullständiga namnet på länet |
| shortName |
string |
Det korta namnet för motsvarande adminDistrict-fält, För adminDistrict[0], kan det här vara ett kort namn på tillståndet, till exempel WA, For adminDistrict[1], detta kan vara det korta namnet på länet |
AddressCountryRegion
Land eller region med dess namn och ISO-kod.
| Name | Typ | Description |
|---|---|---|
| ISO |
string |
ISO för land/region |
| name |
string |
namn på land/region |
Azure.Core.Foundations.Error
Felobjektet.
| Name | Typ | Description |
|---|---|---|
| code |
string |
En av en serverdefinierad uppsättning felkoder. |
| details |
En matris med information om specifika fel som ledde till det rapporterade felet. |
|
| 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
Ett svar som innehåller felinformation.
| Name | Typ | Description |
|---|---|---|
| error |
Felobjektet. |
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.
| Name | Typ | Description |
|---|---|---|
| code |
string |
En av en serverdefinierad uppsättning felkoder. |
| innererror |
Inre fel. |
CalculationMethodEnum
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
Den konfidensnivå som resultatet av den geokodade platsen är en matchning. Använd det här värdet med matchningskoden för att fastställa mer fullständig information om matchningen.
Konfidensen för en geokodad plats baseras på många faktorer, inklusive den relativa betydelsen av den geokodade platsen och användarens plats, om den anges.
| Värde | Description |
|---|---|
| High |
Om konfidensen är inställd Om en begäran innehåller en plats eller en vy kan rankningen ändras på lämpligt sätt. En platsfråga för "Paris" returnerar till exempel "Paris, Frankrike" och "Paris, TX" båda med |
| 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 det här fallet, om geokodtjänsten har en konfidens att postnumret matchar data, anges konfidensen till 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 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 |
| Low |
Låg |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
| Name | Typ | Description |
|---|---|---|
| info |
object |
Ytterligare information. |
| type |
string |
Ytterligare informationstyp. |
ErrorDetail
Felinformationen.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Ytterligare information om felet. |
|
| code |
string |
Felkoden. |
| details |
Felinformationen. |
|
| message |
string |
Felmeddelandet. |
| target |
string |
Felmålet. |
FeatureCollectionEnum
Anger GeoJSON typ. Den enda objekttypen som stöds är FeatureCollection. Mer information finns i RFC 7946.
| Värde | Description |
|---|---|
| FeatureCollection |
Anger |
FeaturesItem
Ett funktionsobjekt.
| Name | Typ | Description |
|---|---|---|
| bbox |
number[] (double) |
Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946. |
| geometry |
En giltig |
|
| id |
string |
ID för funktionen returneras |
| properties |
Egenskaper hos funktionen. |
|
| type |
Typen av funktion måste vara Funktion. |
FeaturesItemProperties
Egenskaper hos funktionen.
| Name | Typ | Description |
|---|---|---|
| address |
Resultatets adress |
|
| confidence |
Den konfidensnivå som resultatet av den geokodade platsen är en matchning. Använd det här värdet med matchningskoden för att fastställa mer fullständig information om matchningen. Konfidensen för en geokodad plats baseras på många faktorer, inklusive den relativa betydelsen av den geokodade platsen och användarens plats, om den anges. |
|
| geocodePoints |
En samling geokodpunkter som skiljer sig åt i hur de beräknades och deras föreslagna användning. |
|
| matchCodes |
En eller flera matchningskodvärden som representerar geokodningsnivån för varje plats i svaret. En geokodad plats med matchningskoder för På samma sätt innebär en geokodad plats med matchningskoder för Möjliga värden är:
|
|
| type |
string |
En av: * Adress * Vägspärr * Vägkorsning * Grannskap * Befolkat Plats * Postnummer1 * AdminDivision1 * AdminDivision2 * LandRegion |
FeatureTypeEnum
Typen av funktion måste vara Funktion.
| Värde | Description |
|---|---|
| Feature |
Anger objekttypen |
GeocodePointsItem
En geokodpunkt.
| Name | Typ | Description |
|---|---|---|
| calculationMethod |
Den metod som användes för att beräkna geokodpunkten. |
|
| geometry |
En giltig |
|
| usageTypes |
Den bästa användningen för geokodpunkten. Varje geokodpunkt definieras som en |
GeocodingBatchResponse
Det här objektet returneras från ett lyckat Batch-tjänstanrop för geokodning.
| Name | Typ | Description |
|---|---|---|
| batchItems |
Matris som innehåller batchresultatet. |
|
| nextLink |
string |
är länken till nästa sida av de funktioner som returneras. Om det är den sista sidan, nej det här fältet. |
| summary |
Sammanfattning av batchbegäran |
GeocodingBatchResponseItem
Ett batchsvarsobjekt.
| Name | Typ | Description |
|---|---|---|
| error |
Felinformationen. |
|
| features |
En rad funktioner återkom från frågan. |
|
| nextLink |
string |
är länken till nästa sida av de funktioner som returneras. Om det är den sista sidan, nej det här fältet. |
| optionalId |
string |
id för batchItem som skulle vara samma som ID:t i begäran |
| type |
Anger |
GeocodingBatchResponseSummary
Sammanfattning av batchbegäran
| Name | Typ | Description |
|---|---|---|
| successfulRequests |
integer (int32) |
Antal lyckade begäranden i batchen |
| totalRequests |
integer (int32) |
Totalt antal begäranden i batchen |
GeoJsonObjectType
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 |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
|
| FeatureCollection |
|
GeoJsonPoint
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 |
| type |
string:
Point |
Anger |
Intersection
Resultatets adress.
| Name | Typ | Description |
|---|---|---|
| baseStreet |
string |
Primär gata för platsen. |
| displayName |
string |
Fullständigt namn på skärningspunkten. |
| intersectionType |
string |
Typ av skärningspunkt. |
| secondaryStreet1 |
string |
Den första korsande gatan. |
| secondaryStreet2 |
string |
Om någon, den andra korsar gatan. |
MatchCodesEnum
Ett enum som representerar matchningskoden.
| Värde | Description |
|---|---|
| Good |
Bra |
| Ambiguous |
Tvetydigt |
| UpHierarchy |
UpHierarchy |
ResultTypeEnum
Ett enum som representerar resultattypen.
| Värde | Description |
|---|---|
| Address |
Adress |
| Neighborhood |
Grannskap |
| PopulatedPlace |
PopulatedPlace |
| Postcode1 |
Postnummer1 |
| AdminDivision1 |
AdminDivision1 |
| AdminDivision2 |
AdminDivision2 |
| CountryRegion |
LandRegion |
ReverseGeocodingBatchRequestBody
Listan över frågor/begäranden om omvänd geokodning som ska bearbetas. Listan kan innehålla högst 100 frågor och måste innehålla minst 1 fråga.
| Name | Typ | Description |
|---|---|---|
| batchItems |
Listan över frågor som ska bearbetas. |
ReverseGeocodingBatchRequestItem
Batch Query-objekt
| Name | Typ | Description |
|---|---|---|
| coordinates |
number[] (double) |
Koordinaterna för den plats där du vill omvända geokod. Exempel: [lon,lat] |
| optionalId |
string |
ID för begäran som skulle visas i motsvarande batchItem |
| resultTypes |
Ange entitetstyper som du vill använda i svaret. Endast de typer som du anger returneras. Om punkten inte kan mappas till de entitetstyper som du anger returneras ingen platsinformation i svaret. Standardvärdet är alla möjliga entiteter. En kommaavgränsad lista över entitetstyper som valts från följande alternativ.
Dessa entitetstyper sorteras från den mest specifika entiteten till den minst specifika entiteten. När entiteter av mer än en entitetstyp hittas returneras endast den mest specifika entiteten. Om du till exempel anger Adress och AdminDistrict1 som entitetstyper och entiteter hittades för båda typerna returneras endast adressentitetsinformationen i svaret. |
|
| view |
string |
En sträng som anger en ISO 3166-1 Alpha-2-region/landskod. Detta ändrar geopolitiska omtvistade kantlinjer och etiketter så att de överensstämmer med den angivna användarregionen. |
UsageTypeEnum
Ett enum som representerar användningstypen.
| Värde | Description |
|---|---|
| Display |
Display |
| Route |
Rutt |