Search - Get Search Address

Referencia

Servicio:: Maps

Versión de la API:: 1.0

Use para obtener coordenadas de latitud y longitud de una dirección postal en un formato de entrada de consulta o no estructurado.

La API de Get Search Address es una solicitud http GET devuelve las coordenadas de latitud y longitud cuando se pasan en una dirección postal o un nombre de un lugar como criterios de búsqueda.

En muchos casos, el servicio de búsqueda completo podría ser demasiado, por ejemplo, si solo está interesado en la geocodificación tradicional. También se puede acceder a la búsqueda de direcciones exclusivamente. La geocodificación se realiza presionando el punto de conexión de código geográfico con solo la dirección o la dirección parcial en cuestión. El índice de búsqueda de geocodificación se consultará para todo lo que está por encima de los datos del nivel de calle. No se devolverá ningún POIs. Tenga en cuenta que el geocodificador es muy tolerante a errores tipográficos y direcciones incompletas. También controlará todo desde direcciones postales exactas o calles o intersecciones, así como zonas geográficas de nivel superior, como centros de ciudad, condados, estados, etc.

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

Con parámetros opcionales:

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	ResponseFormat	Formato deseado de la respuesta. El valor puede ser json o xml.
api-version	query	True	string	Número de versión de la API de Azure Maps.
query	query	True	string	La dirección que se va a buscar (por ejemplo, "1 Microsoft way, Redmond, WA"), debe estar codificada correctamente con la dirección URL.
btmRight	query		string	Posición inferior derecha del rectángulo de selección. Por ejemplo, 37.553,-122.453
countrySet	query		string[]	Cadena separada por comas de códigos de país o región, por ejemplo, FR,ES. Esto limitará la búsqueda a los países o regiones especificados.
entityType	query		GeographicEntityType	Especifica el nivel de filtrado realizado en zonas geográficas. Limita la búsqueda de tipos de entidad geography especificados, por ejemplo, devolver solo el municipio. La respuesta resultante contendrá el identificador de geografía, así como el tipo de entidad coincidente. Si proporciona más de una entidad como una lista separada por comas, el punto de conexión devolverá la "entidad más pequeña disponible". El identificador de geometría devuelto se puede usar para obtener la geometría de esa geografía a través de Get Search Polygon API. Los parámetros siguientes se omiten cuando se establece entityType: encabezado número returnRoadUse returnSpeedLimit roadUse returnMatchType
extendedPostalCodesFor	query		SearchIndexes[]	Índices para los que los códigos postales extendidos deben incluirse en los resultados. Los índices disponibles son: Addr = Intervalos de direcciones Geo = Geographies PAD = Direcciones de punto POI = Puntos de interés Str = Streets XStr = Cross Streets (intersecciones) El valor debe ser una lista separada por comas de tipos de índice (en cualquier orden) o Ninguno para ningún índice. De forma predeterminada, los códigos postales extendidos se incluyen para todos los índices, excepto Geo. Las listas de códigos postales extendidas para las zonas geográficas pueden ser bastante largas, por lo que deben solicitarse explícitamente cuando sea necesario. Ejemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None El código postal extendido se devuelve como una propiedad de extendedPostalCode de una dirección. La disponibilidad depende de la región.
language	query		string	Idioma en el que se deben devolver los resultados de la búsqueda. Debe ser una de las etiquetas de idioma IETF admitidas, sin distinción entre mayúsculas y minúsculas. Cuando los datos del idioma especificado no están disponibles para un campo específico, se usa el idioma predeterminado. Consulte idiomas admitidos para obtener más información.
lat	query		number (double)	Latitud donde los resultados deben estar sesgados. Por ejemplo, 37.337
limit	query		integer minimum: 1 maximum: 100	Número máximo de respuestas que se devolverán. Valor predeterminado: 10, mínimo: 1 y máximo: 100
lon	query		number (double)	Longitud en la que los resultados deben estar sesgados. Por ejemplo, -121,89
ofs	query		integer minimum: 0 maximum: 1900	Desplazamiento inicial de los resultados devueltos dentro del conjunto de resultados completo. Valor predeterminado: 0
radius	query		integer	Radio en metros a para que los resultados se restrinjan al área definida.
topLeft	query		string	Posición superior izquierda del rectángulo de selección. Por ejemplo, 37.553,-122.453
typeahead	query		boolean	Booleano. Si se establece la marca typeahead, la consulta se interpretará como una entrada parcial y la búsqueda entrará en modo predictivo.
view	query		LocalizedMapView	El parámetro View (también denominado parámetro "user region") permite mostrar los mapas correctos para un determinado país o región para regiones geopolíticamente disputadas. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región a la que va a servir la aplicación. De forma predeterminada, el parámetro View se establece en "Unified" incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de los usuarios y, a continuación, establecer el parámetro View correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa en función de la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que los mapas, imágenes y otros datos y contenido de terceros a los que está autorizado para acceder a través de Azure Maps está disponible. Ejemplo: view=IN. Consulte vistas admitidas para obtener más información y ver las vistas disponibles.

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 Id. de Microsoft Entra. 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 la seguridad del identificador de Entra de Microsoft en Azure Maps, consulte los siguientes artículos de para obtener instrucciones.

