Partilhar via

Search - Get Geocoding

  • Referência
Serviço:
Maps
Versão da API:
2023-06-01

Utilize para obter coordenadas de longitude e latitude de um endereço de rua ou nome de um local.

A Get Geocoding API é um pedido HTTP GET que devolve as coordenadas de longitude e latitude da localização que está a ser pesquisada.

Em muitos casos, o serviço de pesquisa completo pode ser demasiado, por exemplo, se estiver apenas interessado na geocodificação tradicional. A pesquisa também pode ser acedida para pesquisa de endereços exclusivamente. A geocodificação é efetuada ao atingir o ponto final de geocodificação apenas com o endereço ou endereço parcial em questão. O índice de pesquisa de geocodificação será consultado para tudo o que estiver acima dos dados de nível de rua. Nenhum Ponto de Interesse (POIs) será devolvido. Tenha em atenção que o geocódigo é muito tolerante a erros de digitação e endereços incompletos. Também tratará de tudo, desde endereços de rua exatos ou ruas ou cruzamentos, bem como geografias de nível superior, como centros da cidade, condados e estados. A resposta também devolve propriedades detalhadas do endereço, como rua, código postal, município e informações de país/região.

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01
Com parâmetros opcionais: 
GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&top={top}&query={query}&addressLine={addressLine}&countryRegion={countryRegion}&bbox={bbox}&view={view}&coordinates={coordinates}&adminDistrict={adminDistrict}&adminDistrict2={adminDistrict2}&adminDistrict3={adminDistrict3}&locality={locality}&postalCode={postalCode}

Parâmetros do URI

Name Em Necessário Tipo Description
api-version
 query True

string

Número da versão da API do Azure Maps.
addressLine
 query

string

A linha de rua oficial de um endereço relativo à área, conforme especificado pela localidade, ou postalCode, propriedades. A utilização típica deste elemento seria fornecer um endereço de rua ou qualquer endereço oficial.

Se a consulta for fornecida, não deve utilizar este parâmetro.
adminDistrict
 query

string

A parte da subdivisão do país de um endereço, como WA.

Se a consulta for fornecida, não deve utilizar este parâmetro.
adminDistrict2
 query

string

O condado para o endereço estruturado, como King.

Se a consulta for fornecida, não deve utilizar este parâmetro.
adminDistrict3
 query

string

A área nomeada para o endereço estruturado.

Se a consulta for fornecida, não deve utilizar este parâmetro.
bbox
 query

number[]

Uma área retangular na terra definida como um objeto de caixa delimitadora. Os lados dos retângulos são definidos por valores de longitude e latitude. Quando especifica este parâmetro, a área geográfica é tida em conta ao calcular os resultados de uma consulta de localização.

Exemplo: lon1,lat1,lon2,lat2
coordinates
 query

number[]

Um ponto na terra especificado como uma longitude e latitude. Quando especifica este parâmetro, a localização do utilizador é tida em conta e os resultados devolvidos podem ser mais relevantes para o utilizador. Exemplo: &coordenadas=lon,lat
countryRegion
 query

string

Sinal para o resultado da geocodificação para um código de região/país Alfa-2 ISO 3166-1 que é especificado, por exemplo, FR./

Se a consulta for fornecida, não deve utilizar este parâmetro.
locality
 query

string

A parte local de um endereço, como Seattle.

Se a consulta for fornecida, não deve utilizar este parâmetro.
postalCode
 query

string

A parte do código postal de um endereço.

Se a consulta for fornecida, não deve utilizar este parâmetro.
query
 query

string

Uma cadeia que contém informações sobre uma localização, como um endereço ou um nome de marco.
top
 query

integer

int32

Número máximo de respostas que serão devolvidas. Predefinição: 5, mínimo: 1 e máximo: 20.
view
 query

string

Uma cadeia que representa um código de região/país ISO 3166-1 Alpha-2. Isto irá alterar os limites e etiquetas geopolíticos contestados para se alinharem com a região de utilizador especificada. Por predefinição, o parâmetro Ver está definido como "Automático", mesmo que não o tenha definido no pedido.

Consulte Vistas Suportadas para obter detalhes e para ver as Vistas disponíveis.

Cabeçalho do Pedido

Name Necessário Tipo Description
Accept-Language

string

Idioma no qual os resultados da pesquisa devem ser devolvidos.

