Search - Get Geocoding Batch

GeocodingBatchResponse

O pedido foi bem-sucedido.

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

string

A primeira linha do endereço, normalmente o nome e número da rua. Por exemplo, "15127 NE 24th St".

AddressAdminDistrictsItem[]

As subdivisões administrativas que contêm o endereço, ordenadas do mais grosseiro para o mais refinado. A primeira entrada é tipicamente a subdivisão de primeira ordem (como um estado dos EUA ou uma província canadiana); Entradas subsequentes cobrem divisões mais finas onde o país, dependência ou região as define (como um condado no índice 1).

AddressCountryRegion

O país ou região que contém o endereço, com o seu nome de exibição e o código de país ISO 3166-1 Alpha-2.

string

O endereço completo é apresentado como uma única cadeia legível por humanos, com os componentes unidos de acordo com as convenções do país ou região do endereço. Exemplo: "15127 NE 24th St, Redmond, WA 98052".

Intersection

Os detalhes das ruas que se cruzam para o endereço, preenchidos quando a entidade resolvida é um RoadIntersection (como a esquina de duas ruas nomeadas).

string

A localidade onde o endereço se encontra: normalmente uma cidade, vila ou aldeia. Por exemplo: "Redmond".

string

O bairro nomeado dentro da localidade, quando um é identificado.

string

O código postal do endereço, quando definido um. Exemplo: "98052".

string

O componente do nome da rua do endereço, quando a entidade resolvida é um endereço ao nível da rua. Exemplo: "NE 24th St".

string

O número da casa ou edifício na rua, quando a entidade resolvida é um endereço ao nível da rua. Exemplo: "15127".

string

O nome completo do loteamento. Por exemplo, "Washington" para um estado dos EUA, ou "King County" para um condado.

string

A forma abreviada ou abreviada do nome da subdivisão, quando é definido. Por exemplo, "WA" para um estado dos EUA. Subdivisões mais finas muitas vezes não têm uma forma curta distinta, caso em shortName que se repete name (como "King County").

string

O código de país ISO 3166-1 Alpha-2 para o país ou região. Por exemplo, "US" para os Estados Unidos, ou "GB" para o Reino Unido.

string

O nome de exibição do país ou região. Por exemplo, "Estados Unidos".

string

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

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 por humanos do erro.

string

O alvo do erro.

Azure.Core.Foundations.Error

O objeto de erro.

string

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

Azure.Core.Foundations.InnerError

Erro interno.

object

As informações adicionais.

string

O tipo de informação adicional.

ErrorAdditionalInfo[]

O erro informações adicionais.

string

O código de erro.

ErrorDetail[]

Os detalhes do erro.

string

A mensagem de erro.

string

O destino do erro.

number[] (double)

O retângulo mais pequeno alinhado ao eixo que contém a geometria da estrutura, na ordem WGS 84 de longitude/latitude. Codificado conforme [westLon, southLat, eastLon, northLat]o RFC 7946, Secção 5.

GeoJsonPoint

O primário GeoJSON Point representa a localização geocodificada, com coordenadas em ordem de longitude/latitude WGS 84.

string

Um identificador opcional atribuído pelo serviço para a funcionalidade, quando estiver disponível.

FeaturesItemProperties

Dados estruturados sobre a localização geocodificada, incluindo o seu tipo de entidade, indicadores de qualidade de correspondência, componentes de endereço e um ou mais pontos de geocodificação.

FeatureTypeEnum

O tipo de GeoJSON objeto. Sempre Feature, conforme definido no RFC 7946.

Address

O endereço da localização geocodificada, dividido em campos estruturados como localidade, código postal, país/região e (quando disponível) nome e número da rua.

ConfidenceEnum

Quão fortemente a localização geocodificada corresponde ao pedido. Utilize-o juntamente matchCodes para obter uma visão completa da qualidade do jogo. Consulte ConfidenceEnum a lista de valores e os fatores que influenciam a classificação.

GeocodePointsItem[]

Um ou mais pontos de geocódigo para a localização, cada um marcado com a forma como foi derivada (calculationMethod) e para o que é mais adequada (usageTypes). Por exemplo, Display para colocação visual num mapa, ou Route para uso como destino de navegação.

MatchCodesEnum[]

Como o serviço de geocodificação produziu este resultado em relação à consulta: uma correspondência direta na especificidade solicitada (Good), um de vários candidatos (Ambiguous), ou um recurso para um nível menos preciso da hierarquia geográfica (UpHierarchy). Podem existir múltiplos valores. Por exemplo, um Ambiguous emparelhamento plus UpHierarchy indica que o serviço não conseguiu corresponder à especificidade solicitada e encontrou múltiplas correspondências a um nível mais grosseiro. Veja MatchCodesEnum as descrições por valor; combine com confidence para uma imagem completa da qualidade da correspondência.

string

O tipo de entidade para o qual a localização geocodificada foi resolvida. Um de: Address, RoadBlock, RoadIntersection, Neighborhood, PopulatedPlace, Postcode1, AdminDivision1, AdminDivision2, , ou CountryRegion.

CalculationMethodEnum

Como o ponto era calculado. Por exemplo, encaixado no telhado de um edifício ou interpolado ao longo da linha central de uma estrada. Veja CalculationMethodEnum a lista de valores.

GeoJsonPoint

A coordenada deste geocódigo aponta como um GeoJSON Point, com valores na ordem de longitude/latitude WGS 84.

UsageTypeEnum[]

Para que o ponto de geocódigo é mais adequado — Display para colocação visual num mapa, ou Route como destino de rota. Um ponto pode valer ambos. Consulte UsageTypeEnum os detalhes por valor, incluindo como cada um está posicionado para características com extensão não trivial.

GeocodingBatchRequestItem[]

As consultas de geocodificação a processar neste lote. Cada entrada é um pedido de geocodificação direta independente; o serviço devolve uma entrada correspondente em GeocodingBatchResponse.batchItems por consulta, na mesma ordem.

string

A linha da rua do endereço, normalmente o nome e número da rua, ou qualquer outro endereço oficial ao nível da rua. Ignorado quando query está definido.

string

A subdivisão administrativa de primeira ordem (como um estado ou província) fornecida como nome ou código curto. Por exemplo, "WA" para Washington. Ignorado quando query está definido.

string

A subdivisão administrativa de segunda ordem (como um condado). Por exemplo, "King" para o Condado de King. Ignorado quando query está definido.

string

A subdivisão administrativa de terceira ordem (como um distrito, freguesia ou município), onde o país, dependência ou região define um. Ignorado quando query está definido.

number[] (double)

Uma caixa delimitadora que estende a pesquisa para uma área geográfica retangular. Codificado como [westLon, southLat, eastLon, northLat] na ordem de longitude/latitude WGS 84, com cada lado a variar de aproximadamente 0.00001 graus (~1 metro) até à extensão global total (-180, -90 a 180, 90).

number[] (double)

Um ponto na Terra, codificado como [longitude, latitude] na ordem WGS 84, era usado para enviesar os resultados em direção à localização do utilizador. Quando fornecidos, resultados mais próximos deste ponto são tipicamente mais relevantes para o utilizador.

string

Um código de região/país ISO 3166-1 Alpha-2 que encaminha a pesquisa para um único país ou região. Por exemplo, "FR" para França. Ignorado quando query está definido.

string

A localidade (cidade, vila ou aldeia) componente do endereço. Por exemplo, "Seattle". Ignorado quando query está definido.

string

Um identificador opcional fornecido pelo chamador ecoava na entrada correspondente como GeocodingBatchResponseItem.optionalId. Útil para correlacionar respostas a pedidos por um identificador estável do lado da aplicação, em vez de depender apenas da posição do array.

string

O componente do código postal do endereço. Ignorado quando query está definido.

string

Uma cadeia de caracteres livres que descreve a localização a geocodificar, tipicamente um endereço ou nome de marco. Quando definidos, os campos de localização estruturados abaixo (addressLine, locality, countryRegion, os adminDistrict níveis, postalCode) são ignorados.

integer (int32)

O número máximo de resultados geocodificados deveria para esta consulta. Por defeito é 5; mínimo 1, máximo 20.

string

Um código de região/país ISO 3166-1 Alpha-2 identificando a região cuja visão geopolítica deve ser aplicada às fronteiras e rótulos contestados na resposta. Por defeito é "auto", que seleciona a vista com base na origem do pedido. Consulte Vistas Suportadas para os valores disponíveis.

GeocodingBatchResponseItem[]

Os resultados por consulta do lote. Cada entrada corresponde posicionalmente à entrada do pedido no mesmo índice do array em GeocodingBatchRequestBody.batchItems. Entradas com error preenchidas representam consultas que falharam; entradas com features preenchidas representam consultas que tiveram sucesso.

string

Contém o URL para obter a página seguinte de resultados se a resposta for paginada. Isto é útil quando a resposta é demasiado grande para ser devolvida numa única chamada, permitindo aos utilizadores navegar por várias páginas de resultados.

GeocodingBatchResponseSummary

O agregado conta para o lote como um todo, o total de consultas submetidas e quantas delas foram concluídas com sucesso.

ErrorDetail

Informação de diagnóstico para uma consulta que falhou dentro do lote, o caminho de erro por entrada complementando o caminho de sucesso em features. Povoado apenas quando a entrada falhava; ver ErrorDetail para a forma por erro.

FeaturesItem[]

O array de GeoJSON Feature objetos geocodificados para a consulta desta entrada em lote. Cada um Feature representa uma única localização geocodificada com detalhes expostos via properties e a sua coordenada primária via geometry. Povoado apenas quando a entrada tinha sucesso.

string

Contém o URL para obter a página seguinte de resultados se a resposta for paginada. Isto é útil quando a resposta é demasiado grande para ser devolvida numa única chamada, permitindo aos utilizadores navegar por várias páginas de resultados.

string

O identificador fornecido pelo chamador ecoava de volta do correspondente GeocodingBatchRequestItem.optionalId. Preenchido apenas quando a entrada do pedido fornecia um. Útil para correlação do lado da aplicação quando a posição do array não é suficiente.

FeatureCollectionEnum

O GeoJSON tipo de objeto do corpo de sucesso desta entrada. Sempre FeatureCollection, conforme definido no RFC 7946. Povoado apenas quando a entrada tinha sucesso.

integer (int32)

O número de consultas no lote que foram processadas com sucesso — aquelas cuja entrada de resposta em GeocodingBatchResponse.batchItems contém features em vez de error.

integer (int32)

O número total de consultas submetidas no lote. Subtrai successfulRequests para obter o número de consultas que falharam.

number[] (double)

Caixa delimitadora. Projeção utilizada - 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 longitude e latitude, precisamente nesta ordem. de 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

A rua principal do cruzamento — normalmente a rua que o número de morada refere.

string

Um nome legível por humanos para o cruzamento que combina as ruas transversais, como "5th Avenue & Main Street".

string

Um pequeno rótulo que descreve a forma da interseção. Por exemplo, distinguir um cruzamento ao nível de um cruzamento a nível separado, como uma ponte ou um viaduto.

string

A primeira rua transversal que se encontra baseStreet no cruzamento.

string

A segunda rua transversal na interseção, quando há uma. Populado apenas para interseções de três ou mais ruas.