Weather - Get Daily Indices

Servicio:: Maps

Versión de la API:: 1.1

Úselo cuando desee saber si las condiciones climáticas son óptimas para una actividad específica, como actividades deportivas al aire libre, construcción o agricultura (los resultados incluyen información sobre la humedad del suelo).

La Get Daily Indices API es una solicitud HTTP GET que devuelve valores de índice que proporcionan orientación para ayudar a planificar actividades futuras. Por ejemplo, una aplicación móvil de salud puede notificar a los usuarios que hoy hace buen tiempo para correr o para otras actividades al aire libre como jugar al golf o volar una cometa. Las tiendas minoristas pueden optimizar sus campañas de marketing digital en función de los valores de índice previstos. El servicio devuelve en índices diarios valores para los días actuales y los próximos 5, 10 y 15 a partir del día actual.

GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query={query}

Con parámetros opcionales:

GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query={query}&language={language}&duration={duration}&indexId={indexId}&indexGroupId={indexGroupId}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	JsonFormat	Formato deseado de la respuesta. Solo se admite `json` formato.
api-version	query	True	string	Número de versión de la API de Azure Maps.
query	query	True	number[]	La consulta aplicable especificada como una cadena separada por comas compuesta por latitud seguida de longitud, por ejemplo, "47.641268,-122.125679". La información meteorológica generalmente está disponible para ubicaciones en tierra, cuerpos de agua rodeados de tierra y áreas del océano que se encuentran dentro de aproximadamente 50 millas náuticas de una costa.
duration	query		integer	Especifica durante cuántos días se devuelven los índices diarios. De forma predeterminada, se devolverán los datos de los índices para el día actual. Al solicitar datos de índices futuros, el día actual se incluye en la respuesta como día 1. Los valores disponibles son: `1` - Devuelve los datos del índice diario del día actual. Valor predeterminado. `5` - Devuelve 5 días de datos diarios del índice a partir del día actual. `10` - Devuelve 10 días de datos de índices diarios a partir del día actual. `15` - Devuelve 15 días de datos de índices diarios a partir del día actual.
indexGroupId	query		integer	Identificador de grupo de índice numérico que se puede usar para restringir los resultados devueltos al subconjunto correspondiente de índices (grupo de índices). No se puede emparejar con `indexId`. Consulte Servicios meteorológicos en Azure Maps para obtener más información y ver los grupos de índices admitidos.
indexId	query		integer	Identificador de índice numérico que se puede usar para restringir los resultados devueltos al tipo de índice correspondiente. No se puede emparejar con `indexGroupId`. Consulte Servicios meteorológicos en Azure Maps para obtener más información y ver los índices admitidos.
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.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-id		string	Indica la cuenta destinada a su uso con el modelo de seguridad de identificador de Microsoft Entra. Este identificador único para la cuenta de Azure Maps se puede obtener de la API de cuenta del plano de administración de Azure Maps. Para obtener más información sobre el uso de la seguridad de ID de Microsoft Entra en Azure Maps, consulte Administración de la autenticación en Azure Maps.

Respuestas

Nombre	Tipo	Description
200 OK	DailyIndicesResult	De acuerdo
Other Status Codes	ErrorResponse	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 los 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.

Notas

Esta definición de seguridad requiere el uso del encabezado para indicar a qué recurso de x-ms-client-id Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración 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

Successfully retrieve daily indices values from current day

Solicitud de ejemplo

HTTP

GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query=43.84745,-79.37849&indexGroupId=11

Respuesta de muestra

status code:: 200

