Search - Get Search POI Category
Służy do wyszukiwania punktów orientacyjnych według kategorii.
Interfejs Get Search POI Category
API to żądanie HTTP GET
, które umożliwia żądanie wyników weryfikacji koncepcji z danej kategorii. Przydatne do wykonywania zapytań dotyczących interfejsów POI z jednej kategorii naraz. Punkt końcowy zwróci tylko wyniki weryfikacji koncepcji, które są klasyfikowane zgodnie z określonymi. Odpowiedź zawiera szczegółowe informacje o interfejsie użytkownika, takie jak adres, lokalizacja współrzędnych i klasyfikacja.
GET https://atlas.microsoft.com/search/poi/category/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/poi/category/{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}&brandSet={brandSet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
format
|
path | True |
Żą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 |
Kategoria POI do wyszukania (np. "AIRPORT", "RESTAURANT"), musi być prawidłowo zakodowana w adresie URL. Obsługiwane główne kategorie można zażądać przez wywołanie interfejsu API pobierania Search kategorii poi. Aby uzyskać listę dostępnych kategorii, zobacz Azure Maps obsługiwane kategorie. Zalecamy użycie interfejsu API drzewa kategorii Search weryfikacji koncepcji w celu zażądania obsługiwanych kategorii. |
brand
|
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 podaniu wielu marek zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list. Marki, które zawierają "", w swojej nazwie powinny być umieszczane w cudzysłowie. Przykłady użycia: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Przecinek",Bar |
|
btm
|
query |
string |
Prawe dolne położenie pola ograniczenia. Np. 37.553,-122.453 |
|
category
|
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
|
|
connector
|
query |
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:
Przykłady użycia: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
||
country
|
query |
string[] |
Rozdzielony przecinkami ciąg kodów kraju/regionu, np. FR,ES. Spowoduje to ograniczenie wyszukiwania do określonych krajów/regionów |
|
extended
|
query |
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. |
||
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 |
|
ofs
|
query |
integer |
Przesunięcie początkowe zwróconych wyników w pełnym zestawie wyników. Ustawienie domyślne: 0 |
|
opening
|
query |
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 |
|
top
|
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 |
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 |
OK |
|
Other Status Codes |
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 for ATM's within 2 miles of Times Square NY and return the top 3 results
Przykładowe żądanie
GET https://atlas.microsoft.com/search/poi/category/json?api-version=1.0&query=atm&limit=3&lat=40.758953&lon=-73.985263&radius=3200&openingHours=nextSevenDays
Przykładowa odpowiedź
{
"summary": {
"query": "atm",
"queryType": "NON_NEAR",
"queryTime": 28,
"numResults": 3,
"offset": 0,
"totalResults": 3696,
"fuzzyLevel": 1,
"geoBias": {
"lat": 40.758953,
"lon": -73.985263
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/7014613",
"score": 2.575,
"dist": 10.743802093311858,
"info": "search:ta:840369001846523-US",
"poi": {
"name": "FISERV MASTERMONEY",
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1560",
"streetName": "Broadway",
"municipalitySubdivision": "Times Square, New York, Midtown",
"municipality": "New York, Manhattan",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10036",
"extendedPostalCode": "100361517",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1560 Broadway, New York, NY 10036",
"localName": "New York",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.75901,
"lon": -73.98516
},
"viewport": {
"topLeftPoint": {
"lat": 40.75991,
"lon": -73.98635
},
"btmRightPoint": {
"lat": 40.75811,
"lon": -73.98397
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.75902,
"lon": -73.98522
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/6830011",
"score": 2.575,
"dist": 58.68107354501256,
"info": "search:ta:840369011803697-US",
"poi": {
"name": "METABANK",
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1567",
"streetName": "Broadway",
"municipalitySubdivision": "Times Square, New York, Midtown",
"municipality": "New York, Manhattan",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10036",
"extendedPostalCode": "100361517",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1567 Broadway, New York, NY 10036",
"localName": "New York",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.75937,
"lon": -73.98569
},
"viewport": {
"topLeftPoint": {
"lat": 40.76027,
"lon": -73.98688
},
"btmRightPoint": {
"lat": 40.75847,
"lon": -73.9845
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.75924,
"lon": -73.98513
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/6830013",
"score": 2.575,
"dist": 55.009653221373966,
"info": "search:ta:840369010525390-US",
"poi": {
"name": "ATM",
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1552",
"streetName": "Broadway",
"municipalitySubdivision": "Times Square, New York, Midtown",
"municipality": "New York, Manhattan",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10036",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1552 Broadway, New York, NY 10036",
"localName": "New York",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.75873,
"lon": -73.98468
},
"viewport": {
"topLeftPoint": {
"lat": 40.75963,
"lon": -73.98587
},
"btmRightPoint": {
"lat": 40.75783,
"lon": -73.98349
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.7588,
"lon": -73.98492
}
}
]
}
]
}
Definicje
Nazwa | Opis |
---|---|
Address |
Adres wyniku |
Address |
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. |
Bounding |
Port widoków, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu panelu widoków. |
Bounding |
Pole ograniczenia lokalizacji. |
Brand |
Marka skojarzona z interfejsem POI |
Classification |
Klasyfikacja zwracanego interfejsu użytkownika |
Classification |
Nazwa klasyfikacji |
Data |
Sekcja opcjonalna. Identyfikatory odwołań do użycia z interfejsem API Get Search Polygon. |
Electric |
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:
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. |
Entry |
Punkt wejścia dla zwracanego punktu weryfikacji koncepcji. |
Entry |
Typ punktu wejścia. Wartość może być główna lub pomocnicza. |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Geographic |
Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna. |
Geometry |
Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geography. |
Lat |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
Localized |
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 . |
Match |
Typy dopasowania dla operacji wyszukiwania odwrotnego adresu. |
Operating |
Godziny otwarcia dla weryfikacji koncepcji (punkty orientacyjne). |
Operating |
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 |
Operating |
Reprezentuje datę i godzinę |
Operating |
Zakres czasu otwierania na dzień |
Point |
Szczegóły zwróconego interfejsu poI, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje. |
Point |
Kategoria poi |
Query |
Zwracany typ zapytania: W POBLIŻU lub NON_NEAR. |
Response |
Żądany format odpowiedzi. Wartość może być json lub xml. |
Search |
Ten obiekt jest zwracany z pomyślnych wywołań Search. |
Search |
Obiekt wyniku odpowiedzi interfejsu API Search. |
Search |
Jeden z:
|
Search |
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. |
Search |
Obiekt podsumowania odpowiedzi interfejsu API Search. |
Address
Adres wyniku
Nazwa | Typ | Opis |
---|---|---|
boundingBox |
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 |
|
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 |
municipality |
string |
Miasto/Miasto |
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 |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
|
rangeLeft |
string |
Zakres adresów po lewej stronie ulicy. |
rangeRight |
string |
Zakres adresów po prawej stronie ulicy. |
to |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
BoundingBox
Port widoków, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu panelu widoków.
Nazwa | Typ | Opis |
---|---|---|
btmRightPoint |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
|
topLeftPoint |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
BoundingBoxCompassNotation
Pole ograniczenia lokalizacji.
Nazwa | Typ | Opis |
---|---|---|
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 |
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 |
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 |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
|
type |
Typ punktu wejścia. Wartość może być główna lub pomocnicza. |
EntryPointType
Typ punktu wejścia. Wartość może być główna lub pomocnicza.
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 |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
Szczegóły błędu. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy błędu. |
ErrorResponse
Odpowiedź na błąd
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt błędu. |
GeographicEntityType
Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna.
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 |
Lista zakresów czasu dla następnych 7 dni |
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
Nazwa | Typ | Opis |
---|---|---|
nextSevenDays |
string |
Pokazuje godziny operacji w następnym tygodniu, 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 |
Punkt w ciągu najbliższych 7 dni od momentu zamknięcia danego interfejsu wiersza polecenia lub początku zakresu, jeśli został zamknięty przed zakresem. |
|
startTime |
Punkt w ciągu najbliższych 7 dni od otwarcia danego interfejsu wiersza polecenia lub początku zakresu, jeśli został otwarty przed zakresem. |
PointOfInterest
Szczegóły zwróconego interfejsu poI, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.
Nazwa | Typ | Opis |
---|---|---|
brands |
Brand[] |
Tablica marek. Nazwa marki zwracanej przez weryfikację koncepcji. |
categories |
string[] |
Tablica kategorii |
categorySet |
Lista najbardziej specyficznych kategorii poI |
|
classifications |
Tablica klasyfikacji |
|
name |
string |
Nazwa właściwości POI |
openingHours |
Godziny otwarcia dla weryfikacji koncepcji (punkty orientacyjne). |
|
phone |
string |
Właściwość numeru telefonu |
url |
string |
Właściwość adresu URL witryny internetowej |
PointOfInterestCategorySet
Kategoria poi
Nazwa | Typ | Opis |
---|---|---|
id |
integer |
Identyfikator kategorii |
QueryType
Zwracany typ zapytania: W POBLIŻU 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 geograficznej 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 |
|
xml |
string |
SearchAddressResult
Ten obiekt jest zwracany z pomyślnych wywołań Search.
Nazwa | Typ | Opis |
---|---|---|
results |
Lista wyników interfejsu API Search. |
|
summary |
Obiekt podsumowania odpowiedzi interfejsu API Search |
SearchAddressResultItem
Obiekt wyniku odpowiedzi interfejsu API Search.
Nazwa | Typ | 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ątkowych i końcowych zakresu adresów. |
|
dataSources |
Sekcja opcjonalna. Identyfikator geometrii odwołania do użycia z interfejsem API Get Search Polygon. |
|
detourTime |
integer |
Czas objazdu w sekundach. Zwrócono tylko wywołania interfejsu API Search Wzdłuż trasy. |
dist |
number |
Odległość linii prostej między lokalizacją wyniku a geobiasami w metrach. |
entityType |
Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna. |
|
entryPoints |
Tablica punktów wejścia. Opisują one typy wejść dostępnych w lokalizacji. Typ może być "główny" dla głównych wejść, takich jak drzwi wejściowe, lub hol, i "drobne", dla drzwi bocznych i tylnych. |
|
id |
string |
Właściwość Id |
info |
string |
Informacje o oryginalnym źródle danych wyniku. Służy do obsługi żądań pomocy technicznej. |
matchType |
Informacje o typie dopasowania. Jeden z:
|
|
poi |
Szczegóły zwróconego interfejsu poI, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje. |
|
position |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
|
score |
number |
Wartość w zestawie wyników wskazująca względny wynik dopasowania między wynikami. Można to użyć, aby określić, że wynik x jest dwa razy bardziej prawdopodobny w wyniku y, jeśli wartość x wynosi 2x wartość y. Wartości różnią się między zapytaniami i są przeznaczone tylko jako wartość względna dla jednego zestawu wyników. |
type |
Jeden z:
|
|
viewport |
Widokport, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu portu widoku. |
SearchAddressResultType
Jeden z:
- UM
- Ulica
- Lokalizacja geograficzna
- Adres punktu
- Zakres adresów
- Cross Street
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 udostępnienia wyników. |
geoBias |
Wskazanie, kiedy wewnętrzna wyszukiwarka zastosowała stronniczość geoprzestrzenną, aby poprawić klasyfikację wyników. W niektórych metodach może to mieć wpływ, ustawiając parametry lat i lon, jeśli są dostępne. W innych przypadkach jest to wyłącznie wewnętrzne. |
|
limit |
integer |
Maksymalna liczba odpowiedzi, które zostaną zwrócone |
numResults |
integer |
Liczba wyników w odpowiedzi. |
offset |
integer |
Przesunięcie początkowe zwróconych wyników w pełnym zestawie wyników. |
query |
string |
Parametr zapytania, który został użyty do wygenerowania tych wyników wyszukiwania. |
queryTime |
integer |
Czas spędzony na rozpoznawaniu zapytania w milisekundach. |
queryType |
Zwracany typ zapytania: W POBLIŻU lub NON_NEAR. |
|
totalResults |
integer |
Łączna liczba znalezionych wyników. |