Udostępnij za pośrednictwem


Search - Get Search Fuzzy

Użyj polecenia , jeśli potrzebujesz żądania wyszukiwania, które może obsługiwać kombinacje adresów i tokenów poi.

Interfejs Get Search Fuzzy API (dowolny formularz Search) — żądanie HTTPGET, które bezproblemowo obsługuje kombinację wyszukiwania poi i geokodowania. Jest to dowolny interfejs API Search formularza, który obsługuje rozmyte dane wejściowe zawierające dowolną kombinację tokenów adresu lub interfejsu POI jako kanoniczne "wyszukiwanie w jednym wierszu". Może być również ważony położeniem kontekstowym (parą lat/lon) lub w pełni ograniczonym przez współrzędną i promień albo można go wykonać bardziej ogólnie bez żadnego geostronnego punktu zakotwiczenia.

Zdecydowanie zalecamy użycie parametru "countrySet" w celu określenia tylko krajów/regionów, dla których aplikacja wymaga pokrycia, ponieważ domyślne zachowanie będzie dotyczyć przeszukiwania całego świata, co może spowodować zwrócenie niepotrzebnych wyników.

Np.: countrySet=US,FR

Aby uzyskać pełną listę wszystkich obsługiwanych krajów/regionów, zobacz Search Pokrycie.

Większość Search zapytania domyślne maxFuzzyLevel= 2, aby uzyskać wydajność, a także zmniejszyć nietypowe wyniki. To nowe ustawienie domyślne można przesłonić zgodnie z potrzebami dla żądania, przekazując parametr maxFuzzyLevelzapytania =3 lub 4.

GET https://atlas.microsoft.com/search/fuzzy/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/fuzzy/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&minFuzzyLevel={minFuzzyLevel}&maxFuzzyLevel={maxFuzzyLevel}&idxSet={idxSet}&brandSet={brandSet}&connectorSet={connectorSet}&entityType={entityType}&view={view}&openingHours=nextSevenDays

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
format
path True

ResponseFormat

Żądany format odpowiedzi. Wartość może być json lub xml.

api-version
query True

string

Numer wersji interfejsu API Azure Maps.

query
query True

string

Odpowiedni ciąg zapytania (np. "seattle", "pizza"). Można również określić jako ciąg rozdzielany przecinkami składający się z szerokości geograficznej, po której następuje długość geograficzna (np. "47.641268, -122.125679"). Musi być poprawnie zakodowany adres URL.

brandSet
query

string[]

Rozdzielona przecinkami lista nazw marek, których można użyć do ograniczenia wyniku do określonych marek. Kolejność elementów nie ma znaczenia. Po udostępnieniu wielu marek zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list. Marki, które zawierają "", w ich nazwie powinny być umieszczane w cudzysłowie.

Przykłady użycia:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Przecinek",Bar

btmRight
query

string

Prawe dolne położenie pola ograniczenia. Np. 37.553,-122.453

categorySet
query

integer[]

Rozdzielona przecinkami lista identyfikatorów zestawów kategorii, których można użyć do ograniczenia wyniku do określonych kategorii Punktów orientacyjnych. Kolejność identyfikatorów nie ma znaczenia. Maksymalna liczba obsługiwanych categorySet wartości na żądanie wynosi 10. Po podaniu wielu identyfikatorów kategorii zostaną zwrócone tylko elementy POI należące do (co najmniej) jednej z kategorii z podanej listy. Listę obsługiwanych kategorii można odnaleźć przy użyciu interfejsu API kategorii weryfikacji koncepcji. Przykłady użycia:

  • categorySet=7315 (Search Punkty orientacyjne z kategorii Restauracja)

  • categorySet=7315025,7315017 (Search Punkty orientacyjne kategorii włoskiej lub francuskiej restauracji)

connectorSet
query

ElectricVehicleConnector[]

Rozdzielona przecinkami lista typów łączników, których można użyć do ograniczenia wyniku do stacji pojazdów elektrycznych obsługujących określone typy łączników. Kolejność elementów nie ma znaczenia. Po podaniu wielu typów łączników zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list.

Dostępne typy łączników to:

  • StandardHouseholdCountrySpecific - Są to standardowe łączniki gospodarstw domowych dla określonego regionu. Wszystkie są one pojedynczą fazą AC i standardowym napięciem i standardowym amperażem. Zobacz też: Podłączanie typów gniazd & — światowe standardy.
  • IEC62196Type1 - Typ 1 łącznik zdefiniowany w standardzie IEC 62196-2. Nazwany również Yazaki po oryginalnym producencie lub SAE J1772 po standardzie, który po raz pierwszy go opublikował. Najczęściej używane w połączeniu z pojedynczą fazą 120V lub maksymalnie 240V infrastruktury jednofazowej.
  • IEC62196Type1CCS - Łącznik kombi oparty na typie 1, zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 1, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie DC.
  • IEC62196Type2CableAttached - Łącznik typu 2 zdefiniowany w standardzie IEC 62196-2. Dostarczone jako kabel i podłączona do punktu ładowania.
  • IEC62196Type2Outlet - Łącznik typu 2 zdefiniowany w standardzie IEC 62196-2. Dostarczone jako gniazdo ustawione w punkcie ładowania.
  • IEC62196Type2CCS - Łącznik kombi oparty na typie 2, zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 2, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie DC.
  • IEC62196Type3 - Łącznik typu 3 zdefiniowany w standardzie IEC 62196-2. Również o nazwie Scame po oryginalnym producencie. Najczęściej używane w połączeniu z maksymalnie 240V pojedynczą fazą lub maksymalnie 420V infrastruktury trójfazowej.
  • Chademo - Łącznik CHAdeMO o nazwie od stowarzyszenia utworzonego przez Tokyo Electric Power Company i partnerów przemysłowych. Z tego powodu jest również znany jako łącznik TEPCO. Obsługuje szybkie ładowanie dc.
  • IEC60309AC1PhaseBlue - Łącznik Przemysłowy Niebieski jest łącznikiem zdefiniowanym w standardzie IEC 60309. Czasami jest określany przez połączenie standardu, koloru i faktu, że jest to łącznik z jedną fazą. Łącznik zwykle ma konfigurację "P+N+E, 6h".
  • IEC60309DCWhite - Łącznik przemysłowy Biały jest łącznikiem DC zdefiniowanym w standardzie IEC 60309.
  • Tesla - Łącznik Tesli jest regionalnie specyficzny łącznik Tesla Supercharger. Oznacza to, że odnosi się do zastrzeżonego łącznika Tesli, czasami określanego jako Tesla Port, głównie ograniczone do Ameryka Północna lub zmodyfikowanego typu 2 (DC nad typem 2) w Europie.

Przykłady użycia:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

countrySet
query

string[]

Rozdzielony przecinkami ciąg kodów kraju/regionu, np. FR,ES. Spowoduje to ograniczenie wyszukiwania do określonych krajów/regionów

entityType
query

GeographicEntityType

Określa poziom filtrowania wykonywanego w lokalizacjach geograficznych. Zawęża wyszukiwanie określonych typów jednostek geograficznych, np. zwraca tylko gminę. Wynikowa odpowiedź będzie zawierać identyfikator geografii, a także typ jednostki dopasowany. Jeśli podasz więcej niż jedną jednostkę jako listę rozdzielaną przecinkami, punkt końcowy zwróci "najmniejszą dostępną jednostkę". Zwracany identyfikator geometrii może służyć do uzyskania geometrii tej lokalizacji geograficznej za pośrednictwem interfejsu API get Search Polygon. Następujące parametry są ignorowane po ustawieniu entityType:

  • Pozycji
  • liczba
  • returnRoadUse
  • returnSpeedLimit
  • roadUse
  • returnMatchType
extendedPostalCodesFor
query

SearchIndexes[]

Indeksy, dla których powinny zostać uwzględnione rozszerzone kody pocztowe w wynikach.

Dostępne indeksy to:

Addr = zakresy adresów

Geo = Geographies

PAD = adresy punktów

PoI = punkty orientacyjne

Str = ulice

XStr = Skrzyżowania (skrzyżowania)

Wartość powinna być rozdzielaną przecinkami listą typów indeksów (w dowolnej kolejności) lub brakiem indeksów.

Domyślnie rozszerzone kody pocztowe są uwzględniane dla wszystkich indeksów z wyjątkiem geo. Rozszerzone listy kodów pocztowych dla lokalizacji geograficznych mogą być dość długie, więc w razie potrzeby muszą być jawnie żądane.

Przykłady użycia:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu.

idxSet
query

SearchIndexes[]

Rozdzielona przecinkami lista indeksów, które powinny być używane do wyszukiwania. Kolejność elementów nie ma znaczenia. Dostępne indeksy to: Addr = Interpolacja zakresu adresów, Geo = Geographies, PAD = Point Address, POI = Punkty orientacyjne, Str = Streets, Xstr = Cross Streets (skrzyżowania)

language
query

string

Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Jeśli dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny.

Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane języki .

lat
query

number

double

Szerokość geograficzna, w której wyniki powinny być stronnicze. Np. 37.337

limit
query

integer

Maksymalna liczba odpowiedzi, które zostaną zwrócone. Ustawienie domyślne: 10, minimum: 1 i maksimum: 100

lon
query

number

double

Długość geograficzna, w której wyniki powinny być stronnicze. Np. -121.89

maxFuzzyLevel
query

integer

Maksymalny poziom rozmycia do użycia. Ustawienie domyślne: 2, minimum: 1 i maksimum: 4

  • Poziom 1 nie ma sprawdzania pisowni.

  • Poziom 2 używa normalnego sprawdzania pisowni n gram. Na przykład zapytanie "restrant" można dopasować do "restaurant".

  • Poziom 3 używa sprawdzania pisowni przypominającego dźwięk i sprawdzania pisowni shingle. Sprawdzanie pisowni przypominające dźwięk służy do dopasowywania "rstrnt" do "restauracji". Sprawdzanie pisowni shingle jest przeznaczone dla "mountainview" do "widok na góry" dopasowania.

  • Poziom 4 nie dodaje więcej funkcji sprawdzania pisowni.

Wyszukiwarka zacznie szukać dopasowania na poziomie zdefiniowanym przez minFuzzyLevel i przestanie wyszukiwać na poziomie określonym przez maxFuzzyLevel.

minFuzzyLevel
query

integer

Minimalny poziom rozmycia do użycia. Ustawienie domyślne: 1, minimum: 1 i maksimum: 4

  • Poziom 1 nie ma sprawdzania pisowni.

  • Poziom 2 używa normalnego sprawdzania pisowni n gram. Na przykład zapytanie "restrant" można dopasować do "restaurant".

  • Poziom 3 używa sprawdzania pisowni przypominającego dźwięk i sprawdzania pisowni shingle. Sprawdzanie pisowni przypominające dźwięk służy do dopasowywania "rstrnt" do "restauracji". Sprawdzanie pisowni shingle jest przeznaczone dla "mountainview" do "widok na góry" dopasowania.

  • Poziom 4 nie dodaje więcej funkcji sprawdzania pisowni.

Wyszukiwarka rozpocznie wyszukiwanie dopasowania na poziomie zdefiniowanym przez minFuzzyLevel i przestanie wyszukiwać na poziomie określonym przez maxFuzzyLevel.

ofs
query

integer

Przesunięcie początkowe zwróconych wyników w pełnym zestawie wyników. Ustawienie domyślne: 0

openingHours
query

OperatingHoursRange

Godziny operacji dla interfejsu poi (punkty orientacyjne). Dostępność godzin pracy będzie się różnić w zależności od dostępnych danych. Jeśli nie zostanie przekazana, nie zostaną zwrócone żadne informacje o godzinach otwarcia. Obsługiwana wartość: nextSevenDays

radius
query

integer

Promień w metrach dla wyników, które mają być ograniczone do zdefiniowanego obszaru

topLeft
query

string

Lewa górna pozycja pola ograniczenia. Np. 37.553,-122.453

typeahead
query

boolean

Boolean. Jeśli flaga typeahead jest ustawiona, zapytanie zostanie zinterpretowane jako częściowe dane wejściowe, a wyszukiwanie przejdzie w tryb predykcyjny

view
query

LocalizedMapView

Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. Różne kraje/regiony mają różne widoki takich regionów, a parametr View umożliwia aplikacji zgodność z widokiem wymaganym przez kraj/region, który aplikacja będzie obsługiwać. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju/regionu, w którym są dostępne mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN.

Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki.

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.

Odpowiedzi

Nazwa Typ Opis
200 OK

SearchAddressResult

OK

Other Status Codes

ErrorResponse

Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy Microsoft Entra OAuth 2.0. 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.

Uwaga

  • Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w celu wskazania, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps .
  • 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 poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
  • Użycie zestawu AZURE MAPS Web SDK umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków 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ółużytkowany podczas tworzenia konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsu API REST.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do wszystkich interfejsów API REST. Innymi słowy, ten klucz może służyć 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 Azure Maps interfejsów API REST, aby klucz mógł być bezpiecznie przechowywany.

Typ: apiKey
W: query

SAS Token

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

Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure oraz szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej bezpieczny 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.

Typ: apiKey
W: header

Przykłady

Search City Seattle

Przykładowe żądanie

GET https://atlas.microsoft.com/search/fuzzy/json?api-version=1.0&query=seattle&openingHours=nextSevenDays

Przykładowa odpowiedź

{
  "summary": {
    "query": "seattle",
    "queryType": "NON_NEAR",
    "queryTime": 66,
    "numResults": 10,
    "offset": 0,
    "totalResults": 3720,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "Geography",
      "id": "US/GEO/p0/188055",
      "score": 2.531,
      "entityType": "Municipality",
      "address": {
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "Seattle, WA",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.60323,
        "lon": -122.33028
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.7344,
          "lon": -122.4594
        },
        "btmRightPoint": {
          "lat": 47.48106,
          "lon": -122.22497
        }
      },
      "dataSources": {
        "geometry": {
          "id": "00005557-4100-3c00-0000-0000596ae8ed"
        }
      }
    },
    {
      "type": "Geography",
      "id": "US/GEO/p0/183911",
      "score": 2.382,
      "entityType": "Municipality",
      "address": {
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countrySubdivisionCode": "WA",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "Seattle, WA",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.55342,
        "lon": -122.25007
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.58995,
          "lon": -122.26723
        },
        "btmRightPoint": {
          "lat": 47.5169,
          "lon": -122.23291
        }
      },
      "dataSources": {
        "geometry": {
          "id": "00005557-4100-3c00-0000-00006553f33d"
        }
      }
    },
    {
      "type": "POI",
      "id": "ZA/POI/p0/449288",
      "score": 2.226,
      "info": "search:ta:710009004165863-ZA",
      "poi": {
        "name": "Seattle Coffee Co - Groote Kerk Sentrum",
        "brands": [
          {
            "name": "Seattle Coffee Company"
          }
        ],
        "categorySet": [
          {
            "id": 9376006
          }
        ],
        "url": "www.seattlecoffeecompany.co.za",
        "classifications": [
          {
            "code": "CAFE_PUB",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "coffee shop"
              },
              {
                "nameLocale": "en-US",
                "name": "café/pub"
              }
            ]
          }
        ]
      },
      "address": {
        "streetName": "Kloof Street",
        "municipalitySubdivision": "Cape Town",
        "municipality": "Cape Town",
        "countrySecondarySubdivision": "City of Cape Town",
        "countrySubdivisionCode": "Western Cape",
        "postalCode": "8001",
        "countryCode": "ZA",
        "country": "South Africa",
        "countryCodeISO3": "ZAF",
        "freeformAddress": "Kloof Street, Gardens, City of Cape Town, Western Cape, 8001",
        "localName": "Gardens"
      },
      "position": {
        "lat": -33.92917,
        "lon": 18.41178
      },
      "viewport": {
        "topLeftPoint": {
          "lat": -33.92827,
          "lon": 18.4107
        },
        "btmRightPoint": {
          "lat": -33.93007,
          "lon": 18.41286
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": -33.92907,
            "lon": 18.41162
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "ZA/POI/p0/449396",
      "score": 2.226,
      "info": "search:ta:710009004163591-ZA",
      "poi": {
        "name": "Seattle Coffee Co - Pietermaritzburg",
        "phone": "+(27)-(33)-3458486",
        "brands": [
          {
            "name": "Seattle Coffee Company"
          }
        ],
        "categorySet": [
          {
            "id": 9376006
          }
        ],
        "url": "www.seattlecoffeecompany.co.za",
        "classifications": [
          {
            "code": "CAFE_PUB",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "coffee shop"
              },
              {
                "nameLocale": "en-US",
                "name": "café/pub"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "9",
        "streetName": "Armitage Road",
        "municipalitySubdivision": "Pietermaritzburg City, Pietermaritzburg",
        "municipality": "Pietermaritzburg",
        "countrySecondarySubdivision": "The Msunduzi",
        "countrySubdivisionCode": "KwaZulu-Natal",
        "postalCode": "3201",
        "countryCode": "ZA",
        "country": "South Africa",
        "countryCodeISO3": "ZAF",
        "freeformAddress": "Armitage Road 9, Athlone, The Msunduzi, KwaZulu-Natal, 3201",
        "localName": "Athlone"
      },
      "position": {
        "lat": -29.58611,
        "lon": 30.37508
      },
      "viewport": {
        "topLeftPoint": {
          "lat": -29.58521,
          "lon": 30.37405
        },
        "btmRightPoint": {
          "lat": -29.58701,
          "lon": 30.37611
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": -29.58668,
            "lon": 30.37531
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "ZA/POI/p0/451868",
      "score": 2.226,
      "info": "search:ta:710009002195538-ZA",
      "poi": {
        "name": "Seattle Coffee Co - Bedford Village",
        "phone": "+(27)-(84)-5451111",
        "brands": [
          {
            "name": "Seattle Coffee Company"
          }
        ],
        "categorySet": [
          {
            "id": 9376006
          }
        ],
        "url": "www.seattlecoffeecompany.co.za",
        "classifications": [
          {
            "code": "CAFE_PUB",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "coffee shop"
              },
              {
                "nameLocale": "en-US",
                "name": "café/pub"
              }
            ]
          }
        ]
      },
      "address": {
        "streetName": "Van Buuren Road",
        "municipalitySubdivision": "Bedfordview",
        "municipality": "Germiston",
        "countrySecondarySubdivision": "Ekurhuleni",
        "countrySubdivisionCode": "Gauteng",
        "postalCode": "2007",
        "countryCode": "ZA",
        "country": "South Africa",
        "countryCodeISO3": "ZAF",
        "freeformAddress": "Van Buuren Road, Bedfordview, Ekurhuleni, Gauteng, 2007",
        "localName": "Bedfordview"
      },
      "position": {
        "lat": -26.18009,
        "lon": 28.13544
      },
      "viewport": {
        "topLeftPoint": {
          "lat": -26.17919,
          "lon": 28.13444
        },
        "btmRightPoint": {
          "lat": -26.18099,
          "lon": 28.13644
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": -26.18006,
            "lon": 28.13636
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "ZA/POI/p0/488888",
      "score": 2.226,
      "info": "search:ta:710009002102639-ZA",
      "poi": {
        "name": "Seattle Coffee Co - Caltex Starstop Milly's",
        "phone": "+(27)-(13)-2560340",
        "brands": [
          {
            "name": "Seattle Coffee Company"
          }
        ],
        "classifications": [
          {
            "code": "CAFE_PUB",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "coffee shop"
              },
              {
                "nameLocale": "en-US",
                "name": "café/pub"
              }
            ]
          }
        ]
      },
      "address": {
        "municipality": "Wonderfontein",
        "countrySecondarySubdivision": "Emakhazeni",
        "countrySubdivisionCode": "Mpumalanga",
        "countryCode": "ZA",
        "country": "South Africa",
        "countryCodeISO3": "ZAF",
        "freeformAddress": "Wonderfontein, Emakhazeni, Mpumalanga"
      },
      "position": {
        "lat": -25.68842,
        "lon": 30.21291
      },
      "viewport": {
        "topLeftPoint": {
          "lat": -25.68752,
          "lon": 30.21191
        },
        "btmRightPoint": {
          "lat": -25.68932,
          "lon": 30.21391
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": -25.68913,
            "lon": 30.21343
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "ZA/POI/p0/489433",
      "score": 2.226,
      "info": "search:ta:710009002184068-ZA",
      "poi": {
        "name": "Seattle Coffee Co - Southcoast Mall",
        "phone": "+(27)-(39)-3150816",
        "brands": [
          {
            "name": "Seattle Coffee Company"
          }
        ],
        "categorySet": [
          {
            "id": 9376006
          }
        ],
        "url": "www.seattlecoffeecompany.co.za",
        "classifications": [
          {
            "code": "CAFE_PUB",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "coffee shop"
              },
              {
                "nameLocale": "en-US",
                "name": "café/pub"
              }
            ]
          }
        ]
      },
      "address": {
        "municipalitySubdivision": "Shelly Beach",
        "municipality": "Shelly Beach",
        "countrySecondarySubdivision": "Hibiscus Coast",
        "countrySubdivisionCode": "KwaZulu-Natal",
        "postalCode": "4265",
        "countryCode": "ZA",
        "country": "South Africa",
        "countryCodeISO3": "ZAF",
        "freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265",
        "localName": "Shelly Beach"
      },
      "position": {
        "lat": -30.79937,
        "lon": 30.40569
      },
      "viewport": {
        "topLeftPoint": {
          "lat": -30.79847,
          "lon": 30.40464
        },
        "btmRightPoint": {
          "lat": -30.80027,
          "lon": 30.40674
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": -30.7994,
            "lon": 30.40618
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "ZA/POI/p0/489976",
      "score": 2.226,
      "info": "search:ta:710009004261897-ZA",
      "poi": {
        "name": "Seattle Cofee Co",
        "phone": "+(27)-(39)-3150816",
        "brands": [
          {
            "name": "Seattle Coffee Company"
          }
        ],
        "categorySet": [
          {
            "id": 9376006
          }
        ],
        "url": "www.seattlecoffeecompany.co.za",
        "classifications": [
          {
            "code": "CAFE_PUB",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "coffee shop"
              },
              {
                "nameLocale": "en-US",
                "name": "café/pub"
              }
            ]
          }
        ]
      },
      "address": {
        "municipalitySubdivision": "Shelly Beach",
        "municipality": "Shelly Beach",
        "countrySecondarySubdivision": "Hibiscus Coast",
        "countrySubdivisionCode": "KwaZulu-Natal",
        "postalCode": "4265",
        "countryCode": "ZA",
        "country": "South Africa",
        "countryCodeISO3": "ZAF",
        "freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265",
        "localName": "Shelly Beach"
      },
      "position": {
        "lat": -30.79801,
        "lon": 30.40557
      },
      "viewport": {
        "topLeftPoint": {
          "lat": -30.79711,
          "lon": 30.40452
        },
        "btmRightPoint": {
          "lat": -30.79891,
          "lon": 30.40662
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": -30.79784,
            "lon": 30.40523
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "ZA/POI/p0/490056",
      "score": 2.226,
      "info": "search:ta:710009004149612-ZA",
      "poi": {
        "name": "Seattle Coffee Co - Constantia Village",
        "brands": [
          {
            "name": "Seattle Coffee Company"
          }
        ],
        "categorySet": [
          {
            "id": 9376006
          }
        ],
        "url": "www.seattlecoffeecompany.co.za",
        "classifications": [
          {
            "code": "CAFE_PUB",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "coffee shop"
              },
              {
                "nameLocale": "en-US",
                "name": "café/pub"
              }
            ]
          }
        ]
      },
      "address": {
        "streetName": "Constantia Main Road",
        "municipalitySubdivision": "Cape Town",
        "municipality": "Cape Town",
        "countrySecondarySubdivision": "City of Cape Town",
        "countrySubdivisionCode": "Western Cape",
        "postalCode": "7708",
        "countryCode": "ZA",
        "country": "South Africa",
        "countryCodeISO3": "ZAF",
        "freeformAddress": "Constantia Main Road, Constantia, City of Cape Town, Western Cape, 7708",
        "localName": "Constantia"
      },
      "position": {
        "lat": -34.02087,
        "lon": 18.44503
      },
      "viewport": {
        "topLeftPoint": {
          "lat": -34.01997,
          "lon": 18.44394
        },
        "btmRightPoint": {
          "lat": -34.02177,
          "lon": 18.44612
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": -34.02017,
            "lon": 18.44476
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "ZA/POI/p0/494340",
      "score": 2.226,
      "info": "search:ta:710009004152570-ZA",
      "poi": {
        "name": "Seattle Coffee Co - Canal Walk Shopping Centre",
        "brands": [
          {
            "name": "Seattle Coffee Company"
          }
        ],
        "categorySet": [
          {
            "id": 9376006
          }
        ],
        "url": "www.seattlecoffeecompany.co.za",
        "classifications": [
          {
            "code": "CAFE_PUB",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "coffee shop"
              },
              {
                "nameLocale": "en-US",
                "name": "café/pub"
              }
            ]
          }
        ]
      },
      "address": {
        "streetName": "Century Boulevard",
        "municipalitySubdivision": "Milnerton",
        "municipality": "Cape Town",
        "countrySecondarySubdivision": "City of Cape Town",
        "countrySubdivisionCode": "Western Cape",
        "postalCode": "7441",
        "countryCode": "ZA",
        "country": "South Africa",
        "countryCodeISO3": "ZAF",
        "freeformAddress": "Century Boulevard, Century City, City of Cape Town, Western Cape, 7441",
        "localName": "Century City"
      },
      "position": {
        "lat": -33.89348,
        "lon": 18.5122
      },
      "viewport": {
        "topLeftPoint": {
          "lat": -33.89258,
          "lon": 18.51112
        },
        "btmRightPoint": {
          "lat": -33.89438,
          "lon": 18.51328
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": -33.8943,
            "lon": 18.51328
          }
        }
      ]
    }
  ]
}

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.

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.

ElectricVehicleConnector

Rozdzielona przecinkami lista typów łączników, których można użyć do ograniczenia wyniku do stacji pojazdów elektrycznych obsługujących określone typy łączników. Kolejność elementów nie ma znaczenia. Po podaniu wielu typów łączników zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list.

Dostępne typy łączników to:

  • StandardHouseholdCountrySpecific - Są to standardowe łączniki gospodarstwa domowego dla określonego regionu. Wszystkie są jednofazowe prądu zmiennego oraz standardowe napięcie i standardowy amperaż. Zobacz również: Plug & socket types - World Standards (Podłącz typy gniazd & — światowe standardy).
  • IEC62196Type1 - Łącznik typu 1 zgodnie z definicją w standardzie IEC 62196-2. Nazwany również Yazaki po oryginalnym producencie lub SAE J1772 po standardzie, który po raz pierwszy go opublikował. Najczęściej używane w połączeniu z pojedynczą fazą 120V lub do 240V pojedynczej infrastruktury fazowej.
  • IEC62196Type1CCS - Łącznik kombi oparty na typie 1 zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 1, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie prądu DC.
  • IEC62196Type2CableAttached - Łącznik typu 2 zgodnie z definicją w standardzie IEC 62196-2. Dostarczone jako kabel i podłączona do punktu ładowania.
  • IEC62196Type2Outlet - Łącznik typu 2 zgodnie z definicją w standardzie IEC 62196-2. Dostarczone jako gniazdo ustawione w punkcie ładowania.
  • IEC62196Type2CCS - Łącznik kombi oparty na typie 2 zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 2, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie prądu DC.
  • IEC62196Type3 - Łącznik typu 3 zgodnie z definicją w standardzie IEC 62196-2. Również o nazwie Scame po oryginalnym producencie. Najczęściej używane w połączeniu z maksymalnie 240V pojedynczą fazą lub do 420V trzyfazowej infrastruktury.
  • Chademo - Łącznik CHAdeMO nazwany na cześć stowarzyszenia utworzonego przez Tokyo Electric Power Company i partnerów przemysłowych. Z tego powodu jest również znany jako łącznik TEPCO. Obsługuje szybkie ładowanie prądu stałego.
  • IEC60309AC1PhaseBlue - Łącznik niebieski przemysłowy jest łącznikiem zdefiniowanym w standardzie IEC 60309. Czasami jest ona określana za pomocą kombinacji standardu, koloru i faktu, że jest to jednofazowy łącznik. Łącznik ma zwykle konfigurację "P+N+E, 6h".
  • IEC60309DCWhite - Łącznik przemysłowy Biały jest łącznikiem DC zdefiniowanym w standardzie IEC 60309.
  • Tesla - Łącznik Tesli jest regionalnie specyficzny łącznik Tesla Supercharger. Tj. odnosi się on do zastrzeżonego łącznika Tesli, czasami określanego jako Tesla Port, głównie ograniczone do Ameryka Północna lub zmodyfikowanego typu 2 (DC nad typem 2) w Europie.

Przykłady użycia:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

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.

LatLongPairAbbreviated

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

LocalizedMapView

Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie prawidłowych map dla określonego kraju/regionu dla spornych geopolitycznie regionów. Różne kraje/regiony mają różne widoki takich regionów, a parametr Wyświetl umożliwia aplikacji zachowanie zgodności z widokiem wymaganym przez kraj/region, który będzie obsługiwać aplikacja. Domyślnie parametr Widok jest ustawiony na wartość "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru Wyświetl dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z przepisami dotyczącymi mapowania, kraju/regionu, w którym udostępniane są mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN.

Aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki, zapoznaj się z tematem Obsługiwane widoki .

MatchType

Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.

OperatingHours

Godziny otwarcia dla weryfikacji koncepcji (punkty orientacyjne).

OperatingHoursRange

Godziny operacji dla weryfikacji koncepcji (punkty orientacyjne). Dostępność godzin pracy będzie się różnić w zależności od dostępnych danych. Jeśli nie upłynął, nie zostaną zwrócone żadne informacje o godzinach otwarcia. Obsługiwana wartość: nextSevenDays

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.

ResponseFormat

Żądany format odpowiedzi. Wartość może być json lub xml.

SearchAddressResult

Ten obiekt jest zwracany z pomyślnych wywołań Search.

SearchAddressResultItem

Wynik obiektu odpowiedzi interfejsu API Search.

SearchAddressResultType

Jeden z:

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

Indeksy, dla których powinny zostać uwzględnione rozszerzone kody pocztowe w wynikach.

Dostępne indeksy to:

Addr = zakresy adresów

Geo = Geographies

PAD = adresy punktów

PoI = punkty orientacyjne

Str = ulice

XStr = Skrzyżowania (skrzyżowania)

Wartość powinna być rozdzielaną przecinkami listą typów indeksów (w dowolnej kolejności) lub brakiem indeksów.

Domyślnie rozszerzone kody pocztowe są uwzględniane dla wszystkich indeksów z wyjątkiem geo. Rozszerzone listy kodów pocztowych dla lokalizacji geograficznych mogą być dość długie, więc w razie potrzeby muszą być jawnie żądane.

Przykłady użycia:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu.

SearchSummary

Obiekt podsumowania odpowiedzi interfejsu API Search.

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

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.

ElectricVehicleConnector

Rozdzielona przecinkami lista typów łączników, których można użyć do ograniczenia wyniku do stacji pojazdów elektrycznych obsługujących określone typy łączników. Kolejność elementów nie ma znaczenia. Po podaniu wielu typów łączników zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list.

Dostępne typy łączników to:

  • StandardHouseholdCountrySpecific - Są to standardowe łączniki gospodarstwa domowego dla określonego regionu. Wszystkie są jednofazowe prądu zmiennego oraz standardowe napięcie i standardowy amperaż. Zobacz również: Plug & socket types - World Standards (Podłącz typy gniazd & — światowe standardy).
  • IEC62196Type1 - Łącznik typu 1 zgodnie z definicją w standardzie IEC 62196-2. Nazwany również Yazaki po oryginalnym producencie lub SAE J1772 po standardzie, który po raz pierwszy go opublikował. Najczęściej używane w połączeniu z pojedynczą fazą 120V lub do 240V pojedynczej infrastruktury fazowej.
  • IEC62196Type1CCS - Łącznik kombi oparty na typie 1 zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 1, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie prądu DC.
  • IEC62196Type2CableAttached - Łącznik typu 2 zgodnie z definicją w standardzie IEC 62196-2. Dostarczone jako kabel i podłączona do punktu ładowania.
  • IEC62196Type2Outlet - Łącznik typu 2 zgodnie z definicją w standardzie IEC 62196-2. Dostarczone jako gniazdo ustawione w punkcie ładowania.
  • IEC62196Type2CCS - Łącznik kombi oparty na typie 2 zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 2, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie prądu DC.
  • IEC62196Type3 - Łącznik typu 3 zgodnie z definicją w standardzie IEC 62196-2. Również o nazwie Scame po oryginalnym producencie. Najczęściej używane w połączeniu z maksymalnie 240V pojedynczą fazą lub do 420V trzyfazowej infrastruktury.
  • Chademo - Łącznik CHAdeMO nazwany na cześć stowarzyszenia utworzonego przez Tokyo Electric Power Company i partnerów przemysłowych. Z tego powodu jest również znany jako łącznik TEPCO. Obsługuje szybkie ładowanie prądu stałego.
  • IEC60309AC1PhaseBlue - Łącznik niebieski przemysłowy jest łącznikiem zdefiniowanym w standardzie IEC 60309. Czasami jest ona określana za pomocą kombinacji standardu, koloru i faktu, że jest to jednofazowy łącznik. Łącznik ma zwykle konfigurację "P+N+E, 6h".
  • IEC60309DCWhite - Łącznik przemysłowy Biały jest łącznikiem DC zdefiniowanym w standardzie IEC 60309.
  • Tesla - Łącznik Tesli jest regionalnie specyficzny łącznik Tesla Supercharger. Tj. odnosi się on do zastrzeżonego łącznika Tesli, czasami określanego jako Tesla Port, głównie ograniczone do Ameryka Północna lub zmodyfikowanego typu 2 (DC nad typem 2) w Europie.

Przykłady użycia:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

Nazwa Typ Opis
Chademo

string

Łącznik CHAdeMO nazwany na cześć stowarzyszenia utworzonego przez Tokyo Electric Power Company i partnerów przemysłowych. Z tego powodu jest również znany jako łącznik TEPCO. Obsługuje szybkie ładowanie prądu stałego.

IEC60309AC1PhaseBlue

string

Łącznik Industrial Blue jest łącznikiem zdefiniowanym w standardzie IEC 60309. Czasami jest ona określana za pomocą kombinacji standardu, koloru i faktu, że jest to jednofazowy łącznik. Łącznik ma zwykle konfigurację "P+N+E, 6h".

IEC60309DCWhite

string

Łącznik Industrial White jest łącznikiem DC zdefiniowanym w standardzie IEC 60309.

IEC62196Type1

string

Łącznik typu 1 zgodnie z definicją w standardzie IEC 62196-2. Nazwany również Yazaki po oryginalnym producencie lub SAE J1772 po standardzie, który po raz pierwszy go opublikował. Najczęściej używane w połączeniu z pojedynczą fazą 120V lub do 240V pojedynczej infrastruktury fazowej.

IEC62196Type1CCS

string

Łącznik kombi oparty na typie 1 zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 1, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie prądu DC.

IEC62196Type2CCS

string

Łącznik kombi oparty na typie 2 zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 2, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie prądu DC.

IEC62196Type2CableAttached

string

Łącznik typu 2 zgodnie z definicją w standardzie IEC 62196-2. Dostarczone jako kabel i podłączona do punktu ładowania

IEC62196Type2Outlet

string

Łącznik typu 2 zgodnie z definicją w standardzie IEC 62196-2. Dostarczone jako gniazdo ustawione w punkcie ładowania.

IEC62196Type3

string

Łącznik typu 3 zgodnie z definicją w standardzie IEC 62196-2. Również o nazwie Scame po oryginalnym producencie. Najczęściej używane w połączeniu z maksymalnie 240V pojedynczą fazą lub do 420V trzyfazowej infrastruktury.

StandardHouseholdCountrySpecific

string

Są to standardowe łączniki gospodarstwa domowego dla określonego regionu. Wszystkie są jednofazowe prądu zmiennego oraz standardowe napięcie i standardowy amperaż.

Zobacz również: Plug & socket types - World Standards

Tesla

string

Łącznik Tesli jest regionalnym łącznikiem Tesla Supercharger. Tj. odnosi się on do zastrzeżonego łącznika Tesli, czasami określanego jako Tesla Port, głównie ograniczone do Ameryka Północna lub zmodyfikowanego typu 2 (DC nad typem 2) w Europie.

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.

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

LocalizedMapView

Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie prawidłowych map dla określonego kraju/regionu dla spornych geopolitycznie regionów. Różne kraje/regiony mają różne widoki takich regionów, a parametr Wyświetl umożliwia aplikacji zachowanie zgodności z widokiem wymaganym przez kraj/region, który będzie obsługiwać aplikacja. Domyślnie parametr Widok jest ustawiony na wartość "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru Wyświetl dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z przepisami dotyczącymi mapowania, kraju/regionu, w którym udostępniane są mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN.

Aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki, zapoznaj się z tematem Obsługiwane widoki .

Nazwa Typ Opis
AE

string

Zjednoczone Emiraty Arabskie (widok arabski)

AR

string

Argentyna (widok argentyński)

Auto

string

Zwróć dane mapy na podstawie adresu IP żądania.

BH

string

Bahrajn (widok arabski)

IN

string

Indie (Widok indyjski)

IQ

string

Irak (widok arabski)

JO

string

Jordania (widok arabski)

KW

string

Kuwejt (widok arabski)

LB

string

Liban (widok arabski)

MA

string

Maroko (widok marokański)

OM

string

Oman (widok arabski)

PK

string

Pakistan (Pakistani View)

PS

string

Autonomia Palestyńska (widok arabski)

QA

string

Katar (widok arabski)

SA

string

Arabia Saudyjska (widok arabski)

SY

string

Syria (widok arabski)

Unified

string

Ujednolicony widok (inne)

YE

string

Jemen (widok arabski)

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

OperatingHoursRange

Godziny operacji dla weryfikacji koncepcji (punkty orientacyjne). Dostępność godzin pracy będzie się różnić w zależności od dostępnych danych. Jeśli nie upłynął, nie zostaną zwrócone żadne informacje o godzinach otwarcia. Obsługiwana wartość: nextSevenDays

Nazwa Typ Opis
nextSevenDays

string

Pokazuje godziny operacji dla następnego tygodnia, począwszy od bieżącego dnia w czasie lokalnym interfejsu użytkownika.

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 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ń

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

ResponseFormat

Żądany format odpowiedzi. Wartość może być json lub xml.

Nazwa Typ Opis
json

string

Format wymiany danych notacji obiektów JavaScript

xml

string

The Extensible Markup Language

SearchAddressResult

Ten obiekt jest zwracany z pomyślnych wywołań Search.

Nazwa Typ Opis
results

SearchAddressResultItem[]

Lista wyników interfejsu API Search.

summary

SearchSummary

Obiekt podsumowania odpowiedzi interfejsu API Search

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

SearchIndexes

Indeksy, dla których powinny zostać uwzględnione rozszerzone kody pocztowe w wynikach.

Dostępne indeksy to:

Addr = zakresy adresów

Geo = Geographies

PAD = adresy punktów

PoI = punkty orientacyjne

Str = ulice

XStr = Skrzyżowania (skrzyżowania)

Wartość powinna być rozdzielaną przecinkami listą typów indeksów (w dowolnej kolejności) lub brakiem indeksów.

Domyślnie rozszerzone kody pocztowe są uwzględniane dla wszystkich indeksów z wyjątkiem geo. Rozszerzone listy kodów pocztowych dla lokalizacji geograficznych mogą być dość długie, więc w razie potrzeby muszą być jawnie żądane.

Przykłady użycia:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu.

Nazwa Typ Opis
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

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.