Search - Post Search Address Reverse Batch

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.0

Służy do wysyłania partii zapytań do interfejsu API odwrotnego adresu Search w jednym żądaniu asynchronicznym.

Interfejs Post Search Address Reverse Batch API to żądanie HTTPPOST, które wysyła partie zapytań do interfejsu API odwrotnego adresu Search w jednym wywołaniu asynchronicznego interfejsu API. Możesz wywołać Post Search Address Reverse Batch interfejs API, 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łą operacją. Oto typowa sekwencja operacji:

Klient wysyła żądanie Search Reverse Batch POST do Azure Maps.

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

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 .
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}

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:

Klient wysyła GET żądanie przy użyciu adresu URL pobierania.
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."
                }
            }
        }
    ]
}

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` format.
api-version	query	True	string	Numer wersji interfejsu API Azure Maps.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Tożsamość Microsoft Entra. 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ń Tożsamość Microsoft Entra w usłudze Azure Maps, zobacz następujące artykuły, aby uzyskać wskazówki.

Treść żądania

Nazwa	Typ	Opis
batchItems	BatchRequestItem[]	Lista zapytań do przetworzenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ReverseSearchAddressBatchProcessResult	OK
202 Accepted		Obsługiwane tylko w przypadku żądania asynchronicznego. Żądanie zaakceptowane: żą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. Nagłówki Location: string
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Nazwa

Typ

Opis

200 OK

ReverseSearchAddressBatchProcessResult

202 Accepted

Obsługiwane tylko w przypadku żądania asynchronicznego. Żądanie zaakceptowane: żą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.

Nagłówki

Location: string

Other Status Codes

ErrorResponse

Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu OAuth 2.0 Microsoft Entra. W 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 konta zasobów Azure Maps 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ęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia 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.

Uwaga

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 Tożsamość Microsoft Entra.
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 Azure Maps zestawu Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.
Aby uzyskać więcej informacji na temat Platforma tożsamości Microsoft, zobacz omówienie Platforma tożsamości Microsoft.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
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.

Typ: apiKey
W: 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 SYGNATURy dostępu współdzielonego.

Typ: apiKey
W: header

Przykłady

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

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
          }
        ]
      }
    }
  ]
}

Kod stanu:: 202

Operation-Location: URL to download the results of the long-running batch request.

Definicje

Nazwa	Opis
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.
BatchRequest	Ten typ reprezentuje treść żądania dla usługi Batch.
BatchRequestItem	Obiekt żądania usługi Batch
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 Get Search Polygon.
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 zażądano parametru entityType i jest dostępny.
Geometry	Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geography.
JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` format.
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 użytkownika, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.
PointOfInterestCategorySet	Kategoria poi
QueryType	Zwracany typ zapytania: NEARBY lub NON_NEAR.
Response	Wynik zapytania. SearchAddressResult, jeśli zapytanie zostało ukończone pomyślnie, błądResponse w przeciwnym razie.
ReverseSearchAddressBatchItem	Element zwrócony z wywołania usługi Search Address Reverse Batch.
ReverseSearchAddressBatchProcessResult	Ten obiekt jest zwracany z pomyślnego wywołania usługi batch Search Address Reverse Batch.
SearchAddressResultItem	Wynik obiektu odpowiedzi interfejsu API Search.
SearchAddressResultType	Jeden z: UM Ulica Lokalizacja geograficzna Adres punktu Zakres adresów Ulica krzyżowa
SearchSummary	Obiekt podsumowania odpowiedzi interfejsu API Search.
Summary	Podsumowanie wyników żądania wsadowego

Address

Adres wyniku

Nazwa	Typ	Opis
boundingBox	BoundingBoxCompassNotation	Pole ograniczenia lokalizacji.
buildingNumber	string	Numer budynku na ulicy. PRZESTARZAŁE, zamiast tego użyj streetNumber.
country	string	nazwa kraju/regionu
countryCode	string	Kraj (Uwaga: jest to dwuliterowy kod, a nie nazwa kraju/regionu).
countryCodeISO3	string	Kod kraju ISO alfa-3
countrySecondarySubdivision	string	Powiat
countrySubdivision	string	Stan lub prowincja
countrySubdivisionCode	string	`countrySubdivisionCode` prefiks ( `countryCode` countryCode-countrySubdivisionCode ) i łącznik tworzy kod ISO 3166-2. Przykłady: TX dla Teksasu, SCT dla Szkocji i ON dla Ontario.
countrySubdivisionName	string	Pełna nazwa pierwszego poziomu hierarchii administracyjnej kraju/regionu. 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/regionu pochodzenia wyniku lub w przypadku kraju/regionu pełna nazwa kraju/regionu.
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 . `localName` reprezentuje gminę pocztową. W zależności od lokalizacji `localName` jest powszechnie znaną nazwą miasta lub miasta. Dla powszechnie znanej nazwy miasta lub miasta użyj `localName` zamiast `municipality`.
municipality	string	Miasto/Miasto Uwaga: `municipality` reprezentuje gminę mieszkaniową. W zależności od lokalizacji `municipality` wartość może różnić się od powszechnie znanej nazwy miasta lub miasta. W przypadku powszechnie znanej nazwy miasta lub miasta zaleca się, aby `localName` wartość była używana zamiast `municipality` wartości.
municipalitySubdivision	string	Sub/Super City
neighbourhood	string	Sąsiedztwo to geograficznie zlokalizowany obszar w mieście lub mieście o charakterystycznych cechach i interakcjach społecznych między mieszkańcami.
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.

Nazwa	Typ	Opis
from	LatLongPairAbbreviated	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	LatLongPairAbbreviated	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

BatchRequest

Ten typ reprezentuje treść żądania dla usługi Batch.

Nazwa	Typ	Opis
batchItems	BatchRequestItem[]	Lista zapytań do przetworzenia.

BatchRequestItem

Obiekt żądania usługi Batch

Nazwa	Typ	Opis
query	string	Ten parametr zawiera ciąg zapytania używany do wykonywania operacji geokodowania bez struktury. Ciąg zapytania zostanie przekazany dosłownie do interfejsu API wyszukiwania na potrzeby przetwarzania.

BoundingBox

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

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

BoundingBoxCompassNotation

Pole ograniczenia lokalizacji.

Nazwa	Typ	Opis
entity	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

Nazwa	Typ	Opis
name	string	Nazwa marki

Classification

Klasyfikacja zwracanego interfejsu użytkownika

Nazwa	Typ	Opis
code	string	Właściwość Code
names	ClassificationName[]	Tablica nazw

ClassificationName

Nazwa klasyfikacji

Nazwa	Typ	Opis
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 Get Search Polygon.

Nazwa	Typ	Opis
geometry	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.

Nazwa	Typ	Opis
position	string	Pozycja jednostki

EntryPoint

Punkt wejścia dla zwracanego punktu weryfikacji koncepcji.

Nazwa	Typ	Opis
position	LatLongPairAbbreviated	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
type	EntryPointType	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.

Nazwa	Typ	Opis
main	string
minor	string

ErrorAdditionalInfo

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

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

GeographicEntityType

Typ jednostki Geografia. Występuje tylko wtedy, gdy zażądano parametru entityType i jest dostępny.

Nazwa	Typ	Opis
Country	string	nazwa kraju/regionu
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.

Nazwa	Typ	Opis
id	string	Przekaż go jako geometryId do interfejsu API Get Search Polygon, aby pobrać informacje o geometrii dla tego wyniku.

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko json format.

Nazwa	Typ	Opis
json	string	Format wymiany danych notacji obiektów JavaScript

LatLongPairAbbreviated

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

Nazwa	Typ	Opis
lat	number	Właściwość Szerokość geograficzna
lon	number	Właściwość Długość geograficzna

MatchType

Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.

Nazwa	Typ	Opis
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

Godziny otwarcia dla weryfikacji koncepcji (punkty orientacyjne).

Nazwa	Typ	Opis
mode	string	Wartość używana w żądaniu: brak lub "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Lista zakresów czasu dla następnych 7 dni

OperatingHoursTime

Reprezentuje datę i godzinę

Nazwa	Typ	Opis
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 poi; możliwe wartości to 0–23.
minute	integer	Minuty są w czasie lokalnym interfejsu użytkownika; możliwe wartości to 0–59.

OperatingHoursTimeRange

Zakres czasu otwierania na dzień

Nazwa	Typ	Opis
endTime	OperatingHoursTime	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	OperatingHoursTime	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 użytkownika, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.

Nazwa	Typ	Opis
brands	Brand[]	Tablica marek. Nazwa marki zwracanej przez weryfikację koncepcji.
categories	string[]	Tablica kategorii
categorySet	PointOfInterestCategorySet[]	Lista najbardziej określonych kategorii poi
classifications	Classification[]	Tablica klasyfikacji
name	string	Nazwa właściwości POI
openingHours	OperatingHours	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

Nazwa	Typ	Opis
id	integer	Identyfikator kategorii

QueryType

Zwracany typ zapytania: NEARBY lub NON_NEAR.

Nazwa	Typ	Opis
NEARBY	string	Search wykonano wokół określonej szerokości i długości geograficznej ze zdefiniowanym promieniem
NON_NEAR	string	Search wykonano globalnie bez uprzedzeń do określonej szerokości i długości geograficznej oraz bez zdefiniowanego promienia

Response

Wynik zapytania. SearchAddressResult, jeśli zapytanie zostało ukończone pomyślnie, błądResponse w przeciwnym razie.

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.
results	SearchAddressResultItem[]	Lista wyników interfejsu API Search.
summary	SearchSummary	Obiekt podsumowania odpowiedzi interfejsu API Search

ReverseSearchAddressBatchItem

Element zwrócony z wywołania usługi Search Address Reverse Batch.

Nazwa	Typ	Opis
response	Response	Wynik zapytania. SearchAddressReverseResponse, jeśli zapytanie zakończyło się 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 Search Address Reverse Batch.

Nazwa	Typ	Opis
batchItems	ReverseSearchAddressBatchItem[]	Tablica zawierająca wyniki wsadowe.
summary	Summary	Podsumowanie wyników żądania wsadowego

SearchAddressResultItem

Wynik obiektu odpowiedzi interfejsu API Search.

Nazwa	Typ	Opis
address	Address	Adres wyniku
addressRanges	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.
dataSources	DataSources	Sekcja opcjonalna. Dokumentacja identyfikatora geometrii do użycia z interfejsem API Get Search Polygon.
detourTime	integer	Czas objazdu w sekundach. Zwracane tylko w przypadku wywołań interfejsu API Search Wzdłuż trasy.
dist	number	Odległość linii prostej między wynikiem a lokalizacją geobiazy w metrach.
entityType	GeographicEntityType	Typ jednostki Geografia. Występuje tylko wtedy, gdy zażądano parametru entityType i jest dostępny.
entryPoints	EntryPoint[]	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	MatchType	Informacje o typie dopasowania. Jeden z: Punkt adresu HouseNumberRange Ulica
poi	PointOfInterest	Szczegóły zwróconego interfejsu użytkownika, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.
position	LatLongPairAbbreviated	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 użyć tej funkcji, aby określić, że wynik x jest dwa razy bardziej prawdopodobny w wyniku y, jeśli wartość x jest 2x wartością y. Wartości różnią się między zapytaniami i są przeznaczone tylko jako wartość względna dla jednego zestawu wyników.
type	SearchAddressResultType	Jeden z: UM Ulica Lokalizacja geograficzna Adres punktu Zakres adresów Ulica krzyżowa
viewport	BoundingBox	Port widoków, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu panelu widoków.

SearchAddressResultType

Jeden z:

UM
Ulica
Lokalizacja geograficzna
Adres punktu
Zakres adresów
Ulica krzyżowa

Nazwa	Typ	Opis
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchSummary

Obiekt podsumowania odpowiedzi interfejsu API Search.

Nazwa	Typ	Opis
fuzzyLevel	integer	Maksymalny poziom rozmyty wymagany do dostarczenia wyników.
geoBias	LatLongPairAbbreviated	Wskazanie, kiedy wewnętrzna wyszukiwarka zastosowała stronniczość geoprzestrzenną, aby poprawić klasyfikację wyników. W niektórych metodach może to mieć wpływ na ustawienie parametrów 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	QueryType	Zwracany typ zapytania: NEARBY lub NON_NEAR.
totalResults	integer	Łączna liczba znalezionych wyników.

Summary

Podsumowanie wyników żądania wsadowego

Nazwa	Typ	Opis
successfulRequests	integer	Liczba żądań zakończonych powodzeniem w partii
totalRequests	integer	Łączna liczba żądań w partii

Udostępnij za pośrednictwem

Search - Post Search Address Reverse Batch

Przesyłanie synchronicznego żądania wsadowego

Przesyłanie asynchronicznego żądania usługi Batch

Treść POST dla żądania wsadowego

Pobieranie asynchronicznych wyników usługi Batch

Model odpowiedzi wsadowej

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

AADToken

Zakresy

subscription-key

SAS Token

Przykłady

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

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Address

AddressRanges

BatchRequest

BatchRequestItem

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

JsonFormat

LatLongPairAbbreviated

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

Response

ReverseSearchAddressBatchItem

ReverseSearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary

Dodatkowe zasoby