Search - Get Geocoding Batch

GeocodingBatchResponse

A solicitação foi bem-sucedida.

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

string

AddressLine que inclui o nome e o número da rua

AddressAdminDistrictsItem[]

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

AddressCountryRegion

País ou região com seu nome e código ISO.

string

Propriedade de endereço formatado

Intersection

O endereço do resultado.

string

Propriedade de localidade

string

Propriedade do bairro

string

Propriedade do CEP

string

O nome da rua de formattedAddress

string

O número na rua, se disponível, de formattedAddress

string

O nome do campo adminDistrict correspondente, For adminDistrict[0], pode ser o nome completo do estado, como Washington, For adminDistrict[1], este pode ser o nome completo do condado

string

O nome curto do campo adminDistrict correspondente, For adminDistrict[0], pode ser um nome curto de estado, como WA, For adminDistrict[1], esse pode ser o nome curto do município

string

ISO do país/região

string

nome do país/região

string

Um de um conjunto definido pelo servidor de códigos de erro.

Azure.Core.Foundations.Error[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

string

Uma representação legível pelo ser humano do erro.

string

O destino do erro.

Azure.Core.Foundations.Error

O objeto de erro.

string

Um de um conjunto definido pelo servidor de códigos de erro.

Azure.Core.Foundations.InnerError

Erro interno.

object

As informações adicionais.

string

O tipo de informação adicional.

ErrorAdditionalInfo[]

As informações adicionais do erro.

string

O código do erro.

ErrorDetail[]

Os detalhes do erro.

string

A mensagem de erro.

string

O destino do erro.

number[] (double)

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

GeoJsonPoint

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

string

ID do recurso retornado

FeaturesItemProperties

Propriedades da característica.

FeatureTypeEnum

O tipo de um recurso deve ser Feature.

Address

O endereço do resultado

ConfidenceEnum

O nível de confiança de que o resultado do local geocodificado é uma correspondência. Use esse valor com o código de correspondência para determinar informações mais completas sobre a correspondência.

A confiança de um local geocodificado baseia-se em muitos fatores, incluindo a importância relativa do local geocodificado e a localização do usuário, se especificado.

GeocodePointsItem[]

Uma coleção de pontos de código geográfico que diferem em como eles foram calculados e seu uso sugerido.

MatchCodesEnum[]

Um ou mais valores de código correspondentes que representam o nível de geocodificação para cada local na resposta.

Por exemplo, um local geocodificado com códigos de correspondência de Good e Ambiguous significa que mais de um local de código geográfico foi encontrado para as informações de localização e que o serviço de geocódigo não tinha uma hierarquia de pesquisa para encontrar uma correspondência.

Da mesma forma, um local geocodificado com códigos de correspondência de Ambiguous e UpHierarchy implica que não foi possível encontrar um local de código geográfico que correspondesse a todas as informações de localização fornecidas, de modo que o serviço de geocódigo teve que pesquisar a hierarquia superior e encontrou várias correspondências nesse nível. Um exemplo de um resultado Ambiguous e UpHierarchy é quando você fornece informações de endereço completas, mas o serviço de geocodificação não pode localizar uma correspondência para o endereço de rua e, em vez disso, retorna informações para mais de um valor roadblock.

Os valores possíveis são:

Good: o local tem apenas uma correspondência ou todas as correspondências retornadas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova York retorna várias correspondências boas.

Ambiguous: o local é uma de um conjunto de possíveis correspondências. Por exemplo, quando você consulta o endereço da rua 128 Main St., a resposta pode retornar dois locais para 128 North Main St. e 128 South Main St. porque não há informações suficientes para determinar qual opção escolher.

UpHierarchy: o local representa um movimento para cima da hierarquia geográfica. Isso ocorre quando uma correspondência para a solicitação de local não foi encontrada, portanto, um resultado menos preciso é retornado. Por exemplo, se uma correspondência para o endereço solicitado não puder ser encontrada, um código de correspondência de UpHierarchy com um tipo de entidade RoadBlock poderá ser retornado.

string

Um dos: * Endereço * BloqueioEstrada * InterseçãoEstrada * Bairro * Lugar Povoado * CEP1 * DivisãoAdministrativa1 * DivisãoAdministrativa2 * PaísRegião

CalculationMethodEnum

O método que foi usado para calcular o ponto de código geográfico.

GeoJsonPoint

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

UsageTypeEnum[]

O melhor uso para o ponto de código geográfico. Cada ponto de código geográfico é definido como um ponto de Route, um ponto Display ou ambos. Use Route pontos se estiver criando uma rota para o local. Use Display pontos se estiver mostrando o local em um mapa. Por exemplo, se o local for um parque, um ponto Route poderá especificar uma entrada para o parque em que você pode entrar com um carro e um ponto Display pode ser um ponto que especifica o centro do parque.

GeocodingBatchRequestItem[]

A lista de consultas a serem processadas.

string

A linha de rua oficial de um endereço relativo à área, conforme especificado pelas propriedades localidade ou postalCode. O uso típico desse elemento seria fornecer um endereço ou qualquer endereço oficial.

Esse parâmetro não deve ser usado quando o query parâmetro é incluído na solicitação.

string

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

Esse parâmetro não deve ser usado quando o query parâmetro é incluído na solicitação.

string

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

Esse parâmetro não deve ser usado quando o query parâmetro é incluído na solicitação.

string

A área nomeada para o endereço estruturado.

Esse parâmetro não deve ser usado quando o query parâmetro é incluído na solicitação.

number[] (double)

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. Para obter mais informações, consulte Tipos de localização e área. Quando você especifica esse parâmetro, a área geográfica é levada em conta ao calcular os resultados de uma consulta de local.

Exemplo: [lon1, lat1, lon2, lat2]

number[] (double)

Um ponto na Terra especificado como longitude e latitude. Quando você especifica esse parâmetro, a localização do usuário é levada em consideração e os resultados retornados podem ser mais relevantes para o usuário. Exemplo: [lon, lat]

string

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

Esse parâmetro não deve ser usado quando o query parâmetro é incluído na solicitação.

string

A parte da localidade de um endereço, como Seattle.

Esse parâmetro não deve ser usado quando o query parâmetro é incluído na solicitação.

string

ID da solicitação que seria mostrada no batchItem correspondente

string

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

Esse parâmetro não deve ser usado quando o query parâmetro é incluído na solicitação.

string

Uma cadeia de caracteres que contém informações sobre um local, como um endereço ou nome de ponto de referência.

integer (int32)

Número máximo de respostas que serão retornadas. Padrão: 5, mínimo: 1 e máximo: 20.

string

Uma cadeia de caracteres que especifica uma de código de região/país iso 3166-1 alfa-2 do ISO 3166-1 . Isso alterará as bordas e rótulos contestados geopolíticos para se alinharem com a região de usuário especificada.

GeocodingBatchResponseItem[]

Matriz que contém os resultados do lote.

string

É o link para a próxima página dos recursos retornados. Se for a última página, não este campo.

GeocodingBatchResponseSummary

Resumo da solicitação em lote

ErrorDetail

O detalhe do erro.

FeaturesItem[]

Uma série de recursos retornados da consulta.

string

É o link para a próxima página dos recursos retornados. Se for a última página, não este campo.

string

id do batchItem que seria o mesmo que a ID na solicitação

FeatureCollectionEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é FeatureCollection. Para obter mais informações, consulte RFC 7946.

integer (int32)

Número de solicitações bem-sucedidas no lote

integer (int32)

Número total de solicitações no lote

number[] (double)

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

number[] (double)

Um Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são de longitude e de latitude, precisamente nessa ordem. altitude/elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.

Point

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

string

Rua primária para o local.

string

Nome completo da interseção.

string

Tipo de interseção.

string

A primeira rua de interseção.

string

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