Search - Post Search Address Batch

Referencia

Servicio:: Maps

Versión de la API:: 1.0

Use para enviar un lote de consultas a la API de dirección de Búsqueda en una única solicitud asincrónica.
La Post Search Address Batch API es una solicitud HTTP POST que envía lotes de consultas a Búsqueda ADDRESS API en una sola llamada API sincrónica. Puede llamar a Búsqueda API de Batch de direcciones para que se ejecute de forma asincrónica (asincrónica) o sincrónica (sincrónica). La API asincrónica permite al autor de la llamada procesar por lotes hasta 10 000 consultas y sincronizar una API de hasta 100 consultas.

Enviar solicitud por lotes sincrónica

Se recomienda la API sincrónica para las solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá en cuanto 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 está limitado a 100 para esta API.

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

Enviar solicitud por lotes asincrónica

La API asincrónica es adecuada para procesar grandes volúmenes de solicitudes de búsqueda relativamente complejas.

Permite la recuperación de resultados en una llamada independiente (se pueden realizar varias descargas).
La API asincrónica está optimizada para la confiabilidad y no se espera que se ejecute un tiempo de espera.
El número de elementos por lotes está limitado a 10 000 para esta API.

Cuando se realiza una solicitud mediante una solicitud asincrónica, el servicio devuelve de forma predeterminada un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL se debe comprobar periódicamente hasta que los datos de respuesta o la información de error estén disponibles. Las respuestas asincrónicas se almacenan durante 14 días. La dirección URL de redireccionamiento devuelve una respuesta 404 si se usa después del período de expiración.

Tenga en cuenta que la solicitud por lotes asincrónica es una operación de larga duración. Esta es una secuencia típica de operaciones:

El cliente envía una solicitud de batch POST de Búsqueda dirección a Azure Maps.

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

El servidor responderá con uno de los siguientes elementos:

HTTP 202 Accepted : se ha aceptado la solicitud por lotes.

HTTP Error : se produjo un error al procesar la solicitud de Batch. Puede ser un 400 Bad Request código de estado o cualquier otro Error .
Si la solicitud por lotes se aceptó correctamente, el Location encabezado de la respuesta contiene la dirección URL para descargar los resultados de la solicitud por lotes. Este URI de estado es similar al siguiente:

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

El cliente emite una GET solicitud en la dirección URL de descarga obtenida en el paso 3 para descargar los resultados por lotes.

Cuerpo POST para la solicitud por lotes

Para enviar las consultas de dirección de búsqueda, usará una POST solicitud en la que el cuerpo de la solicitud contendrá la batchItems matriz en formato y el Content-Type encabezado se establecerá application/jsonen json . Este es un cuerpo de solicitud de ejemplo que contiene 5 consultas de direcciones de búsqueda :

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

Una consulta de dirección de búsqueda en un lote es simplemente una dirección URL parcial sin el protocolo, la dirección URL base, la ruta de acceso, la versión de api y la clave de suscripción. Puede aceptar cualquiera de los parámetros de URI de dirección de búsqueda admitidos. Los valores de cadena de la consulta de dirección de búsqueda deben tener caracteres de escape correctos (por ejemplo, " el carácter debe tener caracteres de escape con \ ) y también deben estar correctamente codificados con una dirección URL.

La API asincrónica permite al autor de la llamada procesar por lotes hasta 10 000 consultas y sincronizar la API hasta 100 consultas, y el lote debe contener al menos 1 consulta.

Descargar resultados de lotes asincrónicos

Para descargar los resultados del lote asincrónico, emitirá una GET solicitud al punto de conexión de descarga por lotes. Esta dirección URL de descarga se puede obtener del Location encabezado de una solicitud por lotes correcta POST y tiene el siguiente aspecto:

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

Esta es la secuencia típica de operaciones para descargar los resultados por lotes:

El cliente envía una GET solicitud mediante la dirección URL de descarga.
El servidor responderá con uno de los siguientes elementos:

HTTP 202 Accepted : se aceptó la solicitud por lotes, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

HTTP 200 OK : solicitud por lotes procesada correctamente. El cuerpo de la respuesta contiene todos los resultados por lotes.

Modelo de respuesta por lotes

El contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un summary componente que indica que totalRequests formaron parte de la solicitud por lotes original y successfulRequestses decir, consultas que se ejecutaron correctamente. La respuesta por lotes también incluye una batchItems matriz que contiene una respuesta para cada consulta de la solicitud por lotes. batchItems contendrá los resultados en el mismo orden en que se enviaron las consultas originales en la solicitud por lotes. Cada elemento de batchItems contiene statusCode y response campos. Cada response elemento batchItems de es de uno de los siguientes tipos:

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

Esta es una respuesta por lotes de ejemplo con 2 resultados correctos y 1 con errores :

{
    "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 identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	JsonFormat	Formato deseado de la respuesta. Solo se admite el formato `json`.
api-version	query	True	string	Número de versión de la API de Azure Maps.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-id		string	Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Microsoft Entra ID. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar Microsoft Entra ID seguridad en Azure Maps consulte los siguientes artículos para obtener instrucciones.

Cuerpo de la solicitud

Nombre	Tipo	Description
batchItems	BatchRequestItem[]	Lista de consultas que se van a procesar.

Respuestas

Nombre	Tipo	Description
200 OK	SearchAddressBatchProcessResult	Aceptar
202 Accepted		Solo se admite para la solicitud asincrónica. Solicitud aceptada: la solicitud se ha aceptado para su procesamiento. Use la dirección URL en el encabezado de ubicación para reintentar o acceder a los resultados. Encabezados Location: string
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Nombre

Tipo

Description

200 OK

SearchAddressBatchProcessResult

Aceptar

202 Accepted

Solo se admite para la solicitud asincrónica. Solicitud aceptada: la solicitud se ha aceptado para su procesamiento. Use la dirección URL en el encabezado de ubicación para reintentar o acceder a los resultados.

Encabezados

Location: string

Other Status Codes

ErrorResponse

Se ha producido un error inesperado.

Seguridad

AADToken

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

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

Nota

Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps .
Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Microsoft Entra ID.
El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
Para obtener más información sobre Plataforma de identidad de Microsoft, consulte Plataforma de identidad de Microsoft información general.

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

Ámbitos

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

subscription-key

Se trata de una clave compartida que se aprovisiona al crear una cuenta de Azure Maps en el Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a Azure Maps API REST para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: query

SAS Token

Se trata de un token de firma de acceso compartido que se crea 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 está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de 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 controlen 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 la cuenta de mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 200

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

status code:: 202

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

Definiciones

Nombre	Description
Address	Dirección del resultado
AddressRanges	Describe el intervalo de direcciones en ambos lados de la calle para obtener un resultado de búsqueda. Se incluyen las coordenadas de las ubicaciones inicial y final del intervalo de direcciones.
BatchRequest	Este tipo representa el cuerpo de la solicitud para el servicio Batch.
BatchRequestItem	Objeto de solicitud de Batch
BoundingBox	Ventanilla que cubre el resultado representado por las coordenadas superior izquierda e inferior derecha de la ventanilla.
BoundingBoxCompassNotation	Cuadro de límite de la ubicación.
Brand	La marca asociada a la POI
Classification	Clasificación de la POI que se va a devolver
ClassificationName	Nombre de la clasificación
DataSources	Sección opcional. Identificadores de referencia para su uso con la API Get Búsqueda Polygon.
Entity	Origen del tipo de entidad del cuadro de límite. Para la geocodificación inversa, siempre es igual a la posición.
EntryPoint	Punto de entrada para la POI que se va a devolver.
EntryPointType	Tipo de punto de entrada. El valor puede ser principal o secundario.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GeographicEntityType	Tipo de entidad Geography. Solo se presenta cuando se solicitó entityType y está disponible.
Geometry	Información sobre la forma geométrica del resultado. Solo está presente si el tipo == Geography.
JsonFormat	Formato deseado de la respuesta. Solo se admite el formato `json`.
LatLongPairAbbreviated	Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".
MatchType	Tipos de coincidencia para una operación de búsqueda de direcciones inversas.
OperatingHours	Horario de apertura de un POI (Puntos de interés).
OperatingHoursTime	Representa una fecha y hora
OperatingHoursTimeRange	Intervalo de tiempo de apertura para un día
PointOfInterest	Detalles de la POI devuelta, incluida la información como el nombre, el teléfono, la dirección URL y las clasificaciones.
PointOfInterestCategorySet	Categoría poi
QueryType	Tipo de consulta que se devuelve: NEARBY o NON_NEAR.
Response	Resultado de la consulta. SearchAddressResult si la consulta se completó correctamente, ErrorResponse de lo contrario.
SearchAddressBatchItem	Un elemento devuelto desde Búsqueda llamada al servicio Batch de direcciones.
SearchAddressBatchProcessResult	Este objeto se devuelve de una llamada correcta al servicio Batch de direcciones Búsqueda.
SearchAddressResultItem	Objeto result para una respuesta de API de Búsqueda.
SearchAddressResultType	Uno de los valores siguientes: POI Calle Geography Dirección del punto Intervalo de direcciones Cruce
SearchSummary	Objeto summary para una respuesta de api de Búsqueda.
Summary	Resumen de los resultados de la solicitud por lotes

Address

Dirección del resultado

Nombre	Tipo	Description
boundingBox	BoundingBoxCompassNotation	Cuadro de límite de la ubicación.
buildingNumber	string	Número de edificio en la calle. EN DESUSO, use streetNumber en su lugar.
country	string	nombre de país o región
countryCode	string	País (Nota: Se trata de un código de dos letras, no un nombre de país o región).
countryCodeISO3	string	Código de país ISO alfa-3
countrySecondarySubdivision	string	County
countrySubdivision	string	Estado o provincia
countrySubdivisionCode	string	`countrySubdivisionCode` prefijo por `countryCode` ( countryCode-countrySubdivisionCode ) y el guión forma el código ISO 3166-2. Ejemplos: TX para Texas, SCT para Escocia y ON para Ontario.
countrySubdivisionName	string	Nombre completo de un primer nivel de jerarquía administrativa de país o región. Este campo solo aparece en caso de que countrySubdivision se presente en un formulario abreviado. Solo se admite para ESTADOS UNIDOS, Canadá y Reino Unido.
countryTertiarySubdivision	string	Área con nombre
crossStreet	string	Nombre de la calle que se cruza.
extendedPostalCode	string	Código postal extendido (la disponibilidad depende de la región).
freeformAddress	string	Una línea de dirección con formato según las reglas de formato del país o región de origen de un resultado, o en el caso de un país o región, su nombre completo de país o región.
localName	string	Componente de dirección que representa el nombre de un área geográfica o localidad que agrupa varios objetos direccionables con fines de direccionamiento, sin ser una unidad administrativa. Este campo se usa para compilar la `freeformAddress` propiedad . `localName` representa el municipio postal. Dependiendo de la ubicación, `localName` es el nombre comúnmente conocido de una ciudad o ciudad. Para el nombre conocido de una ciudad o ciudad, use `localName` en lugar de `municipality`.
municipality	string	Ciudad/Ciudad Nota: `municipality` representa el municipio residencial. Dependiendo de la ubicación, el `municipality` valor puede diferir del nombre conocido de una ciudad o ciudad. Para el nombre conocido de la ciudad o ciudad, se sugiere que el `localName` valor se use en lugar del `municipality` valor.
municipalitySubdivision	string	Sub/Super City
neighbourhood	string	Un barrio es una zona geográficamente localizada dentro de una ciudad o ciudad con características distintivas e interacciones sociales entre los habitantes.
postalCode	string	Código postal/código postal
routeNumbers	string[]	Códigos usados para identificar inequívocamente la calle
street	string	Nombre de la calle. EN DESUSO, use streetName en su lugar.
streetName	string	Nombre de la calle.
streetNameAndNumber	string	Nombre y número de la calle.
streetNumber	string	Número de edificio en la calle.

AddressRanges

Describe el intervalo de direcciones en ambos lados de la calle para obtener un resultado de búsqueda. Se incluyen las coordenadas de las ubicaciones inicial y final del intervalo de direcciones.

Nombre	Tipo	Description
from	LatLongPairAbbreviated	Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".
rangeLeft	string	Intervalo de direcciones en el lado izquierdo de la calle.
rangeRight	string	Intervalo de direcciones en el lado derecho de la calle.
to	LatLongPairAbbreviated	Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".

BatchRequest

Este tipo representa el cuerpo de la solicitud para el servicio Batch.

Nombre	Tipo	Description
batchItems	BatchRequestItem[]	Lista de consultas que se van a procesar.

BatchRequestItem

Objeto de solicitud de Batch

Nombre	Tipo	Description
query	string	Este parámetro contiene una cadena de consulta utilizada para realizar una operación de geocodificación no estructurada. La cadena de consulta se pasará textualmente a la API de búsqueda para su procesamiento.

BoundingBox

Ventanilla que cubre el resultado representado por las coordenadas superior izquierda e inferior derecha de la ventanilla.

Nombre	Tipo	Description
btmRightPoint	LatLongPairAbbreviated	Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".
topLeftPoint	LatLongPairAbbreviated	Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".

BoundingBoxCompassNotation

Cuadro de límite de la ubicación.

Nombre	Tipo	Description
entity	Entity	Origen del tipo de entidad del cuadro de límite. Para la geocodificación inversa, siempre es igual a la posición.
northEast	string	Latitud norte-este,coordenada de longitud del rectángulo delimitador como floats separados por comas
southWest	string	Latitud sur-oeste, coordenada de longitud del rectángulo delimitador como floats separados por comas

Brand

La marca asociada a la POI

Nombre	Tipo	Description
name	string	Nombre de la marca

Classification

Clasificación de la POI que se va a devolver

Nombre	Tipo	Description
code	string	Propiedad code
names	ClassificationName[]	Matriz de nombres

ClassificationName

Nombre de la clasificación

Nombre	Tipo	Description
name	string	Name (propiedad)
nameLocale	string	Name Locale (propiedad)

DataSources

Sección opcional. Identificadores de referencia para su uso con la API Get Búsqueda Polygon.

Nombre	Tipo	Description
geometry	Geometry	Información sobre la forma geométrica del resultado. Solo está presente si el tipo == Geography.

Entity

Origen del tipo de entidad del cuadro de límite. Para la geocodificación inversa, siempre es igual a la posición.

Nombre	Tipo	Description
position	string	Entidad Position

EntryPoint

Punto de entrada para la POI que se va a devolver.

Nombre	Tipo	Description
position	LatLongPairAbbreviated	Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".
type	EntryPointType	Tipo de punto de entrada. El valor puede ser principal o secundario.

EntryPointType

Tipo de punto de entrada. El valor puede ser principal o secundario.

Nombre	Tipo	Description
main	string
minor	string

ErrorAdditionalInfo

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

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GeographicEntityType

Tipo de entidad Geography. Solo se presenta cuando se solicitó entityType y está disponible.

Nombre	Tipo	Description
Country	string	nombre de país o región
CountrySecondarySubdivision	string	County
CountrySubdivision	string	Estado o provincia
CountryTertiarySubdivision	string	Área con nombre
Municipality	string	Ciudad/Ciudad
MunicipalitySubdivision	string	Sub/Super City
Neighbourhood	string	Barrio
PostalCodeArea	string	Código postal/código postal

Geometry

Información sobre la forma geométrica del resultado. Solo está presente si el tipo == Geography.

Nombre	Tipo	Description
id	string	Pase esto como geometryId a get Búsqueda Polygon API para capturar información de geometría para este resultado.

JsonFormat

Formato deseado de la respuesta. Solo se admite el formato json.

Nombre	Tipo	Description
json	string	Formato de intercambio de datos de notación de objetos JavaScript

LatLongPairAbbreviated

Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".

Nombre	Tipo	Description
lat	number	Latitude (propiedad)
lon	number	Longitud (propiedad)

MatchType

Tipos de coincidencia para una operación de búsqueda de direcciones inversas.

Nombre	Tipo	Description
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

Horario de apertura de un POI (Puntos de interés).

Nombre	Tipo	Description
mode	string	Valor usado en la solicitud: none o "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Lista de intervalos de tiempo de los próximos 7 días

OperatingHoursTime

Representa una fecha y hora

Nombre	Tipo	Description
date	string	Representa la fecha actual del calendario en la zona horaria poi, por ejemplo, "2019-02-07".
hour	integer	Las horas tienen el formato de 24 horas en la hora local de un POI; los valores posibles son 0 - 23.
minute	integer	Los minutos se encuentran en la hora local de un POI; los valores posibles son 0 - 59.

OperatingHoursTimeRange

Intervalo de tiempo de apertura para un día

Nombre	Tipo	Description
endTime	OperatingHoursTime	Punto en el intervalo de próximos 7 días cuando se cierra un punto de interés determinado, o el principio del intervalo si se cerró antes del intervalo.
startTime	OperatingHoursTime	Punto en el intervalo de 7 días siguientes cuando se abre una poi determinada, o el principio del intervalo si se abrió antes del intervalo.

PointOfInterest

Detalles de la POI devuelta, incluida la información como el nombre, el teléfono, la dirección URL y las clasificaciones.

Nombre	Tipo	Description
brands	Brand[]	Matriz de marcas. Nombre de la marca para la poi que se va a devolver.
categories	string[]	Matriz de categorías
categorySet	PointOfInterestCategorySet[]	Lista de las categorías de POI más específicas
classifications	Classification[]	Matriz de clasificación
name	string	Nombre de la propiedad POI
openingHours	OperatingHours	Horario de apertura de un POI (Puntos de interés).
phone	string	Propiedad de número de teléfono
url	string	Propiedad URL del sitio web

PointOfInterestCategorySet

Categoría poi

Nombre	Tipo	Description
id	integer	Id. de categoría

QueryType

Tipo de consulta que se devuelve: NEARBY o NON_NEAR.

Nombre	Tipo	Description
NEARBY	string	Búsqueda se realizó alrededor de una determinada latitud y longitud con un radio definido
NON_NEAR	string	Búsqueda se realizó globalmente, sin sesgos en una determinada latitud y longitud, y sin radio definido

Response

Resultado de la consulta. SearchAddressResult si la consulta se completó correctamente, ErrorResponse de lo contrario.

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.
results	SearchAddressResultItem[]	Lista de resultados de la API de Búsqueda.
summary	SearchSummary	Objeto summary para una respuesta de api de Búsqueda

SearchAddressBatchItem

Un elemento devuelto desde Búsqueda llamada al servicio Batch de direcciones.

Nombre	Tipo	Description
response	Response	Resultado de la consulta. SearchAddressResult si la consulta se completó correctamente, ErrorResponse de lo contrario.
statusCode	integer	Código de estado de la solicitud HTTP.

SearchAddressBatchProcessResult

Este objeto se devuelve de una llamada correcta al servicio Batch de direcciones Búsqueda.

Nombre	Tipo	Description
batchItems	SearchAddressBatchItem[]	Matriz que contiene los resultados del lote.
summary	Summary	Resumen de los resultados de la solicitud por lotes

SearchAddressResultItem

Objeto result para una respuesta de API de Búsqueda.

Nombre	Tipo	Description
address	Address	Dirección del resultado
addressRanges	AddressRanges	Describe el intervalo de direcciones en ambos lados de la calle para obtener un resultado de búsqueda. Se incluyen las coordenadas de las ubicaciones inicial y final del intervalo de direcciones.
dataSources	DataSources	Sección opcional. Id. de geometría de referencia para su uso con get Búsqueda Polygon API.
detourTime	integer	Tiempo de desvío en segundos. Solo se devuelve para las llamadas a Búsqueda Along Route API.
dist	number	Distancia recta entre el resultado y la ubicación de geobias en metros.
entityType	GeographicEntityType	Tipo de entidad Geography. Solo se presenta cuando se solicitó entityType y está disponible.
entryPoints	EntryPoint[]	Matriz de EntryPoints. Los que describen los tipos de entradas disponibles en la ubicación. El tipo puede ser "main" para las entradas principales, como una puerta principal, o un vestíbulo, y "menor", para puertas laterales y traseras.
id	string	Propiedad Id
info	string	Información sobre el origen de datos original del resultado. Se usa para solicitudes de soporte técnico.
matchType	MatchType	Información sobre el tipo de coincidencia. Uno de los valores siguientes: AddressPoint HouseNumberRange Calle
poi	PointOfInterest	Detalles de la POI devuelta, incluida la información como el nombre, el teléfono, la dirección URL y las clasificaciones.
position	LatLongPairAbbreviated	Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".
score	number	Valor de un conjunto de resultados para indicar la puntuación de coincidencia relativa entre los resultados. Puede usarlo para determinar que el resultado x es el doble de probabilidad de ser tan relevante como resultado y si el valor de x es 2x el valor de y. Los valores varían entre las consultas y solo está pensado como un valor relativo para un conjunto de resultados.
type	SearchAddressResultType	Uno de los valores siguientes: POI Calle Geography Dirección del punto Intervalo de direcciones Cruce
viewport	BoundingBox	Ventanilla que cubre el resultado representado por las coordenadas superior izquierda e inferior derecha de la ventanilla.

SearchAddressResultType

Uno de los valores siguientes:

POI
Calle
Geography
Dirección del punto
Intervalo de direcciones
Cruce

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

SearchSummary

Objeto summary para una respuesta de api de Búsqueda.

Nombre	Tipo	Description
fuzzyLevel	integer	Nivel máximo aproximado necesario para proporcionar resultados.
geoBias	LatLongPairAbbreviated	Indicación de cuándo el motor de búsqueda interno ha aplicado un sesgo geoespacial para mejorar la clasificación de los resultados. En algunos métodos, esto puede verse afectado estableciendo los parámetros lat y lon cuando están disponibles. En otros casos es puramente interno.
limit	integer	Número máximo de respuestas que se devolverán
numResults	integer	Número de resultados en la respuesta.
offset	integer	Desplazamiento inicial de los resultados devueltos dentro del conjunto de resultados completo.
query	string	Parámetro de consulta que se usó para generar estos resultados de búsqueda.
queryTime	integer	Tiempo dedicado a resolver la consulta, en milisegundos.
queryType	QueryType	Tipo de consulta que se devuelve: NEARBY o NON_NEAR.
totalResults	integer	Número total de resultados encontrados.

Summary

Resumen de los resultados de la solicitud por lotes

Nombre	Tipo	Description
successfulRequests	integer	Número de solicitudes correctas en el lote
totalRequests	integer	Número total de solicitudes en el lote

Compartir a través de

Search - Post Search Address Batch

Enviar solicitud por lotes sincrónica

Enviar solicitud por lotes asincrónica

Cuerpo POST para la solicitud por lotes

Descargar resultados de lotes asincrónicos

Modelo de respuesta por lotes

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

AADToken

Ámbitos

subscription-key

SAS Token

Ejemplos

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

Solicitud de ejemplo

Respuesta de muestra

Definiciones

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 adicionales