Search - Get Search Address Reverse Batch

Interfejs API odwrotnej partii adresu wyszukiwania

Dotyczy: zobacz warstwy cenowe.

Interfejs API usługi Batch adresu wyszukiwania wysyła partie zapytań do interfejsu API odwrotnego wyszukiwania przy użyciu tylko jednego wywołania interfejsu API. Możesz wywołać interfejs API odwrotnej partii wyszukiwania, aby uruchomić asynchronicznie (asynchronicznie) lub synchronicznie (synchronizacja). Interfejs API asynchroniczny umożliwia wywołaniu wsadowe do 10 000 zapytań i synchronizowanie interfejsu API do 100 zapytań.

Przesyłanie synchronicznego żądania wsadowego

Interfejs API synchroniczny jest zalecany w przypadku lekkich żądań wsadowych. Gdy usługa otrzyma żądanie, odpowie zaraz po obliczeniu elementów wsadowych i nie będzie możliwości późniejszego pobrania wyników. Interfejs API synchroniczny zwróci błąd przekroczenia limitu czasu (odpowiedź 408), jeśli żądanie trwa dłużej niż 60 sekund. Liczba elementów wsadowych jest ograniczona do 100 dla tego interfejsu API.

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

Przesyłanie asynchronicznego żądania usługi Batch

Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych ilości stosunkowo złożonych żądań wyszukiwania

  • Umożliwia pobieranie wyników w osobnym wywołaniu (możliwe jest wiele pobierania).
  • Interfejs API asynchroniczny jest zoptymalizowany pod kątem niezawodności i nie oczekuje się przekroczenia limitu czasu.
  • Liczba elementów wsadowych jest ograniczona do 10 000 dla tego interfejsu API.

Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wzdłuż adresu URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Odpowiedzi asynchroniczne są przechowywane przez 14 dni. Adres URL przekierowania zwraca odpowiedź 404, jeśli zostanie użyta po upływie okresu wygaśnięcia.

Należy pamiętać, że żądanie asynchroniczne wsadowe jest długotrwałym żądaniem. Oto typowa sekwencja operacji:

  1. Klient wysyła żądanie wsadowe adresu POST wyszukiwania do Azure Maps

  2. Serwer odpowie na jedną z następujących czynności:

    HTTP 202 Accepted — żądanie usługi Batch zostało zaakceptowane.

    HTTP Error — wystąpił błąd podczas przetwarzania żądania usługi Batch. Może to być 400 Bad Request inny kod stanu lub inny Error .

  3. Jeśli żądanie wsadowe zostało zaakceptowane pomyślnie, Location nagłówek w odpowiedzi zawiera adres URL umożliwiający pobranie wyników żądania wsadowego. Ten identyfikator URI stanu wygląda następująco:

    GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Klient wystawia GET żądanie na adres URL pobierania uzyskany w kroku 3 w celu pobrania wyników wsadowych.

Treść POST dla żądania wsadowego

Aby wysłać zapytania odwrotne dotyczące adresu wyszukiwania , użyj POST żądania, w którym treść żądania będzie zawierać tablicę batchItems w json formacie, a Content-Type nagłówek zostanie ustawiony na application/jsonwartość . Oto przykładowa treść żądania zawierająca 5 zapytań zwrotnych adresów wyszukiwania :

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

Zapytanie odwrotne adresu wyszukiwania w partii jest tylko częściowym adresem URL bez protokołu, podstawowego adresu URL, ścieżki, wersji interfejsu API i klucza subskrypcji. Może on akceptować dowolny z obsługiwanych parametrów identyfikatora URIodwrotnego adresu wyszukiwania. Wartości ciągu w zapytaniu zwrotnym adresu wyszukiwania muszą być prawidłowo uniknięte (np. znak " powinien zostać uniknięty za pomocą znaku \ ), a także powinien być prawidłowo zakodowany pod adresem URL.

Interfejs API asynchroniczny umożliwia wywołaniu wsadowe do 10 000 zapytań i synchronizowanie interfejsu API do 100 zapytań, a partia powinna zawierać co najmniej 1 zapytanie.

Pobieranie asynchronicznych wyników usługi Batch

Aby pobrać wyniki asynchronicznego pobierania wsadowego, należy wysłać GET żądanie do punktu końcowego pobierania wsadowego. Ten adres URL pobierania można uzyskać z Location nagłówka pomyślnego POST żądania wsadowego i wygląda następująco:

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

Oto typowa sekwencja operacji pobierania wyników wsadowych:

  1. Klient wysyła GET żądanie przy użyciu adresu URL pobierania.

  2. Serwer odpowie na jedną z następujących czynności:

    HTTP 202 Accepted — żądanie usługi Batch zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie w pewnym czasie.

    HTTP 200 OK — pomyślnie przetworzone żądanie usługi Batch. Treść odpowiedzi zawiera wszystkie wyniki wsadowe.

Model odpowiedzi wsadowej

Zwrócona zawartość danych jest podobna do żądań asynchronicznych i synchronizacji. Podczas pobierania wyników asynchronicznego żądania wsadowego, jeśli partia zakończyła przetwarzanie, treść odpowiedzi zawiera odpowiedź wsadową. Ta odpowiedź wsadowa summary zawiera składnik wskazujący, że były one częścią oryginalnego żądania wsadowego totalRequests , czyli successfulRequestszapytań, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę zawierającą batchItems odpowiedź dla każdego zapytania w żądaniu wsadowym. Element batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element w elemencie batchItems zawiera statusCode i response pola. Każdy response element w batchItems jest jednym z następujących typów:

  • SearchAddressReverseResponse — Jeśli zapytanie zostało ukończone pomyślnie.

  • Error — Jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać element code i message w tym przypadku.

Oto przykładowa odpowiedź wsadowa z wynikiem pomyślnym 2 i 1 niepowodzeniem :

{
    "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."
                }
            }
        }
    ]
}
GET https://atlas.microsoft.com/search/address/reverse/batch/{format}?api-version=1.0

Parametry identyfikatora URI

Name In Required Type Description
format
path True
  • string

Identyfikator usługi Batch do wykonywania zapytań dotyczących operacji.

api-version
query True
  • string

Numer wersji interfejsu API Azure Maps.

Nagłówek żądania

Name Required Type Description
x-ms-client-id
  • string

Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Azure AD. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby użyć zabezpieczeń Azure AD w usłudze Azure Maps zapoznaj się z następującymi artykułami, aby uzyskać wskazówki.

Odpowiedzi

Name Type Description
200 OK

OK

202 Accepted

Obsługiwane tylko w przypadku żądania asynchronicznego. Zaakceptowano żądanie: żądanie zostało zaakceptowane do przetwarzania. Użyj adresu URL w nagłówku lokalizacji, aby ponowić próbę lub uzyskać dostęp do wyników.

Headers

  • Location: string
Other Status Codes

Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy OAuth2 usługi Azure Active Directory . Po połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego Azure Maps konta zasobu lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

  • Ta definicja zabezpieczeń wymaga użycia nagłówkax-ms-client-id, aby wskazać, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje usługi Azure Active Directory. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

  • Obecnie usługa Azure Active Directory w wersji 1.0 lub 2.0 obsługuje konta służbowe, szkolne i gości, ale nie obsługują kont osobistych.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenia konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST Azure Maps w celu bezpiecznego przechowywania klucza.

Type: apiKey
In: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.

Type: apiKey
In: header

Przykłady

A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries

Sample Request

GET https://atlas.microsoft.com/search/address/reverse/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

Sample Response

{
  "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",
              "countrySubdivision": "Î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",
              "countrySubdivision": "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",
              "countrySubdivision": "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"
          }
        ]
      }
    }
  ]
}

Definicje

Address

Adres wyniku

AddressRanges

Opisuje zakres adresów po obu stronach ulicy dla wyniku wyszukiwania. Uwzględniane są współrzędne dla lokalizacji początkowej i końcowej zakresu adresów.

BoundingBox

Port widoków, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu panelu widoków.

BoundingBoxCompassNotation

Pole ograniczenia lokalizacji.

Brand

Marka skojarzona z interfejsem POI

Classification

Klasyfikacja zwracanego interfejsu użytkownika

ClassificationName

Nazwa klasyfikacji

DataSources

Sekcja opcjonalna. Identyfikatory odwołań do użycia z interfejsem API pobierania wielokąta wyszukiwania .

Entity

Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji.

EntryPoint

Punkt wejścia dla zwracanego punktu weryfikacji koncepcji.

EntryPointType

Typ punktu wejścia. Wartość może być główna lub pomocnicza.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

GeographicEntityType

Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna.

Geometry

Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geography.

LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

MatchType

Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.

OperatingHours

Godziny otwarcia dla weryfikacji koncepcji (punkty orientacyjne).

OperatingHoursTime

Reprezentuje datę i godzinę

OperatingHoursTimeRange

Zakres czasu otwierania na dzień

PointOfInterest

Szczegóły zwróconego interfejsu poI, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.

PointOfInterestCategorySet

Kategoria poi

QueryType

Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.

Response

Wynik zapytania. SearchAddressResponse, jeśli zapytanie zostało zakończone pomyślnie, BłądResponse w przeciwnym razie.

ReverseSearchAddressBatchItem

Element zwrócony z wywołania usługi Reverse Batch z adresu wyszukiwania.

ReverseSearchAddressBatchProcessResult

Ten obiekt jest zwracany z pomyślnego wywołania usługi Batch odwrotnego adresu wyszukiwania.

SearchAddressResultItem

Obiekt wynikowy odpowiedzi interfejsu API wyszukiwania.

SearchAddressResultType

Jeden z:

  • Um
  • Ulica
  • Lokalizacja geograficzna
  • Adres punktu
  • Zakres adresów
  • Cross Street
SearchSummary

Obiekt podsumowania odpowiedzi interfejsu API wyszukiwania.

Summary

Podsumowanie wyników żądania wsadowego

Address

Adres wyniku

Name Type Description
boundingBox

Pole ograniczenia lokalizacji.

buildingNumber
  • string

Numer budynku na ulicy. PRZESTARZAŁE, zamiast tego użyj streetNumber.

country
  • string

Nazwa kraju

countryCode
  • string

Kraj (Uwaga: jest to dwuliterowy kod, a nie nazwa kraju).

countryCodeISO3
  • string

Kod kraju ISO alfa-3

countrySecondarySubdivision
  • string

Powiat

countrySubdivision
  • string

Stan lub prowincja

countrySubdivisionName
  • string

Pełna nazwa pierwszego poziomu hierarchii administracyjnej kraju. To pole jest wyświetlane tylko w przypadku, gdy countrySubdivision jest przedstawiany w skróconej formie. Obsługiwane tylko w przypadku Stanów Zjednoczonych, Kanady i Wielkiej Brytanii.

countryTertiarySubdivision
  • string

Nazwany obszar

crossStreet
  • string

Nazwa ulicy, która jest przekraczana.

extendedPostalCode
  • string

Rozszerzony kod pocztowy (dostępność zależy od regionu).

freeformAddress
  • string

Wiersz adresu sformatowany zgodnie z regułami formatowania kraju pochodzenia wyniku lub w przypadku kraju, jego pełnej nazwy kraju.

localName
  • string

Składnik adresu, który reprezentuje nazwę obszaru geograficznego lub lokalizacji, który grupuje wiele obiektów adresowalnych na potrzeby adresowania, bez jednostki administracyjnej. To pole służy do kompilowania freeformAddress właściwości .

municipality
  • string

Miasto/Miasto

municipalitySubdivision
  • string

Sub/Super City

postalCode
  • string

Kod pocztowy/kod pocztowy

routeNumbers
  • string[]

Kody używane do jednoznacznej identyfikacji ulicy

street
  • string

Nazwa ulicy. PRZESTARZAŁE, zamiast tego użyj nazwy streetName.

streetName
  • string

Nazwa ulicy.

streetNameAndNumber
  • string

Nazwa i numer ulicy.

streetNumber
  • string

Numer budynku na ulicy.

AddressRanges

Opisuje zakres adresów po obu stronach ulicy dla wyniku wyszukiwania. Uwzględniane są współrzędne dla lokalizacji początkowej i końcowej zakresu adresów.

Name Type Description
from

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

rangeLeft
  • string

Zakres adresów po lewej stronie ulicy.

rangeRight
  • string

Zakres adresów po prawej stronie ulicy.

to

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

BoundingBox

Port widoków, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu panelu widoków.

Name Type Description
btmRightPoint

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

topLeftPoint

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

BoundingBoxCompassNotation

Pole ograniczenia lokalizacji.

Name Type Description
entity

Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji.

northEast
  • string

Szerokość geograficzna północno-wschodnia, współrzędna długości geograficznej pola ograniczenia jako rozdzielane przecinkami liczby zmiennoprzecinkowe

southWest
  • string

Szerokość geograficzna południowo-zachodnia,współrzędna długości geograficznej pola ograniczenia jako rozdzielane przecinkami liczby zmiennoprzecinkowe

Brand

Marka skojarzona z interfejsem POI

Name Type Description
name
  • string

Nazwa marki

Classification

Klasyfikacja zwracanego interfejsu użytkownika

Name Type Description
code
  • string

Właściwość Code

names

Tablica nazw

ClassificationName

Nazwa klasyfikacji

Name Type Description
name
  • string

Name — Właściwość

nameLocale
  • string

Nazwa właściwości ustawień regionalnych

DataSources

Sekcja opcjonalna. Identyfikatory odwołań do użycia z interfejsem API pobierania wielokąta wyszukiwania .

Name Type Description
geometry

Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geography.

Entity

Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji.

Name Type Description
position
  • string

Pozycja jednostki

EntryPoint

Punkt wejścia dla zwracanego punktu weryfikacji koncepcji.

Name Type Description
position

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

type

Typ punktu wejścia. Wartość może być główna lub pomocnicza.

EntryPointType

Typ punktu wejścia. Wartość może być główna lub pomocnicza.

Name Type Description
main
  • string
minor
  • string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Name Type Description
info
  • object

Dodatkowe informacje.

type
  • string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Name Type Description
additionalInfo

Dodatkowe informacje o błędzie.

code
  • string

Kod błędu.

details

Szczegóły błędu.

message
  • string

Komunikat o błędzie.

target
  • string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Name Type Description
error

Obiekt błędu.

GeographicEntityType

Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna.

Name Type Description
Country
  • string

Nazwa kraju

CountrySecondarySubdivision
  • string

Powiat

CountrySubdivision
  • string

Stan lub prowincja

CountryTertiarySubdivision
  • string

Nazwany obszar

Municipality
  • string

Miasto /Miasto

MunicipalitySubdivision
  • string

Sub / Super City

Neighbourhood
  • string

Sąsiedztwa

PostalCodeArea
  • string

Kod pocztowy/kod pocztowy

Geometry

Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geography.

Name Type Description
id
  • string

Przekaż go jako geometryId do interfejsu API pobierania wielokąta wyszukiwania , aby pobrać informacje o geometrii dla tego wyniku.

LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

Name Type Description
lat
  • number

Właściwość Szerokość geograficzna

lon
  • number

Właściwość Długość geograficzna

MatchType

Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.

Name Type Description
AddressPoint
  • string
HouseNumberRange
  • string
Street
  • string

OperatingHours

Godziny otwarcia dla weryfikacji koncepcji (punkty orientacyjne).

Name Type Description
mode
  • string

Wartość używana w żądaniu: brak lub "nextSevenDays"

timeRanges

Lista zakresów czasu dla następnych 7 dni

OperatingHoursTime

Reprezentuje datę i godzinę

Name Type Description
date
  • string

Reprezentuje bieżącą datę kalendarza w strefie czasowej POI, np. "2019-02-07".

hour
  • integer

Godziny są w formacie 24 godziny w czasie lokalnym weryfikacji koncepcji; możliwe wartości to 0–23.

minute
  • integer

Minuty są w czasie lokalnym weryfikacji koncepcji; możliwe wartości to 0–59.

OperatingHoursTimeRange

Zakres czasu otwierania na dzień

Name Type Description
endTime

Punkt w ciągu najbliższych 7 dni od momentu zamknięcia danego interfejsu wiersza polecenia lub początku zakresu, jeśli został zamknięty przed zakresem.

startTime

Punkt w ciągu najbliższych 7 dni od otwarcia danego interfejsu wiersza polecenia lub początku zakresu, jeśli został otwarty przed zakresem.

PointOfInterest

Szczegóły zwróconego interfejsu poI, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.

Name Type Description
brands

Tablica marek. Nazwa marki zwracanej przez weryfikację koncepcji.

categories
  • string[]

Tablica kategorii

categorySet

Lista najbardziej określonych kategorii poi

classifications

Tablica klasyfikacji

name
  • string

Nazwa właściwości POI

openingHours

Godziny otwarcia dla weryfikacji koncepcji (punkty orientacyjne).

phone
  • string

Właściwość numeru telefonu

url
  • string

Właściwość adresu URL witryny sieci Web

PointOfInterestCategorySet

Kategoria poi

Name Type Description
id
  • integer

Identyfikator kategorii

QueryType

Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.

Name Type Description
NEARBY
  • string

Wyszukiwanie zostało wykonane wokół określonej szerokości geograficznej i długości geograficznej ze zdefiniowanym promieniem

NON_NEAR
  • string

Wyszukiwanie zostało wykonane globalnie bez uprzedzeń do określonej szerokości geograficznej i długości geograficznej i bez zdefiniowanego promienia

Response

Wynik zapytania. SearchAddressResponse, jeśli zapytanie zostało zakończone pomyślnie, BłądResponse w przeciwnym razie.

Name Type Description
error

Obiekt błędu.

results

Lista wyników interfejsu API wyszukiwania.

summary

Obiekt podsumowania odpowiedzi interfejsu API wyszukiwania

ReverseSearchAddressBatchItem

Element zwrócony z wywołania usługi Reverse Batch z adresu wyszukiwania.

Name Type Description
response

Wynik zapytania. SearchAddressReverseResponse, jeśli zapytanie zostało zakończone pomyślnie, BłądResponse w przeciwnym razie.

statusCode
  • integer

Kod stanu żądania HTTP.

ReverseSearchAddressBatchProcessResult

Ten obiekt jest zwracany z pomyślnego wywołania usługi Batch odwrotnego adresu wyszukiwania.

Name Type Description
batchItems

Tablica zawierająca wyniki wsadowe.

summary

Podsumowanie wyników żądania wsadowego

SearchAddressResultItem

Obiekt wynikowy odpowiedzi interfejsu API wyszukiwania.

Name Type Description
address

Adres wyniku

addressRanges

Opisuje zakres adresów po obu stronach ulicy dla wyniku wyszukiwania. Uwzględniane są współrzędne dla lokalizacji początkowych i końcowych zakresu adresów.

dataSources

Sekcja opcjonalna. Identyfikator geometrii odwołania do użycia z interfejsem API pobierania wielokąta wyszukiwania .

detourTime
  • integer

Czas objazdu w sekundach. Zwracane tylko dla wywołań interfejsu API wyszukiwania wzdłuż trasy.

dist
  • number

Odległość linii prostej między lokalizacją wyniku a geobiasami w metrach.

entityType

Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna.

entryPoints

Tablica punktów wejścia. Opisują one typy wejść dostępnych w lokalizacji. Typ może być "główny" dla głównych wejść, takich jak drzwi wejściowe, lub hol, i "drobne", dla drzwi bocznych i tylnych.

id
  • string

Właściwość Id

info
  • string

Informacje o oryginalnym źródle danych wyniku. Służy do obsługi żądań pomocy technicznej.

matchType

Informacje o typie dopasowania.

Jeden z:

  • Punkt adresowy
  • HouseNumberRange
  • Ulica
poi

Szczegóły zwróconego interfejsu poI, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.

position

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

score
  • number

Wartość w zestawie wyników wskazująca względny wynik dopasowania między wynikami. Można to użyć, aby określić, że wynik x jest dwa razy bardziej prawdopodobny w wyniku y, jeśli wartość x wynosi 2x wartość y. Wartości różnią się między zapytaniami i są przeznaczone tylko jako wartość względna dla jednego zestawu wyników.

type

Jeden z:

  • Um
  • Ulica
  • Lokalizacja geograficzna
  • Adres punktu
  • Zakres adresów
  • Cross Street
viewport

Widokport, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu portu widoku.

SearchAddressResultType

Jeden z:

  • Um
  • Ulica
  • Lokalizacja geograficzna
  • Adres punktu
  • Zakres adresów
  • Cross Street
Name Type Description
Address Range
  • string
Cross Street
  • string
Geography
  • string
POI
  • string
Point Address
  • string
Street
  • string

SearchSummary

Obiekt podsumowania odpowiedzi interfejsu API wyszukiwania.

Name Type Description
fuzzyLevel
  • integer

Maksymalny poziom rozmyty wymagany do udostępnienia wyników.

geoBias

Wskazanie, kiedy wewnętrzna wyszukiwarka zastosowała stronniczość geoprzestrzenną, aby poprawić klasyfikację wyników. W niektórych metodach może to mieć wpływ, ustawiając parametry lat i lon, jeśli są dostępne. W innych przypadkach jest to wyłącznie wewnętrzne.

limit
  • integer

Maksymalna liczba odpowiedzi, które zostaną zwrócone

numResults
  • integer

Liczba wyników w odpowiedzi.

offset
  • integer

Przesunięcie początkowe zwróconych wyników w pełnym zestawie wyników.

query
  • string

Parametr zapytania, który został użyty do wygenerowania tych wyników wyszukiwania.

queryTime
  • integer

Czas spędzony na rozpoznawaniu zapytania w milisekundach.

queryType

Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.

totalResults
  • integer

Łączna liczba znalezionych wyników.

Summary

Podsumowanie wyników żądania wsadowego

Name Type Description
successfulRequests
  • integer

Liczba pomyślnych żądań w partii

totalRequests
  • integer

Łączna liczba żądań w partii