Consulte idiomas suportados para obter detalhes.
x-ms-client-id

string

Especifica a conta que se destina à utilização em conjunto com o modelo de segurança do Azure AD. Representa um ID exclusivo para a conta do Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão do Azure Maps. Para utilizar a segurança do Azure AD no Azure Maps, veja os seguintes artigos para obter orientações.

Respostas

Name Tipo Description
200 OK

GeocodingResponse

OK

Media Types: "application/geo+json"

Cabeçalhos

x-ms-request-id: string
Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Media Types: "application/geo+json"

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 do Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais contas de recursos ou sub-recursos do Azure Maps. 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 as APIs REST do Azure Maps.

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 do Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.
  • 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 do 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 do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
  • A utilização do SDK Web do 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 a plataforma de identidades da Microsoft, consulte Descrição geral da plataforma de identidades 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 partilhada que é aprovisionada ao criar um recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras da conta para a qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor a servidor das APIs REST do Azure Maps, onde esta chave pode ser armazenada de forma segura.

Tipo: apiKey
Em: header

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das 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.

Tipo: apiKey
Em: header

Exemplos

Search detail address 15127 NE 24th Street, Redmond, WA
Search detail address 15127 NE 24th Street, Redmond, WA by addressLine
Search detail address 15127 NE 24th Street, Redmond, WA by query
Search landmark Empire State Building by query

Search detail address 15127 NE 24th Street, Redmond, WA

Pedido de amostra

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond

Resposta da amostra

Código de estado:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

Pedido de amostra

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US

Resposta da amostra

Código de estado:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "Medium",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by query

Pedido de amostra

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&query=15127 NE 24th Street Redmond WA

Resposta da amostra

Código de estado:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search landmark Empire State Building by query

Pedido de amostra

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&query=empire state building

Resposta da amostra

Código de estado:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "New York"
        },
        "type": "PointOfInterest",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98580932617188,
                40.748435974121094
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98580932617188,
          40.748435974121094
        ]
      },
      "bbox": [
        -73.98590850830078,
        40.74833679199219,
        -73.98571014404297,
        40.74853515625
      ]
    },
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            },
            {
              "shortName": "New York County"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "Manhattan"
        },
        "type": "LandmarkBuilding",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98500061035156,
                40.74815368652344
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98500061035156,
          40.74815368652344
        ]
      },
      "bbox": [
        -73.98710632324219,
        40.747314453125,
        -73.98412322998047,
        40.74958038330078
      ]
    }
  ]
}

Definições

Name Description
Address

O endereço do resultado
AdminDistricts

O nome da subdivisão no país ou região de um endereço. Este elemento é normalmente tratado como a subdivisão administrativa da primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem num país, dependência ou região.
CalculationMethodEnum

O método utilizado para calcular o ponto de geocódigo.
ConfidenceEnum

O nível de confiança de que o resultado da localização geocodificada corresponde. Utilize este valor com o código de correspondência para determinar para obter informações mais completas sobre a correspondência.

A confiança de uma localização geocodificada baseia-se em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do utilizador, se especificado.
CountryRegion
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta a erros
FeatureCollectionEnum

O tipo de objeto FeatureCollection tem de ser FeatureCollection.
FeaturesItem
FeatureTypeEnum

O tipo de funcionalidade tem de ser Funcionalidade.
GeocodePoints

Uma coleção de pontos geocódigos que diferem na forma como foram calculados e na utilização sugerida.
GeocodingResponse

Este objeto é devolvido a partir de uma chamada de Geocodificação bem-sucedida
GeoJsonPoint

Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.
Intersection

O endereço do resultado.
MatchCodesEnum

Um ou mais valores de código correspondem ao nível de geocodificação para cada localização na resposta.

Por exemplo, uma localização geocodificada com códigos de correspondência de Good e Ambiguous significa que foi encontrada mais do que uma localização de geocódigo para as informações de localização e que o serviço de geocódigo não tinha a hierarquia de pesquisa para encontrar uma correspondência.

Da mesma forma, uma localização geocodificada com códigos de correspondência de Ambiguous e UpHierarchy implica que não foi possível localizar uma localização de geocódigo que corresponda a todas as informações de localização fornecidas, pelo que o serviço de geocódigo teve de procurar na hierarquia superior e encontrou várias correspondências nesse nível. Um exemplo de um AmbiguousUpHierarchy resultado e é quando fornece informações de endereço completas, mas o serviço de geocódigo não consegue localizar uma correspondência para o endereço da rua e, em vez disso, devolve informações para mais do que um valor RoadBlock.

Os valores possíveis são:

Good: a localização tem apenas uma correspondência ou todas as correspondências devolvidas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova Iorque devolve várias Correspondências boas.

Ambiguous: a localização é uma de um conjunto de correspondências possíveis. Por exemplo, quando consulta o endereço 128 Main St., a resposta pode devolver duas localizações para 128 North Main St. e 128 South Main St. porque não existem informações suficientes para determinar que opção escolher.

UpHierarchy: a localização representa uma mudança para cima na hierarquia geográfica. Isto ocorre quando não foi encontrada uma correspondência para o pedido de localização, pelo que é devolvido um resultado menos preciso. Por exemplo, se não for possível encontrar uma correspondência para o endereço pedido, poderá ser devolvido um código de correspondência de com um tipo de UpHierarchy entidade RoadBlock.
Properties
UsageTypeEnum

A melhor utilização para o ponto de geocódigo. Cada ponto de geocódigo é definido como um Route ponto, um Display ponto ou ambos. Utilize Route pontos se estiver a criar uma rota para a localização. Utilize Display pontos se estiver a mostrar a localização num mapa. Por exemplo, se a localização for um parque, um Route ponto pode especificar uma entrada para o parque onde pode entrar com um carro e um Display ponto pode ser um ponto que especifica o centro do parque.

Address

O endereço do resultado

Name Tipo Description
addressLine

string

AddressLine que inclui Nome da Rua e Número
adminDistricts

AdminDistricts[]

O nome da subdivisão no país ou região de um endereço. Normalmente, este elemento é tratado como a subdivisão administrativa da primeira ordem, mas em alguns casos também contém a subdivisão da segunda, terceira ou quarta ordem num país, dependência ou região.
countryRegion

CountryRegion

formattedAddress

string

Propriedade Endereço Formatado
intersection

Intersection

O endereço do resultado.
locality

string

propriedade de localidade
neighborhood

string

propriedade de bairro
postalCode

string

Propriedade Código Postal

AdminDistricts

O nome da subdivisão no país ou região de um endereço. Este elemento é normalmente tratado como a subdivisão administrativa da primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem num país, dependência ou região.

Name Tipo Description
name

string

O nome do campo adminDistrict correspondente, Para adminDistrict[0], este pode ser o nome completo do estado como Washington, For adminDistrict[1], this could be the full name of the county
shortName

string

O nome abreviado para o campo adminDistrict correspondente, Para adminDistrict[0], este pode ser um nome abreviado de estado, como WA, Para adminDistrict[1], este pode ser o nome abreviado do concelho

CalculationMethodEnum

O método utilizado para calcular o ponto de geocódigo.

Name Tipo Description
Interpolation

string

O ponto geocódigo foi correspondido a um ponto numa estrada através da interpolação.
InterpolationOffset

string

O ponto geocódigo foi correspondido a um ponto numa estrada usando interpolação com um desvio adicional para deslocar o ponto para o lado da rua.
Parcel

string

O ponto geocódigo foi correspondido ao centro de uma parcela.
Rooftop

string

O ponto geocódigo foi combinado com o telhado de um edifício.

ConfidenceEnum

O nível de confiança de que o resultado da localização geocodificada corresponde. Utilize este valor com o código de correspondência para determinar para obter informações mais completas sobre a correspondência.

A confiança de uma localização geocodificada baseia-se em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do utilizador, se especificado.

Name Tipo Description
High

string

Se a confiança estiver definida como High, foi encontrada uma ou mais correspondências fortes. Várias High correspondências de confiança são ordenadas por ordem classificada por importância quando aplicável. Por exemplo, os marcos têm importância, mas os endereços não.

Se um pedido incluir uma localização ou uma vista, a classificação poderá ser alterada adequadamente. Por exemplo, uma consulta de localização para "Paris" devolve "Paris, França" e "Paris, TX" ambos com High confiança. "Paris, França" é sempre classificado em primeiro lugar devido a importância, a menos que uma localização de utilizador indique que o utilizador está dentro ou muito perto de Paris, TX ou a vista de mapa indica que o utilizador está a procurar nessa área.
Low

string

Medium

string

Em algumas situações, a correspondência devolvida pode não estar no mesmo nível que as informações fornecidas no pedido. Por exemplo, um pedido pode especificar informações de endereço e o serviço de geocódigo só poderá corresponder a um código postal. Neste caso, se o serviço de geocódigo tiver a confiança de que o código postal corresponde aos dados, a confiança é definida como Medium e o código de correspondência está definido para UpHierarchy especificar que não conseguiu corresponder a todas as informações e teve de procurar na hierarquia.

Se as informações de localização na consulta forem ambíguas e não existirem informações adicionais para classificar as localizações (como a localização do utilizador ou a importância relativa da localização), a confiança está definida como Medium. Por exemplo, uma consulta de localização para "148th Ave, Bellevue" pode devolver "148th Ave SE" e "148th Ave NE" ambos com Medium confiança.

Se as informações de localização na consulta não fornecerem informações suficientes para geocodificar uma localização específica, poderá ser devolvido um valor de localização menos preciso e a confiança está definida como Medium. Por exemplo, se for fornecido um endereço, mas não for encontrada uma correspondência para o número da casa, o resultado de geocódigo com um tipo de entidade Bloqueio de estrada poderá ser devolvido.

CountryRegion

Name Tipo Description
ISO

string

ISO do país/região
name

string

nome do país/região

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

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 a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

FeatureCollectionEnum

O tipo de objeto FeatureCollection tem de ser FeatureCollection.

Name Tipo Description
FeatureCollection

string

FeaturesItem

Name Tipo Description
bbox

number[]

Caixa delimitadora. Projeção utilizada – EPSG:3857. Consulte RFC 7946 para obter detalhes.
geometry

GeoJsonPoint

Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.
id

string

ID da funcionalidade devolvida
properties

Properties

type

FeatureTypeEnum

O tipo de funcionalidade tem de ser Funcionalidade.

FeatureTypeEnum

O tipo de funcionalidade tem de ser Funcionalidade.

Name Tipo Description
Feature

string

GeocodePoints

Uma coleção de pontos geocódigos que diferem na forma como foram calculados e na utilização sugerida.

Name Tipo Description
calculationMethod

CalculationMethodEnum

O método utilizado para calcular o ponto de geocódigo.
geometry

GeoJsonPoint

Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.
usageTypes

UsageTypeEnum[]

A melhor utilização para o ponto de geocódigo. Cada ponto de geocódigo é definido como um Route ponto, um Display ponto ou ambos. Utilize Route pontos se estiver a criar uma rota para a localização. Utilize Display pontos se estiver a mostrar a localização num mapa. Por exemplo, se a localização for um parque, um Route ponto pode especificar uma entrada para o parque onde pode entrar com um carro e um Display ponto pode ser um ponto que especifica o centro do parque.

GeocodingResponse

Este objeto é devolvido a partir de uma chamada de Geocodificação bem-sucedida

Name Tipo Description
features

FeaturesItem[]

nextLink

string

É a ligação para a página seguinte das funcionalidades devolvidas. Se for a última página, não este campo.
type

FeatureCollectionEnum

O tipo de objeto FeatureCollection tem de ser FeatureCollection.

GeoJsonPoint

Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
bbox

number[]

Caixa delimitadora. Projeção utilizada – EPSG:3857. Consulte RFC 7946 para obter detalhes.
coordinates

number[]

A Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente por essa ordem. Altitude/Elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.
type string:

Point

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

Intersection

O endereço do resultado.

Name Tipo Description
baseStreet

string

Rua primária para a localização.
displayName

string

Nome completo da interseção.
intersectionType

string

Tipo de interseção.
secondaryStreet1

string

A primeira rua de intersecção.
secondaryStreet2

string

Se houver, a segunda rua de intersecção.

MatchCodesEnum

Um ou mais valores de código correspondem ao nível de geocodificação para cada localização na resposta.

Por exemplo, uma localização geocodificada com códigos de correspondência de Good e Ambiguous significa que foi encontrada mais do que uma localização de geocódigo para as informações de localização e que o serviço de geocódigo não tinha a hierarquia de pesquisa para encontrar uma correspondência.

Da mesma forma, uma localização geocodificada com códigos de correspondência de Ambiguous e UpHierarchy implica que não foi possível localizar uma localização de geocódigo que corresponda a todas as informações de localização fornecidas, pelo que o serviço de geocódigo teve de procurar na hierarquia superior e encontrou várias correspondências nesse nível. Um exemplo de um AmbiguousUpHierarchy resultado e é quando fornece informações de endereço completas, mas o serviço de geocódigo não consegue localizar uma correspondência para o endereço da rua e, em vez disso, devolve informações para mais do que um valor RoadBlock.

Os valores possíveis são:

Good: a localização tem apenas uma correspondência ou todas as correspondências devolvidas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova Iorque devolve várias Correspondências boas.

Ambiguous: a localização é uma de um conjunto de correspondências possíveis. Por exemplo, quando consulta o endereço 128 Main St., a resposta pode devolver duas localizações para 128 North Main St. e 128 South Main St. porque não existem informações suficientes para determinar que opção escolher.

UpHierarchy: a localização representa uma mudança para cima na hierarquia geográfica. Isto ocorre quando não foi encontrada uma correspondência para o pedido de localização, pelo que é devolvido um resultado menos preciso. Por exemplo, se não for possível encontrar uma correspondência para o endereço pedido, poderá ser devolvido um código de correspondência de com um tipo de UpHierarchy entidade RoadBlock.

Name Tipo Description
Ambiguous

string

Good

string

UpHierarchy

string

Properties

Name Tipo Description
address

Address

O endereço do resultado
confidence

ConfidenceEnum

O nível de confiança de que o resultado da localização geocodificada corresponde. Utilize este valor com o código de correspondência para determinar para obter informações mais completas sobre a correspondência.

A confiança de uma localização geocodificada baseia-se em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do utilizador, se especificado.
geocodePoints

GeocodePoints[]

Uma coleção de pontos geocódigo que diferem na forma como foram calculados e na respetiva utilização sugerida.
matchCodes

MatchCodesEnum[]

Um ou mais valores de código correspondem ao nível de geocodificação para cada localização na resposta.

Por exemplo, uma localização geocodificada com códigos de correspondência de Good e Ambiguous significa que foi encontrada mais do que uma localização de geocódigo para as informações de localização e que o serviço de geocódigo não tinha a hierarquia de pesquisa para encontrar uma correspondência.

Da mesma forma, uma localização geocodificada com códigos de correspondência de Ambiguous e UpHierarchy implica que não foi possível localizar uma localização de geocódigo que corresponda a todas as informações de localização fornecidas, pelo que o serviço de geocódigo teve de procurar na hierarquia superior e encontrou várias correspondências nesse nível. Um exemplo de um AmbiguousUpHierarchy resultado e é quando fornece informações de endereço completas, mas o serviço de geocódigo não consegue localizar uma correspondência para o endereço da rua e, em vez disso, devolve informações para mais do que um valor RoadBlock.

Os valores possíveis são:

Good: a localização tem apenas uma correspondência ou todas as correspondências devolvidas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova Iorque devolve várias Correspondências boas.

Ambiguous: a localização é uma de um conjunto de correspondências possíveis. Por exemplo, quando consulta o endereço 128 Main St., a resposta pode devolver duas localizações para 128 North Main St. e 128 South Main St. porque não existem informações suficientes para determinar que opção escolher.

UpHierarchy: a localização representa uma mudança para cima na hierarquia geográfica. Isto ocorre quando não foi encontrada uma correspondência para o pedido de localização, pelo que é devolvido um resultado menos preciso. Por exemplo, se não for possível encontrar uma correspondência para o endereço pedido, poderá ser devolvido um código de correspondência de com um tipo de UpHierarchy entidade RoadBlock.
type

string

Um dos seguintes:

  • Endereço
  • RoadBlock
  • RoadIntersection
  • Bairro
  • PopulatedPlace
  • Código postal1
  • AdminDivision1
  • AdminDivision2
  • RegiãoDoPaís

UsageTypeEnum

A melhor utilização para o ponto de geocódigo. Cada ponto de geocódigo é definido como um Route ponto, um Display ponto ou ambos. Utilize Route pontos se estiver a criar uma rota para a localização. Utilize Display pontos se estiver a mostrar a localização num mapa. Por exemplo, se a localização for um parque, um Route ponto pode especificar uma entrada para o parque onde pode entrar com um carro e um Display ponto pode ser um ponto que especifica o centro do parque.

Name Tipo Description
Display

string

Route

string