Search - Get Search Address Reverse Batch

Servicio:: Maps

Versión de la API:: 1.0

Use para enviar un lote de consultas a la API de de dirección de búsqueda inversa de en una sola solicitud asincrónica.

La API de Get Search Address Reverse Batch es una solicitud de GET HTTP que envía lotes de consultas a API de de dirección de búsqueda inversa en una sola llamada API asincrónica. Puede llamar a Get Search Address Reverse Batch API 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 la API hasta 100 consultas.

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/search/address/reverse/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 en un tiempo de espera.
El número de elementos por lotes se limita 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 debe comprobarse 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 inverso de direcciones de búsqueda POST a Azure Maps.

POST https://atlas.microsoft.com/search/address/reverse/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. Esto podría ser un 400 Bad Request o cualquier otro código de estado de Error.
Si la solicitud por lotes se aceptó correctamente, el encabezado Location 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/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

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

Cuerpo POST para solicitud por lotes

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

{
    "batchItems": [
        {"query": "?query=48.858561,2.294911"},
        {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
        {"query": "?query=47.621028,-122.348170"},
        {"query": "?query=43.722990,10.396695"},
        {"query": "?query=40.750958,-73.982336"}
    ]
}

Una dirección de búsqueda inversa consulta 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 dirección de búsqueda dirección de búsqueda inversa consulta deben tener un escape correcto (por ejemplo, " el carácter debe ser de escape con \ ) y también debe estar correctamente codificado con 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 de.

Descargar resultados de lotes asincrónicos

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

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

Esta es la secuencia típica de operaciones para descargar los resultados del lote:

El cliente envía una solicitud de GET mediante la dirección URL de descarga de .
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 de Batch procesada correctamente. El cuerpo de la respuesta contiene todos los resultados del lote.

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 componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequestses decir, 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 de batchItems contiene campos statusCode y response. Cada response de batchItems es de uno de los siguientes tipos:

SearchAddressReverseResponse: 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.

Esta es una respuesta por lotes de ejemplo con 2 correcta y 1 error resultado:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 11
                },
                "addresses": [
                    {
                        "address": {
                            "country": "France",
                            "freeformAddress": "Avenue Anatole France, 75007 Paris"
                        },
                        "position": "48.858490,2.294820"
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 1
                },
                "addresses": [
                    {
                        "address": {
                            "country": "United States of America",
                            "freeformAddress": "157th Pl NE, Redmond WA 98052"
                        },
                        "position": "47.640470,-122.129430"
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

GET https://atlas.microsoft.com/search/address/reverse/batch/{format}?api-version=1.0

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	string	Identificador de Lote para consultar la operación.
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	Indica la cuenta destinada a su uso con el modelo de seguridad de identificador de Microsoft Entra. Este identificador único para la cuenta de Azure Maps se puede obtener de la API de cuenta del plano de administración de Azure Maps. Para obtener más información sobre el uso de la seguridad de ID de Microsoft Entra en Azure Maps, consulte Administración de la autenticación en Azure Maps.

Respuestas

Nombre	Tipo	Description
200 OK	ReverseSearchAddressBatchProcessResult	De acuerdo
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

ReverseSearchAddressBatchProcessResult

De acuerdo

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

Nota:

Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de de Maps.
El 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 id. de Microsoft Entra.
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, la CLI, los SDK de Azure o las API REST.
El uso de 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 la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.

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 Creación de una cuenta de Azure Maps en 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.

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

Tipo: apiKey
En: query

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 GET call containing 5 Reverse Geocoding API queries

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "7",
              "routeNumbers": [],
              "streetName": "Avenue Anatole France",
              "streetNameAndNumber": "7 Avenue Anatole France",
              "countryCode": "FR",
              "countrySubdivisionCode": "Île-de-France",
              "countrySecondarySubdivision": "Paris",
              "municipality": "Paris",
              "postalCode": "75007",
              "municipalitySubdivision": "7ème Arrondissement",
              "country": "France",
              "countryCodeISO3": "FRA",
              "freeformAddress": "7 Avenue Anatole France, Paris, 75007",
              "boundingBox": {
                "northEast": "48.858321,2.295167",
                "southWest": "48.858136,2.295027",
                "entity": "position"
              }
            },
            "position": "48.858231,2.295089"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "routeNumbers": [],
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "municipality": "Redmond",
              "postalCode": "98052",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "Redmond, WA 98052",
              "boundingBox": {
                "northEast": "47.639765,-122.128661",
                "southWest": "47.639502,-122.129456",
                "entity": "position"
              },
              "countrySubdivisionName": "Washington"
            },
            "position": "47.639687,-122.128677"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 19,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "410",
              "routeNumbers": [],
              "streetName": "Thomas Street",
              "streetNameAndNumber": "410 Thomas Street",
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "municipality": "Seattle",
              "postalCode": "98109",
              "municipalitySubdivision": "Seattle, Lower Queen Anne",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "410 Thomas Street, Seattle, WA 98109",
              "boundingBox": {
                "northEast": "47.620954,-122.347601",
                "southWest": "47.620944,-122.348498",
                "entity": "position"
              },
              "extendedPostalCode": "981094621",
              "countrySubdivisionName": "Washington"
            },
            "position": "47.620945,-122.348175"
          }
        ]
      }
    }
  ]
}

status code:: 202

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 de inicio y finalización del intervalo de direcciones.
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 devuelve
ClassificationName	Nombre de la clasificación
DataSources	Sección opcional. Identificadores de referencia para su uso con la API de Get Search 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 el PUNTO de interés que se devuelve.
EntryPointType	Tipo de punto de entrada. El valor puede ser principal o secundaria.
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. Presente solo cuando se solicitó entityType y está disponible.
Geometry	Información sobre la forma geométrica del resultado. Solo está presente si el tipo == Geography.
LatLongPairAbbreviated	Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon".
MatchType	Tipos de coincidencias para una operación de búsqueda de direcciones inversas.
OperatingHours	Horario de apertura de una 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 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. Importante: Esta propiedad está obsoleta y puede omitirse en la respuesta.
Response	Resultado de la consulta. SearchAddressResult si la consulta se completó correctamente, ErrorResponse en caso contrario.
ReverseSearchAddressBatchItem	Un elemento devuelto desde la llamada del servicio Batch inverso de dirección de búsqueda.
ReverseSearchAddressBatchProcessResult	Este objeto se devuelve de una llamada correcta al servicio Batch inverso de dirección de búsqueda.
SearchAddressResultItem	Objeto result para una respuesta de Search API.
SearchAddressResultType	Uno de los valores siguientes: POI Calle Geografía Dirección del punto Intervalo de direcciones Cruce
SearchSummary	Objeto summary para una respuesta de Search API.
Summary	Resumen de los resultados de la solicitud por lotes

Address

Objeto

Dirección del resultado.

Nombre	Tipo	Description
boundingBox	BoundingBoxCompassNotation	Define el cuadro delimitador de la ubicación. Esta propiedad solo la devuelven las API inversas de direcciones de búsqueda. Todas las demás API de búsqueda devuelven la `viewport` propiedad del `SearchAddressResultItem` objeto.
buildingNumber	string	Número de edificio en la calle. Importante: Esta propiedad está en desuso. En su lugar, use `streetNumber`.
country	string	El nombre del país/región.
countryCode	string	Un código alfabético de dos letras definido por la norma ISO 3166-1 Alpha-2 para representar un país/región y territorios dependientes.
countryCodeISO3	string	Un código alfabético de tres letras definido por la norma ISO 3166-1 Alpha-3 para representar un país/región y territorios dependientes.
countrySecondarySubdivision	string	La división administrativa de segundo nivel dentro de un país o región. Identifica una subdivisión que está por debajo de la subdivisión principal, como estado o provincia, pero por encima de unidades más pequeñas como municipios o barrios. Ejemplos incluyen County en Estados Unidos y District en el Reino Unido.
countrySubdivision	string	La división administrativa principal dentro de un país, como un estado, provincia. Se utiliza para representar la subdivisión de primer nivel por debajo del nivel nacional.
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. Esta propiedad no está disponible en la `Get Search Nearby` API de Y `Get Search POI` .
countrySubdivisionName	string	Representa el nombre completo de la división administrativa de primer nivel (como estado, provincia o región) dentro de un país o región. Esta propiedad solo se incluye cuando el `countrySubdivision` valor se proporciona en forma abreviada. Actualmente apoyado para Estados Unidos, Canadá y Reino Unido.
countryTertiarySubdivision	string	La división administrativa de tercer nivel dentro de un país o región. Proporciona una granularidad aún más fina que la subdivisión secundaria (como condado o distrito). Ejemplos incluyen municipios como una ciudad, pueblo, pueblo, municipio o municipio, y barrios de una pequeña área geográfica informal dentro de un municipio, como Capitol Hill, Green Lake y Wallingford en Seattle.
crossStreet	string	Nombre de la calle que se cruza. Esta propiedad solo está disponible en la `Get Search Address Reverse Cross Street` API.
extendedPostalCode	string	Un código postal extendido se refiere a un formato de código postal que va más allá del conjunto estándar de dígitos para proporcionar mayor precisión en la localización. Se utiliza comúnmente en sistemas como el código U.S. ZIP+4 o formatos extendidos similares en otros países o regiones. La disponibilidad depende de la región. No está disponible en la `Get Search Address Reverse Cross Street` API.
freeformAddress	string	Una línea de dirección formateada según las reglas de formato del país/región de origen de un resultado, o en el caso de un país/región, su nombre completo del país/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 propiedad `freeformAddress`. `localName` representa el municipio postal. Dependiendo de la ubicación, `localName` es el nombre 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 valor de `municipality` puede diferir del nombre conocido de una ciudad o ciudad. Para el nombre comúnmente conocido de la ciudad o pueblo, se sugiere que se use el `localName` valor en lugar del `municipality` valor.
municipalitySubdivision	string	Una subdivisión dentro de un municipio. Representa una unidad administrativa o geográfica más pequeña dentro de una ciudad, pueblo u otra entidad municipal.
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	Una serie de números o letras (o ambos) se añadían a una dirección para ayudar a identificar una zona geográfica específica. Un código postal es la versión estadounidense de un código postal; otros países/regiones utilizan otros formatos como código postal, código PIN y PLZ.
routeNumbers	string[]	Los códigos usados para identificar la calle de forma inequívoca. Solo disponible para las API de inversión de direcciones de búsqueda.
street	string	Nombre de la calle. Importante: Esta propiedad está en desuso. En su lugar, use `streetName`.
streetName	string	Nombre de la calle.
streetNameAndNumber	string	Nombre y número de la calle. Solo disponible para las API de inversión de direcciones de búsqueda.
streetNumber	string	Número de edificio en la calle. No está disponible en la `Get Search Address Reverse Cross Street` API.

AddressRanges

Objeto

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 de inicio y finalización del intervalo de direcciones.

Nombre	Tipo	Description
from	LatLongPairAbbreviated	Una ubicación representada como 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 latitud y longitud con nombres cortos "lat" & "lon".

BoundingBox

Objeto

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 latitud y longitud con nombres cortos "lat" & "lon".
topLeftPoint	LatLongPairAbbreviated	Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon".

BoundingBoxCompassNotation

Objeto

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 de selección como floats separados por comas
southWest	string	Latitud sur-oeste,coordenada de longitud del rectángulo delimitador como floats separados por comas

Brand

Objeto

La marca asociada a la POI

Nombre	Tipo	Description
name	string	Nombre de la marca

Classification

Objeto

Clasificación de la POI que se devuelve

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

ClassificationName

Objeto

Nombre de la clasificación

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

DataSources

Objeto

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

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

Entity

Enumeración

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

Valor	Description
position	Entidad Position

EntryPoint

Objeto

Punto de entrada para el PUNTO de interés que se devuelve.

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

EntryPointType

Enumeración

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

Valor	Description
main
minor

ErrorAdditionalInfo

Objeto

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

Objeto

Detalle del error.

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

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GeographicEntityType

Enumeración

Tipo de entidad Geography. Presente solo cuando se solicitó entityType y está disponible.

Valor	Description
Country	nombre de país o región
CountrySubdivision	Estado o provincia
CountrySecondarySubdivision	Condado
CountryTertiarySubdivision	Área con nombre
Municipality	Ciudad/Ciudad
MunicipalitySubdivision	Sub/Super City
Neighbourhood	Datos de formas
PostalCodeArea	Código postal/código postal

Geometry

Objeto

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 la API de Get Search Polygon para capturar información de geometría para este resultado.

LatLongPairAbbreviated

Objeto

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

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

MatchType

Enumeración

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

Valor	Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Objeto

Horario de apertura de una 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 para los próximos 7 días

OperatingHoursTime

Objeto

Representa una fecha y hora

Nombre	Tipo	Description
date	string	Representa la fecha actual del calendario en la zona horaria de POI, por ejemplo, "2019-02-07".
hour	integer	Las horas están en 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

Objeto

Intervalo de tiempo de apertura para un día

Nombre	Tipo	Description
endTime	OperatingHoursTime	El punto del intervalo de 7 días siguientes cuando se cierra un punto de interés determinado o el principio del intervalo si se cerró antes del intervalo.
startTime	OperatingHoursTime	El punto del intervalo de 7 días siguientes cuando se abre un punto de interés determinado o el principio del intervalo si se abrió antes del intervalo.

PointOfInterest

Objeto

Detalles de la POI devuelta, incluida 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 el punto de interés que se devuelve.
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 una POI (Puntos de interés).
phone	string	Propiedad de número de teléfono
url	string	Propiedad URL del sitio web

PointOfInterestCategorySet

Objeto

Categoría poi

Nombre	Tipo	Description
id	integer	Id. de categoría

QueryType

Enumeración

Tipo de consulta que se devuelve: NEARBY o NON_NEAR.

Importante: Esta propiedad está obsoleta y puede omitirse en la respuesta.

Valor	Description
NEARBY	La búsqueda se realizaba alrededor de una determinada latitud y longitud con un radio definido.
NON_NEAR	La búsqueda se realizó globalmente, sin sesgo en una determinada latitud y longitud, y sin radio definido

Response

Objeto

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

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.
results	SearchAddressResultItem[]	Lista de resultados de Search API.
summary	SearchSummary	Objeto summary para una respuesta de Search API

ReverseSearchAddressBatchItem

Objeto

Un elemento devuelto desde la llamada del servicio Batch inverso de dirección de búsqueda.

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

ReverseSearchAddressBatchProcessResult

Objeto

Este objeto se devuelve de una llamada correcta al servicio Batch inverso de dirección de búsqueda.

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

SearchAddressResultItem

Objeto

Objeto result para una respuesta de Search API.

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 de inicio y finalización del intervalo de direcciones.
dataSources	DataSources	Sección opcional. Id. de geometría de referencia para su uso con la API de Get Search Polygon.
detourTime	integer	Tiempo de desvío en segundos. Solo se devuelve para las llamadas a Search Along Route API.
dist	number (double)	Distancia recta entre el resultado y la ubicación de geobias en metros.
entityType	GeographicEntityType	Tipo de entidad Geography. Presente solo cuando se solicitó entityType y está disponible.
entryPoints	EntryPoint[]	Matriz de puntos de entrada. 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 información como el nombre, el teléfono, la dirección URL y las clasificaciones.
position	LatLongPairAbbreviated	Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon".
score	number (double)	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án diseñados como un valor relativo para un conjunto de resultados. Importante: Esta propiedad está obsoleta y puede omitirse en la respuesta.
type	SearchAddressResultType	Uno de los valores siguientes: POI Calle Geografía 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

Enumeración

Uno de los valores siguientes:

POI
Calle
Geografía
Dirección del punto
Intervalo de direcciones
Cruce

Valor	Description
POI
Street
Geography
Point Address
Address Range
Cross Street

SearchSummary

Objeto

Objeto summary para una respuesta de Search API.

Nombre	Tipo	Description
fuzzyLevel	integer	Nivel aproximado máximo 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 en el 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. Importante: Esta propiedad está obsoleta y puede omitirse en la respuesta.
totalResults	integer	Número total de resultados encontrados.

Summary

Objeto

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 - Get Search Address Reverse Batch

Enviar solicitud por lotes sincrónica

Enviar solicitud por lotes asincrónica

Cuerpo POST para solicitud por lotes

Descargar resultados de lotes asincrónicos

Modelo de respuesta por lotes

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

AADToken

Ámbitos

subscription-key

SAS Token

Ejemplos

A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

Response

ReverseSearchAddressBatchItem

ReverseSearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary