Weather - Get Air Quality Daily Forecasts

Reference

Service:: Maps

API Version:: 1.1

Používá se k získání denních předpovědí kvality ovzduší na další jeden až sedm dnů, které zahrnují úrovně znečišťujících látek, potenciální rizika a navrhovaná opatření.

Rozhraní Get Air Quality Daily Forecasts API je požadavek HTTP GET , který vrací podrobné informace o koncentraci znečišťujících látek a celkovém stavu předpokládané denní kvality ovzduší. Služba může poskytovat předpokládané denní informace o kvalitě ovzduší pro nadcházející 1 až 7 dnů, včetně úrovní znečištění, hodnot indexu kvality ovzduší, dominantních znečišťujících látek a stručného prohlášení o úrovni rizika a navrhovaných opatření.

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
format	path	True	JsonFormat	Požadovaný formát odpovědi Podporuje se pouze `json` formát.
api-version	query	True	string	Číslo verze rozhraní API Azure Maps.
query	query	True	number[]	Příslušný dotaz zadaný jako řetězec oddělený čárkou složený podle zeměpisné šířky následované délkou, například 47.641268,-122.125679.
duration	query		DailyDuration int32	Určuje, za kolik dní bychom chtěli vědět o kvalitě ovzduší. Dostupné hodnoty jsou 1, 2, 3, 4, 5, 6 a 7. Výchozí hodnota je 1.
language	query		string	Jazyk, ve kterém se mají vrátit výsledky hledání. Měl by být jednou z podporovaných značek jazyka IETF, nerozlišují se malá a velká písmena. Pokud data v zadaném jazyce nejsou pro konkrétní pole k dispozici, použije se výchozí jazyk. Podrobnosti najdete v části Podporované jazyky .

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích.

Odpovědi

Name	Typ	Description
200 OK	DailyAirQualityForecastResult	OK
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady AZURE MAPS Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.

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

Jedná se o sdílený klíč, který se zřídí při Create účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem může každá aplikace přistupovat ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve kterému je vystavený.

U veřejně vystavených aplikací doporučujeme pro přístup k Azure Maps rozhraní REST API použít přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.

Type: apiKey
In: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v Azure Maps prostředku prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečeným způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.

Type: apiKey
In: header

Příklady

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."
    }
  ]
}

Definice

Name	Description
DailyAirQuality	Informace o kvalitě ovzduší v určitém místě v určitém čase.
DailyAirQualityForecastResult	Tento objekt se vrátí z úspěšného volání Get Daily Air Quality Forecast.
DailyDuration	Určuje, za kolik dní bychom chtěli vědět o kvalitě ovzduší. Dostupné hodnoty jsou 1, 2, 3, 4, 5, 6 a 7. Výchozí hodnota je 1.
DominantPollutant	Typ znečišťujících látek. Mějte prosím na paměti, že kdykoli můžou být přidány další.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
JsonFormat	Požadovaný formát odpovědi Podporuje se pouze `json` formát.

DailyAirQuality

Informace o kvalitě ovzduší v určitém místě v určitém čase.

Name	Typ	Description
category	string	Jednoslovný popis kvality ovzduší v požadovaném jazyce. Například "Vynikající".
categoryColor	string	Jedinečná barva odpovídající kategorii tohoto výsledku kvality ovzduší.
dateTime	string	Datum a čas aktuálního pozorování zobrazeného ve formátu ISO 8601, například 2019-10-27T19:39:57-08:00.
description	string	Textové vysvětlení této kvality ovzduší v požadovaném jazyce.
dominantPollutant	DominantPollutant	Znečišťujících látek s nejvyšší koncentrací.
globalIndex	number	Mezinárodně normalizovaná hodnocení kvality ovzduší na škále od 0 do 300 a vyšší, přičemž vyšší čísla představují horší kvalitu ovzduší.
index	number	Hodnocení kvality ovzduší na stupnici stanovené místními regulačními orgány. Měřítka se můžou výrazně lišit v závislosti na umístění. Další informace najdete na Wikipedii .

DailyAirQualityForecastResult

Tento objekt se vrátí z úspěšného volání Get Daily Air Quality Forecast.

Name	Typ	Description
nextLink	string	Je odkaz na další stránku vrácených funkcí. Pokud se jedná o poslední stránku, toto pole není.
results	DailyAirQuality[]	Seznam všech denních předpovědí kvality ovzduší pro dotazovanou polohu.

DailyDuration

Určuje, za kolik dní bychom chtěli vědět o kvalitě ovzduší. Dostupné hodnoty jsou 1, 2, 3, 4, 5, 6 a 7. Výchozí hodnota je 1.

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

DominantPollutant

Typ znečišťujících látek. Mějte prosím na paměti, že kdykoli můžou být přidány další.

Name	Typ	Description
Carbon Monoxide	string	Oxid uhelnatý ("CO")
Nitrogen Dioxide	string	Oxid dusičitý ("NO2")
Ozone	string	Ozón ("O3")
Particulate Matter 10	string	Částice 10 ("PM10")
Particulate Matter 2.5	string	Částice 2,5 ("PM2,5")
Sulfur Dioxide	string	Oxid siřičitý ("SO2")

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

JsonFormat

Požadovaný formát odpovědi Podporuje se pouze json formát.

Name	Typ	Description
json	string	Formát výměny dat zápisu objektů JavaScriptu