Search - Post Search Address Batch

Referência

Serviço:: Maps

Versão da API:: 1.0

Use para enviar um lote de consultas para a API de Endereço de Pesquisa em uma única solicitação assíncrona.
A API de Post Search Address Batch é uma solicitação HTTP POST que envia lotes de consultas para API endereço de pesquisa em uma única chamada à API síncrona. Você pode chamar a API do 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 lote 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 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 em lote é limitado a 100 para essa 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 é esperada para ser executada em um tempo limite.
O número de itens em lote é limitado a 10.000 para essa API.

Quando você faz uma solicitação usando 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 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 de POST do Lote de Endereços de Pesquisa para o Azure Mapas.

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 - A solicitação do Lote foi aceita.

HTTP Error - Houve um erro ao processar sua solicitação do Lote. Isso 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 é semelhante ao seguinte:

    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 na URL de download obtida na Etapa 3 para baixar os resultados do lote.

Corpo POST para solicitação em lote

Para enviar o endereço de pesquisa consultas, você usará uma solicitação POST em que o corpo da solicitação conterá a matriz de batchItems no formato json e o cabeçalho Content-Type será definido como application/json. Aqui está um corpo de solicitação de exemplo que contém 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 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ço de pesquisa com suporteparâmetros de URI. Os valores de cadeia de caracteres no endereço de pesquisa consulta devem ser escapados corretamente (por exemplo, " o 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 solicitação GET para o ponto de extremidade de download em lote. Este de URL de download pode ser obtido do cabeçalho Location de uma solicitação em lote de POST bem-sucedida e se parece com o seguinte:

https://atlas.microsoft.com/search/address/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 de GET usando a URL de download .
O servidor responderá com um dos seguintes:

HTTP 202 Accepted - A solicitação do 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 componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequestsou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de 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 em lote. Cada item em batchItems contém campos statusCode e response. Cada response em batchItems é de um dos seguintes tipos:

SearchAddressResult - 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 bem-sucedidos e 1 resultado 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."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/search/address/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 `json` formato.
api-version	query	True	string	Número de versão da API do Azure Mapas.

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 da ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança da ID do Microsoft Entra no Azure Mapas, consulte os artigos de 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	SearchAddressBatchProcessResult	OKEY
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. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Nome

Tipo

Description

200 OK

SearchAddressBatchProcessResult

OKEY

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.

Cabeçalhos

Location: string

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. 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 Mapas.

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 controlar o 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 Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.
O Authorization URL é específico para a instância de nuvem pública do Azure. 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 do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
O uso do SDK da Web do do 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 a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

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

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada quando você Criar uma conta do 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 mestra na conta em que elas são emitidas.

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

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das 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 expiração, taxa e região(s) 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 protegida 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 de mapa de 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

Solicitação de exemplo

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 de exemplo

Código de status:: 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 status:: 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 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 a POI que está sendo retornada.
EntryPointType	O tipo de ponto de entrada. O valor pode ser principal ou secundária.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe 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 == Geografia.
JsonFormat	Formato desejado da resposta. Há suporte apenas para `json` formato.
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 para 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, ErrorResponse caso contrário.
SearchAddressBatchItem	Um item retornado da chamada de serviço do Lote de Endereço de Pesquisa.
SearchAddressBatchProcessResult	Esse objeto é retornado de uma chamada de serviço do Lote de Endereço de Pesquisa bem-sucedida.
SearchAddressResultItem	Objeto de resultado para uma resposta da API de Pesquisa.
SearchAddressResultType	Um destes: POI Rua Geografia Endereço de ponto Intervalo de endereços Cruzamento
SearchSummary	Objeto resumo de uma resposta da API de Pesquisa.
Summary	Resumo dos resultados da solicitação em lote

Address

Objeto

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 em vez disso.
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 alfa-3 iso
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 uma hierarquia administrativa de primeiro nível de país/região. Esse campo é exibido somente no caso de countrySubdivision ser apresentado de forma abreviada. Só há suporte para EUA, Canadá e Reino Unido.
countryTertiarySubdivision	string	Área Nomeada
crossStreet	string	O nome da rua que está sendo atravessada.
extendedPostalCode	string	Código postal 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 de país/região completo.
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 criar a propriedade `freeformAddress`. `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 valor de `municipality` pode ser diferente do nome comumente conhecido de uma cidade ou cidade. Para o nome comumente conhecido da cidade ou cidade, sugere-se que o valor `localName` seja usado em vez do valor `municipality`.
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 os 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 em vez disso.
streetName	string	O nome da rua.
streetNameAndNumber	string	O nome e o número da rua.
streetNumber	string	O número do prédio na rua.

AddressRanges

Objeto

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

Objeto

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

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 verbatim para a API de pesquisa para processamento.

BoundingBox

Objeto

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

Objeto

A caixa delimitadora do local.

Nome	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, coordenada longitude da caixa delimitadora como floats separados por vírgulas
southWest	string	Latitude sudoeste, coordenada longitude da caixa delimitadora como floats separados por vírgulas

Brand

Objeto

A marca associada à POI

Nome	Tipo	Description
name	string	Nome da marca

Classification

Objeto

A classificação para a POI que está sendo retornada

Nome	Tipo	Description
code	string	Propriedade Code
names	ClassificationName[]	Matriz de nomes

ClassificationName

Objeto

Nome da classificação

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

DataSources

Objeto

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

Nome	Tipo	Description
geometry	Geometry	Informações sobre a forma geométrica do resultado. Presente somente 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

Objeto

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 principal ou secundária.

EntryPointType

Enumeração

O tipo de ponto de entrada. O valor pode ser principal ou secundária.

Valor	Description
main
minor

ErrorAdditionalInfo

Objeto

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

Objeto

O detalhe 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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

GeographicEntityType

Enumeração

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

Valor	Description
Country	nome do país/região
CountrySecondarySubdivision	Município
CountrySubdivision	Estado ou Província
CountryTertiarySubdivision	Área Nomeada
Municipality	Cidade/Cidade
MunicipalitySubdivision	Sub/Super City
Neighbourhood	Vizinhança
PostalCodeArea	Cep/Cep

Geometry

Objeto

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

Nome	Tipo	Description
id	string	Passe isso como geometryId para a API Obter Polígono de Pesquisa para buscar informações de geometria para esse resultado.

JsonFormat

Enumeração

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

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

LatLongPairAbbreviated

Objeto

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

Nome	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

Objeto

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

Nome	Tipo	Description
mode	string	Valor usado na solicitação: nenhum ou "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Lista de intervalos de tempo para os próximos 7 dias

OperatingHoursTime

Objeto

Representa uma data e hora

Nome	Tipo	Description
date	string	Representa a data do calendário atual no fuso horário da POI, por exemplo, "2019-02-07".
hour	integer	As horas estão no formato de 24 horas no horário 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

Objeto

Abrir intervalo de tempo por um dia

Nome	Tipo	Description
endTime	OperatingHoursTime	O ponto nos próximos 7 dias intervalo quando uma determinada POI está sendo fechada ou o início do intervalo se ele foi fechado antes do intervalo.
startTime	OperatingHoursTime	O ponto nos próximos 7 dias intervalo quando uma determinada POI está sendo aberta ou o início do intervalo se ele foi aberto antes do intervalo.

PointOfInterest

Objeto

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 para uma POI (Pontos de Interesse).
phone	string	Propriedade número de telefone
url	string	Propriedade URL do site

PointOfInterestCategorySet

Objeto

Categoria poi

Nome	Tipo	Description
id	integer	ID da categoria

QueryType

Enumeração

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

Valor	Description
NEARBY	A pesquisa foi realizada em torno de uma certa latitude e longitude com um raio definido
NON_NEAR	A pesquisa foi realizada globalmente, sem ser tendenciosa para uma determinada latitude e longitude, e nenhum raio definido

Response

Objeto

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

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

SearchAddressBatchItem

Objeto

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

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

SearchAddressBatchProcessResult

Objeto

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

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

SearchAddressResultItem

Objeto

Objeto de resultado para uma resposta da API de 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 polígono de pesquisa.
detourTime	integer	Tempo de desvio em segundos. Retornado apenas para chamadas para a API pesquisar ao longo da rota.
dist	number (double)	Distância de linha reta entre o resultado e a localização geográfica 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 "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 destes: AddressPoint HouseNumberRange Rua
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 (double)	O valor dentro de um conjunto de resultados para indicar a pontuação de correspondência relativa entre os resultados. Você pode usá-lo 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 Rua 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

Enumeração

Um destes:

POI
Rua
Geografia
Endereço de ponto
Intervalo de endereços
Cruzamento

Valor	Description
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchSummary

Objeto

Objeto resumo de uma resposta da API de 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 usado para produzir esses resultados da 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

Objeto

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

Escopos

subscription-key

SAS Token

Exemplos

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

Solicitação de exemplo

Resposta de exemplo

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

Recursos adicionais