Search - Get Reverse Geocoding Batch

Se usa para enviar un lote de consultas a la API de geocodificación inversa en una sola solicitud.

La API de Get Reverse Geocoding Batch es una solicitud de POST HTTP que envía lotes de hasta 100 consultas a API de geocodificación inversa mediante una sola solicitud.

Enviar solicitud por lotes sincrónica

Se recomienda la API sincrónica para solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá tan pronto como se calculen los elementos por lotes y no habrá posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes se limita a 100 para esta API.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

Cuerpo POST para solicitud por lotes

Para enviar las consultas de de geocodificación inversa , usará una solicitud de donde el cuerpo de la solicitud contendrá la matriz de en formato y el encabezado se establecerá en . Este es un cuerpo de solicitud de ejemplo que contiene 2 geocodificación inversa consultas:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Un objeto geocodificación inversa batchItem puede aceptar cualquiera de los parámetros de geocodificación inversa admitidos URI.

El lote debe contener al menos 1 consulta de.

Modelo de respuesta por lotes

La respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequests es decir, las consultas que se ejecutaron correctamente. La respuesta por lotes también incluye una matriz de batchItems que contiene una respuesta para cada consulta y cada consulta de la solicitud por lotes. El batchItems contendrá los resultados en el mismo orden en que se enviaron las consultas originales en la solicitud por lotes. Cada elemento es de uno de los siguientes tipos:

• GeocodingResponse: si la consulta se completó correctamente.

• Error: si se produjo un error en la consulta. La respuesta contendrá un code y un message en este caso.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2025-01-01

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0. Cuando se empareja con acceso basado en rol de Azure control, se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

subscription-key

Se trata de una clave compartida que se aprovisiona al crear una recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.

Para las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de las API REST de Azure Maps donde esta clave se puede almacenar de forma segura.

Tipo: apiKey
En: header

SAS Token

Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2025-01-01

{
  "batchItems": [
    {
      "coordinates": [
        -122.138681,
        47.630358
      ],
      "resultTypes": [
        "Address",
        "PopulatedPlace"
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "coordinates": [
        47.630358,
        -122.138681
      ],
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "Medium",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "name": "Washington",
                  "shortName": "WA"
                },
                {
                  "name": "King County",
                  "shortName": "King Co."
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "2267 152nd Ave NE, Redmond, Washington 98052, United States",
              "streetName": "152nd Ave NE",
              "streetNumber": "2267",
              "addressLine": "2267 152nd Ave NE"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.128275,
                    47.639429
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.127028,
                    47.638545
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.128275,
              47.639429
            ]
          },
          "bbox": [
            -122.1359181505759,
            47.63556628242932,
            -122.1206318494241,
            47.643291717570676
          ]
        }
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "error": {
        "code": "Bad Request",
        "message": "The provided coordinates (-122.138681,47.630358) in coordinates field are invalid or out of range"
      },
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

Definiciones

Address

Dirección del resultado

AdminDistricts

Nombre de subdivisión en el país o región de una dirección. Este elemento normalmente se trata como la subdivisión administrativa de primer orden, pero en algunos casos también contiene la segunda, tercera o cuarta subdivisión de orden en un país, dependencia o región.

CalculationMethodEnum

Método que se usó para calcular el punto de código geográfico.

ConfidenceEnum

Nivel de confianza de que el resultado de la ubicación geocodificada es una coincidencia. Use este valor con el código de coincidencia para determinar para obtener información más completa sobre la coincidencia.

La confianza de una ubicación geocodificada se basa en muchos factores, incluida la importancia relativa de la ubicación geocodificada y la ubicación del usuario, si se especifica.

CountryRegion

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

FeatureCollectionEnum

El tipo de un objeto FeatureCollection debe ser FeatureCollection.

FeaturesItem

FeatureTypeEnum

El tipo de una característica debe ser Característica.

GeocodePoints

Colección de puntos de código geográfico que difieren en cómo se calcularon y su uso sugerido.

GeocodingBatchResponse

Este objeto se devuelve de una llamada correcta al servicio Batch de geocodificación.

GeocodingBatchResponseItem

GeoJsonPoint

Un tipo de geometría GeoJSON Point válido. Consulte RFC 7946 para obtener más información.

Intersection

Dirección del resultado.

MatchCodesEnum

Uno o varios valores de código coincidentes que representan el nivel de geocodificación para cada ubicación de la respuesta.

Por ejemplo, una ubicación con codificación geográfica con códigos de coincidencia de Good y Ambiguous significa que se encontró más de una ubicación de código geográfico para la información de ubicación y que el servicio de geocódigo no tenía la jerarquía de búsqueda para encontrar una coincidencia.

Del mismo modo, una ubicación codificada geográficamente con códigos de coincidencia de Ambiguous y UpHierarchy implica que no se encontró una ubicación de código geográfico que coincida con toda la información de ubicación proporcionada, por lo que el servicio de geocódigo tenía que buscar en la jerarquía superior y encontrar varias coincidencias en ese nivel. Un ejemplo de un Ambiguous y UpHierarchy resultado es cuando se proporciona información de dirección completa, pero el servicio de código geográfico no puede encontrar una coincidencia para la dirección postal y, en su lugar, devuelve información para más de un valor RoadBlock.

Los valores posibles son:

Good: la ubicación solo tiene una coincidencia o todas las coincidencias devueltas se consideran coincidencias seguras. Por ejemplo, una consulta de Nueva York devuelve varias coincidencias correctas.

Ambiguous: la ubicación es uno de un conjunto de posibles coincidencias. Por ejemplo, al consultar la dirección postal 128 Main St., la respuesta puede devolver dos ubicaciones para 128 North Main St. y 128 South Main St. porque no hay suficiente información para determinar qué opción elegir.

UpHierarchy: la ubicación representa un movimiento hacia arriba de la jerarquía geográfica. Esto ocurre cuando no se encontró una coincidencia para la solicitud de ubicación, por lo que se devuelve un resultado menos preciso. Por ejemplo, si no se encuentra una coincidencia para la dirección solicitada, se puede devolver un código de coincidencia de UpHierarchy con un tipo de entidad RoadBlock.

Properties

ResultTypeEnum

Especifique los tipos de entidad que desee en la respuesta. Solo se devolverán los tipos que especifique. Si el punto no se puede asignar a los tipos de entidad especificados, no se devuelve información de ubicación en la respuesta. El valor predeterminado es todas las entidades posibles. Lista separada por comas de tipos de entidad seleccionados de las siguientes opciones.

• Dirección
• Vecindario
• PopulatedPlace
• Código postal1
• AdminDivision1
• AdminDivision2
• País/Región

Estos tipos de entidad se ordenan de la entidad más específica a la entidad menos específica. Cuando se encuentran entidades de más de un tipo de entidad, solo se devuelve la entidad más específica. Por ejemplo, si especifica Address y AdminDistrict1 como tipos de entidad y entidades se encontraron para ambos tipos, solo se devuelve la información de la entidad Address en la respuesta.

ReverseGeocodingBatchRequestBody

Lista de consultas o solicitudes de geocodificación inversa que se van a procesar. La lista puede contener un máximo de 100 consultas y debe contener al menos 1 consulta.

ReverseGeocodingBatchRequestItem

Batch Query (objeto)

Summary

Resumen de la solicitud por lotes

UsageTypeEnum

El mejor uso para el punto de código geográfico. Cada punto de código geográfico se define como punto de Route, un punto de Display o ambos. Use Route puntos si va a crear una ruta a la ubicación. Use Display puntos si muestra la ubicación en un mapa. Por ejemplo, si la ubicación es un parque, un punto de Route puede especificar una entrada al parque donde puede entrar con un coche y un punto de Display puede ser un punto que especifique el centro del parque.