{
  "results": [
    {
      "indexName": "Running Forecast",
      "indexId": 1,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.2,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is an excellent day for outdoor running!"
    },
    {
      "indexName": "Jogging Forecast",
      "indexId": 2,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.4,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "Conditions are excellent for jogging outdoors!"
    },
    {
      "indexName": "Hiking Forecast",
      "indexId": 3,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.8,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "Conditions are excellent for hiking!"
    },
    {
      "indexName": "Bicycling Forecast",
      "indexId": 4,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.9,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "Conditions are excellent for bicycling outdoors!"
    },
    {
      "indexName": "Golf Weather Forecast",
      "indexId": 5,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 10,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is a great day for golf."
    },
    {
      "indexName": "Tennis Forecast",
      "indexId": 6,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.2,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is an excellent day for playing tennis!"
    },
    {
      "indexName": "Skateboarding Forecast",
      "indexId": 7,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.9,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is an excellent day for skateboarding!"
    },
    {
      "indexName": "Outdoor Concert Forecast",
      "indexId": 8,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.7,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "Conditions are excellent for attending an outdoor concert!"
    },
    {
      "indexName": "Kite Flying Forecast",
      "indexId": 9,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 8.5,
      "category": "Very Good",
      "categoryValue": 4,
      "ascending": true,
      "description": "Conditions are very good today for kite-flying."
    },
    {
      "indexName": "Beach & Pool Forecast",
      "indexId": 10,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 8.6,
      "category": "Very Good",
      "categoryValue": 4,
      "ascending": true,
      "description": "Conditons will be very good for a visit to the beach or pool."
    },
    {
      "indexName": "Sailing Forecast",
      "indexId": 11,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 8.3,
      "category": "Very Good",
      "categoryValue": 4,
      "ascending": true,
      "description": "Conditions will be very good for sailing."
    },
    {
      "indexName": "Stargazing Forecast",
      "indexId": 12,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.5,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is a great night to be stargazing!"
    },
    {
      "indexName": "Fishing Forecast",
      "indexId": 13,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 3.5,
      "category": "Fair",
      "categoryValue": 2,
      "ascending": true,
      "description": "Expect only fair conditions for fishing."
    },
    {
      "indexName": "Ski Weather Forecast",
      "indexId": 15,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 0,
      "category": "Poor",
      "categoryValue": 1,
      "ascending": true,
      "description": "Expect poor conditions for skiing."
    },
    {
      "indexName": "Mosquito Activity Forecast",
      "indexId": 17,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 7,
      "category": "Very High",
      "categoryValue": 4,
      "ascending": true,
      "description": "The weather is favorable for a very high level of mosquito activity. Plan activities and insect repellents accordingly."
    },
    {
      "indexName": "Hunting Forecast",
      "indexId": 20,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 4.5,
      "category": "Fair",
      "categoryValue": 2,
      "ascending": true,
      "description": "Expect only fair conditions for hunting."
    },
    {
      "indexName": "Outdoor Barbecue",
      "indexId": 24,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.8,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is a great day for an outdoor barbecue!"
    },
    {
      "indexName": "Lawn Mowing Forecast",
      "indexId": 28,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 9.6,
      "category": "Excellent",
      "categoryValue": 5,
      "ascending": true,
      "description": "This is a great day for lawn mowing!"
    },
    {
      "indexName": "Outdoor Activity Forecast",
      "indexId": 29,
      "dateTime": "2020-07-14T07:00:00-04:00",
      "value": 8.7,
      "category": "Very Good",
      "categoryValue": 4,
      "ascending": true,
      "description": "Conditions will be very good for outdoor activities."
    }
  ]
}

Definiciones

Nombre	Description
DailyIndex	El objeto DailyIndex ayuda a los usuarios a planificar actividades al aire libre basándose en las condiciones meteorológicas proporcionando el nombre de la actividad, como 'Pronóstico del Tiempo de Esquí'; una valoración numérica de 0,0 a 10,0 que indica idoneidad; una calificación por mensaje, como 'Pobre'; y una breve descripción de las condiciones, como 'Esperemos malas condiciones para esquiar.'
DailyIndicesResult	Este objeto se devuelve a partir de una llamada correcta a Get Daily Indices.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
JsonFormat	Formato deseado de la respuesta. Solo se admite `json` formato.

DailyIndex

Objeto

El objeto DailyIndex ayuda a los usuarios a planificar actividades al aire libre basándose en las condiciones meteorológicas proporcionando el nombre de la actividad, como 'Pronóstico del Tiempo de Esquí'; una valoración numérica de 0,0 a 10,0 que indica idoneidad; una calificación por mensaje, como 'Pobre'; y una breve descripción de las condiciones, como 'Esperemos malas condiciones para esquiar.'

Nombre	Tipo	Description
ascending	boolean	Indica la dirección de las `value` propiedades y `categoryValue` . Cuando es cierto, el valor índice más bajo es 0 y el mejor valor índice es 10. Cuando es falso, el valor índice más bajo es 10 y el mejor valor índice es 0.
category	string	Proporciona una evaluación cualitativa del índice, describiendo la `categoryValue` propiedad. Las categorías varían entre índices y pueden incluir valores como Excelente, Muy Bueno, Bueno, Regular y Pobre.
categoryValue	integer (int32)	Proporciona una representación numérica de la propiedad de categoría, indicando la evaluación cualitativa del índice. Los valores van del 1 al 5 y deben usarse con la bandera ascendente, ya que pueden variar entre índices. Por ejemplo, para la actividad de mosquitos: Baja = 1, Moderada = 2, Alta = 3 , Muy Alta = 4, Extrema = 5.
dateTime	string (date-time)	Fecha y hora de la observación en formato ISO 8601 (aaa-mm-ddThh:mm:ss-hh:mm). Por ejemplo, 2025-04-29T07:00:00-07:00.
description	string	Proporciona una explicación breve y fácil de usar del valor del índice, ayudando a los usuarios a comprender su importancia en relación con condiciones meteorológicas o actividades específicas. Por ejemplo, si el valor del índice para barbacoa al aire libre es 'Excelente', la descripción será '¡Este es un gran día para una barbacoa al aire libre!'
indexId	integer (int32)	Un identificador numérico que representa de forma única un tipo de índice específico, distinguiendo entre diferentes índices para diversas actividades al aire libre. Por ejemplo, un 'indexId' de 1 corresponde al índice 'Running', y un 'indexId' de 5 corresponde al índice 'Golfing'. Para más información, consulte el artículo sobre Indicadores en el artículo de conceptos del servicio Meteorológico en Azure Maps .
indexName	string	El nombre del índice indica el tipo de actividad o condición a la que se relaciona, como correr, jugar al golf u otras actividades al aire libre. Para más información, consulte el artículo sobre Indicadores en el artículo de conceptos del servicio Meteorológico en Azure Maps .
value	number (float)	Un valor numérico de índice que va de 0,0 a 10,0 y que cuantifica la idoneidad de las condiciones meteorológicas para una actividad o condición específica, como correr o jugar al golf. Valores más altos suelen indicar condiciones más favorables, dependiendo del valor de la `ascending` propiedad. Por ejemplo, un valor de 8 para el índice de 'Running' sugiere un tiempo muy bueno para correr, mientras que un valor de 6 para el índice de 'Golf' indica condiciones buenas pero ligeramente menos ideales. Para más información, consulte Conjuntos de rangos de índices diarios en el artículo de conceptos del servicio meteorológico en Azure Maps .

DailyIndicesResult

Objeto

Este objeto se devuelve a partir de una llamada correcta a Get Daily Indices.

Nombre	Tipo	Description
results	DailyIndex[]	Una lista de todos los índices diarios para la ubicación consultada.

ErrorAdditionalInfo

Objeto

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

Objeto

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	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

JsonFormat

Enumeración

Formato deseado de la respuesta. Solo se admite json formato.

Valor	Description
json	el formato de intercambio de datos de notación de objetos JavaScript

Compartir a través de

Weather - Get Daily Indices

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

AADToken

Notas

Ámbitos

subscription-key

SAS Token

Ejemplos

Successfully retrieve daily indices values from current day

Solicitud de ejemplo

Respuesta de muestra

Definiciones

DailyIndex

DailyIndicesResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat