Search - Post Search Inside Geometry
Use para realizar búsquedas de formulario libre dentro de una geometría más.
La Post Search Inside Geometry
API es yrequest where the request body will contain the
POST request that allows you to perform a free form search inside a single geometry or multiple geometries. The search results that fall inside the geometry/geometries will be returned.<br><br>To send the geometry you will use a
object represented as a
la aplicación. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following
de tipoheader will be set to
de contenido GeoJSON geoJSONtype and the
geometrycan be represented as a
GeoJSONtypes:<ul><li>**GeoJSON FeatureCollection** <br>The
FeatureCollection FeatureCollectionobject. This is the recommended option if the geometry contains both Polygons and Circles. The
GeoJSON Feature Característicaobject for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>A
de característica GeoJSONobject should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>A
objects. Each
Pointtype and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.</li></ul><br> Please see the Examples section below for a sample
Featureobject for the Circle geometry is composed of a _center_ represented using a
GeoJSONrepresentation.<br><br></li><li>**GeoJSON GeometryCollection**<br>The
Geometry Geometrycan be represented as a
GeoJSON GeometryCollection GeometryCollectioncan contain a max of 50
object. This is the recommended option if the geometry contains a list of Polygons only. The
GeoJSONobjects. Each
Polygon Polygonobject can have a max of 50 coordinates. Please see the Examples section below for a sample
GeometryCollectionrepresentation.<br><br></li><li>**GeoJSON Polygon**<br>The
can be represented as a
can contain a max of 50
Geometry GeoJSON Polygon Polygonobject. This is the recommended option if the geometry contains a single Polygon. The
object can have a max of 50 coordinates. Please see the Examples section below for a sample
Representación del polígono.
.
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}&limit={limit}&language={language}&categorySet={categorySet}&extendedPostalCodesFor={extendedPostalCodesFor}&idxSet={idxSet}&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", "pizza"). Debe estar codificada correctamente con la dirección URL. |
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
|
|
extended
|
query |
Índices para los que se deben incluir códigos postales extendidos en los resultados. Los índices disponibles son: Addr = Intervalos de direcciones Geo = Geographies PAD = Direcciones de punto POI = Puntos de interés Str = Calles XStr = Calles cruzadas (intersecciones) El valor debe ser una lista separada por comas de tipos de índice (en cualquier orden) o None 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 extendidos para 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 extendedPostalCode de una dirección. La disponibilidad depende de la región. |
||
idx
|
query |
Lista separada por comas de índices que se deben usar 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 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. |
|
limit
|
query |
integer |
Número máximo de respuestas que se devolverán. Valor predeterminado: 10, mínimo: 1 y máximo: 100 |
|
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 |
||
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. |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
geometry | GeoJsonObject: |
Objeto |
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 a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
- El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
- Para obtener más información sobre Plataforma de identidad de Microsoft, consulte Plataforma de identidad de Microsoft información general.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Se trata de una clave compartida que se aprovisiona al crear una cuenta de Azure Maps en el Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.
Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.
En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a Azure Maps API REST para que la clave se pueda almacenar de forma segura.
Tipo:
apiKey
En:
query
SAS Token
Se trata de un token de firma de acceso compartido que se crea a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.
En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.
Tipo:
apiKey
En:
header
Ejemplos
Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type
Solicitud de ejemplo
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=burger&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
-122.43576049804686,
37.7524152343544
],
[
-122.43301391601562,
37.70660472542312
],
[
-122.36434936523438,
37.712059855877314
],
[
-122.43576049804686,
37.7524152343544
]
]
]
},
{
"type": "Polygon",
"coordinates": [
[
[
-123.43576049804686,
37.7524152343544
],
[
-123.43301391601562,
37.70660472542312
],
[
-123.36434936523438,
37.712059855877314
],
[
-123.43576049804686,
37.7524152343544
]
]
]
}
]
}
}
Respuesta de muestra
{
"summary": {
"query": "burger",
"queryType": "NON_NEAR",
"queryTime": 21,
"numResults": 2,
"offset": 0,
"totalResults": 4,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "9P2i9inRyndAA-_V40J8oA",
"score": 2.0041828156,
"info": "search:ta:840061003419653-US",
"poi": {
"name": "Burger Joint",
"phone": "+1 415-349-4331",
"categorySet": [
{
"id": 7315015
}
],
"categories": [
"fast food",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "fast food"
}
]
}
]
},
"address": {
"streetNumber": "167",
"streetName": "Leland Avenue",
"municipality": "San Francisco",
"neighbourhood": "Visitacion Valley",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-2844",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.712228,
"lon": -122.407022
},
"viewport": {
"topLeftPoint": {
"lat": 37.71313,
"lon": -122.40816
},
"btmRightPoint": {
"lat": 37.71133,
"lon": -122.40589
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.71241,
"lon": -122.40693
}
}
]
},
{
"type": "POI",
"id": "hkr-N07YS6Gv2dOciQ9lwA",
"score": 2.0041515827,
"info": "search:ta:840067000526682-US",
"poi": {
"name": "Sound of Burgers",
"categorySet": [
{
"id": 7315
}
],
"categories": [
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "167",
"streetName": "Leland Avenue",
"municipality": "San Francisco",
"neighbourhood": "Visitacion Valley",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivision": "CA",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-2844",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.712228,
"lon": -122.407022
},
"viewport": {
"topLeftPoint": {
"lat": 37.71313,
"lon": -122.40816
},
"btmRightPoint": {
"lat": 37.71133,
"lon": -122.40589
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.71241,
"lon": -122.40693
}
}
]
}
]
}
Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type
Solicitud de ejemplo
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.143035,
47.653536
],
[
-122.187164,
47.617556
],
[
-122.114981,
47.570599
],
[
-122.132756,
47.654009
],
[
-122.143035,
47.653536
]
]
]
},
"properties": {}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.126986,
47.639754
]
},
"properties": {
"subType": "Circle",
"radius": 100
}
}
]
}
}
Respuesta de muestra
{
"summary": {
"query": "pizza",
"queryType": "NON_NEAR",
"queryTime": 34,
"numResults": 2,
"offset": 0,
"totalResults": 21,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "-UuwTye4GGsea4KmCLvoqQ",
"score": 2.1455535889,
"info": "search:ta:840537000108972-US",
"poi": {
"name": "Biryani & Pizza House",
"categorySet": [
{
"id": 7315036
}
],
"categories": [
"pizza",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "pizza"
}
]
}
]
},
"address": {
"streetNumber": "15025",
"streetName": "Northeast 24th Street",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countrySubdivision": "WA",
"countrySubdivisionName": "Washington",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "98052-5531",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15025 Northeast 24th Street, Redmond, WA 98052",
"localName": "Redmond"
},
"position": {
"lat": 47.630786,
"lon": -122.139302
},
"viewport": {
"topLeftPoint": {
"lat": 47.63169,
"lon": -122.14064
},
"btmRightPoint": {
"lat": 47.62989,
"lon": -122.13797
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63079,
"lon": -122.13931
}
},
{
"type": "main",
"position": {
"lat": 47.63147,
"lon": -122.13935
}
}
]
},
{
"type": "POI",
"id": "7r095LCcCSkdoGoeLcnvsQ",
"score": 2.1454992294,
"info": "search:ta:840537000103468-US",
"poi": {
"name": "Pagliacci Pizza",
"categorySet": [
{
"id": 7315036
}
],
"url": "www.pagliacci.com/",
"categories": [
"pizza",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "pizza"
}
]
}
],
"openingHours": {
"mode": "nextSevenDays",
"timeRanges": [
{
"startTime": {
"date": "2024-03-14",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-14",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-17",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-17",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-18",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-18",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-19",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-19",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-20",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-20",
"hour": 11,
"minute": 0
}
}
]
}
},
"address": {
"streetNumber": "15238",
"streetName": "Bel Red Road",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countrySubdivision": "WA",
"countrySubdivisionName": "Washington",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"extendedPostalCode": "98007-3815",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15238 Bel Red Road, Bellevue, WA 98007",
"localName": "Bellevue"
},
"position": {
"lat": 47.628008,
"lon": -122.13646
},
"viewport": {
"topLeftPoint": {
"lat": 47.62891,
"lon": -122.13779
},
"btmRightPoint": {
"lat": 47.62711,
"lon": -122.13513
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6283,
"lon": -122.13611
}
}
]
}
]
}
Search for subs joints inside a geometry represented as a GeoJSON Polygon type
Solicitud de ejemplo
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=subs&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.43576049804686,
37.7524152343544
],
[
-122.43301391601562,
37.70660472542312
],
[
-122.36434936523438,
37.712059855877314
],
[
-122.43576049804686,
37.7524152343544
]
]
]
}
}
Respuesta de muestra
{
"summary": {
"query": "subs",
"queryType": "NON_NEAR",
"queryTime": 42,
"numResults": 2,
"offset": 0,
"totalResults": 5,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "HOIWGiNwVv0z6bF8MO3EbA",
"score": 2.1455111504,
"info": "search:ta:840069009512242-US",
"poi": {
"name": "Adams Grub Truck",
"phone": "+1 415-307-8844",
"categorySet": [
{
"id": 7315042
}
],
"categories": [
"restaurant",
"sandwich"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "sandwich"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "1465",
"streetName": "Carroll Avenue",
"municipality": "San Francisco",
"neighbourhood": "Bayview",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94124",
"extendedPostalCode": "94124-3604",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1465 Carroll Avenue, San Francisco, CA 94124",
"localName": "San Francisco"
},
"position": {
"lat": 37.72328,
"lon": -122.39091
},
"viewport": {
"topLeftPoint": {
"lat": 37.72418,
"lon": -122.39205
},
"btmRightPoint": {
"lat": 37.72238,
"lon": -122.38977
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.72348,
"lon": -122.39073
}
}
]
},
{
"type": "POI",
"id": "bXbc0QxTRlkSo8GnU7EU-Q",
"score": 2.1454677582,
"info": "search:ta:840061001992959-US",
"poi": {
"name": "SUBWAY San Francisco San Francisco",
"phone": "+1 415-657-9898",
"brands": [
{
"name": "SUBWAY"
}
],
"categorySet": [
{
"id": 7315042
}
],
"categories": [
"restaurant",
"sandwich"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "sandwich"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
],
"openingHours": {
"mode": "nextSevenDays",
"timeRanges": [
{
"startTime": {
"date": "2024-03-13",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-13",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-14",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-14",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-15",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-15",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-16",
"hour": 9,
"minute": 0
},
"endTime": {
"date": "2024-03-16",
"hour": 21,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-17",
"hour": 9,
"minute": 0
},
"endTime": {
"date": "2024-03-17",
"hour": 21,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-18",
"hour": 8,
"minute": 0
},
"endTime": {
"date": "2024-03-18",
"hour": 20,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-19",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-19",
"hour": 21,
"minute": 30
}
}
]
}
},
"address": {
"streetNumber": "2599",
"streetName": "San Bruno Avenue",
"municipality": "San Francisco",
"neighbourhood": "Portola",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivision": "CA",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-1504",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "2599 San Bruno Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.729004,
"lon": -122.403956
},
"viewport": {
"topLeftPoint": {
"lat": 37.7299,
"lon": -122.40509
},
"btmRightPoint": {
"lat": 37.7281,
"lon": -122.40282
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.72892,
"lon": -122.40414
}
}
]
}
]
}
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. |
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 se presenta cuando se solicitó entityType y está disponible. |
Geo |
Tipo de objeto válido |
Geo |
Tipo de objeto válido |
Geo |
Objeto geometry válido |
Geo |
Tipo de objeto válido |
Geo |
Un tipo de geometría válido |
Geo |
Un tipo de geometría válido |
Geo |
Un tipo de geometría válido |
Geo |
Tipo de objeto válido |
Geo |
Un tipo de geometría válido |
Geo |
Un tipo de geometría válido |
Geometry |
Información sobre la forma geométrica del resultado. Solo está presente si el tipo == Geography. |
Lat |
Una ubicación representada como una 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 la 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. |
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 API de Búsqueda. |
Search |
Uno de los valores siguientes:
|
Search |
Índices para los que se deben incluir códigos postales extendidos en los resultados. Los índices disponibles son: Addr = Intervalos de direcciones Geo = Geographies 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 None para ningún índice. De forma predeterminada, se incluyen códigos postales extendidos 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 extendedPostalCode de una dirección. La disponibilidad depende de la región. |
Search |
Este tipo representa el cuerpo de la solicitud del servicio Búsqueda Inside Geometry. |
Search |
Objeto summary para 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 un formulario abreviado. Solo se admite para ESTADOS UNIDOS, Canadá y Reino Unido. |
countryTertiarySubdivision |
string |
Área con nombre |
crossStreet |
string |
Nombre de la calle que se cruza. |
extendedPostalCode |
string |
Código postal extendido (la disponibilidad depende de la región). |
freeformAddress |
string |
Una línea de dirección con formato según las reglas de formato del país o región de origen de un resultado, o en el caso de un país o región, su nombre completo de país o región. |
localName |
string |
Componente de dirección que representa el nombre de un área geográfica o localidad que agrupa varios objetos direccionables con fines de direccionamiento, sin ser una unidad administrativa. Este campo se usa para compilar la |
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[] |
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. |
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 se presenta cuando se solicitó entityType y está disponible.
Nombre | Tipo | Description |
---|---|---|
Country |
string |
nombre de país o región |
CountrySecondarySubdivision |
string |
County |
CountrySubdivision |
string |
Estado o provincia |
CountryTertiarySubdivision |
string |
Área con nombre |
Municipality |
string |
Ciudad/Ciudad |
MunicipalitySubdivision |
string |
Sub/Super City |
Neighbourhood |
string |
Barrio |
PostalCodeArea |
string |
Código postal/código postal |
GeoJsonFeature
Tipo de objeto válido GeoJSON Feature
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
featureType |
string |
Tipo de la característica. El valor depende del modelo de datos del que forma parte la característica actual. Algunos modelos de datos pueden tener un valor vacío. |
geometry | GeoJsonGeometry: |
Objeto geometry válido |
id |
string |
Identificador de la característica. |
type |
string:
Feature |
Especifica el tipo |
GeoJsonFeatureCollection
Tipo de objeto válido GeoJSON FeatureCollection
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
features |
Contiene una lista de objetos válidos |
|
type |
string:
Feature |
Especifica el tipo |
GeoJsonGeometry
Objeto geometry válido GeoJSON
. El tipo debe ser uno de los siete tipos de geometría GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon y GeometryCollection. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
type |
Geo |
Especifica el tipo |
GeoJsonGeometryCollection
Tipo de objeto válido GeoJSON GeometryCollection
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
Contiene una lista de objetos geometry válidos |
type |
string:
Geometry |
Especifica el tipo |
GeoJsonLineString
Un tipo de geometría válido GeoJSON LineString
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Coordenadas de la |
type |
string:
Line |
Especifica el tipo |
GeoJsonMultiLineString
Un tipo de geometría válido GeoJSON MultiLineString
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Coordenadas de la |
type |
string:
Multi |
Especifica el tipo |
GeoJsonMultiPoint
Un tipo de geometría válido GeoJSON MultiPoint
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Coordenadas de la |
type |
string:
Multi |
Especifica el tipo |
GeoJsonMultiPolygon
Tipo de objeto válido GeoJSON MultiPolygon
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Contiene una lista de objetos válidos |
type |
string:
Multi |
Especifica el tipo |
GeoJsonPoint
Un tipo de geometría válido GeoJSON Point
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
A |
type |
string:
Point |
Especifica el tipo |
GeoJsonPolygon
Un tipo de geometría válido GeoJSON Polygon
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Coordenadas para el |
type |
string:
Polygon |
Especifica el tipo |
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 una latitud y longitud con nombres cortos "lat" & "lon".
Nombre | Tipo | Description |
---|---|---|
lat |
number |
Latitude (propiedad) |
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 la información como el nombre, el teléfono, la dirección URL y las clasificaciones.
Nombre | Tipo | Description |
---|---|---|
brands |
Brand[] |
Matriz de marcas. Nombre de la marca para la poi que se va a devolver. |
categories |
string[] |
Matriz de categorías |
categorySet |
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 |
QueryType
Tipo de consulta que se devuelve: NEARBY o NON_NEAR.
Nombre | Tipo | Description |
---|---|---|
NEARBY |
string |
Búsqueda se realizó alrededor de una determinada latitud y longitud con un radio definido |
NON_NEAR |
string |
Búsqueda se realizó globalmente, sin sesgos en una determinada latitud y longitud, y sin radio definido |
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 llamada de Búsqueda correcta.
Nombre | Tipo | Description |
---|---|---|
results |
Lista de 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. Id. de geometría de referencia para su uso con get Búsqueda Polygon API. |
|
detourTime |
integer |
Tiempo de desvío en segundos. Solo se devuelve para las llamadas a Búsqueda Along Route API. |
dist |
number |
Distancia recta entre el resultado y la ubicación de geobias en metros. |
entityType |
Tipo de entidad Geography. Solo se presenta 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 "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 la información como el nombre, el teléfono, la dirección URL y las clasificaciones. |
|
position |
Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon". |
|
score |
number |
Valor de un conjunto de resultados para indicar la puntuación de coincidencia relativa entre los resultados. Puede usarlo para determinar que el resultado x es el doble de probabilidad de ser tan relevante como resultado y si el valor de x es 2x el valor de y. Los valores varían entre las consultas y solo está pensado como un valor relativo para un conjunto de resultados. |
type |
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 |
SearchIndexes
Índices para los que se deben incluir códigos postales extendidos en los resultados.
Los índices disponibles son:
Addr = Intervalos de direcciones
Geo = Geographies
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 None para ningún índice.
De forma predeterminada, se incluyen códigos postales extendidos 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 extendedPostalCode de una dirección. La disponibilidad depende de la región.
Nombre | Tipo | Description |
---|---|---|
Addr |
string |
|
Geo |
string |
|
PAD |
string |
|
POI |
string |
|
Str |
string |
|
Xstr |
string |
SearchInsideGeometryRequest
Este tipo representa el cuerpo de la solicitud del servicio Búsqueda Inside Geometry.
Nombre | Tipo | Description |
---|---|---|
geometry | GeoJsonObject: |
Objeto |
SearchSummary
Objeto summary para una respuesta de api de Búsqueda.
Nombre | Tipo | Description |
---|---|---|
fuzzyLevel |
integer |
Nivel máximo aproximado necesario para proporcionar resultados. |
geoBias |
Indicación de cuándo el motor de búsqueda interno ha aplicado un sesgo geoespacial para mejorar la clasificación de los resultados. En algunos métodos, esto puede verse afectado estableciendo los parámetros lat y lon cuando están disponibles. En otros casos es puramente interno. |
|
limit |
integer |
Número máximo de respuestas que se devolverán |
numResults |
integer |
Número de resultados en la respuesta. |
offset |
integer |
Desplazamiento inicial de los resultados devueltos dentro del conjunto de resultados completo. |
query |
string |
Parámetro de consulta que se usó para generar estos resultados de búsqueda. |
queryTime |
integer |
Tiempo dedicado a resolver la consulta, en milisegundos. |
queryType |
Tipo de consulta que se devuelve: NEARBY o NON_NEAR. |
|
totalResults |
integer |
Número total de resultados encontrados. |