Dela via

Search - Post Search Address Reverse Batch

  • Referens
Tjänst:
Maps
API-version:
1.0

Använd för att skicka en batch med frågor till api:et sökadress omvänd i en enda asynkron begäran.

Post Search Address Reverse Batch-API:et är en HTTP-POST begäran som skickar batchar med frågor till Omvänd API för sökadress i ett enda asynkront API-anrop. Du kan anropa Post Search Address Reverse Batch API för att köra antingen asynkront (asynkront) eller synkront (synkronisering). Med api:et async kan anroparen batcha upp till 10 000 frågor och synkronisera API:et upp till 100 frågor.

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/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Skicka asynkron Batch-begäran

Asynkront API är lämpligt för bearbetning av stora volymer av relativt komplexa sökbegäranden

  • Det gör det möjligt att hämta resultat i ett separat anrop (flera nedladdningar är möjliga).
  • Det asynkrona API:et är optimerat för tillförlitlighet och förväntas inte överskrida tidsgränsen.
  • 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 en 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. Asynkrona svar lagras i 14 dagar. Omdirigerings-URL:en returnerar ett 404-svar om det används efter förfalloperioden.

Observera att en asynkron batchbegäran är en tidskrävande åtgärd. Här är en typisk sekvens med åtgärder:

  1. Klienten skickar en begäran om omvänd batch-POST sökadress till Azure Maps.
POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0&subscription-key={subscription-key}

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

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

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

  2. Om batchbegäran godkändes innehåller Location-huvudet i svaret URL:en för att ladda ned resultatet av batchbegäran. Den här status-URI:n 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 utfärdar en GET begäran om nedladdnings-URL hämtas i steg 3 för att ladda ned batchresultatet.

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

Om du vill skicka sökadressen omvänd frågor använder du en POST begäran där begärandetexten innehåller batchItems-matrisen i json format och Content-Type-huvudet anges till application/json. Här är ett exempel på begärandetext som innehåller 5 omvända sökadresser frå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 fråga i en batch är bara en partiell URL-utan protokollet, bas-URL:en, sökvägen, api-versionen och prenumerationsnyckeln. Den kan acceptera någon av de sökadresser som stöds omvändaURI-parametrar. Strängvärdena i sökadressens omvända fråga måste vara korrekt undantagna (t.ex. " tecknet ska vara undantaget med \ ) och det bör också vara korrekt URL-kodat.

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

Ladda ned asynkrona Batch-resultat

Om du vill ladda ned asynkrona batchresultat utfärdar du en GET begäran till batchnedladdningsslutpunkten. Den här nedladdnings-URL:en kan hämtas från Location-huvudet 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 GET begäran 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 asynkroniserings- och synkroniseringsbegä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 summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequestsdvs. 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 i batchItems innehåller statusCode och response fält. Varje response i batchItems är av någon av följande typer:

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

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

Här är ett Batch-exempelsvar med 2 lyckade och 1 misslyckades 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 https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0

URI-parametrar

Name I Obligatorisk Typ Description
format
 path True

JsonFormat

Önskat format för svaret. Endast json format stöds.
api-version
 query True

string

Versionsnummer för Azure Maps API.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-id

string

Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID-säkerhetsmodellen. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar för vägledning.

Begärandetext

Name Typ Description
batchItems

BatchRequestItem[]

Listan över frågor som ska bearbetas.

Svar

Name Typ Description
200 OK

ReverseSearchAddressBatchProcessResult

OK
202 Accepted

Stöds endast för asynkron begäran. Begäran har godkänts: Begäran har godkänts för bearbetning. Använd URL:en i platsrubriken för att försöka igen eller komma åt resultaten.

Sidhuvuden

Location: string
Other Status Codes

ErrorResponse

Ett oväntat fel uppstod.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. 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.

Anmärkning

  • 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-hantering-API:et.
  • Authorization URL är specifik för den offentliga Azure-molninstansen. Nationella 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 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: query

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 Reverse Geocoding Batch API call containing 5 Reverse Geocoding API queries

Exempelbegäran

POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0

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

Exempelsvar

Statuskod:
200 
{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "7",
              "routeNumbers": [],
              "streetName": "Avenue Anatole France",
              "streetNameAndNumber": "7 Avenue Anatole France",
              "countryCode": "FR",
              "countrySubdivisionCode": "Île-de-France",
              "countrySecondarySubdivision": "Paris",
              "municipality": "Paris",
              "postalCode": "75007",
              "municipalitySubdivision": "7ème Arrondissement",
              "country": "France",
              "countryCodeISO3": "FRA",
              "freeformAddress": "7 Avenue Anatole France, Paris, 75007",
              "boundingBox": {
                "northEast": "48.858321,2.295167",
                "southWest": "48.858136,2.295027",
                "entity": "position"
              }
            },
            "position": "48.858231,2.295089"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "routeNumbers": [],
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "municipality": "Redmond",
              "postalCode": "98052",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "Redmond, WA 98052",
              "boundingBox": {
                "northEast": "47.639765,-122.128661",
                "southWest": "47.639502,-122.129456",
                "entity": "position"
              },
              "countrySubdivisionName": "Washington"
            },
            "position": "47.639687,-122.128677"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 19,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "410",
              "routeNumbers": [],
              "streetName": "Thomas Street",
              "streetNameAndNumber": "410 Thomas Street",
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "municipality": "Seattle",
              "postalCode": "98109",
              "municipalitySubdivision": "Seattle, Lower Queen Anne",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "410 Thomas Street, Seattle, WA 98109",
              "boundingBox": {
                "northEast": "47.620954,-122.347601",
                "southWest": "47.620944,-122.348498",
                "entity": "position"
              },
              "extendedPostalCode": "981094621",
              "countrySubdivisionName": "Washington"
            },
            "position": "47.620945,-122.348175"
          }
        ]
      }
    }
  ]
}
Statuskod:
202 
Operation-Location: URL to download the results of the long-running batch request.

Definitioner

Name Description
Address

Resultatets adress
AddressRanges

Beskriver adressintervallet på båda sidor av gatan för ett sökresultat. Koordinater för start- och slutplatserna för adressintervallet ingår.
BatchRequest

Den här typen representerar begärandetexten för Batch-tjänsten.
BatchRequestItem

Batch-begärandeobjekt
BoundingBox

Det visningsområde som täcker resultatet som representeras av koordinaterna överst till vänster och längst ned till höger i visningsområdet.
BoundingBoxCompassNotation

Avgränsningsrutan för platsen.
Brand

Det varumärke som är associerat med POI
Classification

Klassificeringen för den POI som returneras
ClassificationName

Namn på klassificeringen
DataSources

Valfritt avsnitt. Referens-ID:n för användning med API:et Get Search Polygon.
Entity

Entitetstypkälla för avgränsningsrutan. För omvänd geokodning är detta alltid lika med position.
EntryPoint

Startpunkten för den POI som returneras.
EntryPointType

Typ av startpunkt. Värdet kan vara antingen eller mindre.
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Felsvar
GeographicEntityType

Geografientitetstyp. Presentera endast när entityType begärdes och är tillgängligt.
Geometry

Information om resultatets geometriska form. Presentera endast om du skriver == Geografi.
JsonFormat

Önskat format för svaret. Endast json format stöds.
LatLongPairAbbreviated

En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
MatchType

Matchningstyper för en sökåtgärd för omvänd adress.
OperatingHours

Öppettider för en POI (intressepunkter).
OperatingHoursTime

Representerar ett datum och en tid
OperatingHoursTimeRange

Öppet tidsintervall för en dag
PointOfInterest

Information om den returnerade IP-adressen, inklusive information som namn, telefon, URL-adress och klassificeringar.
PointOfInterestCategorySet

POI-kategori
QueryType

Den typ av fråga som returneras: NEARBY eller NON_NEAR.
Response

Resultatet av frågan. SearchAddressResult om frågan har slutförts, annars ErrorResponse.
ReverseSearchAddressBatchItem

Ett objekt som returneras från anropet för omvänd Batch-tjänst för sökadress.
ReverseSearchAddressBatchProcessResult

Det här objektet returneras från ett lyckat tjänstanrop för omvänd batch-sökadress.
SearchAddressResultItem

Resultatobjekt för ett api-svar för sökning.
SearchAddressResultType

En av:

  • Intressepunkt
  • Gata
  • Geografi
  • Punktadress
  • Adressintervall
  • Tvärs över gatan
SearchSummary

Sammanfattningsobjekt för ett api-svar för sökning.
Summary

Sammanfattning av resultatet för batchbegäran

Address

Objekt

Resultatets adress

Name Typ Description
boundingBox

BoundingBoxCompassNotation

Avgränsningsrutan för platsen.
buildingNumber

string

Byggnadens nummer på gatan. INAKTUELL, använd streetNumber i stället.
country

string

namn på land/region
countryCode

string

Land (Obs! Det här är en kod med två bokstäver, inte ett namn på land/region.)
countryCodeISO3

string

ISO alfa-3 landskod
countrySecondarySubdivision

string

Län
countrySubdivision

string

Delstat eller provins
countrySubdivisionCode

string

countrySubdivisionCode prefixet av countryCode ( countryCode-countrySubdivisionCode ) och bindestrecket utgör KODEN ISO 3166-2. Exempel: TX för Texas, SCT för Skottland och ON för Ontario.
countrySubdivisionName

string

Det fullständiga namnet på en första nivå i den administrativa hierarkin för land/region. Det här fältet visas endast om countrySubdivision visas i ett förkortat formulär. Stöds endast för USA, Kanada och Storbritannien.
countryTertiarySubdivision

string

Namngivet område
crossStreet

string

Namnet på gatan som korsas.
extendedPostalCode

string

Utökat postnummer (tillgängligheten är beroende av regionen).
freeformAddress

string

En adressrad formaterad enligt formateringsreglerna för ett resultats ursprungsland/region, eller om det gäller ett land/en region, dess fullständiga namn på land/region.
localName

string

En adresskomponent som representerar namnet på ett geografiskt område eller en lokal plats som grupperar flera adresserbara objekt i adresseringssyfte, utan att vara en administrativ enhet. Det här fältet används för att skapa egenskapen freeformAddress. localName representerar postkommunen. Beroende på platsen är localName det allmänt kända namnet på en stad eller stad. För det allmänt kända namnet på en stad eller stad använder du localName i stället för municipality.
municipality

string

Stad/Stad
Obs! municipality representerar bostadskommunen. Beroende på plats kan värdet för municipality skilja sig från det allmänt kända namnet på en stad eller stad. För det allmänt kända namnet på staden eller staden föreslås det att det localName värdet ska användas i stället för det municipality värdet.
municipalitySubdivision

string

Sub/Super City
neighbourhood

string

Ett grannskap är ett geografiskt lokaliserat område inom en stad eller stad med distinkta egenskaper och sociala interaktioner mellan invånare.
postalCode

string

Postnummer/postnummer
routeNumbers

string[]

De koder som används för att entydigt identifiera gatan
street

string

Gatunamnet. INAKTUELL, använd streetName i stället.
streetName

string

Gatunamnet.
streetNameAndNumber

string

Gatunamnet och numret.
streetNumber

string

Byggnadens nummer på gatan.

AddressRanges

Objekt

Beskriver adressintervallet på båda sidor av gatan för ett sökresultat. Koordinater för start- och slutplatserna för adressintervallet ingår.

Name Typ Description
from

LatLongPairAbbreviated

En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
rangeLeft

string

Adressintervall till vänster på gatan.
rangeRight

string

Adressintervall på höger sida av gatan.
to

LatLongPairAbbreviated

En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".

BatchRequest

Objekt

Den här typen representerar begärandetexten för Batch-tjänsten.

Name Typ Description
batchItems

BatchRequestItem[]

Listan över frågor som ska bearbetas.

BatchRequestItem

Objekt

Batch-begärandeobjekt

Name Typ Description
query

string

Den här parametern innehåller en frågesträng som används för att utföra en ostrukturerad geokodningsåtgärd. Frågesträngen skickas ordagrant till sök-API:et för bearbetning.

BoundingBox

Objekt

Det visningsområde som täcker resultatet som representeras av koordinaterna överst till vänster och längst ned till höger i visningsområdet.

Name Typ Description
btmRightPoint

LatLongPairAbbreviated

En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
topLeftPoint

LatLongPairAbbreviated

En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".

BoundingBoxCompassNotation

Objekt

Avgränsningsrutan för platsen.

Name Typ Description
entity

Entity

Entitetstypkälla för avgränsningsrutan. För omvänd geokodning är detta alltid lika med position.
northEast

string

Nordostlig latitud, longitudkoordinat för avgränsningslådan som kommaavgränsade flyttal
southWest

string

Sydvästlig latitud, longitudkoordinat för avgränsningslådan som kommaavgränsade flyttal

Brand

Objekt

Det varumärke som är associerat med POI

Name Typ Description
name

string

Namnet på varumärket

Classification

Objekt

Klassificeringen för den POI som returneras

Name Typ Description
code

string

Kodegenskap
names

ClassificationName[]

Namnmatris

ClassificationName

Objekt

Namn på klassificeringen

Name Typ Description
name

string

Namnegenskap
nameLocale

string

Namn på språkegenskap

DataSources

Objekt

Valfritt avsnitt. Referens-ID:n för användning med API:et Get Search Polygon.

Name Typ Description
geometry

Geometry

Information om resultatets geometriska form. Presentera endast om du skriver == Geografi.

Entity

Uppräkning

Entitetstypkälla för avgränsningsrutan. För omvänd geokodning är detta alltid lika med position.

Värde Description
position

Position entitet

EntryPoint

Objekt

Startpunkten för den POI som returneras.

Name Typ Description
position

LatLongPairAbbreviated

En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
type

EntryPointType

Typ av startpunkt. Värdet kan vara antingen eller mindre.

EntryPointType

Uppräkning

Typ av startpunkt. Värdet kan vara antingen eller mindre.

Värde Description
main
minor

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.

ErrorResponse

Objekt

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

GeographicEntityType

Uppräkning

Geografientitetstyp. Presentera endast när entityType begärdes och är tillgängligt.

Värde Description
Country

namn på land/region
CountrySecondarySubdivision

Län
CountrySubdivision

Delstat eller provins
CountryTertiarySubdivision

Namngivet område
Municipality

Stad/Stad
MunicipalitySubdivision

Sub/Super City
Neighbourhood

Grannskap
PostalCodeArea

Postnummer/postnummer

Geometry

Objekt

Information om resultatets geometriska form. Presentera endast om du skriver == Geografi.

Name Typ Description
id

string

Skicka detta som geometriId till api:et Get Search Polygon för att hämta geometriinformation för det här resultatet.

JsonFormat

Uppräkning

Önskat format för svaret. Endast json format stöds.

Värde Description
json

JavaScript-objekt notationens datautbytesformat

LatLongPairAbbreviated

Objekt

En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".

Name Typ Description
lat

number (double)

Latitude-egenskap
lon

number (double)

Longitudegenskap

MatchType

Uppräkning

Matchningstyper för en sökåtgärd för omvänd adress.

Värde Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Objekt

Öppettider för en POI (intressepunkter).

Name Typ Description
mode

string

Värde som används i begäran: ingen eller "nextSevenDays"
timeRanges

OperatingHoursTimeRange[]

Lista över tidsintervall för de kommande 7 dagarna

OperatingHoursTime

Objekt

Representerar ett datum och en tid

Name Typ Description
date

string

Representerar aktuellt kalenderdatum i tidszonen POI, t.ex. "2019-02-07".
hour

integer

Timmarna är i 24-timmarsformatet i den lokala tiden för en POI; möjliga värden är 0–23.
minute

integer

Minuter är i den lokala tiden för en POI; möjliga värden är 0–59.

OperatingHoursTimeRange

Objekt

Öppet tidsintervall för en dag

Name Typ Description
endTime

OperatingHoursTime

Punkten inom de kommande 7 dagarnas intervall när en viss POI stängs, eller början av intervallet om den stängdes före intervallet.
startTime

OperatingHoursTime

Punkten under de kommande 7 dagarnas intervall när en viss POI öppnas, eller början av intervallet om den öppnades före intervallet.

PointOfInterest

Objekt

Information om den returnerade IP-adressen, inklusive information som namn, telefon, URL-adress och klassificeringar.

Name Typ Description
brands

Brand[]

Matris för varumärken. Namnet på varumärket för DEN POI som returneras.
categories

string[]

Matris för kategorier
categorySet

PointOfInterestCategorySet[]

Listan över de mest specifika POI-kategorierna
classifications

Classification[]

Klassificeringsmatris
name

string

Namn på poi-egenskapen
openingHours

OperatingHours

Öppettider för en POI (intressepunkter).
phone

string

Telefonnummeregenskap
url

string

Webbplats-URL-egenskap

PointOfInterestCategorySet

Objekt

POI-kategori

Name Typ Description
id

integer

Kategori-ID

QueryType

Uppräkning

Den typ av fråga som returneras: NEARBY eller NON_NEAR.

Värde Description
NEARBY

Sökningen utfördes runt en viss latitud och longitud med en definierad radie
NON_NEAR

Sökningen utfördes globalt, utan bias till en viss latitud och longitud, och ingen definierad radie

Response

Objekt

Resultatet av frågan. SearchAddressResult om frågan har slutförts, annars ErrorResponse.

Name Typ Description
error

ErrorDetail

Felobjektet.
results

SearchAddressResultItem[]

En lista över SÖKRESULTAT.
summary

SearchSummary

Sammanfattningsobjekt för ett api-svar för sökning

ReverseSearchAddressBatchItem

Objekt

Ett objekt som returneras från anropet för omvänd Batch-tjänst för sökadress.

Name Typ Description
response

Response

Resultatet av frågan. SearchAddressReverseResponse om frågan har slutförts, annars ErrorResponse.
statusCode

integer

Statuskod för HTTP-begäran.

ReverseSearchAddressBatchProcessResult

Objekt

Det här objektet returneras från ett lyckat tjänstanrop för omvänd batch-sökadress.

Name Typ Description
batchItems

ReverseSearchAddressBatchItem[]

Matris som innehåller batchresultatet.
summary

Summary

Sammanfattning av resultatet för batchbegäran

SearchAddressResultItem

Objekt

Resultatobjekt för ett api-svar för sökning.

Name Typ Description
address

Address

Resultatets adress
addressRanges

AddressRanges

Beskriver adressintervallet på båda sidor av gatan för ett sökresultat. Koordinater för start- och slutplatserna för adressintervallet ingår.
dataSources

DataSources

Valfritt avsnitt. Referensgeometri-ID för användning med api:et Get Search Polygon.
detourTime

integer

Omvägstid i sekunder. Returnerades endast för anrop till API:et Search Along Route.
dist

number (double)

Rät linjeavstånd mellan resultatet och geobiasplatsen i meter.
entityType

GeographicEntityType

Geografientitetstyp. Presentera endast när entityType begärdes och är tillgängligt.
entryPoints

EntryPoint[]

Matris med EntryPoints. De beskriver de typer av ingångar som är tillgängliga på platsen. Typen kan vara "main" för huvudentréer som en ytterdörr, eller en lobby, och "mindre", för sido- och bakdörrar.
id

string

ID-egenskap
info

string

Information om den ursprungliga datakällan för resultatet. Används för supportbegäranden.
matchType

MatchType

Information om typen av matchning.

En av:

  • AddressPoint
  • HouseNumberRange
  • Gata
poi

PointOfInterest

Information om den returnerade IP-adressen, inklusive information som namn, telefon, URL-adress och klassificeringar.
position

LatLongPairAbbreviated

En plats som representeras som en latitud och longitud med kortnamnen "lat" & "lon".
score

number (double)

Värdet i en resultatuppsättning som anger den relativa matchningspoängen mellan resultaten. Du kan använda detta för att fastställa att resultat x är dubbelt så sannolikt att vara lika relevant som resultat y om värdet för x är 2x värdet för y. Värdena varierar mellan frågor och är endast avsedda som ett relativt värde för en resultatuppsättning.
type

SearchAddressResultType

En av:

  • Intressepunkt
  • Gata
  • Geografi
  • Punktadress
  • Adressintervall
  • Tvärs över gatan
viewport

BoundingBox

Det visningsområde som täcker resultatet som representeras av koordinaterna överst till vänster och längst ned till höger i visningsområdet.

SearchAddressResultType

Uppräkning

En av:

  • Intressepunkt
  • Gata
  • Geografi
  • Punktadress
  • Adressintervall
  • Tvärs över gatan
Värde Description
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchSummary

Objekt

Sammanfattningsobjekt för ett api-svar för sökning.

Name Typ Description
fuzzyLevel

integer

Den maximala fuzzy-nivå som krävs för att ge resultat.
geoBias

LatLongPairAbbreviated

Indikation när den interna sökmotorn har tillämpat en geospatial bias för att förbättra resultatordningen. I vissa metoder kan detta påverkas genom att ange parametrarna lat och lon där det är tillgängligt. I andra fall är det rent internt.
limit

integer

Maximalt antal svar som ska returneras
numResults

integer

Antal resultat i svaret.
offset

integer

Startförskjutningen för de returnerade resultaten i den fullständiga resultatuppsättningen.
query

string

Frågeparametern som användes för att skapa dessa sökresultat.
queryTime

integer

Tid som ägnas åt att lösa frågan, i millisekunder.
queryType

QueryType

Den typ av fråga som returneras: NEARBY eller NON_NEAR.
totalResults

integer

Det totala antalet resultat som hittades.

Summary

Objekt

Sammanfattning av resultatet för batchbegäran

Name Typ Description
successfulRequests

integer

Antal lyckade begäranden i batchen
totalRequests

integer

Totalt antal begäranden i batchen