Search - Get Search Address Reverse Batch

Endereço de pesquisa Reverso Lote API

Aplica-se a: ver níveis de preços.

A API do Lote de Endereço de Pesquisa envia lotes de consultas para Procurar endereço API reverso usando apenas uma única chamada API. Pode ligar para o Endereço de Pesquisa Reverter a API para funcionar de forma assíncronea (assíncrono) ou sincronizada (sincronização). A API async permite que o chamador emoque até 10.000 consultas e sincronizar a API até 100 consultas.

Submeter pedido de lote sincronizado

A API Sincronizada é recomendada para pedidos de lote leve. Quando o serviço receber um pedido, responderá assim que os itens do lote forem calculados e não haverá possibilidade de recuperar os resultados mais tarde. A API Sincronizada retornará um erro de tempo limite (uma resposta de 408) se o pedido demorar mais de 60 segundos. O número de itens de lote é limitado a 100 para esta API.

POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Submeter pedido de lote assíncronos

A API Assíncrono é adequada para o processamento de grandes volumes de pedidos de pesquisa relativamente complexos

  • Permite a recuperação de resultados numa chamada separada (vários downloads são possíveis).
  • A API assíncrono está otimizada para a fiabilidade e não se espera que se descuida em tempo de intervalo.
  • O número de itens de lote é limitado a 10.000 para esta API.

Quando faz um pedido utilizando um pedido de assínc, por padrão o serviço devolve um código de resposta 202 ao longo de um URL de redirecionamento no campo Localização do cabeçalho de resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. As respostas assíncronos são armazenadas durante 14 dias. O URL de redireccionamento devolve uma resposta de 404 se for utilizado após o período de expiração.

Por favor, note que o pedido de lote assíncronos é um pedido de longa duração. Aqui está uma sequência típica de operações:

  1. O cliente envia um pedido de Lote de POST Endereço de Busca para Azure Maps

  2. O servidor responderá com uma das seguintes:

    HTTP 202 Accepted - O pedido de lote foi aceite.

    HTTP Error - Houve um erro no processamento do seu pedido de Lote. Isto pode ser um 400 Bad Request ou qualquer outro Error código de estado.

  3. Se o pedido de lote foi aceite com sucesso, o Location cabeçalho na resposta contém o URL para descarregar os resultados do pedido do lote. Este estatuto URI parece seguir:

    GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. O cliente emite um GET pedido no URL de descarregamento obtido no Passo 3 para descarregar os resultados do lote.

Corpo POST para pedido de lote

Para enviar as consultas inversas do endereço de pesquisa , utilizará um POST pedido em que o corpo de pedidos conterá a batchItems matriz em json formato e o Content-Type cabeçalho será definido para application/json. Aqui está um corpo de pedido de amostra contendo 5 consultas inversas de endereço de pesquisa :

{
    "batchItems": [
        {"query": "?query=48.858561,2.294911"},
        {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
        {"query": "?query=47.621028,-122.348170"},
        {"query": "?query=43.722990,10.396695"},
        {"query": "?query=40.750958,-73.982336"}
    ]
}

Uma consulta inversa de endereço de pesquisa num lote é apenas um URL parcial sem o protocolo, URL base, caminho, versão api e chave de subscrição. Pode aceitar qualquer um dos parâmetros URI invertidos do endereço de pesquisa suportado. Os valores de cadeia na consulta inversa do endereço de pesquisa devem ser corretamente escapados (por exemplo, " o carácter deve ser escapado com \ ) e também deve ser devidamente codificado por URL.

A API async permite que o chamador emoque até 10.000 consultas e sincronizar a API até 100 consultas, e o lote deve conter pelo menos 1 consulta.

Baixar Resultados do Lote Assíncronos

Para baixar os resultados do lote async, emite um GET pedido para o ponto final de descarregamento do lote. Este URL de descarregamento pode ser obtido a Location partir do cabeçalho de um pedido de lote bem sucedido POST e parece o seguinte:

https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Aqui está a sequência típica de operações para descarregar os resultados do lote:

  1. O cliente envia um GET pedido usando o URL de descarregamento.

  2. O servidor responderá com uma das seguintes:

    HTTP 202 Accepted - O pedido de lote foi aceite, mas ainda está a ser processado. Por favor, tente de novo em algum momento.

    HTTP 200 OK - Pedido de lote processado com sucesso. O corpo de resposta contém todos os resultados do lote.

Modelo de resposta ao lote

O conteúdo dos dados devolvidos é semelhante para pedidos de async e sincronização. Ao descarregar os resultados de um pedido de lote de assínc, se o lote tiver terminado o processamento, o corpo de resposta contém a resposta do lote. Esta resposta do lote contém um summary componente que indica totalRequests que faziam parte do pedido original do lote e successfulRequests, ou seja, consultas que foram executadas com sucesso. A resposta do lote também inclui um batchItems conjunto que contém uma resposta para cada consulta no pedido do lote. O batchItems testamento contém os resultados exatamente da mesma ordem que as consultas originais foram enviadas no pedido do lote. Cada item contém batchItemsstatusCode e response campos. Cada um response é batchItems de um dos seguintes tipos:

  • SearchAddressReverseResponse - Se a consulta tiver sido concluída com sucesso.

  • Error - Se a consulta falhou. A resposta conterá um code e um message neste caso.

Aqui está uma amostra Batch Response com 2 resultados bem sucedidos e 1 falhado :

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 11
                },
                "addresses": [
                    {
                        "address": {
                            "country": "France",
                            "freeformAddress": "Avenue Anatole France, 75007 Paris"
                        },
                        "position": "48.858490,2.294820"
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 1
                },
                "addresses": [
                    {
                        "address": {
                            "country": "United States of America",
                            "freeformAddress": "157th Pl NE, Redmond WA 98052"
                        },
                        "position": "47.640470,-122.129430"
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
GET https://atlas.microsoft.com/search/address/reverse/batch/{format}?api-version=1.0

Parâmetros do URI

Name In Required Type Description
format
path True
  • string

Identificação do lote para consulta da operação.

api-version
query True
  • string

Número de versão da Azure Maps API.

Cabeçalho do Pedido

Name Required Type Description
x-ms-client-id
  • string

Especifica qual a conta destinada a ser utilizada em conjunto com o modelo de segurança Azure AD. Representa um ID único para a conta Azure Maps e pode ser recuperado a partir do plano de gestão Azure Maps Conta API. Para utilizar Azure AD segurança em Azure Maps consulte os seguintes artigos para orientação.

Respostas

Name Type Description
200 OK

OK

202 Accepted

Apoiado apenas para pedido de async. Pedido Aceite: O pedido foi aceite para processamento. Utilize o URL no Cabeçalho de Localização para voltar a tentar ou aceder aos resultados.

Headers

  • Location: string
Other Status Codes

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Fluxos OAuth2 Do Diretório Ativo Azure . Quando emparelhado com o controlo de acesso baseado em funções Azure, pode ser usado para controlar o acesso a AZURE MAPS APIs REST. Os controlos de acesso baseados em funções Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps REST APIs.

Para implementar cenários, recomendamos visualização de conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para aplicações de modelação através de objetos capazes de aceder ao controlo em APIs e âmbitos específicos.

Notas

  • Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso Azure Maps a aplicação está a solicitar acesso. Isto pode ser adquirido pela API de gestão maps.

O Authorization URL é específico para o exemplo de nuvem pública Azure. As nuvens soberanas têm URLs de Autorização únicos e configurações de diretório Azure Ative. * O controlo de acesso baseado em funções Azure é configurado a partir do plano de gestão Azure através de portal do Azure, PowerShell, CLI, Azure SDKs ou REST APIs. * A utilização do Azure Maps Web SDK permite a configuração baseada na configuração de uma aplicação para múltiplos casos de uso.

  • Atualmente, o Azure Ative Directory v1.0 ou v2.0 apoia o Trabalho, a Escola e os Hóspedes, mas não suporta contas pessoais.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Esta é uma chave partilhada que é a provisionada quando cria uma conta Azure Maps no portal do Azure ou utilizando PowerShell, CLI, Azure SDKs ou REST API.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser usada como chave principal na conta em que são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações confidenciais do cliente para aceder Azure Maps REST APIs para que a sua chave possa ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado é criado a partir da operação List SAS no Azure Maps recurso através do plano de gestão Azure via portal do Azure, PowerShell, CLI, Azure SDKs ou REST APIs.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções Azure e controlo de grãos finos à expiração, taxa e(s) de utilização para o token específico. Por outras palavras, o Sas Token pode ser usado 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 Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Type: apiKey
In: header

Exemplos

A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries

Sample Request

GET https://atlas.microsoft.com/search/address/reverse/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

Sample Response

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "7",
              "routeNumbers": [],
              "streetName": "Avenue Anatole France",
              "streetNameAndNumber": "7 Avenue Anatole France",
              "countryCode": "FR",
              "countrySubdivision": "Île-de-France",
              "countrySecondarySubdivision": "Paris",
              "municipality": "Paris",
              "postalCode": "75007",
              "municipalitySubdivision": "7ème Arrondissement",
              "country": "France",
              "countryCodeISO3": "FRA",
              "freeformAddress": "7 Avenue Anatole France, Paris, 75007",
              "boundingBox": {
                "northEast": "48.858321,2.295167",
                "southWest": "48.858136,2.295027",
                "entity": "position"
              }
            },
            "position": "48.858231,2.295089"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "routeNumbers": [],
              "countryCode": "US",
              "countrySubdivision": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "municipality": "Redmond",
              "postalCode": "98052",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "Redmond, WA 98052",
              "boundingBox": {
                "northEast": "47.639765,-122.128661",
                "southWest": "47.639502,-122.129456",
                "entity": "position"
              },
              "countrySubdivisionName": "Washington"
            },
            "position": "47.639687,-122.128677"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 19,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "410",
              "routeNumbers": [],
              "streetName": "Thomas Street",
              "streetNameAndNumber": "410 Thomas Street",
              "countryCode": "US",
              "countrySubdivision": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "municipality": "Seattle",
              "postalCode": "98109",
              "municipalitySubdivision": "Seattle, Lower Queen Anne",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "410 Thomas Street, Seattle, WA 98109",
              "boundingBox": {
                "northEast": "47.620954,-122.347601",
                "southWest": "47.620944,-122.348498",
                "entity": "position"
              },
              "extendedPostalCode": "981094621",
              "countrySubdivisionName": "Washington"
            },
            "position": "47.620945,-122.348175"
          }
        ]
      }
    }
  ]
}

Definições

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. Estão incluídas as coordenadas para as localizações de início e fim da gama de endereços.

BoundingBox

O viewport que cobre o resultado representado pelas coordenadas superior esquerda e inferior direita do viewport.

BoundingBoxCompassNotation

A caixa de delimitação do local.

Brand

A marca associada ao POI

Classification

A classificação para o POI sendo devolvido

ClassificationName

Nome para a classificação

DataSources

Secção opcional. Ids de referência para uso com a API do Polígono de Pesquisa .

Entity

Fonte tipo de entidade da caixa de delimitação. Para a geocodagem inversa isto é sempre igual à posição.

EntryPoint

O ponto de entrada para o POI ser devolvido.

EntryPointType

O tipo de ponto de entrada. O valor pode ser principal ou menor.

ErrorAdditionalInfo

O erro de gestão de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

GeographicEntityType

Tipo de entidade de geografia. Presente apenas quando a entidadeType foi solicitada e está disponível.

Geometry

Informação sobre a forma geométrica do resultado. Só presente se o tipo == Geografia.

LatLongPairAbbreviated

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

MatchType

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

OperatingHours

Horário de funcionamento para um POI (Pontos de Interesse).

OperatingHoursTime

Representa uma data e hora

OperatingHoursTimeRange

Intervalo de tempo aberto para um dia

PointOfInterest

Detalhes do POI devolvido, incluindo informações como o nome, telefone, endereço url e classificações.

PointOfInterestCategorySet

Categoria POI

QueryType

O tipo de consulta que está a ser devolvida: NEARBY ou NON_NEAR.

Response

O resultado da consulta. SearchAddressResponse se a consulta tiver sido concluída com sucesso, ErrorResponse de outra forma.

ReverseSearchAddressBatchItem

Um item devolvido a partir do serviço de serviço reverso do endereço de busca.

ReverseSearchAddressBatchProcessResult

Este objeto é devolvido de uma chamada de serviço de Serviço reverso do Endereço de Pesquisa bem sucedida.

SearchAddressResultItem

Objeto de resultado para uma resposta de API de pesquisa.

SearchAddressResultType

Um dos seguintes:

  • POI
  • Rua
  • Geografia
  • Endereço ponto
  • Intervalo de endereços
  • Rua Cross
SearchSummary

Objeto sumário para uma resposta de API de pesquisa.

Summary

Resumo dos resultados do pedido de lote

Address

O endereço do resultado

Name Type Description
boundingBox

A caixa de delimitação do local.

buildingNumber
  • string

O número do prédio na rua. DEPRECATED, use streetNumber em vez disso.

country
  • string

Nome do país

countryCode
  • string

País (Nota: Este é um código de duas letras, não um nome de país.)

countryCodeISO3
  • string

Código de país ISO alpha-3

countrySecondarySubdivision
  • string

Concelho

countrySubdivision
  • string

Distrito

countrySubdivisionName
  • string

O nome completo de um primeiro nível da hierarquia administrativa do país. Este campo só aparece no caso de o paísAubdivision ser apresentada de forma abreviada. Só apoiado nos EUA, Canadá e Reino Unido.

countryTertiarySubdivision
  • string

Área nomeada

crossStreet
  • string

O nome da rua sendo atravessada.

extendedPostalCode
  • string

Código postal alargado (a disponibilidade depende da região).

freeformAddress
  • string

Uma linha de endereço formatada de acordo com as regras de formatação do país de origem de um Resultado, ou no caso de um país, o seu nome de país completo.

localName
  • string

Um componente de endereço que represente o nome de uma área geográfica ou localidade que agrulem uma série de objetos endereçados para fins de endereçamento, sem ser uma unidade administrativa. Este campo é usado para construir a freeformAddress propriedade.

municipality
  • string

Cidade / Cidade

municipalitySubdivision
  • string

Sub / Super Cidade

postalCode
  • string

Código Postal / Código Postal

routeNumbers
  • string[]

Os códigos usados para identificar inequivocamente a rua

street
  • string

O nome da rua. Depreciado, use o nome de rua em vez disso.

streetName
  • string

O nome da rua.

streetNameAndNumber
  • string

O nome e o número da rua.

streetNumber
  • string

O número do prédio na rua.

AddressRanges

Descreve o intervalo de endereços em ambos os lados da rua para obter um resultado de pesquisa. Estão incluídas as coordenadas para as localizações de início e fim da gama de endereços.

Name Type Description
from

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

rangeLeft
  • string

Alcance de endereço no lado esquerdo da rua.

rangeRight
  • string

Alcance de endereço no lado direito da rua.

to

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

BoundingBox

O viewport que cobre o resultado representado pelas coordenadas superior esquerda e inferior direita do viewport.

Name Type Description
btmRightPoint

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

topLeftPoint

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

BoundingBoxCompassNotation

A caixa de delimitação do local.

Name Type Description
entity

Fonte tipo de entidade da caixa de delimitação. Para a geocodagem inversa isto é sempre igual à posição.

northEast
  • string

Latitude nordeste, longitude coordenada da caixa de delimitação como flutuadores separados por vírgula

southWest
  • string

Latitude sudoeste, longitude coordenada da caixa de delimitação como flutuadores separados por vírgula

Brand

A marca associada ao POI

Name Type Description
name
  • string

Nome da marca

Classification

A classificação para o POI sendo devolvido

Name Type Description
code
  • string

Propriedade código

names

Conjunto de nomes

ClassificationName

Nome para a classificação

Name Type Description
name
  • string

Propriedade de nome

nameLocale
  • string

Nome Locale propriedade

DataSources

Secção opcional. Ids de referência para uso com a API do Polígono de Pesquisa .

Name Type Description
geometry

Informação sobre a forma geométrica do resultado. Só presente se o tipo == Geografia.

Entity

Fonte tipo de entidade da caixa de delimitação. Para a geocodagem inversa isto é sempre igual à posição.

Name Type Description
position
  • string

Entidade de posição

EntryPoint

O ponto de entrada para o POI ser devolvido.

Name Type Description
position

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

type

O tipo de ponto de entrada. O valor pode ser principal ou menor.

EntryPointType

O tipo de ponto de entrada. O valor pode ser principal ou menor.

Name Type Description
main
  • string
minor
  • string

ErrorAdditionalInfo

O erro de gestão de recursos informações adicionais.

Name Type Description
info
  • object

A informação adicional.

type
  • string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Type Description
additionalInfo

A informação adicional do erro.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O alvo do erro.

ErrorResponse

Resposta de erro

Name Type Description
error

O objeto de erro.

GeographicEntityType

Tipo de entidade de geografia. Presente apenas quando a entidadeType foi solicitada e está disponível.

Name Type Description
Country
  • string

Nome do país

CountrySecondarySubdivision
  • string

Concelho

CountrySubdivision
  • string

Distrito

CountryTertiarySubdivision
  • string

Área nomeada

Municipality
  • string

Cidade / Cidade

MunicipalitySubdivision
  • string

Sub / Super Cidade

Neighbourhood
  • string

Bairro

PostalCodeArea
  • string

Código Postal / Código Postal

Geometry

Informação sobre a forma geométrica do resultado. Só presente se o tipo == Geografia.

Name Type Description
id
  • string

Passe isto como geometriaId para a API do Polígono de Pesquisa para obter informações de geometria para este resultado.

LatLongPairAbbreviated

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

Name Type Description
lat
  • number

Propriedade latitude

lon
  • number

Propriedade longitude

MatchType

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

Name Type Description
AddressPoint
  • string
HouseNumberRange
  • string
Street
  • string

OperatingHours

Horário de funcionamento para um POI (Pontos de Interesse).

Name Type Description
mode
  • string

Valor utilizado no pedido: nenhum ou "nextSevenDays"

timeRanges

Lista de intervalos de tempo para os próximos 7 dias

OperatingHoursTime

Representa uma data e hora

Name Type 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 24 horas no horário local de um POI; valores possíveis são 0 - 23.

minute
  • integer

Os minutos são na hora local de um POI; valores possíveis são 0 - 59.

OperatingHoursTimeRange

Intervalo de tempo aberto para um dia

Name Type Description
endTime

O ponto nos próximos 7 dias varia quando um dado POI está a ser fechado, ou o início do intervalo se foi fechado antes do intervalo.

startTime

O ponto nos próximos 7 dias é quando um determinado POI está a ser aberto, ou o início do intervalo se foi aberto antes do intervalo.

PointOfInterest

Detalhes do POI devolvido, incluindo informações como o nome, telefone, endereço url e classificações.

Name Type Description
brands

Variedade de marcas. O nome da marca para o POI a ser devolvido.

categories
  • string[]

Matriz de categorias

categorySet

A lista das categorias de POI mais específicas

classifications

Matriz de classificação

name
  • string

Nome da propriedade POI

openingHours

Horário de funcionamento para um POI (Pontos de Interesse).

phone
  • string

Propriedade número de telefone

url
  • string

Propriedade URL do site

PointOfInterestCategorySet

Categoria POI

Name Type Description
id
  • integer

ID de categoria

QueryType

O tipo de consulta que está a ser devolvida: NEARBY ou NON_NEAR.

Name Type Description
NEARBY
  • string

A busca foi realizada em torno de uma certa latitude e longitude com um raio definido

NON_NEAR
  • string

A pesquisa foi realizada globalmente, sem preconceitos a uma certa latitude e longitude, e nenhum raio definido

Response

O resultado da consulta. SearchAddressResponse se a consulta tiver sido concluída com sucesso, ErrorResponse de outra forma.

Name Type Description
error

O objeto de erro.

results

Uma lista de resultados da API de Pesquisa.

summary

Objeto sumário para uma resposta de API de pesquisa

ReverseSearchAddressBatchItem

Um item devolvido a partir do serviço de serviço reverso do endereço de busca.

Name Type Description
response

O resultado da consulta. SearchAddressReverseResponse se a consulta tiver sido concluída com sucesso, ErrorResponse de outra forma.

statusCode
  • integer

CÓDIGO DE ESTADO DE PEDIDO HTTP.

ReverseSearchAddressBatchProcessResult

Este objeto é devolvido de uma chamada de serviço de Serviço reverso do Endereço de Pesquisa bem sucedida.

Name Type Description
batchItems

Matriz contendo os resultados do lote.

summary

Resumo dos resultados do pedido de lote

SearchAddressResultItem

Objeto de resultado para uma resposta de API de pesquisa.

Name Type 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. Estão incluídas as coordenadas para as localizações de início e fim da gama de endereços.

dataSources

Secção opcional. Id de geometria de referência para uso com a API do Polígono de Pesquisa .

detourTime
  • integer

Tempo de desvio em segundos. Apenas devolvido para chamadas para a API da Rota de Pesquisa ao Longo da Rota.

dist
  • number

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

entityType

Tipo de entidade de geografia. Presente apenas quando a entidadeType foi solicitada e está disponível.

entryPoints

Matriz de Pontos de Entrada. Estes descrevem os tipos de entradas disponíveis no local. O tipo pode ser "principal" para entradas principais, como uma porta da frente, ou um lobby, e "menor", para portas laterais e traseiras.

id
  • string

Propriedade ID

info
  • string

Informação sobre a fonte original de dados do Resultado. Usado para pedidos de apoio.

matchType

Informação sobre o tipo de correspondência.

Um dos seguintes:

  • AddressPoint
  • HouseNumberRange
  • Rua
poi

Detalhes do POI devolvido, incluindo informações como o nome, telefone, endereço url e classificações.

position

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

score
  • number

O valor dentro de um resultado definido para indicar a pontuação relativa entre resultados. Pode usar isto para determinar que o resultado x é duas vezes mais provável de ser tão relevante quanto resultado y se o valor de x for 2x o valor de y. Os valores variam entre consultas e é apenas um valor relativo para um conjunto de resultados.

type

Um dos seguintes:

  • POI
  • Rua
  • Geografia
  • Endereço ponto
  • Intervalo de endereços
  • Rua Cross
viewport

O viewport que cobre o resultado representado pelas coordenadas superior esquerda e inferior direita do viewport.

SearchAddressResultType

Um dos seguintes:

  • POI
  • Rua
  • Geografia
  • Endereço ponto
  • Intervalo de endereços
  • Rua Cross
Name Type Description
Address Range
  • string
Cross Street
  • string
Geography
  • string
POI
  • string
Point Address
  • string
Street
  • string

SearchSummary

Objeto sumário para uma resposta de API de pesquisa.

Name Type Description
fuzzyLevel
  • integer

O nível máximo de peludas necessário para fornecer resultados.

geoBias

Indicação quando o motor de busca interno aplicou um viés geoespacial para melhorar o ranking dos resultados. Em alguns métodos, isto pode ser afetado pela definição dos parâmetros lat e lon sempre que disponíveis. Noutros casos, é puramente interno.

limit
  • integer

Número máximo de respostas que serão devolvidas

numResults
  • integer

Número de resultados na resposta.

offset
  • integer

A compensação inicial dos Resultados devolvidos dentro do conjunto de resultados completos.

query
  • string

O parâmetro de consulta que foi usado para produzir estes resultados de pesquisa.

queryTime
  • integer

Tempo gasto a resolver a consulta, em milissegundos.

queryType

O tipo de consulta que está a ser devolvida: NEARBY ou NON_NEAR.

totalResults
  • integer

O número total de resultados encontrados.

Summary

Resumo dos resultados do pedido de lote

Name Type Description
successfulRequests
  • integer

Número de pedidos bem sucedidos no lote

totalRequests
  • integer

Número total de pedidos no lote