Search - Post Search Along Route
Utilize para efetuar uma pesquisa difusa de POIs ao longo de uma rota especificada.
A Post Search Along Route
API é um pedido HTTP POST
que lhe permite efetuar uma pesquisa difusa de POIs ao longo de uma rota especificada. Esta pesquisa é restrita ao especificar a maxDetourTime
medida de limitação.
Para enviar os pontos de rota, irá utilizar um POST
pedido em que o corpo do pedido irá conter o route
objeto representado como um GeoJSON LineString
tipo e o Content-Type
cabeçalho será definido como application/json
. Cada ponto de rota no route
é representado como um GeoJSON Position
tipo, ou seja, uma matriz em que o valor de longitude é seguido pelo valor de latitude e o valor de altitude é ignorado. O route
deve conter, pelo menos, 2 pontos de rota.
É possível que a rota original seja alterada, alguns dos pontos podem ser ignorados. Se a rota que passa pelo ponto encontrado for mais rápida do que a original, o detourTime
valor na resposta é negativo.
POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}
POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}&limit={limit}&brandSet={brandSet}&categorySet={categorySet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
format
|
path | True |
Response |
Formato pretendido da resposta. O valor pode ser json ou xml. |
api-version
|
query | True |
string |
Número da versão da API Azure Maps. |
max
|
query | True |
integer |
Tempo máximo de desvio do ponto de interesse em segundos. O valor máximo é de 3600 segundos |
query
|
query | True |
string |
O nome POI a procurar (por exemplo, "estátua da liberdade", "starbucks", "pizza"). Tem de ser codificado corretamente pelo URL. |
brand
|
query |
string[] |
Uma lista separada por vírgulas de nomes de marcas que poderiam ser utilizadas para restringir o resultado a marcas específicas. A ordem dos itens não importa. Quando são fornecidas várias marcas, só serão devolvidos resultados que pertençam (pelo menos) a uma das listas fornecidas. As marcas que contêm uma "," no seu nome devem ser colocadas entre aspas. Exemplos de utilização: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,Vírgula C",Barra |
|
category
|
query |
integer[] |
Uma lista separada por vírgulas de IDs de conjuntos de categorias que podem ser utilizados para restringir o resultado a categorias específicas de Pontos de Interesse. A encomenda de ID não importa. O número máximo de
|
|
connector
|
query |
Electric |
Uma lista separada por vírgulas de tipos de conectores que poderiam ser utilizados para restringir o resultado à Estação de Veículos Elétricos que suportasse tipos de conectores específicos. A ordem dos itens não importa. Quando são fornecidos vários tipos de conectores, só serão devolvidos resultados que pertençam (pelo menos) a uma das listas fornecidas. Os tipos de conector disponíveis são:
Exemplos de utilização: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
|
limit
|
query |
integer |
Número máximo de respostas que serão devolvidas. O valor predefinido é 10. O valor máximo é 20 |
|
opening
|
query |
Operating |
Horas de funcionamento de um POI (Pontos de Interesse). A disponibilidade de horas de operação irá variar com base nos dados disponíveis. Se não passar, não serão devolvidas informações sobre o horário de funcionamento. Valor suportado: nextSevenDays |
|
view
|
query |
Localized |
O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que irá devolver os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN. Consulte As Vistas Suportadas para obter detalhes e ver as Vistas disponíveis. |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
x-ms-client-id |
string |
Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps consulte os seguintes artigos para obter orientações. |
Corpo do Pedido
Name | Tipo | Description |
---|---|---|
route |
Geo |
Um tipo de geometria válido |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Search |
OK |
Other Status Codes |
Error |
Ocorreu um erro inesperado. |
Segurança
AADToken
Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.
Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.
Nota
- Esta definição de segurança requer a utilização do
x-ms-client-id
cabeçalho para indicar a que recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps . - O
Authorization URL
é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. - O controlo de acesso baseado em funções do Azure é configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
- A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.
- Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Esta é uma chave partilhada que é aprovisionada quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.
Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.
Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.
Type:
apiKey
In:
query
SAS Token
Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.
Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.
Type:
apiKey
In:
header
Exemplos
Search for burger joints along a route
Sample Request
POST https://atlas.microsoft.com/search/alongRoute/json?api-version=1.0&query=burger&maxDetourTime=1000&limit=2&openingHours=nextSevenDays
{
"route": {
"type": "LineString",
"coordinates": [
[
-122.143035,
47.653536
],
[
-122.187164,
47.617556
],
[
-122.114981,
47.570599
],
[
-122.132756,
47.654009
]
]
}
}
Sample Response
{
"summary": {
"query": "burger",
"queryType": "NON_NEAR",
"queryTime": 394,
"numResults": 2,
"offset": 0,
"totalResults": 2,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/8596348",
"score": 3.104,
"dist": 1754.9604168059973,
"info": "search:ta:840531000465150-US",
"poi": {
"name": "BURGER KING",
"phone": "+(1)-(425)-7467508",
"brands": [
{
"name": "BURGER KING"
}
],
"categorySet": [
{
"id": 7315015
}
],
"url": "www.burgerking.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "fast food"
}
]
}
]
},
"address": {
"streetNumber": "14620",
"streetName": "NE 24th St",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "14620 NE 24th St, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63188,
"lon": -122.14462
},
"viewport": {
"topLeftPoint": {
"lat": 47.63278,
"lon": -122.14595
},
"btmRightPoint": {
"lat": 47.63098,
"lon": -122.14329
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.63155,
"lon": -122.14462
}
}
],
"detourTime": -55
},
{
"type": "POI",
"id": "US/POI/p0/8596112",
"score": 3.111,
"dist": 161.17565489389224,
"info": "search:ta:840531000465149-US",
"poi": {
"name": "BURGER KING",
"phone": "+(1)-(425)-4535775",
"brands": [
{
"name": "BURGER KING"
}
],
"categorySet": [
{
"id": 7315015
}
],
"url": "www.burgerking.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "fast food"
}
]
}
]
},
"address": {
"streetNumber": "11723",
"streetName": "NE 8th St",
"municipalitySubdivision": "Willburton, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98005",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "11723 NE 8th St, Bellevue, WA 98005",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61683,
"lon": -122.18338
},
"viewport": {
"topLeftPoint": {
"lat": 47.61773,
"lon": -122.18471
},
"btmRightPoint": {
"lat": 47.61593,
"lon": -122.18205
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61723,
"lon": -122.1834
}
}
],
"detourTime": 12
}
]
}
Definições
Name | 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. Estão incluídas coordenadas para as localizações de início e de fim do intervalo de endereços. |
Bounding |
A janela viewport que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita da janela viewport. |
Bounding |
A caixa delimitadora da localização. |
Brand |
A marca associada ao POI |
Classification |
A classificação do POI que está a ser devolvido |
Classification |
Nome da classificação |
Data |
Secção opcional. IDs de referência para utilização com a API Get Pesquisa Polygon. |
Electric |
Uma lista separada por vírgulas de tipos de conectores que podem ser utilizados para restringir o resultado à Estação de Veículos Elétricos que suporta tipos de conectores específicos. A ordem do item não importa. Quando são fornecidos vários tipos de conector, apenas serão devolvidos resultados que pertençam (pelo menos) a uma das listas fornecidas. Os tipos de conector disponíveis são:
Exemplos de utilização: connectorSet=IEC62196Type2Cable ConnectorAttachedSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
Entity |
Origem do tipo de entidade da caixa delimitadora. Para a geocodificação inversa, esta opção é sempre igual à posição. |
Entry |
O ponto de entrada para o POI que está a ser devolvido. |
Entry |
O tipo de ponto de entrada. O valor pode ser principal ou menor. |
Error |
Informações adicionais sobre o erro de gestão de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta a erros |
Geographic |
Tipo de entidade geografia. Presente apenas quando entityType foi pedido e está disponível. |
Geo |
Um tipo de geometria válido |
Geometry |
Informações sobre a forma geométrica do resultado. Presente apenas se o tipo == Geografia. |
Lat |
Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon". |
Localized |
O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que devolverá os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN. Consulte Vistas Suportadas para obter detalhes e para ver as Vistas disponíveis. |
Match |
Tipos de correspondência para uma operação de pesquisa de endereço inverso. |
Operating |
Horário de abertura de um POI (Pontos de Interesse). |
Operating |
Horas de funcionamento de um POI (Pontos de Interesse). A disponibilidade de horas de operação irá variar consoante os dados disponíveis. Se não for transmitido, não serão devolvidas informações sobre o horário de funcionamento. Valor suportado: nextSevenDays |
Operating |
Representa uma data e hora |
Operating |
Intervalo de tempo de abertura de um dia |
Point |
Detalhes do POI devolvido, incluindo informações como o nome, telefone, endereço de URL e classificações. |
Point |
Categoria POI |
Query |
O tipo de consulta que está a ser devolvida: NEARBY ou NON_NEAR. |
Response |
Formato pretendido da resposta. O valor pode ser json ou xml. |
Search |
Este objeto é devolvido a partir de uma Pesquisa chamadas com êxito. |
Search |
Objeto de resultado para uma resposta da API Pesquisa. |
Search |
Um dos seguintes:
|
Search |
Este tipo representa o corpo do pedido do serviço Pesquisa Along Route. |
Search |
Objeto de resumo para uma resposta da API Pesquisa. |
Address
O endereço do resultado
Name | Tipo | Description |
---|---|---|
boundingBox |
Bounding |
A caixa delimitadora da localização. |
buildingNumber |
string |
O número do edifício na rua. PRETERIDO, utilize 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 de país iso alfa-3 |
countrySecondarySubdivision |
string |
Concelho |
countrySubdivision |
string |
Distrito |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
O nome completo de um primeiro nível da hierarquia administrativa do país/região. Este campo só é apresentado no caso de countrySubdivision ser apresentado num formulário abreviado. Apenas suportado para os EUA, Canadá e Reino Unido. |
countryTertiarySubdivision |
string |
Área Nomeada |
crossStreet |
string |
O nome da rua a ser atravessada. |
extendedPostalCode |
string |
Código postal alargado (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 é utilizado para criar a |
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 habitantes. |
postalCode |
string |
Código Postal/Código Postal |
routeNumbers |
string[] |
Os códigos utilizados para identificar inequívocamente a rua |
street |
string |
O nome da rua. Preterido, utilize 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. Estão incluídas coordenadas para as localizações de início e de fim do intervalo de endereços.
Name | Tipo | Description |
---|---|---|
from |
Lat |
Uma localização representada como uma latitude e longitude com 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 |
Lat |
Uma localização representada como uma latitude e longitude com nomes curtos "lat" & "lon". |
BoundingBox
A janela viewport que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita da janela viewport.
Name | Tipo | Description |
---|---|---|
btmRightPoint |
Lat |
Uma localização representada como uma latitude e longitude com nomes curtos "lat" & "lon". |
topLeftPoint |
Lat |
Uma localização representada como uma latitude e longitude com nomes curtos "lat" & "lon". |
BoundingBoxCompassNotation
A caixa delimitadora da localização.
Name | Tipo | Description |
---|---|---|
entity |
Origem do tipo de entidade da caixa delimitadora. Para a geocodificação inversa, esta opção é sempre igual à posição. |
|
northEast |
string |
Latitude nordeste, coordenada de longitude da caixa delimitadora como flutuantes separados por vírgulas |
southWest |
string |
Latitude sudoeste, coordenada de longitude da caixa delimitadora como flutuantes separados por vírgulas |
Brand
A marca associada ao POI
Name | Tipo | Description |
---|---|---|
name |
string |
Nome da marca |
Classification
A classificação do POI que está a ser devolvido
Name | Tipo | Description |
---|---|---|
code |
string |
Propriedade do código |
names |
Classification |
Matriz de nomes |
ClassificationName
Nome da classificação
Name | Tipo | Description |
---|---|---|
name |
string |
Propriedade Nome |
nameLocale |
string |
Propriedade Região do Nome |
DataSources
Secção opcional. IDs de referência para utilização com a API Get Pesquisa Polygon.
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 de tipos de conectores que podem ser utilizados para restringir o resultado à Estação de Veículos Elétricos que suporta tipos de conectores específicos. A ordem do item não importa. Quando são fornecidos vários tipos de conector, apenas serão devolvidos resultados que pertençam (pelo menos) a uma das listas fornecidas.
Os tipos de conector disponíveis são:
StandardHouseholdCountrySpecific
- Estes são os conectores domésticos padrão para uma determinada região. São todas uma fase única de AC e a Tensão padrão e o Amperage padrão. Veja também: Plug & socket types - World Standards ( Padrões Mundiais).IEC62196Type1
- Escreva 1 conector conforme definido na norma IEC 62196-2. Também chamado Yazaki em homenagem ao fabricante original ou SAE J1772 após a norma que a publicou pela primeira vez. Utilizado principalmente em combinação com uma fase única de 120V ou até 240V de infraestrutura de fase única.IEC62196Type1CCS
- Escreva um conector de combinação baseado, conforme definido na norma IEC 62196-3. O conector baseia-se no conector Tipo 1 , conforme definido na norma IEC 62196-2, com dois contactos de corrente direta (DC) adicionais para permitir o carregamento rápido de DC.IEC62196Type2CableAttached
- Escreva 2 conector conforme definido na norma IEC 62196-2. Fornecido como um cabo e uma ficha ligadas ao ponto de carregamento.IEC62196Type2Outlet
- Escreva 2 conector conforme definido na norma IEC 62196-2. Fornecido como um conjunto de sockets no ponto de carregamento.IEC62196Type2CCS
- Escreva conector de combinação baseado em 2 conforme definido na norma IEC 62196-3. O conector baseia-se no conector Tipo 2 , conforme definido na norma IEC 62196-2, com dois contactos de corrente direta (DC) adicionais para permitir o carregamento rápido de DC.IEC62196Type3
- Escreva 3 conector conforme definido na norma IEC 62196-2. Também denominado Scame em homenagem ao fabricante original. Utilizado principalmente em combinação com uma única fase de até 240V ou até 420V infraestrutura de três fases.Chademo
- Conector CHAdeMO com o nome de uma associação formada pela Tokyo Electric Power Company e pelos parceiros industriais. Por este motivo, também é conhecido como o conector do TEPCO. Suporta carregamentos DC rápidos.IEC60309AC1PhaseBlue
- O conector Azul Industrial é um conector definido na norma IEC 60309. Por vezes, é referido como por alguma combinação do padrão, a cor e o facto de ser um conector de fase única. Normalmente, o conector tem a configuração "P+N+E, 6h".IEC60309DCWhite
- O conector Industrial White é um conector DC definido na norma IEC 60309.Tesla
- O conector Tesla é o conector Tesla Supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, por vezes referido como Porta Tesla maioritariamente limitado a América do Norte ou ao Tipo 2 modificado (DC sobre o Tipo 2) na Europa.
Exemplos de utilização:
connectorSet=IEC62196Type2Cable ConnectorAttachedSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Name | Tipo | Description |
---|---|---|
Chademo |
string |
Conector CHAdeMO com o nome de uma associação formada pela Tokyo Electric Power Company e parceiros industriais. Por este motivo, também é conhecido como o conector do TEPCO. Suporta carregamentos DC rápidos. |
IEC60309AC1PhaseBlue |
string |
O conector Azul Industrial é um conector definido na norma IEC 60309. Por vezes, é referido como por alguma combinação do padrão, a cor e o facto de ser um conector de fase única. Normalmente, o conector tem a configuração "P+N+E, 6h". |
IEC60309DCWhite |
string |
O conector Industrial White é um conector DC definido na norma IEC 60309. |
IEC62196Type1 |
string |
Conector tipo 1 conforme definido na norma IEC 62196-2. Também chamado Yazaki em homenagem ao fabricante original ou SAE J1772 após a norma que a publicou pela primeira vez. Utilizado principalmente em combinação com uma fase única de 120V ou até 240V de infraestrutura de fase única. |
IEC62196Type1CCS |
string |
Escreva um conector de combinação baseado em 1, conforme definido na norma IEC 62196-3. O conector baseia-se no conector Tipo 1 , conforme definido na norma IEC 62196-2, com dois contactos de corrente direta (DC) adicionais para permitir o carregamento rápido de DC. |
IEC62196Type2CCS |
string |
Escreva um conector de combinação baseado em 2, conforme definido na norma IEC 62196-3. O conector baseia-se no conector Tipo 2 , conforme definido na norma IEC 62196-2, com dois contactos de corrente direta (DC) adicionais para permitir o carregamento rápido de DC. |
IEC62196Type2CableAttached |
string |
Conector tipo 2 conforme definido na norma IEC 62196-2. Fornecido como um cabo e uma ficha ligadas ao ponto de carregamento |
IEC62196Type2Outlet |
string |
Conector tipo 2 conforme definido na norma IEC 62196-2. Fornecido como um conjunto de sockets no ponto de carregamento. |
IEC62196Type3 |
string |
Conector tipo 3 conforme definido na norma IEC 62196-2. Também denominado Scame em homenagem ao fabricante original. Utilizado principalmente em combinação com uma única fase de até 240V ou até 420V infraestrutura de três fases. |
StandardHouseholdCountrySpecific |
string |
Estes são os conectores domésticos padrão para uma determinada região. São todas uma fase única de AC e a Tensão padrão e o Amperage padrão. Veja também: Plug & socket types - World Standards |
Tesla |
string |
O conector Tesla é o conector tesla supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, por vezes referido como Porta Tesla maioritariamente limitado a América do Norte ou ao Tipo 2 modificado (DC sobre o Tipo 2) na Europa. |
Entity
Origem do tipo de entidade da caixa delimitadora. Para a geocodificação inversa, esta opção é sempre igual à posição.
Name | Tipo | Description |
---|---|---|
position |
string |
Entidade de posição |
EntryPoint
O ponto de entrada para o POI que está a ser devolvido.
Name | Tipo | Description |
---|---|---|
position |
Lat |
Uma localização representada como uma latitude e longitude com nomes curtos "lat" & "lon". |
type |
Entry |
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.
Name | Tipo | Description |
---|---|---|
main |
string |
|
minor |
string |
ErrorAdditionalInfo
Informações adicionais sobre o erro de gestão de recursos.
Name | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informações adicionais. |
ErrorDetail
O detalhe do erro.
Name | Tipo | Description |
---|---|---|
additionalInfo |
Error |
As informações adicionais do erro. |
code |
string |
O código de erro. |
details |
Error |
Os detalhes do erro. |
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta a erros
Name | Tipo | Description |
---|---|---|
error |
Error |
O objeto de erro. |
GeographicEntityType
Tipo de entidade geografia. Presente apenas quando entityType foi pedido e está disponível.
Name | Tipo | Description |
---|---|---|
Country |
string |
nome do país/região |
CountrySecondarySubdivision |
string |
Concelho |
CountrySubdivision |
string |
Distrito |
CountryTertiarySubdivision |
string |
Área Nomeada |
Municipality |
string |
Cidade/Cidade |
MunicipalitySubdivision |
string |
Sub/Super Cidade |
Neighbourhood |
string |
Bairro |
PostalCodeArea |
string |
Código Postal/Código Postal |
GeoJsonLineString
Um tipo de geometria válido GeoJSON LineString
. Consulte RFC 7946 para obter detalhes.
Name | Tipo | Description |
---|---|---|
coordinates |
number[] |
Coordenadas para a |
type |
string:
Line |
Especifica o |
Geometry
Informações sobre a forma geométrica do resultado. Presente apenas se o tipo == Geografia.
Name | Tipo | Description |
---|---|---|
id |
string |
Transmita-o como geometryId à API Get Pesquisa Polygon para obter informações de geometria para este resultado. |
LatLongPairAbbreviated
Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon".
Name | Tipo | Description |
---|---|---|
lat |
number |
Propriedade Latitude |
lon |
number |
Propriedade Longitude |
LocalizedMapView
O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que devolverá os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN.
Consulte Vistas Suportadas para obter detalhes e para ver as Vistas disponíveis.
Name | Tipo | Description |
---|---|---|
AE |
string |
Emirados Árabes Unidos (Vista Árabe) |
AR |
string |
Argentina (Vista Argentina) |
Auto |
string |
Devolva os dados do mapa com base no endereço IP do pedido. |
BH |
string |
Bahrein (Vista Árabe) |
IN |
string |
Índia (Vista Indiana) |
IQ |
string |
Iraque (Vista Árabe) |
JO |
string |
Jordânia (Vista Árabe) |
KW |
string |
Kuwait (Vista Árabe) |
LB |
string |
Líbano (Vista Árabe) |
MA |
string |
Marrocos (Vista Marroquina) |
OM |
string |
Omã (Vista Árabe) |
PK |
string |
Paquistão (Vista Paquistanesa) |
PS |
string |
Autoridade Palestiniana (Vista Árabe) |
QA |
string |
Qatar (Vista Árabe) |
SA |
string |
Arábia Saudita (Vista Árabe) |
SY |
string |
Síria (Vista Árabe) |
Unified |
string |
Vista Unificada (Outros) |
YE |
string |
Iémen (Vista Árabe) |
MatchType
Tipos de correspondência para uma operação de pesquisa de endereço inverso.
Name | Tipo | Description |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
OperatingHours
Horário de abertura de um POI (Pontos de Interesse).
Name | Tipo | Description |
---|---|---|
mode |
string |
Valor utilizado no pedido: nenhum ou "nextSevenDays" |
timeRanges |
Operating |
Lista de intervalos de tempo para os próximos 7 dias |
OperatingHoursRange
Horas de funcionamento de um POI (Pontos de Interesse). A disponibilidade de horas de operação irá variar consoante os dados disponíveis. Se não for transmitido, não serão devolvidas informações sobre o horário de funcionamento. Valor suportado: nextSevenDays
Name | Tipo | Description |
---|---|---|
nextSevenDays |
string |
Mostra as horas de funcionamento da próxima semana, 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 na hora 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 de abertura de um dia
Name | Tipo | Description |
---|---|---|
endTime |
Operating |
O ponto no intervalo de 7 dias seguintes quando um determinado POI está a ser fechado ou o início do intervalo se tiver sido fechado antes do intervalo. |
startTime |
Operating |
O ponto no intervalo de 7 dias seguintes quando um determinado POI está a ser aberto ou o início do intervalo, se tiver sido aberto antes do intervalo. |
PointOfInterest
Detalhes do POI devolvido, incluindo informações como o nome, telefone, endereço de URL e classificações.
Name | Tipo | Description |
---|---|---|
brands |
Brand[] |
Matriz de marcas. O nome da marca para o POI que está a ser devolvido. |
categories |
string[] |
Matriz de categorias |
categorySet |
Point |
A lista das categorias POI mais específicas |
classifications |
Matriz de classificação |
|
name |
string |
Nome da propriedade POI |
openingHours |
Operating |
Horário de funcionamento de um POI (Pontos de Interesse). |
phone |
string |
Propriedade número de telefone |
url |
string |
Propriedade URL do Site |
PointOfInterestCategorySet
Categoria POI
Name | Tipo | Description |
---|---|---|
id |
integer |
ID da Categoria |
QueryType
O tipo de consulta que está a ser devolvida: NEARBY ou NON_NEAR.
Name | Tipo | Description |
---|---|---|
NEARBY |
string |
Pesquisa foi realizada em torno de uma determinada latitude e longitude com um raio definido |
NON_NEAR |
string |
Pesquisa foi realizada globalmente, sem distorção para uma determinada latitude e longitude, e nenhum raio definido |
ResponseFormat
Formato pretendido da resposta. O valor pode ser json ou xml.
Name | Tipo | Description |
---|---|---|
json |
string |
O Formato de Intercâmbio de Dados de Notação de Objetos JavaScript |
xml |
string |
SearchAddressResult
Este objeto é devolvido a partir de uma Pesquisa chamadas com êxito.
Name | Tipo | Description |
---|---|---|
results |
Search |
Uma lista de resultados da API Pesquisa. |
summary |
Search |
Objeto de resumo para uma resposta da API Pesquisa |
SearchAddressResultItem
Objeto de resultado para uma resposta da API Pesquisa.
Name | Tipo | Description |
---|---|---|
address |
O endereço do resultado |
|
addressRanges |
Address |
Descreve o intervalo de endereços em ambos os lados da rua para obter um resultado de pesquisa. Estão incluídas coordenadas para as localizações de início e de fim do intervalo de endereços. |
dataSources |
Data |
Secção opcional. ID de geometria de referência para utilização com a API Get Pesquisa Polygon. |
detourTime |
integer |
Tempo de desvio em segundos. Apenas devolvidas para chamadas à API de Pesquisa Ao Longo da Rota. |
dist |
number |
Distância de linha reta entre o resultado e a localização geobias em metros. |
entityType |
Geographic |
Tipo de entidade geografia. Presente apenas quando entityType foi pedido e está disponível. |
entryPoints |
Entry |
Matriz de EntryPoints. Estes descrevem os tipos de entradas disponíveis na localização. 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 origem de dados original do Resultado. Utilizado para pedidos de suporte. |
matchType |
Match |
Informações sobre o tipo de correspondência. Um dos seguintes:
|
poi |
Point |
Detalhes do POI devolvido, incluindo informações como o nome, telefone, endereço de URL e classificações. |
position |
Lat |
Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon". |
score |
number |
O valor dentro de um conjunto de resultados para indicar a classificação correspondente relativa entre os resultados. Pode utilizá-lo para determinar que o resultado x tem duas vezes mais probabilidades de ser tão relevante como o resultado y se o valor de x for 2x o valor de y. Os valores variam entre consultas e destinam-se apenas a um valor relativo para um conjunto de resultados. |
type |
Search |
Um dos seguintes:
|
viewport |
Bounding |
O viewport que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita do viewport. |
SearchAddressResultType
Um dos seguintes:
- POI
- Rua
- Geografia
- Endereço de Ponto
- Intervalo de Endereços
- Cross Street
Name | Tipo | Description |
---|---|---|
Address Range |
string |
|
Cross Street |
string |
|
Geography |
string |
|
POI |
string |
|
Point Address |
string |
|
Street |
string |
SearchAlongRouteRequest
Este tipo representa o corpo do pedido do serviço Pesquisa Along Route.
Name | Tipo | Description |
---|---|---|
route |
Geo |
Um tipo de geometria válido |
SearchSummary
Objeto de resumo para uma resposta da API Pesquisa.
Name | Tipo | Description |
---|---|---|
fuzzyLevel |
integer |
O nível máximo difuso necessário para fornecer Resultados. |
geoBias |
Lat |
Indicação quando o motor de busca interno aplicou um desvio geoespacial para melhorar a classificação dos resultados. Em alguns métodos, isto pode ser afetado ao definir os parâmetros lat e lon sempre que disponíveis. Noutros casos, é puramente interno. |
limit |
integer |
Número máximo de respostas que serão devolvidas |
numResults |
integer |
Número de resultados na resposta. |
offset |
integer |
O desvio inicial dos Resultados devolvidos no conjunto de Resultados completo. |
query |
string |
O parâmetro de consulta que foi utilizado para produzir estes resultados de pesquisa. |
queryTime |
integer |
Tempo gasto a resolver a consulta, em milissegundos. |
queryType |
Query |
O tipo de consulta que está a ser devolvida: NEARBY ou NON_NEAR. |
totalResults |
integer |
O número total de Resultados encontrados. |