Search - Get Search POI
Use para pesquisar pontos de interesse pelo nome.
A API Points of Interest (POI) Search
é uma solicitação de GET
HTTP que permite solicitar resultados de POI pelo nome. Ele também suporta parâmetros de consulta adicionais, como idioma e filtragem de resultados por área de interesse orientada por país/região ou caixa delimitadora. O Endpoint retornará apenas resultados de POI correspondentes à cadeia de caracteres de consulta. A resposta inclui detalhes do POI, como endereço, localização 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 do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
format
|
path | True |
Formato desejado da resposta. O valor pode ser json ou xml. |
|
api-version
|
query | True |
string |
Número da versão da API do Azure Maps. |
query
|
query | True |
string |
O nome do POI a ser pesquisado (por exemplo, "estátua da liberdade", "starbucks") deve ser codificado corretamente por URL. |
brand
|
query |
string[] |
Uma lista separada por vírgulas de nomes de marcas que poderiam ser usados para restringir o resultado a marcas específicas. A ordem dos itens não importa. Quando várias marcas são fornecidas, apenas 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,C Vírgula",Bar |
|
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 podem ser usadas para restringir o resultado a categorias específicas de Pontos de Interesse. A ordem de identificação não importa. O número máximo de valores de
|
|
connector
|
query |
Uma lista separada por vírgulas dos tipos de conectores que podem ser usados para restringir o resultado à Estação de Veículos Elétricos que suporta tipos de conectores específicos. A ordem dos itens não importa. Quando vários tipos de conector são fornecidos, somente os resultados que pertencem a (pelo menos) um da lista fornecida serão retornados. Os tipos de conectores disponíveis são:
Exemplos de uso: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
||
country
|
query |
string[] |
Cadeia de códigos de país/região separada por vírgula, por exemplo, FR,ES. Isso limitará a pesquisa aos países/regiões especificados |
|
extended
|
query |
Os índices para os quais os códigos postais alargados devem ser incluídos nos resultados. Os índices disponíveis são: POI = Pontos de Interesse O valor deve ser POI ou Nenhum para desativar códigos postais estendidos. Por padrão, os códigos postais estendidos estão incluídos. Exemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=Nenhum O código postal estendido é devolvido como um código postal estendido propriedade de um endereço. A disponibilidade depende da região. |
||
language
|
query |
string |
Idioma em que os resultados da pesquisa devem ser retornados. Deve ser uma das tags de idioma IETF suportadas, sem distinção entre maiúsculas e 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 onde os resultados devem ser tendenciosos. Por exemplo, 37.337 |
|
limit
|
query |
integer minimum: 1maximum: 100 |
Número máximo de respostas que serão devolvidas. Padrão: 10, mínimo: 1 e máximo: 100 |
|
lon
|
query |
number (double) |
Longitude onde os resultados devem ser tendenciosos. Por exemplo, -121,89 |
|
ofs
|
query |
integer minimum: 0maximum: 1900 |
Deslocamento inicial dos resultados retornados dentro do conjunto completo de resultados. Padrão: 0 |
|
opening
|
query |
Horário de funcionamento de um POI (Pontos de Interesse). A disponibilidade de horários de funcionamento variará de acordo com os dados disponíveis. Se não for aprovado, nenhuma informação de horário de funcionamento será devolvida. Valor suportado: nextSevenDays |
||
radius
|
query |
integer |
O raio em metros para que os resultados sejam restringidos à á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 preditivo |
|
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 geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. 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 Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN. Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis. |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
x-ms-client-id |
string |
Especifica qual conta deve ser usada em conjunto com o modelo de segurança do Microsoft Entra ID. Ele representa uma ID exclusiva para a conta do Azure Maps e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Maps. Para usar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientação. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Ocorreu um erro inesperado. |
Segurança
AADToken
Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. 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 Maps.
Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de 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 Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento de do Maps. - O
Authorization URL
é específico para a instância de nuvem pública do Azure. As 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 a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
- O uso do SDK da Web do Azure Maps 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
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.
Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.
Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de de aplicativos cliente confidenciais para acessar APIs REST do Azure Maps para que sua chave possa ser armazenada com segurança.
Tipo:
apiKey
Em:
query
SAS Token
Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do
Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(ões) 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 segura 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 do
Tipo:
apiKey
Em:
header
Exemplos
Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results
Pedido de amostra
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 da amostra
{
"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
Name | Description |
---|---|
Address |
O endereço do resultado |
Address |
Descreve o intervalo de endereços em ambos os lados da rua para um resultado de pesquisa. As coordenadas para os locais de início e fim do intervalo de endereços estão incluídas. |
Bounding |
O visor que cobre o resultado representado pelas coordenadas superior esquerda e inferior direita do visor. |
Bounding |
A caixa delimitadora do local. |
Brand |
A marca associada ao POI |
Classification |
A classificação para o POI que está sendo devolvido |
Classification |
Nome para a classificação |
Data |
Secção opcional. IDs de referência para uso com a API Obter Polígono de Pesquisa. |
Electric |
Uma lista separada por vírgulas dos tipos de conectores que podem ser usados para restringir o resultado à Estação de Veículos Elétricos que suporta tipos de conectores específicos. A ordem dos itens não importa. Quando vários tipos de conector são fornecidos, somente os resultados que pertencem a (pelo menos) um da lista fornecida serão retornados. Os tipos de conectores 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 o POI que está sendo retornado. |
Entry |
O tipo de ponto de entrada. O valor pode ser principal ou menor. |
Error |
O erro de gerenciamento de recursos informações adicionais. |
Error |
O detalhe do erro. |
Error |
Resposta de erro |
Geographic |
Tipo de entidade geográfica. Presente somente quando entityType foi solicitado e está disponível. |
Geometry |
Informações sobre a forma geométrica do resultado. Presente apenas se o tipo == Geografia. |
Lat |
Um local representado como uma 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 geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. 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 Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN. Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis. |
Match |
Tipos de correspondência para uma operação de pesquisa de endereço reverso. |
Operating |
Horário de funcionamento de um POI (Pontos de Interesse). |
Operating |
Horário de funcionamento de um POI (Pontos de Interesse). A disponibilidade de horários de funcionamento variará de acordo com os dados disponíveis. Se não for aprovado, nenhuma informação de horário de funcionamento será devolvida. Valor suportado: nextSevenDays |
Operating |
Representa uma data e hora |
Operating |
Intervalo de tempo aberto por um dia |
Point |
Detalhes do POI retornado, incluindo informações como nome, telefone, endereço url e classificações. |
Point |
Categoria POI |
Point |
Os índices para os quais os códigos postais alargados devem ser incluídos nos resultados. Os índices disponíveis são: POI = Pontos de Interesse O valor deve ser POI ou Nenhum para desativar códigos postais estendidos. Por padrão, os códigos postais estendidos estão incluídos. Exemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=Nenhum O código postal estendido é devolvido como um código postal estendido propriedade de um endereço. A disponibilidade depende da região. |
Query |
O tipo de consulta que está sendo retornada: PERTO ou NON_NEAR. |
Response |
Formato desejado da resposta. O valor pode ser json ou xml. |
Search |
Este objeto é retornado de uma chamada de Pesquisa bem-sucedida. |
Search |
Objeto de resultado para uma resposta da API de pesquisa. |
Search |
Um dos seguintes:
|
Search |
Objeto de resumo para uma resposta da API de pesquisa. |
Address
O endereço do resultado
Name | Tipo | Description |
---|---|---|
boundingBox |
A caixa delimitadora do local. |
|
buildingNumber |
string |
O número do edifício na rua. DEPRECATED, use streetNumber em vez disso. |
country |
string |
Nome do país/região |
countryCode |
string |
País (Nota: Este é um código de duas letras, não um nome de país/região.) |
countryCodeISO3 |
string |
Código ISO alpha-3 do país |
countrySecondarySubdivision |
string |
Condado |
countrySubdivision |
string |
Distrito |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
O nome completo de um primeiro nível de hierarquia administrativa de país/região. Este campo aparece apenas no caso de paísSubdivisão ser apresentado de forma abreviada. Apenas suportado 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, o nome completo do país/região. |
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. Este campo é usado para construir a propriedade |
municipality |
string |
Cidade |
municipalitySubdivision |
string |
Sub / Super Cidade |
neighbourhood |
string |
Um Bairro é uma área geograficamente localizada dentro de uma cidade ou vila, com características distintas e interações sociais entre os habitantes. |
postalCode |
string |
Código Postal / Código Postal |
routeNumbers |
string[] |
Os códigos utilizados para identificar inequivocamente a rua |
street |
string |
O nome da rua. DEPRECATED, 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 edifício na rua. |
AddressRanges
Descreve o intervalo de endereços em ambos os lados da rua para um resultado de pesquisa. As coordenadas para os locais de início e fim do intervalo de endereços estão incluídas.
Name | Tipo | Description |
---|---|---|
from |
Um local representado como uma 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 uma latitude e longitude usando nomes curtos 'lat' & 'lon'. |
BoundingBox
O visor que cobre o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.
Name | Tipo | Description |
---|---|---|
btmRightPoint |
Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'. |
|
topLeftPoint |
Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'. |
BoundingBoxCompassNotation
A caixa delimitadora do local.
Name | Tipo | Description |
---|---|---|
entity |
Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa isso é sempre igual à posição. |
|
northEast |
string |
latitude nordeste, coordenadas de longitude da caixa delimitadora como flutuadores separados por vírgulas |
southWest |
string |
latitude sudoeste, coordenadas de longitude da caixa delimitadora como flutuadores separados por vírgulas |
Brand
A marca associada ao POI
Name | Tipo | Description |
---|---|---|
name |
string |
Nome da marca |
Classification
A classificação para o POI que está sendo devolvido
Name | Tipo | Description |
---|---|---|
code |
string |
Propriedade de Código |
names |
Matriz de nomes |
ClassificationName
Nome para a classificação
Name | Tipo | Description |
---|---|---|
name |
string |
Propriedade Name |
nameLocale |
string |
Propriedade Name Locale |
DataSources
Secção opcional. IDs de referência para uso com a API Obter Polígono de Pesquisa.
Name | Tipo | Description |
---|---|---|
geometry |
Informações sobre a forma geométrica do resultado. Presente apenas se o tipo == Geografia. |
ElectricVehicleConnector
Uma lista separada por vírgulas dos tipos de conectores que podem ser usados para restringir o resultado à Estação de Veículos Elétricos que suporta tipos de conectores específicos. A ordem dos itens não importa. Quando vários tipos de conector são fornecidos, somente os resultados que pertencem a (pelo menos) um da lista fornecida serão retornados.
Os tipos de conectores disponíveis são:
-
StandardHouseholdCountrySpecific
- Estes são os conectores domésticos padrão para uma determinada região. Eles são todos AC monofásico e a tensão padrão e amperagem padrão. Consulte também: Tipos de tomadas & plugue - World Standards. -
IEC62196Type1
- Conector tipo 1, conforme definido na norma 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 infraestrutura monofásica de 120V ou até 240V monofásica. -
IEC62196Type1CCS
- Conector combinado baseado no tipo 1, conforme definido na norma IEC 62196-3. O conector é baseado no conector Tipo 1 – conforme definido na norma IEC 62196-2 – com dois contatos adicionais de corrente contínua (DC) para permitir o carregamento rápido DC. -
IEC62196Type2CableAttached
- Conector tipo 2, conforme definido na norma IEC 62196-2. Fornecido como um cabo e ficha ligados ao ponto de carregamento. -
IEC62196Type2Outlet
- Conector tipo 2, conforme definido na norma IEC 62196-2. Fornecido como um conjunto de tomada no ponto de carregamento. -
IEC62196Type2CCS
- Conector combinado baseado no tipo 2, conforme definido na norma IEC 62196-3. O conector é baseado no conector Tipo 2 – conforme definido na norma IEC 62196-2 – com dois contatos adicionais de corrente contínua (DC) para permitir o carregamento rápido DC. -
IEC62196Type3
- Conector tipo 3, conforme definido na norma IEC 62196-2. Também chamado de Scame em homenagem ao fabricante original. Usado principalmente em combinação com infraestrutura monofásica de até 240V ou trifásica de até 420V. -
Chademo
- Conector CHAdeMO em homenagem a uma associação formada pela Tokyo Electric Power Company e parceiros industriais. Por causa disso também é conhecido como o conector da TEPCO. Suporta carregamento DC rápido. -
IEC60309AC1PhaseBlue
- Conector azul industrial é um conector definido na norma IEC 60309. É em algum momento referido como por alguma combinação do padrão, a cor eo fato de que é um conector monofásico. O conector geralmente tem a configuração "P + N + E, 6h". -
IEC60309DCWhite
- Industrial White connector é um conector DC definido na norma IEC 60309. -
Tesla
- O conector Tesla é o conector Supercharger Tesla específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, às vezes referido como Tesla Port principalmente limitado à América do Norte ou ao Tipo 2 modificado (DC sobre Tipo 2) na Europa.
Exemplos de uso:
connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Valor | Description |
---|---|
Chademo |
Conector CHAdeMO em homenagem a uma associação formada pela Tokyo Electric Power Company e parceiros industriais. Por causa disso também é conhecido como o conector da TEPCO. Suporta carregamento DC rápido. |
IEC60309AC1PhaseBlue |
Conector azul industrial é um conector definido na norma IEC 60309. É em algum momento referido como por alguma combinação do padrão, a cor eo fato de que é um conector monofásico. O conector geralmente tem a configuração "P + N + E, 6h". |
IEC60309DCWhite |
Industrial White connector é um conector DC definido na norma IEC 60309. |
IEC62196Type1 |
Conector tipo 1, conforme definido na norma 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 infraestrutura monofásica de 120V ou até 240V monofásica. |
IEC62196Type1CCS |
Conector combinado baseado no tipo 1, conforme definido na norma IEC 62196-3. O conector é baseado no conector Tipo 1 – conforme definido na norma IEC 62196-2 – com dois contatos adicionais de corrente contínua (DC) para permitir o carregamento rápido DC. |
IEC62196Type2CCS |
Conector combinado baseado no tipo 2, conforme definido na norma IEC 62196-3. O conector é baseado no conector Tipo 2 – conforme definido na norma IEC 62196-2 – com dois contatos adicionais de corrente contínua (DC) para permitir o carregamento rápido DC. |
IEC62196Type2CableAttached |
Conector tipo 2, conforme definido na norma IEC 62196-2. Fornecido como um cabo e ficha ligados ao ponto de carregamento |
IEC62196Type2Outlet |
Conector tipo 2, conforme definido na norma IEC 62196-2. Fornecido como um conjunto de tomada no ponto de carregamento. |
IEC62196Type3 |
Conector tipo 3, conforme definido na norma IEC 62196-2. Também chamado de Scame em homenagem ao fabricante original. Usado principalmente em combinação com infraestrutura monofásica de até 240V ou trifásica de até 420V. |
StandardHouseholdCountrySpecific |
Estes são os conectores domésticos padrão para uma determinada região. Eles são todos AC monofásico e a tensão padrão e amperagem padrão. Consulte também: Tipos de tomadas & plugue - World Standards |
Tesla |
O conector Tesla é o conector Supercharger Tesla específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, às vezes referido como Tesla Port principalmente limitado à América do Norte ou ao Tipo 2 modificado (DC sobre 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 o POI que está sendo retornado.
Name | Tipo | Description |
---|---|---|
position |
Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'. |
|
type |
O tipo de ponto de entrada. O valor pode ser principal ou menor. |
EntryPointType
O tipo de ponto de entrada. O valor pode ser principal ou menor.
Valor | Description |
---|---|
main | |
minor |
ErrorAdditionalInfo
O erro de gerenciamento de recursos informações adicionais.
Name | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
Name | Tipo | Description |
---|---|---|
additionalInfo |
O erro informações adicionais. |
|
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
Name | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
GeographicEntityType
Tipo de entidade geográfica. Presente somente quando entityType foi solicitado e está disponível.
Valor | Description |
---|---|
Country |
Nome do país/região |
CountrySecondarySubdivision |
Condado |
CountrySubdivision |
Distrito |
CountryTertiarySubdivision |
Área nomeada |
Municipality |
Cidade |
MunicipalitySubdivision |
Sub / Super Cidade |
Neighbourhood |
Bairro |
PostalCodeArea |
Código Postal / Código Postal |
Geometry
Informações sobre a forma geométrica do resultado. Presente apenas se o tipo == Geografia.
Name | Tipo | Description |
---|---|---|
id |
string |
Passe isso como geometryId para o Get Search Polygon API para buscar informações de geometria para esse resultado. |
LatLongPairAbbreviated
Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'.
Name | 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 geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. 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 Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN.
Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.
Valor | Description |
---|---|
AE |
Emirados Árabes Unidos (Vista árabe) |
AR |
Argentina (Vista Argentina) |
Auto |
Retornar os dados do mapa com base no endereço IP da solicitação. |
BH |
Bahrein (Vista árabe) |
IN |
Índia (Vista indiana) |
IQ |
Iraque (Vista árabe) |
JO |
Jordânia (Vista árabe) |
KW |
Kuwait (Vista árabe) |
LB |
Líbano (Vista árabe) |
MA |
Marrocos (Vista Marroquina) |
OM |
Omã (Vista árabe) |
PK |
Paquistão (Vista paquistanesa) |
PS |
Autoridade Palestiniana (Vista árabe) |
QA |
Qatar (Vista árabe) |
SA |
Arábia Saudita (Vista árabe) |
SY |
Síria (Vista árabe) |
Unified |
Modo de Exibição Unificado (Outros) |
YE |
Iémen (Vista á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 de um POI (Pontos de Interesse).
Name | Tipo | Description |
---|---|---|
mode |
string |
Valor usado na solicitação: none ou "nextSevenDays" |
timeRanges |
Lista de intervalos de tempo para os próximos 7 dias |
OperatingHoursRange
Horário de funcionamento de um POI (Pontos de Interesse). A disponibilidade de horários de funcionamento variará de acordo com os dados disponíveis. Se não for aprovado, nenhuma informação de horário de funcionamento será devolvida. Valor suportado: nextSevenDays
Valor | Description |
---|---|
nextSevenDays |
Mostra o horário de funcionamento para a semana seguinte, começando com o dia atual na hora local do POI. |
OperatingHoursTime
Representa uma data e hora
Name | Tipo | Description |
---|---|---|
date |
string |
Representa a data atual do calendário no fuso horário POI, por exemplo, "2019-02-07". |
hour |
integer |
As horas estão no formato de 24 horas no horário local de um POI; Os valores possíveis são 0 - 23. |
minute |
integer |
Os minutos estão na hora local de um POI; Os valores possíveis são 0 - 59. |
OperatingHoursTimeRange
Intervalo de tempo aberto por um dia
Name | Tipo | Description |
---|---|---|
endTime |
O ponto no próximo intervalo de 7 dias quando um determinado POI está sendo fechado, ou o início do intervalo se ele foi fechado antes do intervalo. |
|
startTime |
O ponto no intervalo de 7 dias seguintes quando um determinado POI está sendo aberto, ou o início do intervalo se ele foi aberto antes do intervalo. |
PointOfInterest
Detalhes do POI retornado, incluindo informações como nome, telefone, endereço url e classificações.
Name | Tipo | Description |
---|---|---|
brands |
Brand[] |
Matriz de marcas. O nome da marca para o POI sendo devolvido. |
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 de um POI (Pontos de Interesse). |
|
phone |
string |
Propriedade do número de telefone |
url |
string |
Propriedade URL do site |
PointOfInterestCategorySet
Categoria POI
Name | Tipo | Description |
---|---|---|
id |
integer |
ID da categoria |
PointOfInterestExtendedPostalCodes
Os índices para os quais os códigos postais alargados devem ser incluídos nos resultados.
Os índices disponíveis são:
POI = Pontos de Interesse
O valor deve ser POI ou Nenhum para desativar códigos postais estendidos.
Por padrão, os códigos postais estendidos estão incluídos.
Exemplos de uso:
extendedPostalCodesFor=POI
extendedPostalCodesFor=Nenhum
O código postal estendido é devolvido como um código postal estendido propriedade de um endereço. A disponibilidade depende da região.
Valor | Description |
---|---|
None | |
POI |
QueryType
O tipo de consulta que está sendo retornada: PERTO ou NON_NEAR.
Valor | Description |
---|---|
NEARBY |
A pesquisa foi realizada em torno de uma determinada latitude e longitude com um raio definido |
NON_NEAR |
A pesquisa foi realizada globalmente, sem polarização para uma determinada latitude e longitude, e sem 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
Este objeto é retornado de uma chamada de Pesquisa bem-sucedida.
Name | Tipo | Description |
---|---|---|
results |
Uma lista de resultados da API de pesquisa. |
|
summary |
Objeto de resumo para uma resposta da API de Pesquisa |
SearchAddressResultItem
Objeto de resultado para uma resposta da API de pesquisa.
SearchAddressResultType
Um dos seguintes:
- POI
- Rua
- Geografia
- Endereço do ponto
- Intervalo de endereços
- Rua Cross
Valor | Description |
---|---|
Address Range | |
Cross Street | |
Geography | |
POI | |
Point Address | |
Street |
SearchSummary
Objeto de resumo para uma resposta da API de pesquisa.
Name | Tipo | Description |
---|---|---|
fuzzyLevel |
integer |
O nível máximo difuso necessário para fornecer Resultados. |
geoBias |
Indicação de quando o motor de busca interno aplicou um viés geoespacial para melhorar a classificação dos resultados. Em alguns métodos, isso pode ser afetado pela definição dos parâmetros lat e lon, quando disponíveis. Noutros casos, é puramente interna. |
|
limit |
integer |
Número máximo de respostas que serão devolvidas |
numResults |
integer |
Número de resultados na resposta. |
offset |
integer |
O deslocamento inicial dos Resultados retornados dentro do conjunto completo de Resultados. |
query |
string |
O parâmetro de consulta que foi usado para produzir esses resultados de pesquisa. |
queryTime |
integer |
Tempo gasto na resolução da consulta, em milissegundos. |
queryType |
O tipo de consulta que está sendo retornada: PERTO ou NON_NEAR. |
|
totalResults |
integer |
O número total de Resultados encontrados. |