Weather - Get Daily Indices

Referência

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 API Get Daily Indices é uma solicitação HTTP GET retorna valores de índice que fornecem orientação para ajudar no planejamento de atividades futuras. Por exemplo, uma aplicação móvel de saúde pode notificar os utilizadores 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 próximos 5, 10 e 15 dias 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 do URI

Name	Em	Necessário	Tipo	Description
format	path	True	JsonFormat	Formato desejado da resposta. Apenas `json` formato é suportado.
api-version	query	True	string	Número da versão da API do Azure Maps.
query	query	True	number[]	A consulta aplicável especificada como uma cadeia de caracteres separada por vírgulas composta por latitude seguida de longitude, por exemplo, "47.641268,-122.125679". As informações meteorológicas estão geralmente disponíveis para locais em terra, corpos de á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 dos índices para o 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` - Retorna 10 dias de dados de índice diário a partir do dia atual. `15` - Retorna 15 dias de dados diários do índice 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 índices). Não pode ser emparelhado com `indexId`. Consulte serviços meteorológicos no do Azure Maps para obter detalhes e ver os grupos de índice suportados.
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 do Azure Maps para obter detalhes e ver os índices suportados.
language	query		string	Idioma em que os resultados da pesquisa devem ser retornados. Deve ser uma das tags de idioma IETF suportadas, sem distinção entre maiúsculas e 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 suportados para obter detalhes.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica qual conta deve ser usada em conjunto com o modelo de segurança do Microsoft Entra ID. Ele representa uma ID exclusiva para a conta do Azure Maps e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Maps. Para usar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientação.

Respostas

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

Segurança

AADToken

Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. 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 Maps.

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

Observações

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

O Authorization URL é específico para a instância de nuvem pública do Azure. As 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 a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Maps 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
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

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

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(ões) 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 segura 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 do Map 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

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

Name	Description
DailyIndex	Informações sobre um índice diário.
DailyIndicesResult	Este objeto é retornado de uma chamada Get Daily Indices bem-sucedida.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
JsonFormat	Formato desejado da resposta. Apenas `json` formato é suportado.

DailyIndex

Informações sobre um índice diário.

Name	Tipo	Description
ascending	boolean	Descreve a direção do `value` e `categoryValue`. Por exemplo, quando definido como `true`, o menor valor de índice é 0 e o melhor valor de índice é 10. Quando definido como `true`, o menor valor de índice é 10 e o melhor valor de índice é 0.
category	string	Descrição textual para `categoryValue` correspondente ao nível em que o valor do índice se enquadra, por exemplo "Muito Bom".
categoryValue	integer	Nível em que o valor do índice cai, representado por um inteiro. Este valor pode ser de 1 a 5 e deve ser usado em combinação com a bandeira `ascending` porque pode diferir entre os índices. Por exemplo, os seguintes valores se aplicam à Atividade do Mosquito: Baixa=1, Moderada=2, Alta=3, Muito Alta=4 e Extrema=5.
dateTime	string	Data e hora da observação atual exibida no formato ISO 8601, por exemplo, 2019-10-27T19:39:57-08:00.
description	string	Uma explicação textual que pode ser usada para fins de exibição para resumir o valor e a categoria do índice. Por exemplo, quando o valor do índice para Atrasos de Voo é muito bom, a descrição será "As condições são excelentes para voar!".
indexId	integer	ID numérico usado para identificar o índice específico. Consulte serviços meteorológicos no Azure Maps para obter detalhes e ver as IDs de índice suportadas. Por exemplo, o ID de índice pode suportar cenários de visualização de interface do usuário.
indexName	string	Nome do índice, por exemplo, "Construção", "Atividade ao ar livre", "Atrasos de voos".
value	number	Valor do índice. Varia de 0,0 a 10,0. Consulte serviços meteorológicos no Azure Maps para obter detalhes e ver os intervalos suportados.

DailyIndicesResult

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

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

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.

Name	Tipo	Description
json	string	O formato de intercâmbio de dados de notação de objeto JavaScript

Partilhar via