Search - Get Search Fuzzy
Use cuando necesite una solicitud de búsqueda que pueda controlar combinaciones de direcciones y tokens de POI.
La API Get Search Fuzzy (búsqueda de formulario libre), una solicitud de GET HTTP que controla sin problemas una combinación de de búsqueda de PUNTOS de interés y . Se trata de una API de búsqueda de formulario libre que controla aproximadamente las entradas que contienen cualquier combinación de tokens de dirección o poi como una "búsqueda de una sola línea" canónica. También se puede ponderar con una posición contextual (par lat/lon) o totalmente restringido por una coordenada y radio, o bien se puede ejecutar más generalmente sin ningún punto de anclaje de sesgo geográfico.
Le recomendamos encarecidamente que use el parámetro "countrySet" para especificar solo los países o regiones para los que la aplicación necesita cobertura, ya que el comportamiento predeterminado será buscar en todo el mundo, lo que podría devolver resultados innecesarios.
Por ejemplo: countrySet=US,FR
Consulte de cobertura de búsqueda para obtener una lista completa de todos los países o regiones admitidos.
La mayoría de las consultas de búsqueda de forma predeterminada maxFuzzyLevel=2 para obtener rendimiento y también reducir los resultados inusuales. Este nuevo valor predeterminado se puede invalidar según sea necesario por solicitud pasando el parámetro de consulta maxFuzzyLevel=3 o 4.
GET https://atlas.microsoft.com/search/fuzzy/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/fuzzy/{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}&minFuzzyLevel={minFuzzyLevel}&maxFuzzyLevel={maxFuzzyLevel}&idxSet={idxSet}&brandSet={brandSet}&connectorSet={connectorSet}&entityType={entityType}&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 |
Cadena de consulta aplicable (por ejemplo, "seattle", "pizza"). También puede especificarse como una cadena separada por comas compuesta por latitud seguida de longitud (por ejemplo, "47.641268, -122.125679"). Debe estar codificada correctamente con la dirección URL. |
|
brand
|
query |
string[] |
Una 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 "," en su nombre deben colocarse 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 de selección. 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 valores de
|
|
|
connector
|
query |
Una 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 admite tipos de conector específicos. No importa el orden de los elementos. Cuando se proporcionan varios tipos de conector, 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=IEC62196Tipo2CableConectorConjunto=IEC62196Tipo2Toma,IEC62196Tipo2CableConectado |
||
|
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. |
|
|
entity
|
query |
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:
|
||
|
extended
|
query |
Índices para los que los códigos postales extendidos deben incluirse en los resultados. Los índices disponibles son: Addr = Intervalos de direcciones Geo = Geografías PAD = Direcciones de punto POI = Puntos de interés Str = Calles 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. |
||
|
idx
|
query |
Lista separada por comas de índices que se deben utilizar para la búsqueda. No importa el orden de los elementos. Los índices disponibles son: Addr = Interpolación de intervalos de direcciones, Geo = Geografías, PAD = Direcciones de punto, POI = Puntos de interés, Str = Calles, Xstr = Calles cruzadas (intersecciones) |
||
|
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: 1maximum: 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 |
|
|
max
|
query |
integer minimum: 1maximum: 4 |
Nivel máximo de profundidad que se va a usar. Valor predeterminado: 2, mínimo: 1 y máximo: 4
El motor de búsqueda comenzará a buscar una coincidencia en el nivel definido por minFuzzyLevel y dejará de buscar en el nivel especificado por maxFuzzyLevel. |
|
|
min
|
query |
integer minimum: 1maximum: 4 |
Nivel mínimo de difusa que se va a usar. Valor predeterminado: 1, mínimo: 1 y máximo: 4
El motor de búsqueda comenzará a buscar una coincidencia en el nivel definido por minFuzzyLevel y dejará de buscar en el nivel especificado por maxFuzzyLevel. |
|
|
ofs
|
query |
integer minimum: 0maximum: 1900 |
Desplazamiento inicial de los resultados devueltos dentro del conjunto de resultados completo. Valor predeterminado: 0 |
|
|
opening
|
query |
Horas de funcionamiento de una POI (Puntos de interés). La disponibilidad de 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 a para que los resultados se restrinjan al área definida. |
|
|
top
|
query |
string |
Posición superior izquierda del rectángulo de selección. Por ejemplo, 37.553,-122.453 |
|
|
typeahead
|
query |
boolean |
Si se activa la bandera de tipeado, 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 "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 |
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 |
De acuerdo |
|
| Other Status Codes |
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-idpara 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 URLes 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 City Seattle
Solicitud de ejemplo
GET https://atlas.microsoft.com/search/fuzzy/json?api-version=1.0&query=seattle&openingHours=nextSevenDays
Respuesta de muestra
{
"summary": {
"query": "seattle",
"queryType": "NON_NEAR",
"queryTime": 66,
"numResults": 10,
"offset": 0,
"totalResults": 3720,
"fuzzyLevel": 1
},
"results": [
{
"type": "Geography",
"id": "US/GEO/p0/188055",
"score": 2.531,
"entityType": "Municipality",
"address": {
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "Seattle, WA",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.60323,
"lon": -122.33028
},
"viewport": {
"topLeftPoint": {
"lat": 47.7344,
"lon": -122.4594
},
"btmRightPoint": {
"lat": 47.48106,
"lon": -122.22497
}
},
"dataSources": {
"geometry": {
"id": "00005557-4100-3c00-0000-0000596ae8ed"
}
}
},
{
"type": "Geography",
"id": "US/GEO/p0/183911",
"score": 2.382,
"entityType": "Municipality",
"address": {
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countrySubdivisionCode": "WA",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "Seattle, WA",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.55342,
"lon": -122.25007
},
"viewport": {
"topLeftPoint": {
"lat": 47.58995,
"lon": -122.26723
},
"btmRightPoint": {
"lat": 47.5169,
"lon": -122.23291
}
},
"dataSources": {
"geometry": {
"id": "00005557-4100-3c00-0000-00006553f33d"
}
}
},
{
"type": "POI",
"id": "ZA/POI/p0/449288",
"score": 2.226,
"info": "search:ta:710009004165863-ZA",
"poi": {
"name": "Seattle Coffee Co - Groote Kerk Sentrum",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Kloof Street",
"municipalitySubdivision": "Cape Town",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "8001",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Kloof Street, Gardens, City of Cape Town, Western Cape, 8001",
"localName": "Gardens"
},
"position": {
"lat": -33.92917,
"lon": 18.41178
},
"viewport": {
"topLeftPoint": {
"lat": -33.92827,
"lon": 18.4107
},
"btmRightPoint": {
"lat": -33.93007,
"lon": 18.41286
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -33.92907,
"lon": 18.41162
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/449396",
"score": 2.226,
"info": "search:ta:710009004163591-ZA",
"poi": {
"name": "Seattle Coffee Co - Pietermaritzburg",
"phone": "+(27)-(33)-3458486",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "9",
"streetName": "Armitage Road",
"municipalitySubdivision": "Pietermaritzburg City, Pietermaritzburg",
"municipality": "Pietermaritzburg",
"countrySecondarySubdivision": "The Msunduzi",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "3201",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Armitage Road 9, Athlone, The Msunduzi, KwaZulu-Natal, 3201",
"localName": "Athlone"
},
"position": {
"lat": -29.58611,
"lon": 30.37508
},
"viewport": {
"topLeftPoint": {
"lat": -29.58521,
"lon": 30.37405
},
"btmRightPoint": {
"lat": -29.58701,
"lon": 30.37611
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -29.58668,
"lon": 30.37531
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/451868",
"score": 2.226,
"info": "search:ta:710009002195538-ZA",
"poi": {
"name": "Seattle Coffee Co - Bedford Village",
"phone": "+(27)-(84)-5451111",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Van Buuren Road",
"municipalitySubdivision": "Bedfordview",
"municipality": "Germiston",
"countrySecondarySubdivision": "Ekurhuleni",
"countrySubdivisionCode": "Gauteng",
"postalCode": "2007",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Van Buuren Road, Bedfordview, Ekurhuleni, Gauteng, 2007",
"localName": "Bedfordview"
},
"position": {
"lat": -26.18009,
"lon": 28.13544
},
"viewport": {
"topLeftPoint": {
"lat": -26.17919,
"lon": 28.13444
},
"btmRightPoint": {
"lat": -26.18099,
"lon": 28.13644
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -26.18006,
"lon": 28.13636
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/488888",
"score": 2.226,
"info": "search:ta:710009002102639-ZA",
"poi": {
"name": "Seattle Coffee Co - Caltex Starstop Milly's",
"phone": "+(27)-(13)-2560340",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipality": "Wonderfontein",
"countrySecondarySubdivision": "Emakhazeni",
"countrySubdivisionCode": "Mpumalanga",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Wonderfontein, Emakhazeni, Mpumalanga"
},
"position": {
"lat": -25.68842,
"lon": 30.21291
},
"viewport": {
"topLeftPoint": {
"lat": -25.68752,
"lon": 30.21191
},
"btmRightPoint": {
"lat": -25.68932,
"lon": 30.21391
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -25.68913,
"lon": 30.21343
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/489433",
"score": 2.226,
"info": "search:ta:710009002184068-ZA",
"poi": {
"name": "Seattle Coffee Co - Southcoast Mall",
"phone": "+(27)-(39)-3150816",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipalitySubdivision": "Shelly Beach",
"municipality": "Shelly Beach",
"countrySecondarySubdivision": "Hibiscus Coast",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "4265",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265",
"localName": "Shelly Beach"
},
"position": {
"lat": -30.79937,
"lon": 30.40569
},
"viewport": {
"topLeftPoint": {
"lat": -30.79847,
"lon": 30.40464
},
"btmRightPoint": {
"lat": -30.80027,
"lon": 30.40674
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -30.7994,
"lon": 30.40618
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/489976",
"score": 2.226,
"info": "search:ta:710009004261897-ZA",
"poi": {
"name": "Seattle Cofee Co",
"phone": "+(27)-(39)-3150816",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"municipalitySubdivision": "Shelly Beach",
"municipality": "Shelly Beach",
"countrySecondarySubdivision": "Hibiscus Coast",
"countrySubdivisionCode": "KwaZulu-Natal",
"postalCode": "4265",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265",
"localName": "Shelly Beach"
},
"position": {
"lat": -30.79801,
"lon": 30.40557
},
"viewport": {
"topLeftPoint": {
"lat": -30.79711,
"lon": 30.40452
},
"btmRightPoint": {
"lat": -30.79891,
"lon": 30.40662
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -30.79784,
"lon": 30.40523
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/490056",
"score": 2.226,
"info": "search:ta:710009004149612-ZA",
"poi": {
"name": "Seattle Coffee Co - Constantia Village",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Constantia Main Road",
"municipalitySubdivision": "Cape Town",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "7708",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Constantia Main Road, Constantia, City of Cape Town, Western Cape, 7708",
"localName": "Constantia"
},
"position": {
"lat": -34.02087,
"lon": 18.44503
},
"viewport": {
"topLeftPoint": {
"lat": -34.01997,
"lon": 18.44394
},
"btmRightPoint": {
"lat": -34.02177,
"lon": 18.44612
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -34.02017,
"lon": 18.44476
}
}
]
},
{
"type": "POI",
"id": "ZA/POI/p0/494340",
"score": 2.226,
"info": "search:ta:710009004152570-ZA",
"poi": {
"name": "Seattle Coffee Co - Canal Walk Shopping Centre",
"brands": [
{
"name": "Seattle Coffee Company"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.seattlecoffeecompany.co.za",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetName": "Century Boulevard",
"municipalitySubdivision": "Milnerton",
"municipality": "Cape Town",
"countrySecondarySubdivision": "City of Cape Town",
"countrySubdivisionCode": "Western Cape",
"postalCode": "7441",
"countryCode": "ZA",
"country": "South Africa",
"countryCodeISO3": "ZAF",
"freeformAddress": "Century Boulevard, Century City, City of Cape Town, Western Cape, 7441",
"localName": "Century City"
},
"position": {
"lat": -33.89348,
"lon": 18.5122
},
"viewport": {
"topLeftPoint": {
"lat": -33.89258,
"lon": 18.51112
},
"btmRightPoint": {
"lat": -33.89438,
"lon": 18.51328
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": -33.8943,
"lon": 18.51328
}
}
]
}
]
}
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 de inicio y finalización 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 la API de Get Search Polygon. |
|
Electric |
Una 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 admite tipos de conector específicos. No importa el orden de los elementos. Cuando se proporcionan varios tipos de conector, 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=IEC62196Tipo2CableConectorConjunto=IEC62196Tipo2Toma,IEC62196Tipo2CableConectado |
| Entity |
Origen del tipo de entidad del cuadro de límite. 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 secundaria. |
|
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. 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. |
|
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") 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. |
|
Match |
Tipos de coincidencias para una operación de búsqueda de direcciones inversas. |
|
Operating |
Horario de apertura de una POI (Puntos de interés). |
|
Operating |
Horas de funcionamiento de una POI (Puntos de interés). La disponibilidad de 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 |
|
Query |
Tipo de consulta que se devuelve: NEARBY o NON_NEAR. Importante: Esta propiedad está obsoleta y puede omitirse en la respuesta. |
|
Response |
Formato deseado de la respuesta. El valor puede ser json o xml. |
|
Search |
Este objeto se devuelve de una llamada de búsqueda correcta. |
|
Search |
Objeto result para una respuesta de Search API. |
|
Search |
Uno de los valores siguientes:
|
|
Search |
Índices para los que los códigos postales extendidos deben incluirse en los resultados. Los índices disponibles son: Addr = Intervalos de direcciones Geo = Geografías PAD = Direcciones de punto POI = Puntos de interés Str = Calles 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. |
|
Search |
Objeto summary para una respuesta de Search API. |
Address
Dirección del resultado.
| Nombre | Tipo | Description |
|---|---|---|
| boundingBox |
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 |
|
| buildingNumber |
string |
Número de edificio en la calle.
Importante: Esta propiedad está en desuso. En su lugar, use |
| 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 |
Esta propiedad no está disponible en la |
| 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 |
| 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 |
| 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 |
| 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 |
| municipality |
string |
Ciudad/Ciudad |
| 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 |
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 |
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.
| 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 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
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 la API de Get Search Polygon.
| Nombre | Tipo | Description |
|---|---|---|
| geometry |
Información sobre la forma geométrica del resultado. Solo está presente si el tipo == Geography. |
ElectricVehicleConnector
Una 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 admite tipos de conector específicos. No importa el orden de los elementos. Cuando se proporcionan varios tipos de conector, 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 amperaje estándar. Vea también: Plug & socket types - World Standards. -
IEC62196Type1: conector de tipo 1 tal como se define en el estándar IEC 62196-2. También se llama 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 la infraestructura de una sola fase de 120V o hasta 240V. -
IEC62196Type1CCS: conector combinado basado en tipo 1 tal como 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 como se define en el estándar IEC 62196-2. Se proporciona como cable y enchufe conectado al punto de carga. -
IEC62196Type2Outlet: conector de tipo 2 tal 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 el tipo 2 tal como se define en el estándar IEC 62196-3. El conector se basa en el conector type 2 , tal y 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 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 la carga rápida de DC. -
IEC60309AC1PhaseBlue: 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- Industrial White connector es un conector DC definido en el estándar IEC 60309. -
Tesla: el conector Tesla es el conector Tesla Supercharger específico de la región. 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=IEC62196Tipo2CableConectorConjunto=IEC62196Tipo2Toma,IEC62196Tipo2CableConectado
| Valor | Description |
|---|---|
| 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 amperaje estándar. Vea también: Plug & socket types - World Standards |
| IEC62196Type1 |
Conector de tipo 1 tal como se define en el estándar IEC 62196-2. También se llama 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 la infraestructura de una sola fase de 120V o hasta 240V. |
| IEC62196Type1CCS |
Conector combinado basado en tipo 1 tal como 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 como se define en el estándar IEC 62196-2. Se proporciona como cable y enchufe conectado al punto de carga |
| IEC62196Type2Outlet |
Conector de tipo 2 tal 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 el tipo 2 tal como se define en el estándar IEC 62196-3. El conector se basa en el conector type 2 , tal y 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 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 la carga rápida de DC. |
| IEC60309AC1PhaseBlue |
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 |
El conector Industrial White es un conector dc definido en el estándar IEC 60309. |
| Tesla |
El conector Tesla es el conector Tesla Supercharger específico de la región. 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 cuadro de límite. Para la geocodificación inversa, siempre es igual a la posición.
| Valor | Description |
|---|---|
| position |
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 secundaria. |
EntryPointType
Tipo de punto de entrada. El valor puede ser principal o secundaria.
| Valor | Description |
|---|---|
| main | |
| minor |
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 |
Detalles del error. |
|
| message |
string |
Mensaje de error. |
| target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
| Nombre | Tipo | Description |
|---|---|---|
| error |
Objeto de error. |
GeographicEntityType
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
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
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
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) |
| 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) |
| US |
Estados Unidos de América |
| YE |
Yemen (vista árabe) |
| Auto |
Devuelve los datos del mapa en función de la dirección IP de la solicitud. |
| Unified |
Vista unificada (otros) |
MatchType
Tipos de coincidencias para una operación de búsqueda de direcciones inversas.
| Valor | Description |
|---|---|
| AddressPoint | |
| HouseNumberRange | |
| Street |
OperatingHours
Horario de apertura de una 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 una POI (Puntos de interés). La disponibilidad de 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
| Valor | Description |
|---|---|
| nextSevenDays |
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 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
Intervalo de tiempo de apertura para un día
| Nombre | Tipo | Description |
|---|---|---|
| endTime |
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 |
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
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 |
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 una POI (Puntos de interés). |
|
| phone |
string |
Propiedad de número de teléfono |
| url |
string |
Propiedad URL del sitio web |
PointOfInterestCategorySet
Categoría poi
| Nombre | Tipo | Description |
|---|---|---|
| id |
integer |
Id. de categoría |
QueryType
Tipo de consulta que se devuelve: NEARBY o NON_NEAR.
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 |
ResponseFormat
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 |
SearchAddressResult
Este objeto se devuelve de una llamada de búsqueda correcta.
| Nombre | Tipo | Description |
|---|---|---|
| results |
Lista de resultados de Search API. |
|
| summary |
Objeto summary para una respuesta de Search API |
SearchAddressResultItem
Objeto result para una respuesta de Search API.
| 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 de inicio y finalización del intervalo de direcciones. |
|
| 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 |
Tipo de entidad Geography. Presente solo cuando se solicitó entityType y está disponible. |
|
| entryPoints |
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 |
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 (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 |
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
- Geografía
- Dirección del punto
- Intervalo de direcciones
- Cruce
| Valor | Description |
|---|---|
| POI | |
| Street | |
| Geography | |
| Point Address | |
| Address Range | |
| Cross Street |
SearchIndexes
Índices para los que los códigos postales extendidos deben incluirse en los resultados.
Los índices disponibles son:
Addr = Intervalos de direcciones
Geo = Geografías
PAD = Direcciones de punto
POI = Puntos de interés
Str = Calles
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
Objeto summary para una respuesta de Search API.
| Nombre | Tipo | Description |
|---|---|---|
| fuzzyLevel |
integer |
Nivel aproximado máximo necesario para proporcionar resultados. |
| geoBias |
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 |
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. |