Search - Get Search POI
Use para pesquisar pontos de interesse por nome.
A API de Points of Interest (POI) Search
é uma solicitação HTTP GET
que permite solicitar resultados de POI por nome. Ele também dá suporte a parâmetros de consulta adicionais, como linguagem e filtragem de resultados por área de interesse orientada por país/região ou caixa delimitadora. O Ponto de Extremidade retornará apenas os resultados de POI correspondentes à cadeia de caracteres de consulta. A resposta inclui detalhes de POI, como endereço, local da coordenada e categoria.
GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/poi/{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
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
format
|
path | True |
Formato desejado da resposta. O valor pode ser json ou xml. |
|
api-version
|
query | True |
string |
Número de versão da API do Azure Mapas. |
query
|
query | True |
string |
O nome da POI a ser procurado (por exemplo, "estátua da liberdade", "starbucks"), deve ser codificado corretamente na URL. |
brand
|
query |
string[] |
Uma lista separada por vírgulas de marcas que podem ser usadas para restringir o resultado a marcas específicas. A ordem do item não importa. Quando várias marcas forem fornecidas, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados. As marcas que contêm um "," em seu nome devem ser colocadas entre aspas. Exemplos de uso: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,Vírgula C",Barra |
|
btm
|
query |
string |
Posição inferior direita da caixa delimitadora. Por exemplo, 37.553,-122,453 |
|
category
|
query |
integer[] |
Uma lista separada por vírgulas de IDs de conjunto de categorias que pode ser usada para restringir o resultado a categorias específicas de Pontos de Interesse. A ordem de ID não importa. O número máximo de valores de
|
|
connector
|
query |
Uma lista separada por vírgulas de tipos de conector que podem ser usados para restringir o resultado à Estação de Veículos Elétricos que dá suporte a tipos de conectores específicos. A ordem do item não importa. Quando vários tipos de conector são fornecidos, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados. Os tipos de conector disponíveis são:
Exemplos de uso: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
||
country
|
query |
string[] |
Cadeia de caracteres separada por vírgulas de códigos de país/região, por exemplo, FR, ES. Isso limitará a pesquisa aos países/regiões especificados |
|
extended
|
query |
Índices para os quais os códigos postais estendidos devem ser incluídos nos resultados. Os índices disponíveis são: de POI = Pontos de Interesse O valor deve ser poi ou nenhum para desabilitar códigos postais estendidos. Por padrão, os códigos postais estendidos são incluídos. Exemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=None O código postal estendido é retornado como uma propriedade extendedPostalCode de um endereço. A disponibilidade depende da região. |
||
language
|
query |
string |
Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de linguagem IETF com suporte, que não diferencia maiúsculas de minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado. |
|
lat
|
query |
number (double) |
Latitude em que os resultados devem ser tendenciosos. Por exemplo, 37.337 |
|
limit
|
query |
integer minimum: 1maximum: 100 |
Número máximo de respostas que serão retornadas. Padrão: 10, mínimo: 1 e máximo: 100 |
|
lon
|
query |
number (double) |
Longitude em que os resultados devem ser tendenciosos. Por exemplo, -121,89 |
|
ofs
|
query |
integer minimum: 0maximum: 1900 |
Deslocamento inicial dos resultados retornados dentro do conjunto de resultados completo. Padrão: 0 |
|
opening
|
query |
Horas de operação para uma POI (pontos de interesse). A disponibilidade de horas de operação variará com base nos dados disponíveis. Se não for passado, nenhuma informação de horário de funcionamento será retornada. Valor com suporte: nextSevenDays |
||
radius
|
query |
integer |
O raio em metros para que os resultados sejam restritos à área definida |
|
top
|
query |
string |
Posição superior esquerda da caixa delimitadora. Por exemplo, 37.553,-122,453 |
|
typeahead
|
query |
boolean |
Booleano. Se o sinalizador typeahead estiver definido, a consulta será interpretada como uma entrada parcial e a pesquisa entrará no modo de previsão |
|
view
|
query |
O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição dessas regiões e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo atenderá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro Exibir no Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Mapas. Exemplo: view=IN. Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis. |
Cabeçalho da solicitação
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
x-ms-client-id |
string |
Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança da ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança da ID do Microsoft Entra no Azure Mapas, consulte os artigos de a seguir para obter diretrizes. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
OKEY |
|
Other Status Codes |
Ocorreu um erro inesperado. |
Segurança
AADToken
Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.
Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de controlar o acesso em APIs e escopos específicos.
Observação
- Essa definição de segurança requer o uso do cabeçalho
x-ms-client-id
para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas. - O
Authorization URL
é específico para a instância de nuvem pública do Azure. Nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. - O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
- O uso do SDK da Web do do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
- Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Essa é uma chave compartilhada provisionada quando você Criar uma conta do Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.
Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que elas são emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar o aplicativos cliente confidenciais abordagem para acessar AS APIs REST do Azure Mapas para que sua chave possa ser armazenada com segurança.
Tipo:
apiKey
Em:
query
SAS Token
Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais protegida do que a chave compartilhada.
Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta de mapa de
Tipo:
apiKey
Em:
header
Exemplos
Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results
Solicitação de exemplo
GET https://atlas.microsoft.com/search/poi/json?api-version=1.0&query=juice bars&limit=5&lat=47.606038&lon=-122.333345&radius=8046&openingHours=nextSevenDays
Resposta de exemplo
{
"summary": {
"query": "juice bars",
"queryType": "NON_NEAR",
"queryTime": 36,
"numResults": 5,
"offset": 0,
"totalResults": 12,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.606038,
"lon": -122.333345
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/9223158",
"score": 5.664,
"dist": 667.2710170950347,
"info": "search:ta:840539001755244-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-6240804",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "400",
"streetName": "Pine St",
"municipalitySubdivision": "Seattle, Central Business District",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98101",
"extendedPostalCode": "981011628",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "400 Pine St, Seattle, WA 98101",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61138,
"lon": -122.3374
},
"viewport": {
"topLeftPoint": {
"lat": 47.61228,
"lon": -122.33873
},
"btmRightPoint": {
"lat": 47.61048,
"lon": -122.33607
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61134,
"lon": -122.33737
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/9222534",
"score": 5.663,
"dist": 1101.6849025777728,
"info": "search:ta:840539001760125-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-4533785",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "315",
"streetName": "E Pine St",
"municipalitySubdivision": "Seattle, Broadway",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98122",
"extendedPostalCode": "9812200",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "315 E Pine St, Seattle, WA 98122",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61518,
"lon": -122.32768
},
"viewport": {
"topLeftPoint": {
"lat": 47.61608,
"lon": -122.32901
},
"btmRightPoint": {
"lat": 47.61428,
"lon": -122.32635
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61523,
"lon": -122.32768
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/9133689",
"score": 5.659,
"dist": 2649.8700791555398,
"info": "search:ta:840539001339220-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-2820651",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "604",
"streetName": "1st Ave N",
"municipalitySubdivision": "Seattle, Lower Queen Anne",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98109",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "604 1st Ave N, Seattle, WA 98109",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.6247,
"lon": -122.35533
},
"viewport": {
"topLeftPoint": {
"lat": 47.6256,
"lon": -122.35666
},
"btmRightPoint": {
"lat": 47.6238,
"lon": -122.354
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6247,
"lon": -122.3554
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/9131285",
"score": 5.646,
"dist": 5097.757019046541,
"info": "search:ta:840539001743255-US",
"poi": {
"name": "Custom Smoothie & Sports Nutrition",
"phone": "+(1)-(206)-5475522",
"categorySet": [
{
"id": 7315149
}
],
"url": "www.customsmoothie.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "462",
"streetName": "N 34th St",
"municipalitySubdivision": "Seattle, Fremont",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98103",
"extendedPostalCode": "981038600",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "462 N 34th St, Seattle, WA 98103",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.65016,
"lon": -122.35182
},
"viewport": {
"topLeftPoint": {
"lat": 47.65106,
"lon": -122.35315
},
"btmRightPoint": {
"lat": 47.64926,
"lon": -122.35049
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.64991,
"lon": -122.3519
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/9228250",
"score": 5.637,
"dist": 6235.798481758295,
"info": "search:ta:840531000416784-US",
"poi": {
"name": "Jamba Juice",
"phone": "+(1)-(206)-6322060",
"brands": [
{
"name": "Jamba Juice"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.jambajuice.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "4555",
"streetName": "Stone Way N",
"municipalitySubdivision": "Wallingford, Seattle",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98103",
"extendedPostalCode": "981036600",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "4555 Stone Way N, Seattle, WA 98103",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.66179,
"lon": -122.34233
},
"viewport": {
"topLeftPoint": {
"lat": 47.66269,
"lon": -122.34367
},
"btmRightPoint": {
"lat": 47.66089,
"lon": -122.34099
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.66188,
"lon": -122.34211
}
}
]
}
]
}
Definições
Nome | Description |
---|---|
Address |
O endereço do resultado |
Address |
Descreve o intervalo de endereços em ambos os lados da rua para obter um resultado de pesquisa. Coordenadas para os locais de início e término do intervalo de endereços estão incluídas. |
Bounding |
O visor que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita do visor. |
Bounding |
A caixa delimitadora do local. |
Brand |
A marca associada à POI |
Classification |
A classificação para a POI que está sendo retornada |
Classification |
Nome da classificação |
Data |
Seção opcional. IDs de referência para uso com a API Obter Polígono de Pesquisa. |
Electric |
Uma lista separada por vírgulas de tipos de conector que podem ser usados para restringir o resultado à Estação de Veículos Elétricos que dá suporte a tipos de conectores específicos. A ordem do item não importa. Quando vários tipos de conector são fornecidos, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados. Os tipos de conector disponíveis são:
Exemplos de uso: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
Entity |
Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa, isso é sempre igual à posição. |
Entry |
O ponto de entrada para a POI que está sendo retornada. |
Entry |
O tipo de ponto de entrada. O valor pode ser principal ou secundária. |
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta de erro |
Geographic |
Tipo de entidade geography. Presente somente quando entityType foi solicitado e está disponível. |
Geometry |
Informações sobre a forma geométrica do resultado. Presente somente se o tipo == Geografia. |
Lat |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
Localized |
O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição dessas regiões e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo atenderá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro Exibir no Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Mapas. Exemplo: view=IN. Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis. |
Match |
Tipos de correspondência para uma operação de pesquisa de endereço reverso. |
Operating |
Horário de funcionamento para uma POI (Pontos de Interesse). |
Operating |
Horas de operação para uma POI (pontos de interesse). A disponibilidade de horas de operação variará com base nos dados disponíveis. Se não for passado, nenhuma informação de horário de funcionamento será retornada. Valor com suporte: nextSevenDays |
Operating |
Representa uma data e hora |
Operating |
Abrir intervalo de tempo por um dia |
Point |
Detalhes da POI retornada, incluindo informações como nome, telefone, endereço de URL e classificações. |
Point |
Categoria poi |
Point |
Índices para os quais os códigos postais estendidos devem ser incluídos nos resultados. Os índices disponíveis são: de POI = Pontos de Interesse O valor deve ser poi ou nenhum para desabilitar códigos postais estendidos. Por padrão, os códigos postais estendidos são incluídos. Exemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=None O código postal estendido é retornado como uma propriedade extendedPostalCode de um endereço. A disponibilidade depende da região. |
Query |
O tipo de consulta que está sendo retornada: NEARBY ou NON_NEAR. |
Response |
Formato desejado da resposta. O valor pode ser json ou xml. |
Search |
Esse objeto é retornado de chamadas de pesquisa bem-sucedidas. |
Search |
Objeto de resultado para uma resposta da API de Pesquisa. |
Search |
Um destes:
|
Search |
Objeto resumo de uma resposta da API de Pesquisa. |
Address
O endereço do resultado
Nome | Tipo | Description |
---|---|---|
boundingBox |
A caixa delimitadora do local. |
|
buildingNumber |
string |
O número do prédio na rua. PRETERIDO, use streetNumber em vez disso. |
country |
string |
nome do país/região |
countryCode |
string |
País (Observação: este é um código de duas letras, não um nome de país/região.) |
countryCodeISO3 |
string |
Código de país alfa-3 iso |
countrySecondarySubdivision |
string |
Município |
countrySubdivision |
string |
Estado ou Província |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
O nome completo de uma hierarquia administrativa de primeiro nível de país/região. Esse campo é exibido somente no caso de countrySubdivision ser apresentado de forma abreviada. Só há suporte para EUA, Canadá e Reino Unido. |
countryTertiarySubdivision |
string |
Área Nomeada |
crossStreet |
string |
O nome da rua que está sendo atravessada. |
extendedPostalCode |
string |
Código postal estendido (a disponibilidade depende da região). |
freeformAddress |
string |
Uma linha de endereço formatada de acordo com as regras de formatação do país/região de origem de um resultado ou, no caso de um país/região, seu nome de país/região completo. |
localName |
string |
Um componente de endereço que representa o nome de uma área geográfica ou localidade que agrupa vários objetos endereçáveis para fins de endereçamento, sem ser uma unidade administrativa. Esse campo é usado para criar a propriedade |
municipality |
string |
Cidade/Cidade |
municipalitySubdivision |
string |
Sub/Super City |
neighbourhood |
string |
Um Bairro é uma área geograficamente localizada dentro de uma cidade ou cidade com características distintas e interações sociais entre os habitantes. |
postalCode |
string |
Cep/Cep |
routeNumbers |
string[] |
Os códigos usados para identificar de forma inequívoca a rua |
street |
string |
O nome da rua. PRETERIDO, use streetName em vez disso. |
streetName |
string |
O nome da rua. |
streetNameAndNumber |
string |
O nome e o número da rua. |
streetNumber |
string |
O número do prédio na rua. |
AddressRanges
Descreve o intervalo de endereços em ambos os lados da rua para obter um resultado de pesquisa. Coordenadas para os locais de início e término do intervalo de endereços estão incluídas.
Nome | Tipo | Description |
---|---|---|
from |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
|
rangeLeft |
string |
Intervalo de endereços no lado esquerdo da rua. |
rangeRight |
string |
Intervalo de endereços no lado direito da rua. |
to |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
BoundingBox
O visor que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.
Nome | Tipo | Description |
---|---|---|
btmRightPoint |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
|
topLeftPoint |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
BoundingBoxCompassNotation
A caixa delimitadora do local.
Nome | Tipo | Description |
---|---|---|
entity |
Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa, isso é sempre igual à posição. |
|
northEast |
string |
Latitude nordeste, coordenada longitude da caixa delimitadora como floats separados por vírgulas |
southWest |
string |
Latitude sudoeste, coordenada longitude da caixa delimitadora como floats separados por vírgulas |
Brand
A marca associada à POI
Nome | Tipo | Description |
---|---|---|
name |
string |
Nome da marca |
Classification
A classificação para a POI que está sendo retornada
Nome | Tipo | Description |
---|---|---|
code |
string |
Propriedade Code |
names |
Matriz de nomes |
ClassificationName
Nome da classificação
Nome | Tipo | Description |
---|---|---|
name |
string |
Propriedade Name |
nameLocale |
string |
Propriedade Name Locale |
DataSources
Seção opcional. IDs de referência para uso com a API Obter Polígono de Pesquisa.
Nome | Tipo | Description |
---|---|---|
geometry |
Informações sobre a forma geométrica do resultado. Presente somente se o tipo == Geografia. |
ElectricVehicleConnector
Uma lista separada por vírgulas de tipos de conector que podem ser usados para restringir o resultado à Estação de Veículos Elétricos que dá suporte a tipos de conectores específicos. A ordem do item não importa. Quando vários tipos de conector são fornecidos, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados.
Os tipos de conector disponíveis são:
-
StandardHouseholdCountrySpecific
- Estes são os conectores domésticos padrão para uma determinada região. Todas elas são uma única fase ac e a tensão padrão e o amperamento padrão. Veja também: tipos de soquete & plug – Padrões Mundiais. -
IEC62196Type1
- Conector tipo 1 conforme definido no padrão IEC 62196-2. Também chamado yazaki após o fabricante original ou SAE J1772 após o padrão que o publicou pela primeira vez. Usado principalmente em combinação com a fase única de 120V ou até 240V de infraestrutura de fase única. -
IEC62196Type1CCS
- Conector de combinação baseado no tipo 1, conforme definido no padrão IEC 62196-3. O conector baseia-se no conector tipo 1, conforme definido no padrão IEC 62196-2, com dois contatos dc (corrente direta) adicionais para permitir o carregamento rápido de DC. -
IEC62196Type2CableAttached
- Conector tipo 2 conforme definido no padrão IEC 62196-2. Fornecido como um cabo e plug anexado ao ponto de carregamento. -
IEC62196Type2Outlet
- Conector tipo 2 conforme definido no padrão IEC 62196-2. Fornecido como um soquete definido no ponto de carregamento. -
IEC62196Type2CCS
- Conector de combinação baseado no tipo 2, conforme definido no padrão IEC 62196-3. O conector baseia-se no conector tipo 2, conforme definido no padrão IEC 62196-2, com dois contatos atuais diretos adicionais (DC) para permitir o carregamento rápido de DC. -
IEC62196Type3
- Conector tipo 3 conforme definido no padrão IEC 62196-2. Também chamado de Scame após o fabricante original. Usado principalmente em combinação com até 240V de fase única ou até 420V de infraestrutura de três fases. -
Chademo
- Conector CHAdeMO com o nome de uma associação formada pela Tokyo Electric Power Company e parceiros industriais. Por isso também é conhecido como conector do TEPCO. Ele dá suporte a carregamento rápido de DC. -
IEC60309AC1PhaseBlue
– O conector Azul Industrial é um conector definido no padrão IEC 60309. Em algum momento, ele é conhecido como por alguma combinação do padrão, da cor e do fato de que é um conector de fase única. O conector geralmente tem a configuração "P+N+E, 6h". -
IEC60309DCWhite
– O conector Branco Industrial é um conector dc definido no padrão IEC 60309. -
Tesla
- O conector tesla é o conector do Tesla Supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, às vezes conhecido como Tesla Port, limitado principalmente à América do Norte ou o modificado Tipo 2 (DC sobre o Tipo 2) na Europa.
Exemplos de uso:
connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Valor | Description |
---|---|
Chademo |
Conector CHAdeMO com o nome de uma associação formada pela Tokyo Electric Power Company e parceiros industriais. Por isso também é conhecido como conector do TEPCO. Ele dá suporte a carregamento rápido de DC. |
IEC60309AC1PhaseBlue |
O conector Azul Industrial é um conector definido no padrão IEC 60309. Em algum momento, ele é conhecido como por alguma combinação do padrão, da cor e do fato de que é um conector de fase única. O conector geralmente tem a configuração "P+N+E, 6h". |
IEC60309DCWhite |
O conector Branco Industrial é um conector dc definido no padrão IEC 60309. |
IEC62196Type1 |
Conector tipo 1 conforme definido no padrão IEC 62196-2. Também chamado yazaki após o fabricante original ou SAE J1772 após o padrão que o publicou pela primeira vez. Usado principalmente em combinação com a fase única de 120V ou até 240V de infraestrutura de fase única. |
IEC62196Type1CCS |
Conector de combinação baseado no tipo 1, conforme definido no padrão IEC 62196-3. O conector baseia-se no conector tipo 1, conforme definido no padrão IEC 62196-2, com dois contatos dc (corrente direta) adicionais para permitir o carregamento rápido de DC. |
IEC62196Type2CCS |
Conector de combinação baseado no tipo 2, conforme definido no padrão IEC 62196-3. O conector baseia-se no conector tipo 2, conforme definido no padrão IEC 62196-2, com dois contatos atuais diretos adicionais (DC) para permitir o carregamento rápido de DC. |
IEC62196Type2CableAttached |
Conector tipo 2 conforme definido no padrão IEC 62196-2. Fornecido como um cabo e plug anexado ao ponto de carregamento |
IEC62196Type2Outlet |
Conector tipo 2 conforme definido no padrão IEC 62196-2. Fornecido como um soquete definido no ponto de carregamento. |
IEC62196Type3 |
Conector tipo 3 conforme definido no padrão IEC 62196-2. Também chamado de Scame após o fabricante original. Usado principalmente em combinação com até 240V de fase única ou até 420V de infraestrutura de três fases. |
StandardHouseholdCountrySpecific |
Estes são os conectores domésticos padrão para uma determinada região. Todas elas são uma única fase ac e a tensão padrão e o amperamento padrão. Veja também: tipos de soquete Plug & – World Standards |
Tesla |
O conector tesla é o conector do Tesla Supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, às vezes conhecido como Tesla Port, limitado principalmente à América do Norte ou o modificado Tipo 2 (DC sobre o Tipo 2) na Europa. |
Entity
Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa, isso é sempre igual à posição.
Valor | Description |
---|---|
position |
Entidade de posição |
EntryPoint
O ponto de entrada para a POI que está sendo retornada.
Nome | Tipo | Description |
---|---|---|
position |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
|
type |
O tipo de ponto de entrada. O valor pode ser principal ou secundária. |
EntryPointType
O tipo de ponto de entrada. O valor pode ser principal ou secundária.
Valor | Description |
---|---|
main | |
minor |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
Nome | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
Nome | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
GeographicEntityType
Tipo de entidade geography. Presente somente quando entityType foi solicitado e está disponível.
Valor | Description |
---|---|
Country |
nome do país/região |
CountrySecondarySubdivision |
Município |
CountrySubdivision |
Estado ou Província |
CountryTertiarySubdivision |
Área Nomeada |
Municipality |
Cidade/Cidade |
MunicipalitySubdivision |
Sub/Super City |
Neighbourhood |
Vizinhança |
PostalCodeArea |
Cep/Cep |
Geometry
Informações sobre a forma geométrica do resultado. Presente somente se o tipo == Geografia.
Nome | Tipo | Description |
---|---|---|
id |
string |
Passe isso como geometryId para a API Obter Polígono de Pesquisa para buscar informações de geometria para esse resultado. |
LatLongPairAbbreviated
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.
Nome | Tipo | Description |
---|---|---|
lat |
number (double) |
Propriedade Latitude |
lon |
number (double) |
Propriedade Longitude |
LocalizedMapView
O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição dessas regiões e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo atenderá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro Exibir no Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Mapas. Exemplo: view=IN.
Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis.
Valor | Description |
---|---|
AE |
Emirados Árabes Unidos (Exibição árabe) |
AR |
Argentina (Exibição argentina) |
Auto |
Retorne os dados do mapa com base no endereço IP da solicitação. |
BH |
Bahrein (exibição árabe) |
IN |
Índia (Modo de Exibição Indiano) |
IQ |
Iraque (exibição árabe) |
JO |
Jordânia (exibição árabe) |
KW |
Kuwait (exibição árabe) |
LB |
Líbano (exibição árabe) |
MA |
Marrocos (Vista Marroquina) |
OM |
Omã (exibição árabe) |
PK |
Paquistão (Exibição paquistanesa) |
PS |
Autoridade Palestina (Exibição Árabe) |
QA |
Catar (exibição árabe) |
SA |
Arábia Saudita (exibição árabe) |
SY |
Síria (Exibição árabe) |
Unified |
Exibição unificada (outros) |
YE |
Iêmen (exibição árabe) |
MatchType
Tipos de correspondência para uma operação de pesquisa de endereço reverso.
Valor | Description |
---|---|
AddressPoint | |
HouseNumberRange | |
Street |
OperatingHours
Horário de funcionamento para uma POI (Pontos de Interesse).
Nome | Tipo | Description |
---|---|---|
mode |
string |
Valor usado na solicitação: nenhum ou "nextSevenDays" |
timeRanges |
Lista de intervalos de tempo para os próximos 7 dias |
OperatingHoursRange
Horas de operação para uma POI (pontos de interesse). A disponibilidade de horas de operação variará com base nos dados disponíveis. Se não for passado, nenhuma informação de horário de funcionamento será retornada. Valor com suporte: nextSevenDays
Valor | Description |
---|---|
nextSevenDays |
Mostra as horas de operação para a próxima semana, começando com o dia atual no horário local da POI. |
OperatingHoursTime
Representa uma data e hora
Nome | Tipo | Description |
---|---|---|
date |
string |
Representa a data do calendário atual no fuso horário da POI, por exemplo, "2019-02-07". |
hour |
integer |
As horas estão no formato de 24 horas no horário local de uma POI; os valores possíveis são 0 a 23. |
minute |
integer |
Os minutos estão no horário local de uma POI; os valores possíveis são 0 a 59. |
OperatingHoursTimeRange
Abrir intervalo de tempo por um dia
Nome | Tipo | Description |
---|---|---|
endTime |
O ponto nos próximos 7 dias intervalo quando uma determinada POI está sendo fechada ou o início do intervalo se ele foi fechado antes do intervalo. |
|
startTime |
O ponto nos próximos 7 dias intervalo quando uma determinada POI está sendo aberta ou o início do intervalo se ele foi aberto antes do intervalo. |
PointOfInterest
Detalhes da POI retornada, incluindo informações como nome, telefone, endereço de URL e classificações.
Nome | Tipo | Description |
---|---|---|
brands |
Brand[] |
Matriz de marcas. O nome da marca para a POI que está sendo retornada. |
categories |
string[] |
Matriz de categorias |
categorySet |
A lista das categorias de POI mais específicas |
|
classifications |
Matriz de classificação |
|
name |
string |
Nome da propriedade POI |
openingHours |
Horário de funcionamento para uma POI (Pontos de Interesse). |
|
phone |
string |
Propriedade número de telefone |
url |
string |
Propriedade URL do site |
PointOfInterestCategorySet
Categoria poi
Nome | Tipo | Description |
---|---|---|
id |
integer |
ID da categoria |
PointOfInterestExtendedPostalCodes
Índices para os quais os códigos postais estendidos devem ser incluídos nos resultados.
Os índices disponíveis são:
de POI = Pontos de Interesse
O valor deve ser poi ou nenhum para desabilitar códigos postais estendidos.
Por padrão, os códigos postais estendidos são incluídos.
Exemplos de uso:
extendedPostalCodesFor=POI
extendedPostalCodesFor=None
O código postal estendido é retornado como uma propriedade extendedPostalCode de um endereço. A disponibilidade depende da região.
Valor | Description |
---|---|
None | |
POI |
QueryType
O tipo de consulta que está sendo retornada: NEARBY ou NON_NEAR.
Valor | Description |
---|---|
NEARBY |
A pesquisa foi realizada em torno de uma certa latitude e longitude com um raio definido |
NON_NEAR |
A pesquisa foi realizada globalmente, sem ser tendenciosa para uma determinada latitude e longitude, e nenhum raio definido |
ResponseFormat
Formato desejado da resposta. O valor pode ser json ou xml.
Valor | Description |
---|---|
json |
o formato de intercâmbio de dados de notação de objeto JavaScript |
xml |
SearchAddressResult
Esse objeto é retornado de chamadas de pesquisa bem-sucedidas.
Nome | Tipo | Description |
---|---|---|
results |
Uma lista de resultados da API de Pesquisa. |
|
summary |
Objeto resumo de uma resposta à API de Pesquisa |
SearchAddressResultItem
Objeto de resultado para uma resposta da API de Pesquisa.
Nome | Tipo | Description |
---|---|---|
address |
O endereço do resultado |
|
addressRanges |
Descreve o intervalo de endereços em ambos os lados da rua para obter um resultado de pesquisa. Coordenadas para os locais de início e término do intervalo de endereços estão incluídas. |
|
dataSources |
Seção opcional. ID de geometria de referência para uso com a API obter polígono de pesquisa. |
|
detourTime |
integer |
Tempo de desvio em segundos. Retornado apenas para chamadas para a API pesquisar ao longo da rota. |
dist |
number (double) |
Distância de linha reta entre o resultado e a localização geográfica em metros. |
entityType |
Tipo de entidade geography. Presente somente quando entityType foi solicitado e está disponível. |
|
entryPoints |
Matriz de EntryPoints. Eles descrevem os tipos de entradas disponíveis no local. O tipo pode ser "principal" para entradas principais, como uma porta da frente, ou um lobby, e "menor", para portas laterais e traseiras. |
|
id |
string |
Propriedade Id |
info |
string |
Informações sobre a fonte de dados original do Resultado. Usado para solicitações de suporte. |
matchType |
Informações sobre o tipo de correspondência. Um destes:
|
|
poi |
Detalhes da POI retornada, incluindo informações como nome, telefone, endereço de URL e classificações. |
|
position |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
|
score |
number (double) |
O valor dentro de um conjunto de resultados para indicar a pontuação de correspondência relativa entre os resultados. Você pode usá-lo para determinar que o resultado x tem duas vezes mais chances de ser tão relevante quanto o resultado y se o valor de x for 2x o valor de y. Os valores variam entre consultas e são destinados apenas como um valor relativo para um conjunto de resultados. |
type |
Um destes:
|
|
viewport |
O visor que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita do visor. |
SearchAddressResultType
Um destes:
- POI
- Rua
- Geografia
- Endereço de ponto
- Intervalo de endereços
- Cruzamento
Valor | Description |
---|---|
Address Range | |
Cross Street | |
Geography | |
POI | |
Point Address | |
Street |
SearchSummary
Objeto resumo de uma resposta da API de Pesquisa.
Nome | Tipo | Description |
---|---|---|
fuzzyLevel |
integer |
O nível difuso máximo necessário para fornecer Resultados. |
geoBias |
Indicação de quando o mecanismo de pesquisa interno aplicou um viés geoespacial para melhorar a classificação dos resultados. Em alguns métodos, isso pode ser afetado definindo os parâmetros lat e lon quando disponíveis. Em outros casos, é puramente interno. |
|
limit |
integer |
Número máximo de respostas que serão retornadas |
numResults |
integer |
Número de resultados na resposta. |
offset |
integer |
O deslocamento inicial dos resultados retornados dentro do conjunto de resultados completo. |
query |
string |
O parâmetro de consulta usado para produzir esses resultados da pesquisa. |
queryTime |
integer |
Tempo gasto resolvendo a consulta, em milissegundos. |
queryType |
O tipo de consulta que está sendo retornada: NEARBY ou NON_NEAR. |
|
totalResults |
integer |
O número total de resultados encontrados. |