Weather - Get Daily Indices

Serviço:: Maps

Versão da API:: 1.1

Use quando quiser saber se as condições climáticas são ideais para uma atividade específica, como atividades esportivas ao ar livre, construção ou agricultura (os resultados incluem informações sobre a umidade do solo).

A Get Daily Indices API é uma solicitação HTTP GET que retorna valores de índice que fornecem orientação para ajudar no planejamento de atividades futuras. Por exemplo, um aplicativo móvel de saúde pode notificar os usuários de que hoje está bom tempo para correr ou para outras atividades ao ar livre, como jogar golfe ou empinar pipa. As lojas de varejo podem otimizar suas campanhas de marketing digital com base nos valores de índice previstos. O serviço retorna em valores de índices diários para os 5, 10 e 15 dias atuais e seguintes a partir do dia atual.

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

Com parâmetros opcionais:

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 URI

Nome	Em	Obrigatório	Tipo	Description
format	path	True	JsonFormat	Formato desejado da resposta. Há suporte apenas para `json` formato.
api-version	query	True	string	Número de versão da API do Azure Mapas.
query	query	True	number[]	A consulta aplicável especificada como uma cadeia de caracteres separada por vírgula composta por latitude seguida por longitude, por exemplo, "47,641268,-122,125679". As informações meteorológicas geralmente estão disponíveis para locais em terra, corpos d'água cercados por terra e áreas do oceano que estão a aproximadamente 50 milhas náuticas de uma costa.
duration	query		integer	Especifica por quantos dias os índices diários são retornados. Por padrão, os dados de índices do dia atual serão retornados. Ao solicitar dados de índices futuros, o dia atual é incluído na resposta como dia 1. Os valores disponíveis são `1` - Retorna dados de índice diário para o dia atual. Valor padrão. `5` - Retorna 5 dias de dados de índice diário a partir do dia atual. `10` - Retornar 10 dias de dados de índice diário a partir do dia atual. `15` - Retornar 15 dias de dados de índice diário a partir do dia atual.
indexGroupId	query		integer	Identificador de grupo de índice numérico que pode ser usado para restringir os resultados retornados ao subconjunto correspondente de índices (grupo de índice). Não pode ser emparelhado com `indexId`. Consulte Serviços meteorológicos no Azure Mapas para obter detalhes e ver os grupos de índice com suporte.
indexId	query		integer	Identificador de índice numérico que pode ser usado para restringir os resultados retornados ao tipo de índice correspondente. Não pode ser emparelhado com `indexGroupId`. Consulte Serviços meteorológicos no Azure Mapas para obter detalhes e ver os índices com suporte.
language	query		string	Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de linguagem IETF com suporte, que não diferencia maiúsculas de minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado. Consulte de idiomas com suporte para obter detalhes.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Indica a conta destinada ao uso com o modelo de segurança de ID do Microsoft Entra. Essa ID exclusiva para a conta do Azure Mapas pode ser obtida na API da conta do plano de gerenciamento do Azure Mapas. Para obter mais informações sobre como usar a segurança de ID do Microsoft Entra no Azure Mapas, consulte Gerenciar autenticação no Azure Mapas.

Respostas

Nome	Tipo	Description
200 OK	DailyIndicesResult	OKEY
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Segurança

AADToken

Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de controlar o acesso em APIs e escopos específicos.

Anotações

Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. Nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. * O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada quando você Criar uma conta do Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o aplicativos cliente confidenciais abordagem para acessar AS APIs REST do Azure Mapas para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais protegida do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta de mapa de para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Successfully retrieve daily indices values from current day

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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."
    }
  ]
}

Definições

Nome	Description
DailyIndex	O objeto DailyIndex ajuda os usuários a planejar atividades ao ar livre com base nas condições climáticas, fornecendo o nome da atividade, como 'Previsão do Tempo de Esqui'; uma avaliação numérica de 0,0 a 10,0 indicando adequação; uma classificação por texto, como 'Pobre'; e uma breve descrição das condições, como 'Espere condições ruins para esquiar.'
DailyIndicesResult	Esse objeto é retornado de uma chamada bem-sucedida de Get Daily Indices.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
JsonFormat	Formato desejado da resposta. Há suporte apenas para `json` formato.

DailyIndex

Objeto

O objeto DailyIndex ajuda os usuários a planejar atividades ao ar livre com base nas condições climáticas, fornecendo o nome da atividade, como 'Previsão do Tempo de Esqui'; uma avaliação numérica de 0,0 a 10,0 indicando adequação; uma classificação por texto, como 'Pobre'; e uma breve descrição das condições, como 'Espere condições ruins para esquiar.'

Nome	Tipo	Description
ascending	boolean	Indica a direção das `value` propriedades e `categoryValue` . Quando verdadeiro, o menor valor do índice é 0 e o melhor valor do índice é 10. Quando falso, o menor valor do índice é 10 e o melhor valor é 0.
category	string	Fornece uma avaliação qualitativa do índice, descrevendo a `categoryValue` propriedade. As categorias variam entre índices e podem incluir valores como Excelente, Muito Bom, Bom, Razoável e Ruim.
categoryValue	integer (int32)	Fornece uma representação numérica da propriedade da categoria, indicando a avaliação qualitativa do índice. Os valores variam de 1 a 5 e devem ser usados com a bandeira ascendente, pois podem variar entre os índices. Por exemplo, para Atividade de Mosquitos: Baixa=1, Moderada=2, Alta=3, Muito Alta=4, Extrema=5.
dateTime	string (date-time)	Data e hora da observação no formato ISO 8601 (yyy-mm-ddThh:mm:ss-hh:mm). Por exemplo, 2025-04-29T07:00:00-07:00.
description	string	Fornece uma explicação breve e amigável do valor do índice, ajudando os usuários a entender sua importância em relação a condições climáticas ou atividades específicas. Por exemplo, se o valor do índice para Churrasco ao ar livre for 'Excelente', a descrição será 'Este é um ótimo dia para um churrasco ao ar livre!'
indexId	integer (int32)	Um identificador numérico que representa de forma única um tipo específico de índice, distinguindo entre diferentes índices para diversas atividades ao ar livre. Por exemplo, um 'indexId' de 1 corresponde ao índice 'Running', e um 'indexId' de 5 corresponde ao índice 'Golfing'. Para mais informações, veja IDs de Índice no artigo sobre conceitos do serviço Meteorológico no Azure Maps .
indexName	string	O nome do índice indica o tipo de atividade ou condição a que se relaciona, como corrida, golfe ou outras atividades ao ar livre. Para mais informações, veja IDs de Índice no artigo sobre conceitos do serviço Meteorológico no Azure Maps .
value	number (float)	Um valor numérico de índice variando de 0,0 a 10,0 que quantifica a adequação das condições climáticas para uma atividade ou condição específica, como corrida ou golfe. Valores mais altos normalmente indicam condições mais favoráveis, dependendo do valor do `ascending` imóvel. Por exemplo, um valor de 8 para o índice 'Running' sugere um tempo muito bom para correr, enquanto um valor de 6 para o índice 'Golfe' indica boas condições, mas um pouco menos ideais. Para mais informações, veja Conjuntos de intervalos de índice diários no artigo sobre conceitos do serviço Meteorológico no Azure Maps .

DailyIndicesResult

Objeto

Esse objeto é retornado de uma chamada bem-sucedida de Get Daily Indices.

Nome	Tipo	Description
results	DailyIndex[]	Uma lista de todos os índices diários para o local consultado.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

JsonFormat

Enumeração

Formato desejado da resposta. Há suporte apenas para json formato.

Valor	Description
json	o formato de intercâmbio de dados de notação de objeto JavaScript

Compartilhar via

Weather - Get Daily Indices

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

AADToken

Anotações

Escopos

subscription-key

SAS Token

Exemplos

Successfully retrieve daily indices values from current day

Solicitação de exemplo

Resposta de exemplo

Definições

DailyIndex

DailyIndicesResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat