Search - Post Search Address Reverse Batch

Referência

Service:: Maps

API Version:: 1.0

Use para enviar um lote de consultas para a API inversa de endereço Pesquisa em uma única solicitação assíncrona.

A Post Search Address Reverse Batch API é uma solicitação HTTP POST que envia lotes de consultas para Pesquisa API inversa de endereço em uma única chamada à API assíncrona. Você pode chamar Post Search Address Reverse Batch a API para ser executada de forma assíncrona (assíncrona) ou síncrona (sincronização). A API assíncrona permite que o chamador lote até 10.000 consultas e sincronize a API em até 100 consultas.

Enviar Solicitação de Lote Síncrona

A API síncrona é recomendada para solicitações em lotes leves. Quando o serviço receber uma solicitação, ele responderá assim que os itens do lote forem calculados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente. A API síncrona retornará um erro de tempo limite (uma resposta 408) se a solicitação levar mais de 60 segundos. O número de itens de lote é limitado a 100 para essa API.

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

Enviar Solicitação de Lote Assíncrona

A API assíncrona é apropriada para processar grandes volumes de solicitações de pesquisa relativamente complexas

Ele permite a recuperação de resultados em uma chamada separada (vários downloads são possíveis).
A API assíncrona é otimizada para confiabilidade e não se espera que haja um tempo limite.
O número de itens de lote é limitado a 10.000 para essa API.

Quando você faz uma solicitação usando a solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho de resposta. Essa URL deve ser verificada periodicamente até que os dados de resposta ou as informações de erro estejam disponíveis. As respostas assíncronas são armazenadas por 14 dias. A URL de redirecionamento retorna uma resposta 404 se usada após o período de expiração.

Observe que a solicitação de lote assíncrona é uma operação de execução prolongada. Aqui está uma sequência típica de operações:

O cliente envia uma solicitação do Lote POST Reverso de Endereço Pesquisa para Azure Mapas.

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

O servidor responderá com um dos seguintes:

HTTP 202 Accepted – A solicitação em lote foi aceita.

HTTP Error - Ocorreu um erro ao processar sua solicitação do Lote. Isso pode ser um 400 Bad Request ou qualquer outro Error código status.
Se a solicitação em lote foi aceita com êxito, o Location cabeçalho na resposta contém a URL para baixar os resultados da solicitação em lote. Esse URI de status é semelhante ao seguinte:

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

O cliente emite uma GET solicitação na URL de download obtida na Etapa 3 para baixar os resultados do lote.

Corpo POST para solicitação em lote

Para enviar as consultas inversas do endereço de pesquisa , você usará uma POST solicitação em que o corpo da solicitação conterá a batchItems matriz no json formato e o Content-Type cabeçalho será definido application/jsoncomo . Aqui está um corpo de solicitação de exemplo que contém cinco 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 em um lote é apenas uma URL parcial sem o protocolo, a URL base, o caminho, a api-version e a subscription-key. Ele pode aceitar qualquer um dos parâmetros de URIreverso de endereço de pesquisa com suporte. Os valores de cadeia de caracteres na consulta inversa do endereço de pesquisa devem ser escapados corretamente (por exemplo, " caractere deve ser escapado com \ ) e também deve ser codificado corretamente em URL.

A API assíncrona permite que o chamador lote até 10.000 consultas e sincronize a API até 100 consultas, e o lote deve conter pelo menos 1 consulta.

Baixar Resultados do Lote Assíncrono

Para baixar os resultados do lote assíncrono, você emitirá uma GET solicitação para o ponto de extremidade de download em lote. Essa URL de download pode ser obtida do Location cabeçalho de uma solicitação em lote bem-sucedida POST e tem a seguinte aparência:

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

Esta é a sequência típica de operações para baixar os resultados do lote:

O cliente envia uma solicitação GET usando a URL de download.
O servidor responderá com um dos seguintes:

HTTP 202 Accepted – A solicitação em lote foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

HTTP 200 OK – Solicitação em lote processada com êxito. O corpo da resposta contém todos os resultados do lote.

Modelo de resposta em lote

O conteúdo de dados retornado é semelhante para solicitações assíncronas e de sincronização. Ao baixar os resultados de uma solicitação em lote assíncrona, se o lote tiver concluído o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um summary componente que indica o totalRequests que fazia parte da solicitação em lote original e, por successfulRequestsexemplo, consultas que foram executadas com êxito. A resposta em lote também inclui uma batchItems matriz que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item em batchItems contém statusCode campos e response . Cada response um em batchItems é de um dos seguintes tipos:

SearchAddressReverseResponse - Se a consulta foi concluída com êxito.
Error - Se a consulta falhou. A resposta conterá um code e um message nesse caso.

Aqui está um exemplo de Resposta em Lote com 2 resultados bem-sucedidos e 1 com falha :

{
    "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."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
format	path	True	JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.
api-version	query	True	string	Número de versão da API de Mapas Azure.

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.

Corpo da solicitação

Nome	Tipo	Description
batchItems	BatchRequestItem[]	A lista de consultas a serem processadas.

Respostas

Nome	Tipo	Description
200 OK	ReverseSearchAddressBatchProcessResult	OK
202 Accepted		Com suporte apenas para solicitação assíncrona. Solicitação Aceita: a solicitação foi aceita para processamento. Use a URL no Cabeçalho de Localização para tentar novamente ou acessar os resultados. Headers Location: string
Other Status Codes	ErrorResponse	Erro inesperado.

Nome

Tipo

Description

200 OK

ReverseSearchAddressBatchProcessResult

202 Accepted

Com suporte apenas para solicitação assíncrona. Solicitação Aceita: a solicitação foi aceita para processamento. Use a URL no Cabeçalho de Localização para tentar novamente ou acessar os resultados.

Headers

Location: string

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.

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

Scopes

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.

Type: apiKey
In: 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.

Type: apiKey
In: header

Exemplos

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

Sample Request

HTTP

POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0

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

Sample Response

Status code:: 200

{
  "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",
              "countrySubdivisionCode": "Î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",
              "countrySubdivisionCode": "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",
              "countrySubdivisionCode": "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"
          }
        ]
      }
    }
  ]
}

Status code:: 202

Operation-Location: URL to download the results of the long-running batch request.

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.
BatchRequest	Esse tipo representa o corpo da solicitação para o serviço do Lote.
BatchRequestItem	Objeto de solicitação em lote
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.
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.
JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.
LatLongPairAbbreviated	Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.
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).
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.
Response	O resultado da consulta. SearchAddressResult se a consulta tiver sido concluída com êxito, caso contrário, ErrorResponse.
ReverseSearchAddressBatchItem	Um item retornado de Pesquisa chamada de serviço do Lote Reverso de Endereço.
ReverseSearchAddressBatchProcessResult	Esse objeto é retornado de uma chamada de serviço do Lote Reverso de Endereço Pesquisa bem-sucedida.
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
SearchSummary	Objeto summary para uma resposta da API Pesquisa.
Summary	Resumo dos resultados da solicitação em lote

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

BatchRequest

Esse tipo representa o corpo da solicitação para o serviço do Lote.

Nome	Tipo	Description
batchItems	BatchRequestItem[]	A lista de consultas a serem processadas.

BatchRequestItem

Objeto de solicitação em lote

Nome	Tipo	Description
query	string	Esse parâmetro contém uma cadeia de caracteres de consulta usada para executar uma operação de geocodificação não estruturada. A cadeia de caracteres de consulta será passada textualmente para a API de pesquisa para processamento.

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.

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.

JsonFormat

Formato desejado da resposta. Há suporte apenas para o formato json.

Nome	Tipo	Description
json	string	O formato de intercâmbio de dados de notação de objeto JavaScript

LatLongPairAbbreviated

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

Nome	Tipo	Description
lat	number	Propriedade Latitude
lon	number	Propriedade Longitude

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

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

Response

O resultado da consulta. SearchAddressResult se a consulta tiver sido concluída com êxito, caso contrário, ErrorResponse.

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.
results	SearchAddressResultItem[]	Uma lista de resultados da API Pesquisa.
summary	SearchSummary	Objeto summary para uma resposta da API Pesquisa

ReverseSearchAddressBatchItem

Um item retornado de Pesquisa chamada de serviço do Lote Reverso de Endereço.

Nome	Tipo	Description
response	Response	O resultado da consulta. SearchAddressReverseResponse se a consulta foi concluída com êxito, caso contrário, ErrorResponse.
statusCode	integer	Solicitação HTTP status código.

ReverseSearchAddressBatchProcessResult

Esse objeto é retornado de uma chamada de serviço do Lote Reverso de Endereço Pesquisa bem-sucedida.

Nome	Tipo	Description
batchItems	ReverseSearchAddressBatchItem[]	Matriz que contém os resultados do lote.
summary	Summary	Resumo dos resultados da solicitação em lote

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

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.

Summary

Resumo dos resultados da solicitação em lote

Nome	Tipo	Description
successfulRequests	integer	Número de solicitações bem-sucedidas no lote
totalRequests	integer	Número total de solicitações no lote

Compartilhar via

Search - Post Search Address Reverse Batch

Enviar Solicitação de Lote Síncrona

Enviar Solicitação de Lote Assíncrona

Corpo POST para solicitação em lote

Baixar Resultados do Lote Assíncrono

Modelo de resposta em lote

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

AADToken

Scopes

subscription-key

SAS Token

Exemplos

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

Sample Request

Sample Response

Definições

Address

AddressRanges

BatchRequest

BatchRequestItem

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

JsonFormat

LatLongPairAbbreviated

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

Response

ReverseSearchAddressBatchItem

ReverseSearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary

Recursos adicionais