Weather - Get Air Quality Daily Forecasts

Referência

Service:: Maps

API Version:: 1.1

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

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

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 de URI

Nome	Em	Obrigatório	Tipo	Description
format	path	True	JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.
api-version	query	True	string	Número de versão da API de Mapas Azure.
query	query	True	number[]	A consulta aplicável especificada como uma cadeia de caracteres separada por vírgulas composta por latitude seguida por 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 padrão é 1.
language	query		string	Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de idioma 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 Idiomas com suporte para obter detalhes.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Nome	Tipo	Description
200 OK	DailyAirQualityForecastResult	OK
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

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

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 acessar o controle em APIs e escopos específicos.

Observações

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

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 Microsoft Entra ID. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou 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 plataforma de identidade da Microsoft, consulte visão geral plataforma de identidade da Microsoft.

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

Scopes

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

subscription-key

Essa é uma chave compartilhada provisionada quando você Create uma conta 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 master na conta em que elas são emitidas.

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

Type: apiKey
In: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado com base na operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou 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 a expiração, a taxa e as regiõ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 maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta de mapa para limitar o abuso de renderização e renovar regularmente o Token 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

Nome	Description
DailyAirQuality	Informações sobre a qualidade do ar em um local específico em um momento específico.
DailyAirQualityForecastResult	Esse objeto é retornado de uma chamada bem-sucedida obter previsão diária de qualidade do ar.
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 padrão é 1.
DominantPollutant	Tipo de poluente. Observe que mais podem ser adicionados a qualquer momento.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	Os detalhes do erro.
ErrorResponse	Resposta de erro
JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.

DailyAirQuality

Informações sobre a qualidade do ar em um local específico em um momento específico.

Nome	Tipo	Description
category	string	Descrição de uma palavra da qualidade do ar no idioma solicitado. Por exemplo, "Excelente".
categoryColor	string	Uma cor exclusiva correspondente à categoria desse resultado de qualidade do ar.
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 desse resultado de qualidade do ar no idioma solicitado.
dominantPollutant	DominantPollutant	O poluente com maior concentração.
globalIndex	number	Classificação de qualidade do ar normalizada internacionalmente em uma escala de 0 a 300 ou mais, com números mais altos representando pior qualidade do ar.
index	number	Classificação de qualidade do ar em um conjunto de dimensionamento por órgãos reguladores locais. As escalas podem variar amplamente com base na localização. Consulte Wikipédia para obter mais informações.

DailyAirQualityForecastResult

Esse objeto é retornado de uma chamada bem-sucedida obter previsão diária de qualidade do ar.

Nome	Tipo	Description
nextLink	string	O é o link para a próxima página dos recursos retornados. 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 o local consultado.

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 padrão é 1.

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

DominantPollutant

Tipo de poluente. Observe que mais podem ser adicionados a qualquer momento.

Nome	Tipo	Description
Carbon Monoxide	string	Monóxido de carbono ("CO")
Nitrogen Dioxide	string	Dióxido de nitrogênio ("NO2")
Ozone	string	Ozônio ("O3")
Particulate Matter 10	string	Material particulado 10 ("PM10")
Particulate Matter 2.5	string	Material particulado 2,5 ("PM2.5")
Sulfur Dioxide	string	Dióxido de enxofre ("SO2")

ErrorAdditionalInfo

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

Os detalhes 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

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

JsonFormat

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

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