Respuestas

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

Search detail address 15127 NE 24th Street, Redmond, WA 98052

Solicitud de ejemplo

HTTP

GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052

Respuesta de muestra

status code:: 200

{
  "summary": {
    "query": "15127 NE 24th Street, Redmond, WA 98052",
    "queryType": "NON_NEAR",
    "queryTime": 58,
    "numResults": 1,
    "offset": 0,
    "totalResults": 1,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/19173426",
      "score": 14.51,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "980525544",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15127 NE 24th St, Redmond, WA 980525544",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6308,
        "lon": -122.1385
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6317,
          "lon": -122.13983
        },
        "btmRightPoint": {
          "lat": 47.6299,
          "lon": -122.13717
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6315,
            "lon": -122.13852
          }
        }
      ]
    }
  ]
}

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".
LocalizedMapView	El parámetro View (también denominado parámetro "user region") permite mostrar los mapas correctos para un determinado país o región para regiones geopolíticamente disputadas. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región a la que va a servir la aplicación. De forma predeterminada, el parámetro View se establece en "Unified" incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de los usuarios y, a continuación, establecer el parámetro View correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa en función de la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que los mapas, imágenes y otros datos y contenido de terceros a los que está autorizado para acceder a través de Azure Maps está disponible. Ejemplo: view=IN. Consulte vistas admitidas para obtener más información y ver las vistas disponibles.
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.
ResponseFormat	Formato deseado de la respuesta. El valor puede ser json o xml.
SearchAddressResult	Este objeto se devuelve de una llamada de búsqueda correcta.
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
SearchIndexes	Índices para los que los códigos postales extendidos deben incluirse en los resultados. Los índices disponibles son: Addr = Intervalos de direcciones Geo = Geographies PAD = Direcciones de punto POI = Puntos de interés Str = Streets XStr = Cross Streets (intersecciones) El valor debe ser una lista separada por comas de tipos de índice (en cualquier orden) o Ninguno para ningún índice. De forma predeterminada, los códigos postales extendidos se incluyen para todos los índices, excepto Geo. Las listas de códigos postales extendidas para las zonas geográficas pueden ser bastante largas, por lo que deben solicitarse explícitamente cuando sea necesario. Ejemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None El código postal extendido se devuelve como una propiedad de extendedPostalCode de una dirección. La disponibilidad depende de la región.
SearchSummary	Objeto summary para una respuesta de Search API.

Address

Object

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	Condado
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 direcciones 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 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 conocido de la ciudad o la ciudad, se recomienda usar el valor de `localName` en lugar del valor de `municipality`.
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

Object

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

Object

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

Object

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

Object

La marca asociada a la POI

Nombre	Tipo	Description
name	string	Nombre de la marca

Classification

Object

Clasificación de la POI que se devuelve

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

ClassificationName

Object

Nombre de la clasificación

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

DataSources

Object

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

Object

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

Object

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

Object

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

Object

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
CountrySecondarySubdivision	Condado
CountrySubdivision	Estado o provincia
CountryTertiarySubdivision	Área con nombre
Municipality	Ciudad/Ciudad
MunicipalitySubdivision	Sub/Super City
Neighbourhood	Datos de formas
PostalCodeArea	Código postal/código postal

Geometry

Object

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

Object

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)

LocalizedMapView

Enumeración

El parámetro View (también denominado parámetro "user region") permite mostrar los mapas correctos para un determinado país o región para regiones geopolíticamente disputadas. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región a la que va a servir la aplicación. De forma predeterminada, el parámetro View se establece en "Unified" incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de los usuarios y, a continuación, establecer el parámetro View correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa en función de la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que los mapas, imágenes y otros datos y contenido de terceros a los que está autorizado para acceder a través de Azure Maps está disponible. Ejemplo: view=IN.

Consulte vistas admitidas para obtener más información y ver las vistas disponibles.

Valor	Description
AE	Emiratos Árabes Unidos (vista árabe)
AR	Argentina (Vista argentina)
Auto	Devuelve los datos del mapa en función de la dirección IP de la solicitud.
BH	Bahréin (vista árabe)
IN	India (Vista india)
IQ	Irak (vista árabe)
JO	Jordania (vista árabe)
KW	Kuwait (vista árabe)
LB	Líbano (vista árabe)
MA	Marruecos (Vista marroquí)
OM	Oman (vista árabe)
PK	Pakistán (Vista paquistaní)
PS	Autoridad Palestina (vista árabe)
QA	Qatar (vista árabe)
SA	Arabia Saudita (vista árabe)
SY	Siria (vista árabe)
Unified	Vista unificada (otros)
YE	Yemen (vista árabe)

MatchType

Enumeración

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

Valor	Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Object

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

Object

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

Object

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

Object

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

Object

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.

Valor	Description
NEARBY	La búsqueda se realizó 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

ResponseFormat

Enumeración

Formato deseado de la respuesta. El valor puede ser json o xml.

Valor	Description
json	el formato de intercambio de datos de notación de objetos JavaScript
xml	el lenguaje de marcado extensible

SearchAddressResult

Object

Este objeto se devuelve de una llamada de búsqueda correcta.

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

SearchAddressResultItem

Object

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.
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
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchIndexes

Enumeración

Índices para los que los códigos postales extendidos deben incluirse en los resultados.

Los índices disponibles son:

Addr = Intervalos de direcciones

Geo = Geographies

PAD = Direcciones de punto

POI = Puntos de interés

Str = Streets

XStr = Cross Streets (intersecciones)

El valor debe ser una lista separada por comas de tipos de índice (en cualquier orden) o Ninguno para ningún índice.

De forma predeterminada, los códigos postales extendidos se incluyen para todos los índices, excepto Geo. Las listas de códigos postales extendidas para las zonas geográficas pueden ser bastante largas, por lo que deben solicitarse explícitamente cuando sea necesario.

Ejemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

El código postal extendido se devuelve como una propiedad de extendedPostalCode de una dirección. La disponibilidad depende de la región.

Valor	Description
Addr
Geo
PAD
POI
Str
Xstr

SearchSummary

Object

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.
totalResults	integer	Número total de resultados encontrados.

Compartir a través de

Search - Get Search Address

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

AADToken

Ámbitos

subscription-key

SAS Token

Ejemplos

Search detail address 15127 NE 24th Street, Redmond, WA 98052

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

LocalizedMapView

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

ResponseFormat

SearchAddressResult

SearchAddressResultItem

SearchAddressResultType

SearchIndexes

SearchSummary

Recursos adicionales