Search - Post Search Address Batch

Serviço:: Maps

Versão da API:: 1.0

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

Enviar solicitação de lote síncrona

A API síncrona é recomendada para solicitações em lote leves. Quando o serviço recebe uma solicitação, ele responderá assim que os itens do lote forem calculados e não haverá possibilidade de recuperar os resultados posteriormente. A API síncrona retornará um erro de tempo limite (uma resposta 408) se a solicitação 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/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 atinja um tempo limite.
O número de itens de lote é limitado a 10.000 para esta API.

Quando você faz uma solicitação usando uma 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 da resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. As respostas assíncronas são armazenadas por 14 dias. O URL de redirecionamento retorna uma resposta 404 se usado após o período de expiração.

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

O Cliente envia uma solicitação de POST de Lote de Endereço de Pesquisa para o Azure Maps.

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

O servidor responderá com uma das seguintes opções:

HTTP 202 Accepted - A solicitação de lote foi aceita.

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

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

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

Corpo POST para solicitação de lote

Para enviar o endereço de pesquisa consultas, você usará uma solicitação de POST onde o corpo da solicitação conterá a matriz batchItems em formato json e o cabeçalho Content-Type será definido como application/json. Aqui está um corpo de solicitação de exemplo contendo 5 endereço de pesquisa consultas:

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

Um endereço de pesquisa consulta em um lote é apenas uma de URL parcial, sem o protocolo, a URL base, o caminho, a versão da api e a chave de assinatura. Ele pode aceitar qualquer um dos endereços de pesquisa de suportadosparâmetros de URI. Os valores de cadeia de caracteres no endereço de pesquisa consulta devem ser escapados corretamente (por exemplo, " caractere deve ser escapado com \ ) e também devem ser codificados corretamente por URL.

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

Baixar resultados de lote assíncronos

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

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

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

O cliente envia uma solicitação de GET usando o URL de download .
O servidor responderá com uma das seguintes opções:

HTTP 202 Accepted - A solicitação em lote foi aceita, mas ainda está sendo processada. Por favor, tente novamente dentro de algum tempo.

HTTP 200 OK - Solicitação em lote processada com sucesso. 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 de lote assíncrona, se o lote tiver terminado o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz batchItems 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 de lote. Cada item no batchItems contém statusCode e response campos. Cada response em batchItems é de um dos seguintes tipos:

SearchAddressResult - Se a consulta foi concluída com êxito.
Error - Se a consulta falhou. Neste caso, a resposta conterá um code e um message.

Aqui está um exemplo de resposta em lote com 2 bem-sucedidos e 1 resultado falhado:

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

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
format	path	True	JsonFormat	Formato desejado da resposta. Apenas `json` formato é suportado.
api-version	query	True	string	Número da versão da API do Azure Maps.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Indica a conta destinada a ser usada com o modelo de segurança Microsoft Entra ID. Essa ID exclusiva para a conta do Azure Maps pode ser obtida na API de Conta do plano de gerenciamento do Azure Maps. Para obter mais informações sobre como usar a segurança do Microsoft Entra ID no Azure Maps, consulte Gerenciar autenticação no Azure Maps.

Corpo do Pedido

Name	Tipo	Description
batchItems	BatchRequestItem[]	A lista de consultas a processar.

Respostas

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

Name

Tipo

Description

200 OK

SearchAddressBatchProcessResult

202 Accepted

Suportado apenas para solicitação assíncrona. Pedido aceite: O pedido foi aceite para processamento. Utilize o URL no cabeçalho da localização para repetir ou aceder aos resultados.

Cabeçalhos

Location: string

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. 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 APIs REST do Azure Maps.

Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.

Observação

Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento de do Maps.
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 ID do Microsoft Entra.
O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de de aplicativos cliente confidenciais para acessar APIs REST do Azure Maps para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(õ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 forma mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta do Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

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

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:: 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
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Código de estado:: 202

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

Definições

Name	Description
Address	O endereço do resultado.
AddressRanges	Descreve o intervalo de endereços em ambos os lados da rua para um resultado de pesquisa. As coordenadas para os locais de início e fim do intervalo de endereços estão incluídas.
BatchRequest	Esse tipo representa o corpo da solicitação para o serviço de lote.
BatchRequestItem	Objeto de solicitação de lote
BoundingBox	O visor que cobre o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.
BoundingBoxCompassNotation	A caixa delimitadora do local.
Brand	A marca associada ao POI
Classification	A classificação para o POI que está sendo devolvido
ClassificationName	Nome para a classificação
DataSources	Secção opcional. IDs de referência para uso com a API Obter Polígono de Pesquisa.
Entity	Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa isso é sempre igual à posição.
EntryPoint	O ponto de entrada para o POI que está sendo retornado.
EntryPointType	O tipo de ponto de entrada. O valor pode ser principal ou menor.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GeographicEntityType	Tipo de entidade geográfica. Presente somente quando entityType foi solicitado e está disponível.
Geometry	Informações sobre a forma geométrica do resultado. Presente apenas se o tipo == Geografia.
JsonFormat	Formato desejado da resposta. Apenas `json` formato é suportado.
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 reverso.
OperatingHours	Horário de funcionamento de um POI (Pontos de Interesse).
OperatingHoursTime	Representa uma data e hora
OperatingHoursTimeRange	Intervalo de tempo aberto por um dia
PointOfInterest	Detalhes do POI retornado, incluindo informações como nome, telefone, endereço url e classificações.
PointOfInterestCategorySet	Categoria POI
QueryType	O tipo de consulta que está sendo retornada: PERTO ou NON_NEAR. Importante: Esta propriedade está obsoleta e pode ser omitida da resposta.
Response	O resultado da consulta. SearchAddressResult se a consulta for concluída com êxito, ErrorResponse caso contrário.
SearchAddressBatchItem	Um item retornado da chamada de serviço do Lote de Endereço de Pesquisa.
SearchAddressBatchProcessResult	Este objeto é retornado de uma chamada de serviço de Lote de Endereço de Pesquisa bem-sucedida.
SearchAddressResultItem	Objeto de resultado para uma resposta da API de pesquisa.
SearchAddressResultType	Um dos seguintes: POI Rua Geografia Endereço do ponto Intervalo de endereços Rua Cross
SearchSummary	Objeto de resumo para uma resposta da API de pesquisa.
Summary	Resumo dos resultados do pedido de lote

Address

Object

O endereço do resultado.

Name	Tipo	Description
boundingBox	BoundingBoxCompassNotation	Define a caixa delimitadora para o local. Essa propriedade só é retornada pelas APIs reversas de endereço de pesquisa. Todas as outras APIs de pesquisa retornam a `viewport` propriedade do `SearchAddressResultItem` objeto.
buildingNumber	string	O número do edifício na rua. Importante: Esta propriedade foi preterida. Utilize `streetNumber` em substituição.
country	string	O nome do país/região.
countryCode	string	Um código alfabético de duas letras definido pela norma ISO 3166-1 Alpha-2 para representar um país/região e territórios dependentes.
countryCodeISO3	string	Um código alfabético de três letras definido pela norma ISO 3166-1 Alpha-3 para representar um país/região e territórios dependentes.
countrySecondarySubdivision	string	A divisão administrativa de segundo nível dentro de um país/região. Identifica uma subdivisão que está abaixo da subdivisão principal, como estado ou província, mas acima de unidades menores como municípios ou bairros. Exemplos incluem County nos Estados Unidos e District no Reino Unido.
countrySubdivision	string	A principal divisão administrativa dentro de um país, como um estado, província. É usado para representar a subdivisão de primeiro nível abaixo do nível nacional.
countrySubdivisionCode	string	`countrySubdivisionCode` prefixada por `countryCode` ( countryCode-countrySubdivisionCode ) e o hífen forma o código ISO 3166-2. Exemplos: TX para o Texas, SCT para a Escócia e ON para Ontário. Esta propriedade não está disponível na `Get Search Nearby` API E.`Get Search POI`
countrySubdivisionName	string	Representa o nome completo da divisão administrativa de primeiro nível (como estado, província ou região) dentro de um país ou região. Esta propriedade é incluída apenas quando o `countrySubdivision` valor é fornecido em forma abreviada. Atualmente apoiado para os Estados Unidos, Canadá e Reino Unido.
countryTertiarySubdivision	string	A divisão administrativa de terceiro nível dentro de um país/região. Proporciona uma granularidade ainda mais fina do que a subdivisão secundária (como condado ou distrito). Exemplos incluem municípios como uma cidade, vila, aldeia, município ou freguesia, e bairros uma área geográfica menor e informal dentro de um município, como Capitol Hill, Green Lake e Wallingford em Seattle.
crossStreet	string	O nome da rua que está sendo atravessada. Esta propriedade está disponível apenas na `Get Search Address Reverse Cross Street` API.
extendedPostalCode	string	Um código postal alargado refere-se a um formato de código postal que vai além do conjunto padrão de dígitos para proporcionar maior precisão de localização. É comumente usado em sistemas como o código U.S. ZIP+4 ou formatos estendidos semelhantes noutros países/regiões. A disponibilidade depende da região. Não está disponível na `Get Search Address Reverse Cross Street` API.
freeformAddress	string	Uma linha de endereço formatada de acordo com as regras de formatação do país/região de origem do 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 é usado para construir a propriedade `freeformAddress`. `localName` representa o município postal. Dependendo da localização, `localName` é o nome comumente conhecido de uma cidade ou vila. Para o nome comumente conhecido de uma cidade ou vila, use `localName` em vez de `municipality`.
municipality	string	Cidade Nota: `municipality` representa o município residencial. Dependendo da localização, o valor `municipality` pode diferir do nome comumente conhecido de uma cidade ou vila. Para o nome mais conhecido da cidade ou vila, sugere-se que o `localName` valor seja usado em vez do `municipality` valor.
municipalitySubdivision	string	Uma subdivisão dentro de um município. Representa uma unidade administrativa ou geográfica menor dentro de uma cidade, vila ou outra entidade municipal.
neighbourhood	string	Um Bairro é uma área geograficamente localizada dentro de uma cidade ou vila, com características distintas e interações sociais entre os habitantes.
postalCode	string	Uma série de números ou letras (ou ambos) adicionados a um endereço para ajudar a identificar uma área geográfica específica. Um código postal é a versão norte-americana de um código postal; outros países/regiões utilizam outros formatos como código postal, código postal e PLZ.
routeNumbers	string[]	Os códigos usados para identificar a rua de forma inequívoca. Disponível apenas para as APIs reversas de endereço de pesquisa.
street	string	O nome da rua. Importante: Esta propriedade foi preterida. Utilize `streetName` em substituição.
streetName	string	O nome da rua.
streetNameAndNumber	string	O nome e o número da rua. Disponível apenas para as APIs reversas de endereço de pesquisa.
streetNumber	string	O número do edifício na rua. Não está disponível na `Get Search Address Reverse Cross Street` API.

AddressRanges

Object

Descreve o intervalo de endereços em ambos os lados da rua para um resultado de pesquisa. As coordenadas para os locais de início e fim do intervalo de endereços estão incluídas.

Name	Tipo	Description
from	LatLongPairAbbreviated	Um local representado como uma 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 uma latitude e longitude usando nomes curtos 'lat' & 'lon'.

BatchRequest

Object

Esse tipo representa o corpo da solicitação para o serviço de lote.

Name	Tipo	Description
batchItems	BatchRequestItem[]	A lista de consultas a processar.

BatchRequestItem

Object

Objeto de solicitação de lote

Name	Tipo	Description
query	string	Este 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 literalmente para a API de pesquisa para processamento.

BoundingBox

Object

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

Name	Tipo	Description
btmRightPoint	LatLongPairAbbreviated	Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'.
topLeftPoint	LatLongPairAbbreviated	Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'.

BoundingBoxCompassNotation

Object

A caixa delimitadora do local.

Name	Tipo	Description
entity	Entity	Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa isso é sempre igual à posição.
northEast	string	latitude nordeste, coordenadas de longitude da caixa delimitadora como flutuadores separados por vírgulas
southWest	string	latitude sudoeste, coordenadas de longitude da caixa delimitadora como flutuadores separados por vírgulas

Brand

Object

A marca associada ao POI

Name	Tipo	Description
name	string	Nome da marca

Classification

Object

A classificação para o POI que está sendo devolvido

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

ClassificationName

Object

Nome para a classificação

Name	Tipo	Description
name	string	Propriedade Name
nameLocale	string	Propriedade Name Locale

DataSources

Object

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

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

Entity

Enumeração

Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa isso é sempre igual à posição.

Valor	Description
position	Entidade de posição

EntryPoint

Object

O ponto de entrada para o POI que está sendo retornado.

Name	Tipo	Description
position	LatLongPairAbbreviated	Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'.
type	EntryPointType	O tipo de ponto de entrada. O valor pode ser principal ou menor.

EntryPointType

Enumeração

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

Valor	Description
main
minor

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

GeographicEntityType

Enumeração

Tipo de entidade geográfica. Presente somente quando entityType foi solicitado e está disponível.

Valor	Description
Country	Nome do país/região
CountrySubdivision	Distrito
CountrySecondarySubdivision	Condado
CountryTertiarySubdivision	Área nomeada
Municipality	Cidade
MunicipalitySubdivision	Sub / Super Cidade
Neighbourhood	Bairro
PostalCodeArea	Código Postal / Código Postal

Geometry

Object

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

Name	Tipo	Description
id	string	Passe isso como geometryId para o Get Search Polygon API para buscar informações de geometria para esse resultado.

JsonFormat

Enumeração

Formato desejado da resposta. Apenas json formato é suportado.

Valor	Description
json	O formato de intercâmbio de dados de notação de objeto JavaScript

LatLongPairAbbreviated

Object

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

Name	Tipo	Description
lat	number (double)	Propriedade Latitude
lon	number (double)	Propriedade Longitude

MatchType

Enumeração

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

Valor	Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Object

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

Name	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

Object

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 no horário 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

Object

Intervalo de tempo aberto por um dia

Name	Tipo	Description
endTime	OperatingHoursTime	O ponto no próximo intervalo de 7 dias quando um determinado POI está sendo fechado, ou o início do intervalo se ele foi fechado antes do intervalo.
startTime	OperatingHoursTime	O ponto no intervalo de 7 dias seguintes quando um determinado POI está sendo aberto, ou o início do intervalo se ele foi aberto antes do intervalo.

PointOfInterest

Object

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

Name	Tipo	Description
brands	Brand[]	Matriz de marcas. O nome da marca para o POI sendo devolvido.
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 um POI (Pontos de Interesse).
phone	string	Propriedade do número de telefone
url	string	Propriedade URL do site

PointOfInterestCategorySet

Object

Categoria POI

Name	Tipo	Description
id	integer	ID da categoria

QueryType

Enumeração

O tipo de consulta que está sendo retornada: PERTO ou NON_NEAR.

Importante: Esta propriedade está obsoleta e pode ser omitida da resposta.

Valor	Description
NEARBY	A busca era realizada em torno de uma certa latitude e longitude com um raio definido.
NON_NEAR	A pesquisa foi realizada globalmente, sem polarização para uma determinada latitude e longitude, e sem raio definido

Response

Object

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

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

SearchAddressBatchItem

Object

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

Name	Tipo	Description
response	Response	O resultado da consulta. SearchAddressResult se a consulta for concluída com êxito, ErrorResponse caso contrário.
statusCode	integer	Código de status da solicitação HTTP.

SearchAddressBatchProcessResult

Object

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

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

SearchAddressResultItem

Object

Objeto de resultado para uma resposta da API de 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 um resultado de pesquisa. As coordenadas para os locais de início e fim do intervalo de endereços estão incluídas.
dataSources	DataSources	Secção opcional. ID de geometria de referência para uso com a API Obter Polígono de Pesquisa.
detourTime	integer	Tempo de desvio em segundos. Retornado somente para chamadas para a API Pesquisar ao longo da rota.
dist	number (double)	Distância em linha reta entre o resultado e a localização geográfica em metros.
entityType	GeographicEntityType	Tipo de entidade geográfica. Presente somente quando entityType foi solicitado 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 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 dos seguintes: Ponto de endereço CasaNúmeroGama Rua
poi	PointOfInterest	Detalhes do POI retornado, incluindo informações como nome, telefone, endereço url e classificações.
position	LatLongPairAbbreviated	Um local representado como uma latitude e longitude usando nomes curtos 'lat' & 'lon'.
score	number (double)	O valor dentro de um conjunto de resultados para indicar a pontuação correspondente relativa entre os resultados. Você pode usar isso para determinar que o resultado x tem duas vezes mais probabilidade 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 apenas um valor relativo para um conjunto de resultados. Importante: Esta propriedade está obsoleta e pode ser omitida da resposta.
type	SearchAddressResultType	Um dos seguintes: POI Rua Geografia Endereço do ponto Intervalo de endereços Rua Cross
viewport	BoundingBox	O visor que cobre o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.

SearchAddressResultType

Enumeração

Um dos seguintes:

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

Valor	Description
POI
Street
Geography
Point Address
Address Range
Cross Street

SearchSummary

Object

Objeto de resumo para uma resposta da API de pesquisa.

Name	Tipo	Description
fuzzyLevel	integer	O nível máximo difuso necessário para fornecer Resultados.
geoBias	LatLongPairAbbreviated	Indicação de quando o motor de busca interno aplicou um viés geoespacial para melhorar a classificação dos resultados. Em alguns métodos, isso pode ser afetado pela definição dos parâmetros lat e lon, quando disponíveis. Noutros casos, é puramente interna.
limit	integer	Número máximo de respostas que serão devolvidas
numResults	integer	Número de resultados na resposta.
offset	integer	O deslocamento inicial dos Resultados retornados dentro do conjunto completo de Resultados.
query	string	O parâmetro de consulta que foi usado para produzir esses resultados de pesquisa.
queryTime	integer	Tempo gasto na resolução da consulta, em milissegundos.
queryType	QueryType	O tipo de consulta que está sendo retornada: PERTO ou NON_NEAR. Importante: Esta propriedade está obsoleta e pode ser omitida da resposta.
totalResults	integer	O número total de Resultados encontrados.

Summary

Object

Resumo dos resultados do pedido de lote

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

Partilhar via

Search - Post Search Address Batch

Enviar solicitação de lote síncrona

Enviar solicitação de lote assíncrona

Corpo POST para solicitação de lote

Baixar resultados de lote assíncronos

Modelo de resposta em lote

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

AADToken

Âmbitos

subscription-key

SAS Token

Exemplos

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

Pedido de amostra

Resposta da amostra

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

SearchAddressBatchItem

SearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary