Compartilhar via

Search - Get Search POI Category

  • Referência
Serviço:
Maps
Versão da API:
1.0

Use para pesquisar pontos de interesse por categoria.

A Get Search POI Category API é uma solicitação HTTP GET que permite que você solicite resultados de POI de determinada categoria. Útil para consultar POIs de uma categoria por vez. O ponto de extremidade retornará apenas os resultados de POI categorizados conforme especificado. A resposta inclui detalhes de POI, como endereço, local de coordenadas e classificação.

GET https://atlas.microsoft.com/search/poi/category/{format}?api-version=1.0&query={query}
Com parâmetros opcionais: 
GET https://atlas.microsoft.com/search/poi/category/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&brandSet={brandSet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays

Parâmetros de URI

Nome Em Obrigatório Tipo Description
format
 path True

ResponseFormat

Formato desejado da resposta. O valor pode ser json ou xml.
api-version
 query True

string

Número de versão da API de Mapas Azure.
query
 query True

string

A categoria POI a ser pesquisada (por exemplo, "AEROPORTO", "RESTAURANTE"), deve ser codificada corretamente na URL. As categorias de main com suporte podem ser solicitadas chamando Obter Pesquisa API de Árvore de Categoria poi. Para obter uma lista de categorias disponíveis, consulte Azure Mapas categorias com suporte. É recomendável usar a POI Pesquisa API de Árvore de Categoria para solicitar as categorias com suporte.
brandSet
 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 são 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,C Vírgula", Barra
btmRight
 query

string

Posição inferior direita da caixa delimitadora. Por exemplo, 37,553,-122,453
categorySet
 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 categorySet valores com suporte por solicitação é 10. Quando vários identificadores de categoria forem fornecidos, somente as POIs que pertencem a (pelo menos) uma das categorias da lista fornecida serão retornadas. A lista de categorias com suporte pode ser descoberta usando a API de Categorias de POI . Exemplos de uso:

  • categorySet=7315 (Pesquisa Pontos de Interesse da categoria Restaurante)

  • categorySet=7315025,7315017 (Pesquisa Pontos de Interesse da categoria restaurante italiano ou francês)
connectorSet
 query

ElectricVehicleConnector[]

Uma lista separada por vírgulas de tipos de conectores 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 conectores disponíveis são:

  • StandardHouseholdCountrySpecific - Esses são os conectores domésticos padrão para uma determinada região. Elas são todas fase única ac e a tensão padrão e amperagem padrão. Consulte também: Tipos de soquete plug & – Padrões Mundiais.
  • IEC62196Type1 – Digite um conector 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 infraestrutura de fase única.
  • IEC62196Type1CCS - Conector de combinação baseado em 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 do tipo 2, conforme definido no padrão IEC 62196-2. Fornecido como um cabo e plugue anexado ao ponto de carregamento.
  • IEC62196Type2Outlet - Conector do 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 dc (atuais diretos) adicionais para permitir o carregamento rápido de DC.
  • IEC62196Type3 - Conector do tipo 3, conforme definido no padrão IEC 62196-2. Também chamado scame após o fabricante original. Usado principalmente em combinação com até 240V fase única 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 por parceiros industriais. Por isso, também é conhecido como o conector do TEPCO. Ele dá suporte ao carregamento rápido de DC.
  • IEC60309AC1PhaseBlue – O conector Azul Industrial é um conector definido no padrão IEC 60309. Às vezes, ele é conhecido como por alguma combinação do padrão, a cor e o 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 Tesla Supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, às vezes chamado de Porta Tesla, em sua maioria limitado a América do Norte ou o Tipo 2 modificado (DC sobre o Tipo 2) na Europa.

Exemplos de uso:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
countrySet
 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
extendedPostalCodesFor
 query

SearchIndexes[]

Índices para os quais os códigos postais estendidos devem ser incluídos nos resultados.

Os índices disponíveis são:

Addr = Intervalos de endereços

Geo = Geografias

PAD = Endereços de ponto

POI = Pontos de Interesse

Str = Ruas

XStr = Cross Streets (interseções)

O valor deve ser uma lista separada por vírgulas de tipos de índice (em qualquer ordem) ou Nenhum para nenhum índice.

Por padrão, os códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas de cep estendidas para geografias podem ser muito longas, portanto, elas precisam ser solicitadas explicitamente quando necessário.

Exemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,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 idioma 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.

Consulte Idiomas com suporte para obter detalhes.
lat
 query

number

double

Latitude em que os resultados devem ser tendenciosos. Por exemplo, 37,337
limit
 query

integer

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

Deslocamento inicial dos resultados retornados dentro do conjunto de resultados completo. Padrão: 0
openingHours
 query

OperatingHoursRange

Horas de operação para uma POI (Pontos de Interesse). A disponibilidade de horas de operação varia de acordo com os 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 para que os resultados sejam restritos à área definida
topLeft
 query

string

Posição superior esquerda da caixa delimitadora. Por exemplo, 37,553,-122,453
typeahead
 query

boolean

Booliano. Se o sinalizador typeahead estiver definido, a consulta será interpretada como uma entrada parcial e a pesquisa entrará no modo preditivo
view
 query

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 geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições 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 fornecerá. 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 dos 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 View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas é disponibilizado. Exemplo: view=IN.

Consulte Modos de exibição com suporte para obter detalhes e ver os Modos de Exibição 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 Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Nome Tipo Description
200 OK

SearchAddressResult

OK
Other Status Codes

ErrorResponse

Erro inesperado.

Segurança

AADToken

Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso a Azure Mapas APIs REST. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. 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 Azure Mapas APIs REST.

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 acessar o controle em APIs e escopos específicos.

Observação

  • Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas .
  • 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 Microsoft Entra ID.
  • O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
  • O uso do SDK da Web 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 plataforma de identidade da Microsoft, consulte visão geral 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ê cria uma conta 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 master na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST 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 com base na operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou 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 a expiração, a taxa e as regiõ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 maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta de mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Search for ATM's within 2 miles of Times Square NY and return the top 3 results

Solicitação de exemplo

GET https://atlas.microsoft.com/search/poi/category/json?api-version=1.0&query=atm&limit=3&lat=40.758953&lon=-73.985263&radius=3200&openingHours=nextSevenDays

Resposta de exemplo

Código de status:
200 
{
  "summary": {
    "query": "atm",
    "queryType": "NON_NEAR",
    "queryTime": 28,
    "numResults": 3,
    "offset": 0,
    "totalResults": 3696,
    "fuzzyLevel": 1,
    "geoBias": {
      "lat": 40.758953,
      "lon": -73.985263
    }
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/7014613",
      "score": 2.575,
      "dist": 10.743802093311858,
      "info": "search:ta:840369001846523-US",
      "poi": {
        "name": "FISERV MASTERMONEY",
        "categorySet": [
          {
            "id": 7397
          }
        ],
        "classifications": [
          {
            "code": "CASH_DISPENSER",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "cash dispenser"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1560",
        "streetName": "Broadway",
        "municipalitySubdivision": "Times Square, New York, Midtown",
        "municipality": "New York, Manhattan",
        "countrySecondarySubdivision": "New York",
        "countryTertiarySubdivision": "Manhattan",
        "countrySubdivisionCode": "NY",
        "postalCode": "10036",
        "extendedPostalCode": "100361517",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1560 Broadway, New York, NY 10036",
        "localName": "New York",
        "countrySubdivisionName": "New York"
      },
      "position": {
        "lat": 40.75901,
        "lon": -73.98516
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 40.75991,
          "lon": -73.98635
        },
        "btmRightPoint": {
          "lat": 40.75811,
          "lon": -73.98397
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 40.75902,
            "lon": -73.98522
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/6830011",
      "score": 2.575,
      "dist": 58.68107354501256,
      "info": "search:ta:840369011803697-US",
      "poi": {
        "name": "METABANK",
        "categorySet": [
          {
            "id": 7397
          }
        ],
        "classifications": [
          {
            "code": "CASH_DISPENSER",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "cash dispenser"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1567",
        "streetName": "Broadway",
        "municipalitySubdivision": "Times Square, New York, Midtown",
        "municipality": "New York, Manhattan",
        "countrySecondarySubdivision": "New York",
        "countryTertiarySubdivision": "Manhattan",
        "countrySubdivisionCode": "NY",
        "postalCode": "10036",
        "extendedPostalCode": "100361517",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1567 Broadway, New York, NY 10036",
        "localName": "New York",
        "countrySubdivisionName": "New York"
      },
      "position": {
        "lat": 40.75937,
        "lon": -73.98569
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 40.76027,
          "lon": -73.98688
        },
        "btmRightPoint": {
          "lat": 40.75847,
          "lon": -73.9845
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 40.75924,
            "lon": -73.98513
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/6830013",
      "score": 2.575,
      "dist": 55.009653221373966,
      "info": "search:ta:840369010525390-US",
      "poi": {
        "name": "ATM",
        "categorySet": [
          {
            "id": 7397
          }
        ],
        "classifications": [
          {
            "code": "CASH_DISPENSER",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "cash dispenser"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1552",
        "streetName": "Broadway",
        "municipalitySubdivision": "Times Square, New York, Midtown",
        "municipality": "New York, Manhattan",
        "countrySecondarySubdivision": "New York",
        "countryTertiarySubdivision": "Manhattan",
        "countrySubdivisionCode": "NY",
        "postalCode": "10036",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1552 Broadway, New York, NY 10036",
        "localName": "New York",
        "countrySubdivisionName": "New York"
      },
      "position": {
        "lat": 40.75873,
        "lon": -73.98468
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 40.75963,
          "lon": -73.98587
        },
        "btmRightPoint": {
          "lat": 40.75783,
          "lon": -73.98349
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 40.7588,
            "lon": -73.98492
          }
        }
      ]
    }
  ]
}

Definições

Nome 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.
BoundingBox

O visor que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.
BoundingBoxCompassNotation

A caixa delimitadora do local.
Brand

A marca associada à POI
Classification

A classificação para a POI que está sendo retornada
ClassificationName

Nome da classificação
DataSources

Seção opcional. IDs de referência para uso com a API Get Pesquisa Polygon.
ElectricVehicleConnector

Uma lista separada por vírgulas de tipos de conectores 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 conectores disponíveis são:

  • StandardHouseholdCountrySpecific - Esses são os conectores domésticos padrão para uma determinada região. Elas são todas fase única ac e a tensão padrão e amperagem padrão. Consulte também: Tipos de soquete plug & – Padrões Mundiais.
  • IEC62196Type1 – Digite um conector 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 infraestrutura de fase única.
  • IEC62196Type1CCS - Conector de combinação baseado em 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 do tipo 2, conforme definido no padrão IEC 62196-2. Fornecido como um cabo e plugue anexado ao ponto de carregamento.
  • IEC62196Type2Outlet - Conector do 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 dc (atuais diretos) adicionais para permitir o carregamento rápido de DC.
  • IEC62196Type3 - Conector do tipo 3, conforme definido no padrão IEC 62196-2. Também chamado scame após o fabricante original. Usado principalmente em combinação com até 240V fase única 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 por parceiros industriais. Por isso, também é conhecido como o conector do TEPCO. Ele dá suporte ao carregamento rápido de DC.
  • IEC60309AC1PhaseBlue – O conector Azul Industrial é um conector definido no padrão IEC 60309. Às vezes, ele é conhecido como por alguma combinação do padrão, a cor e o 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 Tesla Supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, às vezes chamado de Porta Tesla, em sua maioria limitado a América do Norte ou o Tipo 2 modificado (DC sobre o Tipo 2) na Europa.

Exemplos de uso:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Entity

Origem do tipo de entidade da caixa delimitadora. Para geocódigo reverso, isso é sempre igual à posição.
EntryPoint

O ponto de entrada para a POI que está sendo retornada.
EntryPointType

O tipo de ponto de entrada. O valor pode ser main ou secundário.
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

Os detalhes do erro.
ErrorResponse

Resposta de erro
GeographicEntityType

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 == Geography.
LatLongPairAbbreviated

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.
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 geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições 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 fornecerá. 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 dos 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 View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas é disponibilizado. Exemplo: view=IN.

Consulte Modos de exibição com suporte para obter detalhes e ver os Modos de Exibição disponíveis.
MatchType

Tipos de correspondência para uma operação de pesquisa de endereço reverso.
OperatingHours

Horário de funcionamento de uma POI (Pontos de Interesse).
OperatingHoursRange

Horas de operação para uma POI (Pontos de Interesse). A disponibilidade de horas de operação varia de acordo com os dados disponíveis. Se não for passado, nenhuma informação de horário de funcionamento será retornada. Valor com suporte: nextSevenDays
OperatingHoursTime

Representa uma data e hora
OperatingHoursTimeRange

Abrir intervalo de tempo por um dia
PointOfInterest

Detalhes da POI retornada, incluindo informações como nome, telefone, endereço de URL e classificações.
PointOfInterestCategorySet

Categoria POI
QueryType

O tipo de consulta que está sendo retornada: NEARBY ou NON_NEAR.
ResponseFormat

Formato desejado da resposta. O valor pode ser json ou xml.
SearchAddressResult

Esse objeto é retornado de um Pesquisa chamadas bem-sucedidas.
SearchAddressResultItem

Objeto de resultado para uma resposta da API Pesquisa.
SearchAddressResultType

Um destes:

  • POI
  • Street
  • Geografia
  • Endereço de ponto
  • Intervalo de Endereços
  • Cruzamento
SearchIndexes

Índices para os quais os códigos postais estendidos devem ser incluídos nos resultados.

Os índices disponíveis são:

Addr = Intervalos de endereços

Geo = Geografias

PAD = Endereços de ponto

POI = Pontos de Interesse

Str = Ruas

XStr = Cross Streets (interseções)

O valor deve ser uma lista separada por vírgulas de tipos de índice (em qualquer ordem) ou Nenhum para nenhum índice.

Por padrão, os códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas de cep estendidas para geografias podem ser muito longas, portanto, elas precisam ser solicitadas explicitamente quando necessário.

Exemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

O código postal estendido é retornado como uma propriedade extendedPostalCode de um endereço. A disponibilidade depende da região.
SearchSummary

Objeto summary para uma resposta da API Pesquisa.

Address

O endereço do resultado

Nome Tipo Description
boundingBox

BoundingBoxCompassNotation

A caixa delimitadora do local.
buildingNumber

string

O número do prédio na rua. PRETERIDO, use streetNumber.
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 ISO alfa-3
countrySecondarySubdivision

string

Município
countrySubdivision

string

Estado ou Província
countrySubdivisionCode

string

countrySubdivisionCode prefixado por countryCode ( countryCode-countrySubdivisionCode ) e o hífen forma o código ISO 3166-2. Exemplos: TX para Texas, SCT para Escócia e ON para Ontário.
countrySubdivisionName

string

O nome completo de um primeiro nível de hierarquia administrativa de país/região. Esse campo aparece somente no caso de countrySubdivision ser apresentado em um formulário abreviado. Com suporte apenas para EUA, Canadá e Reino Unido.
countryTertiarySubdivision

string

Área Nomeada
crossStreet

string

O nome da rua que está sendo atravessada.
extendedPostalCode

string

Cep 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 completo de 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. Esse campo é usado para compilar a freeformAddress propriedade . localName representa o município postal. Dependendo do local, localName é o nome comumente conhecido de uma cidade ou cidade. Para o nome comumente conhecido de uma cidade ou cidade, use localName em vez de municipality.
municipality

string

Cidade/Cidade
Observação: municipality representa o município residencial. Dependendo do local, o municipality valor pode ser diferente do nome comumente conhecido de uma cidade ou cidade. Para o nome comumente conhecido da cidade ou cidade, é recomendável que o localName valor seja usado em vez do municipality valor .
municipalitySubdivision

string

Sub/Super Cidade
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

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

LatLongPairAbbreviated

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

LatLongPairAbbreviated

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

LatLongPairAbbreviated

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.
topLeftPoint

LatLongPairAbbreviated

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.

BoundingBoxCompassNotation

A caixa delimitadora do local.

Nome Tipo Description
entity

Entity

Origem do tipo de entidade da caixa delimitadora. Para geocódigo reverso, isso é sempre igual à posição.
northEast

string

Latitude do Nordeste, coordenada de longitude da caixa delimitadora como floats separados por vírgulas
southWest

string

Latitude sudoeste, coordenada de 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 do código
names

ClassificationName[]

Matriz de nomes

ClassificationName

Nome da classificação

Nome Tipo Description
name

string

Propriedade Name
nameLocale

string

Propriedade Localidade do Nome

DataSources

Seção opcional. IDs de referência para uso com a API Get Pesquisa Polygon.

Nome Tipo Description
geometry

Geometry

Informações sobre a forma geométrica do resultado. Presente somente se o tipo == Geography.

ElectricVehicleConnector

Uma lista separada por vírgulas de tipos de conectores 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 conectores disponíveis são:

  • StandardHouseholdCountrySpecific - Esses são os conectores domésticos padrão para uma determinada região. Elas são todas fase única ac e a tensão padrão e amperagem padrão. Consulte também: Tipos de soquete plug & – Padrões Mundiais.
  • IEC62196Type1 – Digite um conector 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 infraestrutura de fase única.
  • IEC62196Type1CCS - Conector de combinação baseado em 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 do tipo 2, conforme definido no padrão IEC 62196-2. Fornecido como um cabo e plugue anexado ao ponto de carregamento.
  • IEC62196Type2Outlet - Conector do 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 dc (atuais diretos) adicionais para permitir o carregamento rápido de DC.
  • IEC62196Type3 - Conector do tipo 3, conforme definido no padrão IEC 62196-2. Também chamado scame após o fabricante original. Usado principalmente em combinação com até 240V fase única 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 por parceiros industriais. Por isso, também é conhecido como o conector do TEPCO. Ele dá suporte ao carregamento rápido de DC.
  • IEC60309AC1PhaseBlue – O conector Azul Industrial é um conector definido no padrão IEC 60309. Às vezes, ele é conhecido como por alguma combinação do padrão, a cor e o 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 Tesla Supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, às vezes chamado de Porta Tesla, em sua maioria limitado a América do Norte ou o Tipo 2 modificado (DC sobre o Tipo 2) na Europa.

Exemplos de uso:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

Nome Tipo Description
Chademo

string

Conector CHAdeMO com o nome de uma associação formada pela Tokyo Electric Power Company e parceiros industriais. Por isso, também é conhecido como o conector do TEPCO. Ele dá suporte ao carregamento rápido de DC.
IEC60309AC1PhaseBlue

string

O conector Azul Industrial é um conector definido no padrão IEC 60309. Às vezes, ele é conhecido como por alguma combinação do padrão, a cor e o fato de que é um conector de fase única. O conector geralmente tem a configuração "P+N+E, 6h".
IEC60309DCWhite

string

O conector Branco Industrial é um conector dc definido no padrão IEC 60309.
IEC62196Type1

string

Conector do 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 infraestrutura de fase única.
IEC62196Type1CCS

string

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

string

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 dc (atuais diretos) adicionais para permitir o carregamento rápido de DC.
IEC62196Type2CableAttached

string

Conector do tipo 2, conforme definido no padrão IEC 62196-2. Fornecido como cabo e plugue anexado ao ponto de carregamento
IEC62196Type2Outlet

string

Conector do tipo 2, conforme definido no padrão IEC 62196-2. Fornecido como um soquete definido no ponto de carregamento.
IEC62196Type3

string

Conector do tipo 3, conforme definido no padrão IEC 62196-2. Também chamado scame após o fabricante original. Usado principalmente em combinação com até 240V fase única ou até 420V infraestrutura de três fases.
StandardHouseholdCountrySpecific

string

Estes são os conectores domésticos padrão para uma determinada região. Elas são todas fase única ac e a tensão padrão e amperagem padrão.

Consulte também: Tipos de soquete plug & – Padrões Mundiais
Tesla

string

O conector tesla é o conector Tesla Supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, às vezes chamado de Porta Tesla, em sua maioria limitado a América do Norte ou o Tipo 2 modificado (DC sobre o Tipo 2) na Europa.

Entity

Origem do tipo de entidade da caixa delimitadora. Para geocódigo reverso, isso é sempre igual à posição.

Nome Tipo Description
position

string

Posicionar entidade

EntryPoint

O ponto de entrada para a POI que está sendo retornada.

Nome Tipo Description
position

LatLongPairAbbreviated

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.
type

EntryPointType

O tipo de ponto de entrada. O valor pode ser main ou secundário.

EntryPointType

O tipo de ponto de entrada. O valor pode ser main ou secundário.

Nome Tipo Description
main

string

minor

string

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

Os detalhes do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

GeographicEntityType

Tipo de entidade geography. Presente somente quando entityType foi solicitado e está disponível.

Nome Tipo Description
Country

string

nome do país/região
CountrySecondarySubdivision

string

Município
CountrySubdivision

string

Estado ou Província
CountryTertiarySubdivision

string

Área Nomeada
Municipality

string

Cidade/Cidade
MunicipalitySubdivision

string

Sub/Super Cidade
Neighbourhood

string

Bairro
PostalCodeArea

string

Cep/CEP

Geometry

Informações sobre a forma geométrica do resultado. Presente somente se o tipo == Geography.

Nome Tipo Description
id

string

Passe isso como geometryId para a API Get Pesquisa Polygon 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

Propriedade Latitude
lon

number

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 geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições 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 fornecerá. 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 dos 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 View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas é disponibilizado. Exemplo: view=IN.

Consulte Modos de exibição com suporte para obter detalhes e ver os Modos de Exibição disponíveis.

Nome Tipo Description
AE

string

Emirados Árabes Unidos (Exibição Árabe)
AR

string

Argentina (Exibição Argentina)
Auto

string

Retornar os dados do mapa com base no endereço IP da solicitação.
BH

string

Bahrein (Exibição Árabe)
IN

string

Índia (Exibição Indiana)
IQ

string

Iraque (Exibição Árabe)
JO

string

Jordânia (Exibição Árabe)
KW

string

Kuwait (Exibição Árabe)
LB

string

Líbano (Exibição Árabe)
MA

string

Marrocos (Exibição Marroquina)
OM

string

Omã (Exibição Árabe)
PK

string

Paquistão (Exibição Paquistanesa)
PS

string

Autoridade Palestina (Exibição Árabe)
QA

string

Qatar (Exibição Árabe)
SA

string

Arábia Saudita (Exibição Árabe)
SY

string

Síria (Exibição Árabe)
Unified

string

Exibição Unificada (Outras)
YE

string

Iêmen (Exibição Árabe)

MatchType

Tipos de correspondência para uma operação de pesquisa de endereço reverso.

Nome Tipo Description
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Horário de funcionamento de uma POI (Pontos de Interesse).

Nome Tipo Description
mode

string

Valor usado na solicitação: none ou "nextSevenDays"
timeRanges

OperatingHoursTimeRange[]

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 varia de acordo com os dados disponíveis. Se não for passado, nenhuma informação de horário de funcionamento será retornada. Valor com suporte: nextSevenDays

Nome Tipo Description
nextSevenDays

string

Mostra as horas de operação para a próxima semana, começando com o dia atual na hora local da POI.

OperatingHoursTime

Representa uma data e hora

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

OperatingHoursTime

O ponto no intervalo de 7 dias seguinte quando uma determinada POI está sendo fechada ou o início do intervalo se ele foi fechado antes do intervalo.
startTime

OperatingHoursTime

O ponto no intervalo de 7 dias seguinte 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

PointOfInterestCategorySet[]

A lista das categorias de POI mais específicas
classifications

Classification[]

Matriz de classificação
name

string

Nome da propriedade POI
openingHours

OperatingHours

Horário de funcionamento de 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

QueryType

O tipo de consulta que está sendo retornada: NEARBY ou NON_NEAR.

Nome Tipo Description
NEARBY

string

Pesquisa foi executado em torno de uma certa latitude e longitude com um raio definido
NON_NEAR

string

Pesquisa foi executado globalmente, sem desvio para uma determinada latitude e longitude, e nenhum raio definido

ResponseFormat

Formato desejado da resposta. O valor pode ser json ou xml.

Nome Tipo Description
json

string

O formato de intercâmbio de dados de notação de objeto JavaScript
xml

string

A linguagem de marcação extensível

SearchAddressResult

Esse objeto é retornado de um Pesquisa chamadas bem-sucedidas.

Nome Tipo Description
results

SearchAddressResultItem[]

Uma lista de resultados da API Pesquisa.
summary

SearchSummary

Objeto summary para uma resposta da API Pesquisa

SearchAddressResultItem

Objeto de resultado para uma resposta da API Pesquisa.

Nome Tipo Description
address

Address

O endereço do resultado
addressRanges

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

DataSources

Seção opcional. ID de geometria de referência para uso com a API Obter Pesquisa Polígono.
detourTime

integer

Tempo de desvio em segundos. Retornado apenas para chamadas para a API Pesquisa Ao Longo da Rota.
dist

number

Distância de linha reta entre o resultado e a localização geobias em metros.
entityType

GeographicEntityType

Tipo de entidade geography. Presente somente quando entityType foi solicitado e está disponível.
entryPoints

EntryPoint[]

Matriz de EntryPoints. Eles descrevem os tipos de entradas disponíveis no local. O tipo pode ser "main" para entradas main, 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

MatchType

Informações sobre o tipo de correspondência.

Um destes:

  • AddressPoint
  • HouseNumberRange
  • Street
poi

PointOfInterest

Detalhes da POI retornada, incluindo informações como nome, telefone, endereço de URL e classificações.
position

LatLongPairAbbreviated

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.
score

number

O valor dentro de um conjunto de resultados para indicar a pontuação de correspondência relativa entre os resultados. Você pode usar isso 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

SearchAddressResultType

Um destes:

  • POI
  • Street
  • Geografia
  • Endereço de ponto
  • Intervalo de Endereços
  • Cruzamento
viewport

BoundingBox

O visor que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.

SearchAddressResultType

Um destes:

  • POI
  • Street
  • Geografia
  • Endereço de ponto
  • Intervalo de Endereços
  • Cruzamento
Nome Tipo Description
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchIndexes

Índices para os quais os códigos postais estendidos devem ser incluídos nos resultados.

Os índices disponíveis são:

Addr = Intervalos de endereços

Geo = Geografias

PAD = Endereços de ponto

POI = Pontos de Interesse

Str = Ruas

XStr = Cross Streets (interseções)

O valor deve ser uma lista separada por vírgulas de tipos de índice (em qualquer ordem) ou Nenhum para nenhum índice.

Por padrão, os códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas de cep estendidas para geografias podem ser muito longas, portanto, elas precisam ser solicitadas explicitamente quando necessário.

Exemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

O código postal estendido é retornado como uma propriedade extendedPostalCode de um endereço. A disponibilidade depende da região.

Nome Tipo Description
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

SearchSummary

Objeto summary para uma resposta da API Pesquisa.

Nome Tipo Description
fuzzyLevel

integer

O nível difuso máximo necessário para fornecer Resultados.
geoBias

LatLongPairAbbreviated

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 que foi usado para produzir esses resultados de pesquisa.
queryTime

integer

Tempo gasto resolvendo a consulta, em milissegundos.
queryType

QueryType

O tipo de consulta que está sendo retornada: NEARBY ou NON_NEAR.
totalResults

integer

O número total de Resultados encontrados.