Search - Post Search Inside Geometry

Referencia

Servicio:: Maps

Versión de la API:: 1.0

Use para realizar búsquedas de formulario libre dentro de una geometría más.

La API de Post Search Inside Geometry es y larequest where the request body will contain therequest where the request body will contain thegeometry 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. To send the geometry you will use a POSTobject represented as aGeoJSONtype and theheader will be set toapplication/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following GeoJSONtypes:<ul><li>**GeoJSON FeatureCollection** Thegeometrycan be represented as aGeoJSON FeatureCollectionobject. This is the recommended option if the geometry contains both Polygons and Circles. TheFeatureCollectioncan contain a max of 50Característica geoJSONobjects. Eachcaracterísticaobject should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>Acaracterísticaobject for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>ACaracterísticaobject for the Circle geometry is composed of a _center_ represented using apunto geoJSONtype 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> Please see the Examples section below for a sampleFeatureCollectionrepresentation. </li><li>**GeoJSON GeometryCollection** Thegeometrycan be represented as aGeoJSON GeometryCollectionobject. This is the recommended option if the geometry contains a list of Polygons only. TheGeometryCollectioncan contain a max of 50GeoJSON Polygonobjects. EachPolygonobject can have a max of 50 coordinates. Please see the Examples section below for a sampleGeometryCollectionrepresentation. </li><li>**GeoJSON Polygon** Thegeometrycan be represented as aGeoJSON Polygonobject. This is the recommended option if the geometry contains a single Polygon. ThePolygonobject can have a max of 50 coordinates. Please see the Examples section below for a samplePolygon'.

.

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

Con parámetros opcionales:

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	ResponseFormat	Formato deseado de la respuesta. El valor puede ser json o xml.
api-version	query	True	string	Número de versión de la API de Azure Maps.
query	query	True	string	Nombre de POI que se va a buscar (por ejemplo, "estatua de la libertad", "starbucks", "pizza"). Debe estar codificada correctamente con la dirección URL.
categorySet	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 `categorySet` admitidos por solicitud es 10. Cuando se proporcionan varios identificadores de categoría, solo se devolverán las POIs que pertenecen a (al menos) una de las categorías de la lista proporcionada. La lista de categorías admitidas se puede detectar mediante POI Categories API. Ejemplos de uso: categorySet=7315 (Buscar puntos de interés de la categoría Restaurante) categorySet=7315025,7315017 (Buscar puntos de interés de categoría italiano o francés)
extendedPostalCodesFor	query		SearchIndexes[]	Índices para los que los códigos postales extendidos deben incluirse en los resultados. Los índices disponibles son: Addr = Intervalos de direcciones Geo = Geographies PAD = Direcciones de punto POI = Puntos de interés Str = Streets XStr = Cross Streets (intersecciones) El valor debe ser una lista separada por comas de tipos de índice (en cualquier orden) o Ninguno para ningún índice. De forma predeterminada, los códigos postales extendidos se incluyen para todos los índices, excepto Geo. Las listas de códigos postales extendidas para las zonas geográficas pueden ser bastante largas, por lo que deben solicitarse explícitamente cuando sea necesario. Ejemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None El código postal extendido se devuelve como una propiedad de extendedPostalCode de una dirección. La disponibilidad depende de la región.
idxSet	query		SearchIndexes[]	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.
limit	query		integer minimum: 1 maximum: 100	Número máximo de respuestas que se devolverán. Valor predeterminado: 10, mínimo: 1 y máximo: 100
openingHours	query		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
view	query		LocalizedMapView	El parámetro View (también denominado parámetro "user region") permite mostrar los mapas correctos para un determinado país o región para regiones geopolíticamente disputadas. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región a la que va a servir la aplicación. De forma predeterminada, el parámetro View se establece en "Unified" incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de los usuarios y, a continuación, establecer el parámetro View correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa en función de la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que los mapas, imágenes y otros datos y contenido de terceros a los que está autorizado para acceder a través de Azure Maps está disponible. Ejemplo: view=IN. Consulte vistas admitidas para obtener más información y ver las vistas disponibles.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-id		string	Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Id. de Microsoft Entra. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad del identificador de Entra de Microsoft en Azure Maps, consulte los siguientes artículos de para obtener instrucciones.

Cuerpo de la solicitud

Nombre	Tipo	Description
geometry	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	Objeto `GeoJSON` válido. Consulte RFC 7946 para obtener más información.

Respuestas

Nombre	Tipo	Description
200 OK	SearchAddressResult	De acuerdo
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0. Cuando se empareja con acceso basado en rol de Azure control, se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Nota:

Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de de Maps.
El Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra.
El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
El uso de SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Se trata de una clave compartida que se aprovisiona al Creación de una cuenta de Azure Maps en Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

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

Tipo: apiKey
En: query

SAS Token

Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type

Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Solicitud de ejemplo

HTTP

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

status code:: 200

{
  "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

HTTP

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

status code:: 200

{
  "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

HTTP

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

status code:: 200

{
  "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
AddressRanges	Describe el intervalo de direcciones en ambos lados de la calle para obtener un resultado de búsqueda. Se incluyen las coordenadas de las ubicaciones de inicio y finalización del intervalo de direcciones.
BoundingBox	Ventanilla que cubre el resultado representado por las coordenadas superior izquierda e inferior derecha de la ventanilla.
BoundingBoxCompassNotation	Cuadro de límite de la ubicación.
Brand	La marca asociada a la POI
Classification	Clasificación de la POI que se devuelve
ClassificationName	Nombre de la clasificación
DataSources	Sección opcional. Identificadores de referencia para su uso con la API de Get Search Polygon.
Entity	Origen del tipo de entidad del cuadro de límite. Para la geocodificación inversa, siempre es igual a la posición.
EntryPoint	Punto de entrada para el PUNTO de interés que se devuelve.
EntryPointType	Tipo de punto de entrada. El valor puede ser principal o secundaria.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GeographicEntityType	Tipo de entidad Geography. Presente solo cuando se solicitó entityType y está disponible.
GeoJsonFeature	Tipo de objeto `GeoJSON Feature` válido. Consulte RFC 7946 para obtener más información.
GeoJsonFeatureCollection	Tipo de objeto `GeoJSON FeatureCollection` válido. Consulte RFC 7946 para obtener más información.
GeoJsonGeometry	Un 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.
GeoJsonGeometryCollection	Tipo de objeto `GeoJSON GeometryCollection` válido. Consulte RFC 7946 para obtener más información.
GeoJsonLineString	Un tipo de geometría `GeoJSON LineString` válido. Consulte RFC 7946 para obtener más información.
GeoJsonMultiLineString	Un tipo de geometría `GeoJSON MultiLineString` válido. Consulte RFC 7946 para obtener más información.
GeoJsonMultiPoint	Un tipo de geometría `GeoJSON MultiPoint` válido. Consulte RFC 7946 para obtener más información.
GeoJsonMultiPolygon	Tipo de objeto `GeoJSON MultiPolygon` válido. Consulte RFC 7946 para obtener más información.
GeoJsonPoint	Un tipo de geometría `GeoJSON Point` válido. Consulte RFC 7946 para obtener más información.
GeoJsonPolygon	Un tipo de geometría `GeoJSON Polygon` válido. Consulte RFC 7946 para obtener más información.
Geometry	Información sobre la forma geométrica del resultado. Solo está presente si el tipo == Geography.
LatLongPairAbbreviated	Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon".
LocalizedMapView	El parámetro View (también denominado parámetro "user region") permite mostrar los mapas correctos para un determinado país o región para regiones geopolíticamente disputadas. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región a la que va a servir la aplicación. De forma predeterminada, el parámetro View se establece en "Unified" incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de los usuarios y, a continuación, establecer el parámetro View correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa en función de la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que los mapas, imágenes y otros datos y contenido de terceros a los que está autorizado para acceder a través de Azure Maps está disponible. Ejemplo: view=IN. Consulte vistas admitidas para obtener más información y ver las vistas disponibles.
MatchType	Tipos de coincidencias para una operación de búsqueda de direcciones inversas.
OperatingHours	Horario de apertura de una POI (Puntos de interés).
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
OperatingHoursTime	Representa una fecha y hora
OperatingHoursTimeRange	Intervalo de tiempo de apertura para un día
PointOfInterest	Detalles de la POI devuelta, incluida información como el nombre, el teléfono, la dirección URL y las clasificaciones.
PointOfInterestCategorySet	Categoría poi
QueryType	Tipo de consulta que se devuelve: NEARBY o NON_NEAR.
ResponseFormat	Formato deseado de la respuesta. El valor puede ser json o xml.
SearchAddressResult	Este objeto se devuelve de una llamada de búsqueda correcta.
SearchAddressResultItem	Objeto result para una respuesta de Search API.
SearchAddressResultType	Uno de los valores siguientes: POI Calle Geografía Dirección del punto Intervalo de direcciones Cruce
SearchIndexes	Índices para los que los códigos postales extendidos deben incluirse en los resultados. Los índices disponibles son: Addr = Intervalos de direcciones Geo = Geographies PAD = Direcciones de punto POI = Puntos de interés Str = Streets XStr = Cross Streets (intersecciones) El valor debe ser una lista separada por comas de tipos de índice (en cualquier orden) o Ninguno para ningún índice. De forma predeterminada, los códigos postales extendidos se incluyen para todos los índices, excepto Geo. Las listas de códigos postales extendidas para las zonas geográficas pueden ser bastante largas, por lo que deben solicitarse explícitamente cuando sea necesario. Ejemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None El código postal extendido se devuelve como una propiedad de extendedPostalCode de una dirección. La disponibilidad depende de la región.
SearchInsideGeometryRequest	Este tipo representa el cuerpo de la solicitud para el servicio Search Inside Geometry.
SearchSummary	Objeto summary para una respuesta de Search API.

Address

Object

Dirección del resultado

Nombre	Tipo	Description
boundingBox	BoundingBoxCompassNotation	Cuadro de límite de la ubicación.
buildingNumber	string	Número de edificio en la calle. EN DESUSO, use streetNumber en su lugar.
country	string	nombre de país o región
countryCode	string	País (Nota: Se trata de un código de dos letras, no un nombre de país o región).
countryCodeISO3	string	Código de país ISO alfa-3
countrySecondarySubdivision	string	Condado
countrySubdivision	string	Estado o provincia
countrySubdivisionCode	string	`countrySubdivisionCode` prefijo por `countryCode` ( countryCode-countrySubdivisionCode ) y el guión forma el código ISO 3166-2. Ejemplos: TX para Texas, SCT para Escocia y ON para Ontario.
countrySubdivisionName	string	Nombre completo de un primer nivel de jerarquía administrativa de país o región. Este campo solo aparece en caso de que countrySubdivision se presente en un formulario abreviado. Solo se admite para ESTADOS UNIDOS, Canadá y Reino Unido.
countryTertiarySubdivision	string	Área con nombre
crossStreet	string	Nombre de la calle que se cruza.
extendedPostalCode	string	Código postal extendido (la disponibilidad depende de la región).
freeformAddress	string	Una línea de direcciones con formato según las reglas de formato del país o región de origen de un resultado, o en el caso de un país o región, su nombre completo de país o región.
localName	string	Componente de dirección que representa el nombre de un área geográfica o localidad que agrupa varios objetos direccionables con fines de direccionamiento, sin ser una unidad administrativa. Este campo se usa para compilar la propiedad `freeformAddress`. `localName` representa el municipio postal. Dependiendo de la ubicación, `localName` es el nombre conocido de una ciudad o ciudad. Para el nombre conocido de una ciudad o ciudad, use `localName` en lugar de `municipality`.
municipality	string	Ciudad/Ciudad Nota: `municipality` representa el municipio residencial. Dependiendo de la ubicación, el valor de `municipality` puede diferir del nombre conocido de una ciudad o ciudad. Para el nombre conocido de la ciudad o la ciudad, se recomienda usar el valor de `localName` en lugar del valor de `municipality`.
municipalitySubdivision	string	Sub/Super City
neighbourhood	string	Un barrio es una zona geográficamente localizada dentro de una ciudad o ciudad con características distintivas e interacciones sociales entre los habitantes.
postalCode	string	Código postal/código postal
routeNumbers	string[]	Códigos usados para identificar inequívocamente la calle
street	string	Nombre de la calle. EN DESUSO, use streetName en su lugar.
streetName	string	Nombre de la calle.
streetNameAndNumber	string	Nombre y número de la calle.
streetNumber	string	Número de edificio en la calle.

AddressRanges

Object

Describe el intervalo de direcciones en ambos lados de la calle para obtener un resultado de búsqueda. Se incluyen las coordenadas de las ubicaciones de inicio y finalización del intervalo de direcciones.

Nombre	Tipo	Description
from	LatLongPairAbbreviated	Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon".
rangeLeft	string	Intervalo de direcciones en el lado izquierdo de la calle.
rangeRight	string	Intervalo de direcciones en el lado derecho de la calle.
to	LatLongPairAbbreviated	Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon".

BoundingBox

Object

Ventanilla que cubre el resultado representado por las coordenadas superior izquierda e inferior derecha de la ventanilla.

Nombre	Tipo	Description
btmRightPoint	LatLongPairAbbreviated	Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon".
topLeftPoint	LatLongPairAbbreviated	Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon".

BoundingBoxCompassNotation

Object

Cuadro de límite de la ubicación.

Nombre	Tipo	Description
entity	Entity	Origen del tipo de entidad del cuadro de límite. Para la geocodificación inversa, siempre es igual a la posición.
northEast	string	Latitud norte-este,coordenada de longitud del rectángulo de selección como floats separados por comas
southWest	string	Latitud sur-oeste,coordenada de longitud del rectángulo delimitador como floats separados por comas

Brand

Object

La marca asociada a la POI

Nombre	Tipo	Description
name	string	Nombre de la marca

Classification

Object

Clasificación de la POI que se devuelve

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

ClassificationName

Object

Nombre de la clasificación

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

DataSources

Object

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

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

Entity

Enumeración

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

Valor	Description
position	Entidad Position

EntryPoint

Object

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

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

EntryPointType

Enumeración

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

Valor	Description
main
minor

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

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

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GeographicEntityType

Enumeración

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

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

GeoJsonFeature

Object

Tipo de objeto GeoJSON Feature válido. 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: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Un 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.
id	string	Identificador de la característica.
type	string: Feature	Especifica el tipo de `GeoJSON`. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonFeatureCollection

Object

Tipo de objeto GeoJSON FeatureCollection válido. Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
features	GeoJsonFeature[]	Contiene una lista de objetos `GeoJSON Feature` válidos.
type	string: FeatureCollection	Especifica el tipo de `GeoJSON`. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonGeometry

Object

Un 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	GeoJsonObjectType	Especifica el tipo de `GeoJSON`. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonGeometryCollection

Object

Tipo de objeto GeoJSON GeometryCollection válido. Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Contiene una lista de objetos de geometría de `GeoJSON` válidos. Nota que las coordenadas de GeoJSON están en x, y order (longitud, latitud).
type	string: GeometryCollection	Especifica el tipo de `GeoJSON`. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonLineString

Object

Un tipo de geometría GeoJSON LineString válido. Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[] (double)	Coordenadas de la geometría `GeoJson LineString`.
type	string: LineString	Especifica el tipo de `GeoJSON`. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiLineString

Object

Un tipo de geometría GeoJSON MultiLineString válido. Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[] (double)	Coordenadas de la geometría `GeoJson MultiLineString`.
type	string: MultiLineString	Especifica el tipo de `GeoJSON`. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiPoint

Object

Un tipo de geometría GeoJSON MultiPoint válido. Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[] (double)	Coordenadas de la geometría `GeoJson MultiPoint`.
type	string: MultiPoint	Especifica el tipo de `GeoJSON`. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiPolygon

Object

Tipo de objeto GeoJSON MultiPolygon válido. Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[] (double)	Contiene una lista de objetos `GeoJSON Polygon` válidos. Nota que las coordenadas de GeoJSON están en x, y order (longitud, latitud).
type	string: MultiPolygon	Especifica el tipo de `GeoJSON`. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonPoint

Object

Un tipo de geometría GeoJSON Point válido. Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[] (double)	Un `Position` es una matriz de números con dos o más elementos. Los dos primeros elementos son longitud y latitud, precisamente en ese orden. altitud/elevación es un tercer elemento opcional. Consulte RFC 7946 para obtener más información.
type	string: Point	Especifica el tipo de `GeoJSON`. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonPolygon

Object

Un tipo de geometría GeoJSON Polygon válido. Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[] (double)	Coordenadas del tipo de geometría `GeoJson Polygon`.
type	string: Polygon	Especifica el tipo de `GeoJSON`. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

Geometry

Object

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

Nombre	Tipo	Description
id	string	Pase esto como geometryId a la API de Get Search Polygon para capturar información de geometría para este resultado.

LatLongPairAbbreviated

Object

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

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

LocalizedMapView

Enumeración

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

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

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

MatchType

Enumeración

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

Valor	Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Object

Horario de apertura de una POI (Puntos de interés).

Nombre	Tipo	Description
mode	string	Valor usado en la solicitud: none o "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Lista de intervalos de tiempo para los próximos 7 días

OperatingHoursRange

Enumeración

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

Object

Representa una fecha y hora

Nombre	Tipo	Description
date	string	Representa la fecha actual del calendario en la zona horaria de POI, por ejemplo, "2019-02-07".
hour	integer	Las horas están en formato de 24 horas en la hora local de un POI; los valores posibles son 0 - 23.
minute	integer	Los minutos se encuentran en la hora local de un POI; los valores posibles son 0 - 59.

OperatingHoursTimeRange

Object

Intervalo de tiempo de apertura para un día

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

PointOfInterest

Object

Detalles de la POI devuelta, incluida información como el nombre, el teléfono, la dirección URL y las clasificaciones.

Nombre	Tipo	Description
brands	Brand[]	Matriz de marcas. Nombre de la marca para el punto de interés que se devuelve.
categories	string[]	Matriz de categorías
categorySet	PointOfInterestCategorySet[]	Lista de las categorías de POI más específicas
classifications	Classification[]	Matriz de clasificación
name	string	Nombre de la propiedad POI
openingHours	OperatingHours	Horario de apertura de una POI (Puntos de interés).
phone	string	Propiedad de número de teléfono
url	string	Propiedad URL del sitio web

PointOfInterestCategorySet

Object

Categoría poi

Nombre	Tipo	Description
id	integer	Id. de categoría

QueryType

Enumeración

Tipo de consulta que se devuelve: NEARBY o NON_NEAR.

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

ResponseFormat

Enumeración

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

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

SearchAddressResult

Object

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

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

SearchAddressResultItem

Object

Objeto result para una respuesta de Search API.

Nombre	Tipo	Description
address	Address	Dirección del resultado
addressRanges	AddressRanges	Describe el intervalo de direcciones en ambos lados de la calle para obtener un resultado de búsqueda. Se incluyen las coordenadas de las ubicaciones de inicio y finalización del intervalo de direcciones.
dataSources	DataSources	Sección opcional. Id. de geometría de referencia para su uso con la API de Get Search Polygon.
detourTime	integer	Tiempo de desvío en segundos. Solo se devuelve para las llamadas a Search Along Route API.
dist	number (double)	Distancia recta entre el resultado y la ubicación de geobias en metros.
entityType	GeographicEntityType	Tipo de entidad Geography. Presente solo cuando se solicitó entityType y está disponible.
entryPoints	EntryPoint[]	Matriz de puntos de entrada. Los que describen los tipos de entradas disponibles en la ubicación. El tipo puede ser "main" para las entradas principales, como una puerta principal, o un vestíbulo, y "menor", para puertas laterales y traseras.
id	string	Propiedad Id
info	string	Información sobre el origen de datos original del resultado. Se usa para solicitudes de soporte técnico.
matchType	MatchType	Información sobre el tipo de coincidencia. Uno de los valores siguientes: AddressPoint HouseNumberRange Calle
poi	PointOfInterest	Detalles de la POI devuelta, incluida información como el nombre, el teléfono, la dirección URL y las clasificaciones.
position	LatLongPairAbbreviated	Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon".
score	number (double)	Valor de un conjunto de resultados para indicar la puntuación de coincidencia relativa entre los resultados. Puede usarlo para determinar que el resultado x es el doble de probabilidad de ser tan relevante como resultado y si el valor de x es 2x el valor de y. Los valores varían entre las consultas y solo están diseñados como un valor relativo para un conjunto de resultados.
type	SearchAddressResultType	Uno de los valores siguientes: POI Calle Geografía Dirección del punto Intervalo de direcciones Cruce
viewport	BoundingBox	Ventanilla que cubre el resultado representado por las coordenadas superior izquierda e inferior derecha de la ventanilla.

SearchAddressResultType

Enumeración

Uno de los valores siguientes:

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

Valor	Description
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchIndexes

Enumeración

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

Los índices disponibles son:

Addr = Intervalos de direcciones

Geo = Geographies

PAD = Direcciones de punto

POI = Puntos de interés

Str = Streets

XStr = Cross Streets (intersecciones)

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

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

Ejemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

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

Valor	Description
Addr
Geo
PAD
POI
Str
Xstr

SearchInsideGeometryRequest

Object

Este tipo representa el cuerpo de la solicitud para el servicio Search Inside Geometry.

Nombre	Tipo	Description
geometry	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	Objeto `GeoJSON` válido. Consulte RFC 7946 para obtener más información.

SearchSummary

Object

Objeto summary para una respuesta de Search API.

Nombre	Tipo	Description
fuzzyLevel	integer	Nivel aproximado máximo necesario para proporcionar resultados.
geoBias	LatLongPairAbbreviated	Indicación de cuándo el motor de búsqueda interno ha aplicado un sesgo geoespacial para mejorar la clasificación de los resultados. En algunos métodos, esto puede verse afectado estableciendo los parámetros lat y lon cuando están disponibles. En otros casos, es puramente interno.
limit	integer	Número máximo de respuestas que se devolverán
numResults	integer	Número de resultados en la respuesta.
offset	integer	Desplazamiento inicial de los resultados devueltos en el conjunto de resultados completo.
query	string	Parámetro de consulta que se usó para generar estos resultados de búsqueda.
queryTime	integer	Tiempo dedicado a resolver la consulta, en milisegundos.
queryType	QueryType	Tipo de consulta que se devuelve: NEARBY o NON_NEAR.
totalResults	integer	Número total de resultados encontrados.

Compartir a través de

Search - Post Search Inside Geometry

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

AADToken

Ámbitos

subscription-key

SAS Token

Ejemplos

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Solicitud de ejemplo

Respuesta de muestra

Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type

Solicitud de ejemplo

Respuesta de muestra

Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

GeoJsonFeature

GeoJsonFeatureCollection

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

Geometry

LatLongPairAbbreviated

LocalizedMapView

MatchType

OperatingHours

OperatingHoursRange

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

ResponseFormat

SearchAddressResult

SearchAddressResultItem

SearchAddressResultType

SearchIndexes

SearchInsideGeometryRequest

SearchSummary

Recursos adicionales