Weather - Get Air Quality Daily Forecasts

Referência

Service:: Maps

API Version:: 1.1

Utilizado para obter previsões diárias de qualidade do ar para os próximos um a sete dias que incluam níveis poluentes, riscos potenciais e precauções sugeridas.

A Get Air Quality Daily Forecasts API é um pedido HTTP GET que devolve informações detalhadas sobre a concentração de poluentes e o estado geral da qualidade diária prevista do ar. O serviço pode fornecer informações diárias de qualidade do ar previstas para os próximos 1 a 7 dias, incluindo níveis de poluição, valores de índice de qualidade do ar, poluente dominante, e uma breve declaração resumindo o nível de risco e sugerindo precauções.

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

With optional parameters:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
format	path	True	JsonFormat	Formato pretendido da resposta. Apenas `json` o formato é suportado.
api-version	query	True	string	Número da versão da API Azure Maps.
query	query	True	number[]	A consulta aplicável especificada como uma cadeia separada por vírgulas composta por latitude seguida de longitude, por exemplo, "47.641268,-122.125679".
duration	query		DailyDuration int32	Especifica quantos dias a partir de agora gostaríamos de saber sobre a qualidade do ar. Os valores disponíveis são 1, 2, 3, 4, 5, 6 e 7. O valor predefinido é 1.
language	query		string	Idioma no qual os resultados da pesquisa devem ser devolvidos. Deve ser uma das etiquetas de linguagem IETF suportadas, não sensível a maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, é utilizado o idioma predefinido. Consulte idiomas suportados para obter detalhes.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps consulte os seguintes artigos para obter orientações.

Respostas

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

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps .

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Esta é uma chave partilhada que é aprovisionada quando Create uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

Get Daily Air Quality Forecasts

Sample Request

HTTP

GET https://atlas.microsoft.com/weather/airQuality/forecasts/daily/json?api-version=1.1&query=47.632346,-122.13887&duration=3

Sample Response

Status code:: 200

{
  "results": [
    {
      "dateTime": "2021-07-18T07:00:00+00:00",
      "index": 35.1,
      "globalIndex": 42.2,
      "dominantPollutant": "Ozone",
      "category": "Fair",
      "categoryColor": "#FFC300",
      "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure."
    },
    {
      "dateTime": "2021-07-19T07:00:00+00:00",
      "index": 31.6,
      "globalIndex": 37,
      "dominantPollutant": "Ozone",
      "category": "Fair",
      "categoryColor": "#FFC300",
      "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure."
    },
    {
      "dateTime": "2021-07-20T07:00:00+00:00",
      "index": 33.6,
      "globalIndex": 40,
      "dominantPollutant": "Ozone",
      "category": "Fair",
      "categoryColor": "#FFC300",
      "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure."
    }
  ]
}

Definições

Name	Description
DailyAirQuality	Informações sobre a qualidade do ar numa localização específica numa hora específica.
DailyAirQualityForecastResult	Este objeto é devolvido de uma chamada Get Daily Air Quality Forecast com êxito.
DailyDuration	Especifica quantos dias a partir de agora gostaríamos de saber sobre a qualidade do ar. Os valores disponíveis são 1, 2, 3, 4, 5, 6 e 7. O valor predefinido é 1.
DominantPollutant	Tipo de poluente. Tenha em atenção que podem ser adicionados mais em qualquer altura.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
JsonFormat	Formato pretendido da resposta. Apenas `json` o formato é suportado.

DailyAirQuality

Informações sobre a qualidade do ar numa localização específica numa hora específica.

Name	Tipo	Description
category	string	Descrição de uma palavra da qualidade do ar no idioma pedido. Por exemplo, "Excelente".
categoryColor	string	Uma cor exclusiva correspondente à categoria deste resultado de qualidade do ar.
dateTime	string	Data e hora da observação atual apresentada no formato ISO 8601, por exemplo, 2019-10-27T19:39:57-08:00.
description	string	Uma explicação textual deste resultado de qualidade do ar na linguagem pedida.
dominantPollutant	DominantPollutant	O poluente com maior concentração.
globalIndex	number	Classificação da qualidade do ar normalizada internacionalmente numa escala de 0 a 300 e superior, com números mais elevados a representarem pior qualidade do ar.
index	number	Classificação da qualidade do ar num conjunto de dimensionamento por organismos reguladores locais. As escalas podem variar bastante com base na localização. Consulte a Wikipédia para obter mais informações.

DailyAirQualityForecastResult

Este objeto é devolvido de uma chamada Get Daily Air Quality Forecast com êxito.

Name	Tipo	Description
nextLink	string	É a ligação para a página seguinte das funcionalidades devolvidas. Se for a última página, não este campo.
results	DailyAirQuality[]	Uma lista de todas as previsões diárias de qualidade do ar para a localização consultada.

DailyDuration

Especifica quantos dias a partir de agora gostaríamos de saber sobre a qualidade do ar. Os valores disponíveis são 1, 2, 3, 4, 5, 6 e 7. O valor predefinido é 1.

Name	Tipo	Description
1	string
2	string
3	string
4	string
5	string
6	string
7	string

DominantPollutant

Tipo de poluente. Tenha em atenção que podem ser adicionados mais em qualquer altura.

Name	Tipo	Description
Carbon Monoxide	string	Monóxido de carbono ("CO")
Nitrogen Dioxide	string	Dióxido de azoto ("NO2")
Ozone	string	Ozono ("O3")
Particulate Matter 10	string	Partículas 10 ("PM10")
Particulate Matter 2.5	string	Partículas 2.5 ("PM2.5")
Sulfur Dioxide	string	Dióxido de enxofre ("SO2")

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

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

ErrorDetail

O detalhe do erro.

Name	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

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.

Name	Tipo	Description
json	string	Formato JavaScript Object Notation Data Interchange