Search - Get Search Address Batch

Referência

Service:: Maps

API Version:: 1.0

Utilize para enviar um lote de consultas para a API de Endereço Pesquisa num único pedido assíncrono.
A Get Search Address Batch API é um pedido HTTP GET que envia lotes de consultas para Pesquisa API de Endereço numa única chamada de API assíncrona. Pode chamar Pesquisa API do Batch de Endereços para executar de forma assíncrona (assíncrona) ou síncrona (sincronização). A API assíncrona permite que o autor da chamada crie um lote de até 10 000 consultas e sincronize a API até 100 consultas.

Submeter Pedido do Batch Síncrono

A API Síncrona é recomendada para pedidos em lote simples. Quando o serviço recebe um pedido, responderá assim que os itens do lote forem calculados e não haverá possibilidade de obter os resultados mais tarde. A API Síncrona devolverá um erro de tempo limite (uma resposta 408) se o pedido demorar mais de 60 segundos. O número de itens de lote está limitado a 100 para esta API.

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

Submeter Pedido do Batch Assíncrono

A API Assíncrona é adequada para processar grandes volumes de pedidos de pesquisa relativamente complexos

Permite a obtenção de resultados numa chamada separada (são possíveis várias transferências).
A API assíncrona está otimizada para fiabilidade e não se espera que se deparar com um tempo limite.
O número de itens de lote está limitado a 10 000 para esta API.

Quando faz um pedido com um pedido assíncrono, por predefiniçã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 as informações de erro estejam disponíveis. As respostas assíncronas são armazenadas durante 14 dias. O URL de redirecionamento devolve uma resposta 404 se for utilizado após o período de expiração.

Tenha em atenção que o pedido de lote assíncrono é uma operação de execução prolongada. Eis uma sequência típica de operações:

O cliente envia um pedido do Batch POST de Endereços Pesquisa para Azure Maps.

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

O servidor responderá com um dos seguintes:

HTTP 202 Accepted – O pedido do Batch foi aceite.

HTTP Error – Ocorreu um erro ao processar o pedido do Batch. Isto pode ser um 400 Bad Request ou qualquer outro Error código de estado.
Se o pedido em lote tiver sido aceite com êxito, o Location cabeçalho na resposta contém o URL para transferir os resultados do pedido em lote. Este URI de estado tem o seguinte aspeto:

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

O cliente emite um GET pedido no URL de transferência obtido no Passo 3 para transferir os resultados do lote.

POST Body for Batch Request

Para enviar as consultas de endereços de pesquisa , irá utilizar um POST pedido em que o corpo do pedido irá conter a batchItems matriz no json formato e o Content-Type cabeçalho será definido como application/json. Eis um corpo de pedido de exemplo que contém 5 consultas de endereços de pesquisa :

{
    "batchItems": [
        {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"},
        {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"},
        {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"},
        {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"},
        {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"}
    ]
}

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

A API assíncrona permite que o autor da chamada crie um lote de até 10 000 consultas e sincronize a API até 100 consultas e o lote deve conter, pelo menos, 1 consulta.

Transferir Resultados do Batch Assíncronos

Para transferir os resultados do lote assíncrono, emitirá um GET pedido para o ponto final de transferência do lote. Este URL de transferência pode ser obtido a Location partir do cabeçalho de um pedido em lote com êxito POST e tem o seguinte aspeto:

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

Eis a sequência típica de operações para transferir os resultados do lote:

O cliente envia um GET pedido com o URL de transferência.
O servidor responderá com um dos seguintes:

HTTP 202 Accepted – O pedido do Batch foi aceite, mas ainda está a ser processado. Tente novamente dentro de algum tempo.

HTTP 200 OK – Pedido do Batch processado com êxito. O corpo da resposta contém todos os resultados do lote.

Modelo de Resposta do Batch

O conteúdo de dados devolvido é semelhante para pedidos de sincronização e assíncrono. Ao transferir os resultados de um pedido em lote assíncrono, se o lote tiver terminado o processamento, o corpo da resposta contém a resposta do lote. Esta resposta em lote contém um summary componente que indica o totalRequests que fazia parte do pedido de lote original e successfulRequests, por exemplo, consultas que foram executadas com êxito. A resposta do batch também inclui uma batchItems matriz que contém uma resposta para cada consulta no pedido batch. O batchItems irá conter os resultados na mesma ordem em que as consultas originais foram enviadas no pedido de lote. Cada item no batchItems contém statusCode e response campos. Cada response um em batchItems é de um dos seguintes tipos:

SearchAddressResult - Se a consulta tiver sido concluída com êxito.
Error - Se a consulta tiver falhado. A resposta irá conter um code e um message neste caso.

Eis um exemplo de Resposta do Batch com 2 resultados com êxito e 1 com falha :

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "one microsoft way redmond wa 98052"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.63989,
                            "lon": -122.12509
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "pike pl seattle wa 98101"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.60963,
                            "lon": -122.34215
                        }
                    }
                ]
            }
        },
        {
            "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/batch/{format}?api-version=1.0

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
format	path	True	string	ID do Batch para consultar a operação.
api-version	query	True	string	Número da versão da API Azure Maps.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps consulte os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	SearchAddressBatchProcessResult	OK
202 Accepted		Suportado apenas para pedido assíncrono. Pedido Aceite: o pedido foi aceite para processamento. Utilize o URL no Cabeçalho da Localização para repetir ou aceder aos resultados. Headers Location: string
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Name

Tipo

Description

200 OK

SearchAddressBatchProcessResult

202 Accepted

Suportado apenas para pedido assíncrono. Pedido Aceite: o pedido foi aceite para processamento. Utilize o URL no Cabeçalho da Localização para repetir ou aceder aos resultados.

Headers

Location: string

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

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 Azure Maps. Os controlos de acesso baseados em funções do 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 APIs REST.

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 Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps .
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 de 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 de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
A utilização do SDK Web 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 plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

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 é aprovisionada quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST 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 Listar SAS no recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou 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.

Type: apiKey
In: header

Exemplos

An Address Geocoding Batch API GET call containing 5 Address Geocoding API queries

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "400 broad st seattle wa 98109",
          "queryType": "NON_NEAR",
          "queryTime": 127,
          "numResults": 3,
          "offset": 0,
          "totalResults": 9,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/20843845",
            "score": 11.966,
            "address": {
              "streetNumber": "400",
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "400 Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62039,
              "lon": -122.34928
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62129,
                "lon": -122.35061
              },
              "btmRightPoint": {
                "lat": 47.61949,
                "lon": -122.34795
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.61982,
                  "lon": -122.34886
                }
              }
            ]
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388442",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "extendedPostalCode": "981094612",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62001,
              "lon": -122.34843
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61965,
                "lon": -122.34761
              },
              "btmRightPoint": {
                "lat": 47.62066,
                "lon": -122.349
              }
            }
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388680",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, Belltown",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109,98121",
              "extendedPostalCode": "981094991,981211117,981211237,981213206",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61691,
              "lon": -122.35251
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61502,
                "lon": -122.35041
              },
              "btmRightPoint": {
                "lat": 47.61857,
                "lon": -122.35484
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "one microsoft way redmond wa 98052",
          "queryType": "NON_NEAR",
          "queryTime": 169,
          "numResults": 2,
          "offset": 0,
          "totalResults": 3292,
          "fuzzyLevel": 2
        },
        "results": [
          {
            "type": "Street",
            "id": "US/STR/p0/1692663",
            "score": 10.225,
            "address": {
              "streetName": "Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526399,980528300",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63989,
              "lon": -122.12509
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63748,
                "lon": -122.12309
              },
              "btmRightPoint": {
                "lat": 47.64223,
                "lon": -122.13061
              }
            }
          },
          {
            "type": "Cross Street",
            "id": "US/XSTR/p1/4779971",
            "score": 8.506,
            "address": {
              "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63962,
              "lon": -122.13061
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.64052,
                "lon": -122.13194
              },
              "btmRightPoint": {
                "lat": 47.63872,
                "lon": -122.12928
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "350 5th ave new york ny 10118",
          "queryType": "NON_NEAR",
          "queryTime": 233,
          "numResults": 1,
          "offset": 0,
          "totalResults": 8032,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/48052000",
            "score": 14.334,
            "address": {
              "streetNumber": "350",
              "streetName": "5th Avenue",
              "municipalitySubdivision": "New York, Midtown South",
              "municipality": "New York, Manhattan",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivisionCode": "NY",
              "postalCode": "10118",
              "extendedPostalCode": "1011800",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "350 5th Avenue, NYC, NY 10118",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.74817,
              "lon": -73.985
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.74907,
                "lon": -73.98619
              },
              "btmRightPoint": {
                "lat": 40.74727,
                "lon": -73.98381
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.74808,
                  "lon": -73.98482
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Status code:: 202

Definições

Name	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 coordenadas para as localizações de início e de fim do intervalo de endereços.
BoundingBox	A janela viewport que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita da janela viewport.
BoundingBoxCompassNotation	A caixa delimitadora da localização.
Brand	A marca associada ao POI
Classification	A classificação do POI que está a ser devolvido
ClassificationName	Nome da classificação
DataSources	Secção opcional. IDs de referência para utilização com a API Get Pesquisa Polygon.
Entity	Origem do tipo de entidade da caixa delimitadora. Para a geocodificação inversa, esta opção é sempre igual à posição.
EntryPoint	O ponto de entrada para o POI que está a ser devolvido.
EntryPointType	O tipo de ponto de entrada. O valor pode ser principal ou menor.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
GeographicEntityType	Tipo de entidade geografia. Presente apenas quando entityType foi pedido e está disponível.
Geometry	Informações sobre a forma geométrica do resultado. Presente apenas se o tipo == Geografia.
LatLongPairAbbreviated	Uma localização representada como uma latitude e longitude com nomes curtos "lat" & "lon".
MatchType	Tipos de correspondência para uma operação de pesquisa de endereço inverso.
OperatingHours	Horário de abertura de um POI (Pontos de Interesse).
OperatingHoursTime	Representa uma data e hora
OperatingHoursTimeRange	Intervalo de tempo de abertura de um dia
PointOfInterest	Detalhes do POI devolvido, incluindo informações como o nome, telefone, endereço de 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. ProcureAddressResult se a consulta tiver sido concluída com êxito, caso contrário, ErrorResponse.
SearchAddressBatchItem	Um item devolvido a partir da chamada de serviço do Batch de Endereço Pesquisa.
SearchAddressBatchProcessResult	Este objeto é devolvido de uma chamada de serviço batch de endereços Pesquisa com êxito.
SearchAddressResultItem	Objeto de resultado para uma resposta da API Pesquisa.
SearchAddressResultType	Um dos seguintes: POI Rua Geografia Endereço do Ponto Intervalo de Endereços Cross Street
SearchSummary	Objeto de resumo de uma resposta da API Pesquisa.
Summary	Resumo dos resultados do pedido em lote

Address

O endereço do resultado

Name	Tipo	Description
boundingBox	BoundingBoxCompassNotation	A caixa delimitadora da localização.
buildingNumber	string	O número do prédio na rua. PRETERIDO, utilize streetNumber como alternativa.
country	string	nome do país/região
countryCode	string	País (Nota: 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	Concelho
countrySubdivision	string	Distrito
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 a Escócia e ON para Ontário.
countrySubdivisionName	string	O nome completo de um primeiro nível da hierarquia administrativa do país/região. Este campo só é apresentado no caso de countrySubdivision ser apresentado num formulário abreviado. Apenas suportado para os EUA, Canadá e Reino Unido.
countryTertiarySubdivision	string	Área Nomeada
crossStreet	string	O nome da rua a ser 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/região de origem de um Resultado ou, no caso de um país/região, o nome completo do 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. Este campo é utilizado para criar a `freeformAddress` propriedade. `localName` representa o município postal. Consoante a localização, `localName` é o nome mais conhecido de uma cidade ou cidade. Para o nome mais conhecido de uma cidade ou cidade, utilize `localName` em vez de `municipality`.
municipality	string	Cidade/Cidade Nota: `municipality` representa o município residencial. Consoante a localização, o `municipality` valor pode diferir do nome mais conhecido de uma cidade ou cidade. Para o nome mais conhecido da cidade ou cidade, sugere-se que o `localName` valor seja utilizado em vez do `municipality` valor.
municipalitySubdivision	string	Sub/Super City
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	Código Postal/Código Postal
routeNumbers	string[]	Os códigos utilizados para identificar inequívocamente a rua
street	string	O nome da rua. PRETERIDO, utilize streetName como alternativa.
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 coordenadas para as localizações de início e de fim do intervalo de endereços.

Name	Tipo	Description
from	LatLongPairAbbreviated	Uma localização representada como uma latitude e longitude com 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	Uma localização representada como uma latitude e longitude com nomes curtos "lat" & "lon".

BoundingBox

A janela viewport que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita da janela viewport.

Name	Tipo	Description
btmRightPoint	LatLongPairAbbreviated	Uma localização representada como uma latitude e longitude com nomes curtos "lat" & "lon".
topLeftPoint	LatLongPairAbbreviated	Uma localização representada como uma latitude e longitude com nomes curtos "lat" & "lon".

BoundingBoxCompassNotation

A caixa delimitadora da localização.

Name	Tipo	Description
entity	Entity	Origem do tipo de entidade da caixa delimitadora. Para a geocodificação inversa, esta opção é sempre igual à posição.
northEast	string	Latitude nordeste, coordenada de longitude da caixa delimitadora como flutuantes separados por vírgulas
southWest	string	Latitude sudoeste, coordenada de longitude da caixa delimitadora como flutuantes separados por vírgulas

Brand

A marca associada ao POI

Name	Tipo	Description
name	string	Nome da marca

Classification

A classificação do POI que está a ser devolvido

Name	Tipo	Description
code	string	Propriedade do código
names	ClassificationName[]	Matriz de nomes

ClassificationName

Nome da classificação

Name	Tipo	Description
name	string	Propriedade Nome
nameLocale	string	Propriedade Região do Nome

DataSources

Secção opcional. IDs de referência para utilização com a API Get Pesquisa Polygon.

Name	Tipo	Description
geometry	Geometry	Informações sobre a forma geométrica do resultado. Presente apenas se o tipo == Geografia.

Entity

Origem do tipo de entidade da caixa delimitadora. Para a geocodificação inversa, esta opção é sempre igual à posição.

Name	Tipo	Description
position	string	Entidade de posição

EntryPoint

O ponto de entrada para o POI que está a ser devolvido.

Name	Tipo	Description
position	LatLongPairAbbreviated	Uma localização representada como uma latitude e longitude com nomes curtos "lat" & "lon".
type	EntryPointType	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	Tipo	Description
main	string
minor	string

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.

GeographicEntityType

Tipo de entidade geografia. Presente apenas quando entityType foi pedido e está disponível.

Name	Tipo	Description
Country	string	nome do país/região
CountrySecondarySubdivision	string	Concelho
CountrySubdivision	string	Distrito
CountryTertiarySubdivision	string	Área Nomeada
Municipality	string	Cidade/Cidade
MunicipalitySubdivision	string	Sub/Super City
Neighbourhood	string	Bairro
PostalCodeArea	string	Código Postal/Código Postal

Geometry

Informações sobre a forma geométrica do resultado. Presente apenas se o tipo == Geografia.

Name	Tipo	Description
id	string	Transmita-o como geometryId à API Get Pesquisa Polygon para obter informações de geometria para este resultado.

LatLongPairAbbreviated

Uma localização representada como uma latitude e longitude com nomes curtos "lat" & "lon".

Name	Tipo	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	Tipo	Description
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

Horário de abertura de um POI (Pontos de Interesse).

Name	Tipo	Description
mode	string	Valor utilizado no pedido: nenhum ou "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Lista de intervalos de tempo para os próximos 7 dias

OperatingHoursTime

Representa uma data e hora

Name	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 um POI; os valores possíveis são 0 - 23.
minute	integer	Os minutos estão na hora local de um POI; os valores possíveis são 0 - 59.

OperatingHoursTimeRange

Intervalo de tempo de abertura de um dia

Name	Tipo	Description
endTime	OperatingHoursTime	O ponto no intervalo de 7 dias seguintes quando um determinado POI está a ser fechado ou o início do intervalo se tiver sido fechado antes do intervalo.
startTime	OperatingHoursTime	O ponto no intervalo de 7 dias seguintes quando um determinado POI está a ser aberto ou o início do intervalo, se tiver sido aberto antes do intervalo.

PointOfInterest

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

Name	Tipo	Description
brands	Brand[]	Matriz de marcas. O nome da marca para o POI que está a ser devolvido.
categories	string[]	Matriz de categorias
categorySet	PointOfInterestCategorySet[]	A lista das categorias POI mais específicas
classifications	Classification[]	Matriz de classificação
name	string	Nome da propriedade POI
openingHours	OperatingHours	Horário de abertura de um POI (Pontos de Interesse).
phone	string	Propriedade do número de telefone
url	string	Propriedade URL do Site

PointOfInterestCategorySet

Categoria POI

Name	Tipo	Description
id	integer	ID da Categoria

QueryType

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

Name	Tipo	Description
NEARBY	string	Pesquisa foi realizada em torno de uma determinada latitude e longitude com um raio definido
NON_NEAR	string	Pesquisa foi realizada globalmente, sem desvios para uma determinada latitude e longitude, e nenhum raio definido

Response

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

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

SearchAddressBatchItem

Um item devolvido a partir da chamada de serviço do Batch de Endereço Pesquisa.

Name	Tipo	Description
response	Response	O resultado da consulta. ProcureAddressResult se a consulta tiver sido concluída com êxito, caso contrário, ErrorResponse.
statusCode	integer	Código de estado do pedido HTTP.

SearchAddressBatchProcessResult

Este objeto é devolvido de uma chamada de serviço batch de endereços Pesquisa com êxito.

Name	Tipo	Description
batchItems	SearchAddressBatchItem[]	Matriz que contém os resultados do lote.
summary	Summary	Resumo dos resultados do pedido em lote

SearchAddressResultItem

Objeto de resultado para uma resposta da API Pesquisa.

Name	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. Estão incluídas coordenadas para as localizações de início e de fim do intervalo de endereços.
dataSources	DataSources	Secção opcional. ID de geometria de referência para utilização com a API Get Pesquisa Polygon.
detourTime	integer	Desvio de tempo em segundos. Apenas devolvidas para chamadas para a API de Pesquisa Ao Longo da Rota.
dist	number	Distância da linha reta entre o resultado e a localização geobias em metros.
entityType	GeographicEntityType	Tipo de entidade geografia. Presente apenas quando entityType foi pedido e está disponível.
entryPoints	EntryPoint[]	Matriz de EntryPoints. 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 átrio, e "menor", para portas laterais e traseiras.
id	string	Propriedade ID
info	string	Informações sobre a origem de dados original do Resultado. Utilizado para pedidos de suporte.
matchType	MatchType	Informações sobre o tipo de correspondência. Um dos seguintes: AddressPoint HouseNumberRange Rua
poi	PointOfInterest	Detalhes do POI devolvido, incluindo informações como o nome, telefone, endereço de URL e classificações.
position	LatLongPairAbbreviated	Uma localização representada como uma latitude e longitude com nomes curtos "lat" & "lon".
score	number	O valor dentro de um conjunto de resultados para indicar a pontuação correspondente relativa entre os resultados. Pode utilizá-lo para determinar que o resultado x tem o dobro da probabilidade de ser tão relevante como o resultado y se o valor de x for 2x o valor de y. Os valores variam entre consultas e destinam-se apenas a um valor relativo para um conjunto de resultados.
type	SearchAddressResultType	Um dos seguintes: POI Rua Geografia Endereço do Ponto Intervalo de Endereços Cross Street
viewport	BoundingBox	A janela viewport que abrange o resultado representado pelas coordenadas superior esquerda e inferior direita da janela viewport.

SearchAddressResultType

Um dos seguintes:

POI
Rua
Geografia
Endereço do Ponto
Intervalo de Endereços
Cross Street

Name	Tipo	Description
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchSummary

Objeto de resumo de uma resposta da API Pesquisa.

Name	Tipo	Description
fuzzyLevel	integer	O nível máximo difuso necessário para fornecer Resultados.
geoBias	LatLongPairAbbreviated	Indicação quando o motor de busca interno aplicou um desvio geoespacial para melhorar a classificação dos resultados. Em alguns métodos, isto pode ser afetado ao definir os parâmetros lat e lon quando 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	O desvio inicial dos Resultados devolvidos no conjunto de Resultados completo.
query	string	O parâmetro de consulta que foi utilizado para produzir estes resultados de pesquisa.
queryTime	integer	Tempo despendido na resolução da consulta, em milissegundos.
queryType	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 em lote

Name	Tipo	Description
successfulRequests	integer	Número de pedidos bem-sucedidos no lote
totalRequests	integer	Número total de pedidos no lote

Search - Get Search Address Batch

Submeter Pedido do Batch Síncrono

Submeter Pedido do Batch Assíncrono

POST Body for Batch Request

Transferir Resultados do Batch Assíncronos

Modelo de Resposta do Batch

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

AADToken

Scopes

subscription-key

SAS Token

Exemplos

An Address Geocoding Batch API GET call containing 5 Address Geocoding API queries

Sample Request

Sample Response

Definições

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

Response

SearchAddressBatchItem

SearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary

Recursos adicionais