Search - Get Search POI
Use para buscar puntos de interés por nombre.
La Points of Interest (POI) Search
API es una solicitud HTTP GET
que permite solicitar resultados de POI por nombre. También admite parámetros de consulta adicionales, como el idioma y el filtrado de resultados por área de interés controlada por país o región o cuadro de límite. El punto de conexión solo devolverá resultados de POI que coincidan con la cadena de consulta. La respuesta incluye detalles de POI, como dirección, ubicación de coordenadas y categoría.
GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&brandSet={brandSet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
format
|
path | True |
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 |
El nombre de POI que se va a buscar (por ejemplo, "estatua de libertad", "starbucks"), debe estar codificado correctamente con la dirección URL. |
brand
|
query |
string[] |
Lista separada por comas de nombres de marca que se podrían usar para restringir el resultado a marcas específicas. No importa el orden de los elementos. Cuando se proporcionan varias marcas, solo se devolverán los resultados que pertenecen a (al menos) una de las listas proporcionadas. Las marcas que contienen un elemento "," en su nombre deben incluirse entre comillas. Ejemplos de uso: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Coma",Bar |
|
btm
|
query |
string |
Posición inferior derecha del rectángulo delimitador. Por ejemplo, 37.553,-122.453 |
|
category
|
query |
integer[] |
Lista separada por comas de identificadores de conjuntos de categorías que se podrían usar para restringir el resultado a categorías específicas de puntos de interés. El orden de identificación no importa. El número máximo de
|
|
connector
|
query |
Lista separada por comas de tipos de conectores que se podrían usar para restringir el resultado a la estación de vehículos eléctricos que admita tipos de conector específicos. No importa el orden de los elementos. Cuando se proporcionan varios tipos de conectores, solo se devolverán los resultados que pertenecen a (al menos) una de las listas proporcionadas. Los tipos de conector disponibles son:
Ejemplos de uso: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
||
country
|
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. |
|
extended
|
query |
Índices para los que se deben incluir códigos postales extendidos en los resultados. Los índices disponibles son: POI = Puntos de interés El valor debe ser POI o None para deshabilitar los códigos postales extendidos. De forma predeterminada, se incluyen códigos postales extendidos. Ejemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=None El código postal extendido se devuelve como una propiedad 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 búsqueda. Debe ser una de las etiquetas de lenguaje 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 en la que los resultados deben estar sesgados. Por ejemplo, 37.337 |
|
limit
|
query |
integer |
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 |
Desplazamiento inicial de los resultados devueltos dentro del conjunto de resultados completo. Valor predeterminado: 0 |
|
opening
|
query |
Horas de funcionamiento de un POI (Puntos de interés). La disponibilidad de las horas de funcionamiento variará en función de los datos disponibles. Si no se pasa, no se devolverá información del horario de apertura. Valor admitido: nextSevenDays |
||
radius
|
query |
integer |
Radio en metros para que los resultados se restrinjan al área definida. |
|
top
|
query |
string |
Posición superior izquierda del rectángulo delimitador. 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 |
El parámetro View (también denominado parámetro "región de usuario") le permite mostrar los mapas correctos para un determinado país o región para regiones controvertidas geopolíticamente. 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 que la aplicación va a atender. De forma predeterminada, el parámetro View se establece en "Unificado", incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de sus usuarios y luego establecer el parámetro Vista correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa según 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 están disponibles mapas, imágenes y otros datos y contenido de terceros a los que está autorizado a acceder a través de Azure Maps. Ejemplo: view=IN. Consulte Vistas admitidas para obtener más información y para 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 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. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Aceptar |
|
Other Status Codes |
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 mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las 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 introducción a 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 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 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 está autorizada para acceder a los controles de acceso basado en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. En otras palabras, 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 asignación para limitar la representación del abuso y renovar periódicamente el token de SAS.
Tipo:
apiKey
En:
header
Ejemplos
Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results
Solicitud de ejemplo
GET https://atlas.microsoft.com/search/poi/json?api-version=1.0&query=juice bars&limit=5&lat=47.606038&lon=-122.333345&radius=8046&openingHours=nextSevenDays
Respuesta de muestra
{
"summary": {
"query": "juice bars",
"queryType": "NON_NEAR",
"queryTime": 36,
"numResults": 5,
"offset": 0,
"totalResults": 12,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.606038,
"lon": -122.333345
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/9223158",
"score": 5.664,
"dist": 667.2710170950347,
"info": "search:ta:840539001755244-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-6240804",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "400",
"streetName": "Pine St",
"municipalitySubdivision": "Seattle, Central Business District",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98101",
"extendedPostalCode": "981011628",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "400 Pine St, Seattle, WA 98101",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61138,
"lon": -122.3374
},
"viewport": {
"topLeftPoint": {
"lat": 47.61228,
"lon": -122.33873
},
"btmRightPoint": {
"lat": 47.61048,
"lon": -122.33607
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61134,
"lon": -122.33737
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/9222534",
"score": 5.663,
"dist": 1101.6849025777728,
"info": "search:ta:840539001760125-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-4533785",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "315",
"streetName": "E Pine St",
"municipalitySubdivision": "Seattle, Broadway",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98122",
"extendedPostalCode": "9812200",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "315 E Pine St, Seattle, WA 98122",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61518,
"lon": -122.32768
},
"viewport": {
"topLeftPoint": {
"lat": 47.61608,
"lon": -122.32901
},
"btmRightPoint": {
"lat": 47.61428,
"lon": -122.32635
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61523,
"lon": -122.32768
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/9133689",
"score": 5.659,
"dist": 2649.8700791555398,
"info": "search:ta:840539001339220-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-2820651",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "604",
"streetName": "1st Ave N",
"municipalitySubdivision": "Seattle, Lower Queen Anne",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98109",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "604 1st Ave N, Seattle, WA 98109",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.6247,
"lon": -122.35533
},
"viewport": {
"topLeftPoint": {
"lat": 47.6256,
"lon": -122.35666
},
"btmRightPoint": {
"lat": 47.6238,
"lon": -122.354
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6247,
"lon": -122.3554
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/9131285",
"score": 5.646,
"dist": 5097.757019046541,
"info": "search:ta:840539001743255-US",
"poi": {
"name": "Custom Smoothie & Sports Nutrition",
"phone": "+(1)-(206)-5475522",
"categorySet": [
{
"id": 7315149
}
],
"url": "www.customsmoothie.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "462",
"streetName": "N 34th St",
"municipalitySubdivision": "Seattle, Fremont",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98103",
"extendedPostalCode": "981038600",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "462 N 34th St, Seattle, WA 98103",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.65016,
"lon": -122.35182
},
"viewport": {
"topLeftPoint": {
"lat": 47.65106,
"lon": -122.35315
},
"btmRightPoint": {
"lat": 47.64926,
"lon": -122.35049
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.64991,
"lon": -122.3519
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/9228250",
"score": 5.637,
"dist": 6235.798481758295,
"info": "search:ta:840531000416784-US",
"poi": {
"name": "Jamba Juice",
"phone": "+(1)-(206)-6322060",
"brands": [
{
"name": "Jamba Juice"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.jambajuice.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "4555",
"streetName": "Stone Way N",
"municipalitySubdivision": "Wallingford, Seattle",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98103",
"extendedPostalCode": "981036600",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "4555 Stone Way N, Seattle, WA 98103",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.66179,
"lon": -122.34233
},
"viewport": {
"topLeftPoint": {
"lat": 47.66269,
"lon": -122.34367
},
"btmRightPoint": {
"lat": 47.66089,
"lon": -122.34099
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.66188,
"lon": -122.34211
}
}
]
}
]
}
Definiciones
Nombre | Description |
---|---|
Address |
Dirección del resultado |
Address |
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. |
Bounding |
Ventanilla que cubre el resultado representado por las coordenadas superior izquierda e inferior derecha de la ventanilla. |
Bounding |
Cuadro de límite de la ubicación. |
Brand |
La marca asociada a la POI |
Classification |
Clasificación de la POI que se devuelve |
Classification |
Nombre de la clasificación |
Data |
Sección opcional. Identificadores de referencia para su uso con get Búsqueda Polygon API. |
Electric |
Lista separada por comas de tipos de conectores que se podrían usar para restringir el resultado a la estación de vehículos eléctricos que admita tipos de conector específicos. No importa el orden de los elementos. Cuando se proporcionan varios tipos de conectores, solo se devolverán los resultados que pertenecen a (al menos) una de las listas proporcionadas. Los tipos de conector disponibles son:
Ejemplos de uso: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
Entity |
Origen del tipo de entidad del rectángulo de selección. Para la geocodificación inversa, siempre es igual a la posición. |
Entry |
Punto de entrada para el PUNTO de interés que se devuelve. |
Entry |
Tipo de punto de entrada. El valor puede ser principal o secundario. |
Error |
Información adicional sobre el error de administración de recursos. |
Error |
Detalle del error. |
Error |
Respuesta de error |
Geographic |
Tipo de entidad Geography. Solo está presente cuando se solicitó entityType y está disponible. |
Geometry |
Información sobre la forma geométrica del resultado. Solo está presente si el tipo == Geography. |
Lat |
Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon". |
Localized |
El parámetro View (también denominado parámetro "user region") le permite mostrar los mapas correctos para un determinado país o región para las regiones controvertidas geopolíticamente. Los distintos países o regiones tienen diferentes vistas 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 que la aplicación va a atender. De forma predeterminada, el parámetro View se establece en "Unified" aunque no lo haya definido en la solicitud. Es su responsabilidad determinar la ubicación de sus usuarios y luego establecer el parámetro Vista correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa según la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relacionadas con la asignación, del país o región en el que están disponibles mapas, imágenes y otros datos y contenido de terceros a los que está autorizado para acceder a través de Azure Maps. Ejemplo: view=IN. Consulte Vistas admitidas para obtener más información y ver las vistas disponibles. |
Match |
Tipos de coincidencias para una operación de búsqueda de direcciones inversas. |
Operating |
Horario de apertura de un POI (Puntos de interés). |
Operating |
Horas de funcionamiento de un POI (Puntos de interés). La disponibilidad de las horas de funcionamiento variará en función de los datos disponibles. Si no se pasa, no se devolverá información del horario de apertura. Valor admitido: nextSevenDays |
Operating |
Representa una fecha y hora |
Operating |
Intervalo de tiempo de apertura para un día |
Point |
Detalles de la POI devuelta, incluida información como el nombre, el teléfono, la dirección URL y las clasificaciones. |
Point |
Categoría poi |
Point |
Índices para los que se deben incluir códigos postales extendidos en los resultados. Los índices disponibles son: POI = Puntos de interés El valor debe ser POI o None para deshabilitar los códigos postales extendidos. De forma predeterminada, se incluyen códigos postales extendidos. Ejemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=None El código postal extendido se devuelve como una propiedad extendedPostalCode de una dirección. La disponibilidad depende de la región. |
Query |
Tipo de consulta que se devuelve: NEARBY o NON_NEAR. |
Response |
Formato deseado de la respuesta. El valor puede ser json o xml. |
Search |
Este objeto se devuelve de una Búsqueda llamadas correctas. |
Search |
Objeto result para una respuesta de API de Búsqueda. |
Search |
Uno de los valores siguientes:
|
Search |
Objeto de resumen de una respuesta de API de Búsqueda. |
Address
Dirección del resultado
Nombre | Tipo | Description |
---|---|---|
boundingBox |
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 |
|
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 forma abreviada. 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 |
municipality |
string |
Ciudad/Ciudad |
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[] |
Los 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 |
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 |
Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon". |
BoundingBox
Ventanilla que cubre el resultado representado por las coordenadas superior izquierda e inferior derecha de la ventanilla.
Nombre | Tipo | Description |
---|---|---|
btmRightPoint |
Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon". |
|
topLeftPoint |
Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon". |
BoundingBoxCompassNotation
Cuadro de límite de la ubicación.
Nombre | Tipo | Description |
---|---|---|
entity |
Origen del tipo de entidad del rectángulo de selección. 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 devuelve
Nombre | Tipo | Description |
---|---|---|
code |
string |
Propiedad code |
names |
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 get Búsqueda Polygon API.
Nombre | Tipo | Description |
---|---|---|
geometry |
Información sobre la forma geométrica del resultado. Solo está presente si el tipo == Geography. |
ElectricVehicleConnector
Lista separada por comas de tipos de conectores que se podrían usar para restringir el resultado a la estación de vehículos eléctricos que admita tipos de conector específicos. No importa el orden de los elementos. Cuando se proporcionan varios tipos de conectores, solo se devolverán los resultados que pertenecen a (al menos) una de las listas proporcionadas.
Los tipos de conector disponibles son:
-
StandardHouseholdCountrySpecific
- Estos son los conectores domésticos estándar para una determinada región. Son todas las fases únicas de CA y el voltaje estándar y el amperaje estándar. Consulte también: Plug & socket types - World Standards. -
IEC62196Type1
- Conector de tipo 1 tal y como se define en el estándar IEC 62196-2. También llamado Yazaki después del fabricante original o SAE J1772 después del estándar que lo publicó por primera vez. Se usa principalmente en combinación con una sola fase de 120V o una infraestructura de una sola fase de hasta 240V. -
IEC62196Type1CCS
- Conector combinado basado en 1 según se define en el estándar IEC 62196-3. El conector se basa en el conector type 1 , tal como se define en el estándar IEC 62196-2, con dos contactos adicionales de corriente directa (DC) para permitir la carga rápida del controlador de dominio. -
IEC62196Type2CableAttached
- Conector de tipo 2 tal y como se define en el estándar IEC 62196-2. Proporcionado como cable y conectado al punto de carga. -
IEC62196Type2Outlet
- Conector de tipo 2 tal y como se define en el estándar IEC 62196-2. Se proporciona como un socket establecido en el punto de carga. -
IEC62196Type2CCS
- Conector combinado basado en 2, tal como se define en el estándar IEC 62196-3. El conector se basa en el conector type 2 , tal como se define en el estándar IEC 62196-2, con dos contactos adicionales de corriente directa (DC) para permitir la carga rápida del controlador de dominio. -
IEC62196Type3
- Conector de tipo 3 tal y como se define en el estándar IEC 62196-2. También llamado Scame después del fabricante original. Se usa principalmente en combinación con una sola fase de hasta 240V o hasta una infraestructura de tres fases de 420V. -
Chademo
- Conector CHAdeMO denominado después de una asociación formada por tokyo Electric Power Company y socios industriales. Debido a esto, también se conoce como conector de TEPCO. Admite una carga de DC rápida. -
IEC60309AC1PhaseBlue
- Industrial Blue Connector es un conector definido en el estándar IEC 60309. En algún momento se conoce como por alguna combinación del estándar, el color y el hecho de que es un conector de una sola fase. Normalmente, el conector tiene la configuración "P+N+E, 6h". -
IEC60309DCWhite
- Conector blanco industrial es un conector dc definido en el estándar IEC 60309. -
Tesla
- El conector Tesla es el conector Tesla Supercharger específico regionalmente. Es decir, hace referencia al conector propietario de Tesla, que a veces se conoce como Tesla Port principalmente limitado a Norteamérica o al tipo 2 modificado (DC sobre el tipo 2) en Europa.
Ejemplos de uso:
connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Nombre | Tipo | Description |
---|---|---|
Chademo |
string |
Conector CHAdeMO denominado después de una asociación formada por tokyo Electric Power Company y socios industriales. Debido a esto, también se conoce como conector de TEPCO. Admite una carga de DC rápida. |
IEC60309AC1PhaseBlue |
string |
El conector Industrial Blue es un conector definido en el estándar IEC 60309. En algún momento se conoce como por alguna combinación del estándar, el color y el hecho de que es un conector de una sola fase. Normalmente, el conector tiene la configuración "P+N+E, 6h". |
IEC60309DCWhite |
string |
El conector Industrial White es un conector dc definido en el estándar IEC 60309. |
IEC62196Type1 |
string |
Conector de tipo 1 tal y como se define en el estándar IEC 62196-2. También llamado Yazaki después del fabricante original o SAE J1772 después del estándar que lo publicó por primera vez. Se usa principalmente en combinación con una sola fase de 120V o una infraestructura de una sola fase de hasta 240V. |
IEC62196Type1CCS |
string |
Conector combinado basado en tipo 1 tal y como se define en la norma IEC 62196-3. El conector se basa en el conector type 1 , tal como se define en el estándar IEC 62196-2, con dos contactos adicionales de corriente directa (DC) para permitir la carga rápida del controlador de dominio. |
IEC62196Type2CCS |
string |
Conector combinado basado en tipo 2 tal y como se define en el estándar IEC 62196-3. El conector se basa en el conector type 2 , tal como se define en el estándar IEC 62196-2, con dos contactos adicionales de corriente directa (DC) para permitir la carga rápida del controlador de dominio. |
IEC62196Type2CableAttached |
string |
Conector de tipo 2 tal y como se define en el estándar IEC 62196-2. Proporcionado como cable y conectado al punto de carga |
IEC62196Type2Outlet |
string |
Conector de tipo 2 tal y como se define en el estándar IEC 62196-2. Se proporciona como un socket establecido en el punto de carga. |
IEC62196Type3 |
string |
Conector de tipo 3 tal y como se define en el estándar IEC 62196-2. También llamado Scame después del fabricante original. Se usa principalmente en combinación con una sola fase de hasta 240V o hasta una infraestructura de tres fases de 420V. |
StandardHouseholdCountrySpecific |
string |
Estos son los conectores domésticos estándar para una determinada región. Son todas las fases únicas de CA y el voltaje estándar y el amperaje estándar. Consulte también: Plug & socket types - World Standards |
Tesla |
string |
El conector Tesla es el conector Tesla Supercharger específico regionalmente. Es decir, hace referencia al conector propietario de Tesla, que a veces se conoce como Tesla Port principalmente limitado a Norteamérica o al tipo 2 modificado (DC sobre el tipo 2) en Europa. |
Entity
Origen del tipo de entidad del rectángulo de selección. Para la geocodificación inversa, siempre es igual a la posición.
Nombre | Tipo | Description |
---|---|---|
position |
string |
Entidad position |
EntryPoint
Punto de entrada para el PUNTO de interés que se devuelve.
Nombre | Tipo | Description |
---|---|---|
position |
Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon". |
|
type |
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 |
Información adicional del error. |
|
code |
string |
Código de error. |
details |
Los detalles del error. |
|
message |
string |
El mensaje de error. |
target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
GeographicEntityType
Tipo de entidad Geography. Solo está presente 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. |
LatLongPairAbbreviated
Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon".
Nombre | Tipo | Description |
---|---|---|
lat |
number |
Propiedad Latitude |
lon |
number |
Longitud (propiedad) |
LocalizedMapView
El parámetro View (también denominado parámetro "user region") le permite mostrar los mapas correctos para un determinado país o región para las regiones controvertidas geopolíticamente. Los distintos países o regiones tienen diferentes vistas 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 que la aplicación va a atender. De forma predeterminada, el parámetro View se establece en "Unified" aunque no lo haya definido en la solicitud. Es su responsabilidad determinar la ubicación de sus usuarios y luego establecer el parámetro Vista correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa según la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relacionadas con la asignación, del país o región en el que están disponibles mapas, imágenes y otros datos y contenido de terceros a los que está autorizado para acceder a través de Azure Maps. Ejemplo: view=IN.
Consulte Vistas admitidas para obtener más información y ver las vistas disponibles.
Nombre | Tipo | Description |
---|---|---|
AE |
string |
Emiratos Árabes Unidos (vista árabe) |
AR |
string |
Argentina (vista argentina) |
Auto |
string |
Devuelva los datos del mapa según la dirección IP de la solicitud. |
BH |
string |
Baréin (vista árabe) |
IN |
string |
India (vista india) |
IQ |
string |
Irak (vista árabe) |
JO |
string |
Jordania (vista árabe) |
KW |
string |
Kuwait (vista árabe) |
LB |
string |
Líbano (vista árabe) |
MA |
string |
Marruecos (vista marroquí) |
OM |
string |
Omán (vista árabe) |
PK |
string |
Pakistán (vista pakistaní) |
PS |
string |
Autoridad Nacional Palestina (vista árabe) |
QA |
string |
Catar (vista árabe) |
SA |
string |
Arabia Saudí (vista árabe) |
SY |
string |
Siria (vista árabe) |
Unified |
string |
Vista unificada (otros) |
YE |
string |
Yemen (vista árabe) |
MatchType
Tipos de coincidencias 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 |
Lista de intervalos de tiempo para los próximos 7 días |
OperatingHoursRange
Horas de funcionamiento de un POI (Puntos de interés). La disponibilidad de las horas de funcionamiento variará en función de los datos disponibles. Si no se pasa, no se devolverá información del horario de apertura. Valor admitido: nextSevenDays
Nombre | Tipo | Description |
---|---|---|
nextSevenDays |
string |
Muestra las horas de funcionamiento de la semana siguiente, empezando por el día actual en la hora local del POI. |
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 |
El punto en el intervalo de 7 días siguiente cuando se cierra una poi determinada, o el principio del intervalo si se cerró antes del intervalo. |
|
startTime |
El punto en el intervalo de 7 días siguiente cuando se abre una poi determinada, o el principio del intervalo si se abrió antes del intervalo. |
PointOfInterest
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 POI que se va a devolver. |
categories |
string[] |
Matriz de categorías |
categorySet |
Lista de las categorías de POI más específicas |
|
classifications |
Matriz de clasificación |
|
name |
string |
Nombre de la propiedad POI |
openingHours |
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 |
PointOfInterestExtendedPostalCodes
Índices para los que se deben incluir códigos postales extendidos en los resultados.
Los índices disponibles son:
POI = Puntos de interés
El valor debe ser POI o None para deshabilitar los códigos postales extendidos.
De forma predeterminada, se incluyen códigos postales extendidos.
Ejemplos de uso:
extendedPostalCodesFor=POI
extendedPostalCodesFor=None
El código postal extendido se devuelve como una propiedad extendedPostalCode de una dirección. La disponibilidad depende de la región.
Nombre | Tipo | Description |
---|---|---|
None |
string |
|
POI |
string |
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 sesgo en una determinada latitud y longitud, y ningún radio definido |
ResponseFormat
Formato deseado de la respuesta. El valor puede ser json o xml.
Nombre | Tipo | Description |
---|---|---|
json |
string |
Formato de intercambio de datos de notación de objetos JavaScript |
xml |
string |
SearchAddressResult
Este objeto se devuelve de una Búsqueda llamadas correctas.
Nombre | Tipo | Description |
---|---|---|
results |
Una lista de los resultados de la API de Búsqueda. |
|
summary |
Objeto summary para una respuesta de API de Búsqueda |
SearchAddressResultItem
Objeto result para una respuesta de API de Búsqueda.
Nombre | Tipo | 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. |
|
dataSources |
Sección opcional. Identificador 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 |
Tipo de entidad Geography. Solo está presente cuando se solicitó entityType y está disponible. |
|
entryPoints |
Matriz de EntryPoints. Los que describen los tipos de entradas disponibles en la ubicación. El tipo puede ser "principal" 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 las solicitudes de soporte técnico. |
matchType |
Información sobre el tipo de coincidencia. Uno de los valores siguientes:
|
|
poi |
Detalles de la POI devuelta, incluida información como el nombre, el teléfono, la dirección URL y las clasificaciones. |
|
position |
Una ubicación representada como 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án diseñados como un valor relativo para un conjunto de resultados. |
type |
Uno de los valores siguientes:
|
|
viewport |
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 de resumen de una respuesta de API de Búsqueda.
Nombre | Tipo | Description |
---|---|---|
fuzzyLevel |
integer |
Nivel máximo aproximado necesario para proporcionar resultados. |
geoBias |
Indicación cuando 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 |
Tipo de consulta que se devuelve: NEARBY o NON_NEAR. |
|
totalResults |
integer |
Número total de resultados encontrados. |