Weather - Get Current Air Quality

Reference

Služba:: Maps

Verze rozhraní API:: 1.1

Slouží k získání aktuálních informací o kvalitě ovzduší, které zahrnují potenciální rizika a navrhovaná opatření.

Rozhraní Get Current Air Quality API je požadavek HTTP GET , který vrací podrobné informace o koncentraci znečišťujících látek a celkovém stavu aktuální kvality ovzduší, 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í shrnujícího úroveň rizika a navrhovaná opatření.

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

S volitelnými parametry:

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

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 služby Azure Maps
query	query	True	number[]	Příslušný dotaz zadaný jako řetězec oddělený čárkami složený podle zeměpisné šířky následované zeměpisnou délkou, např. "47.641268,-122.125679".
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 .
pollutants	query		boolean	Logická hodnota, která vrací podrobné informace o jednotlivých znečišťujících látkách. Ve výchozím nastavení je Pravda.

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 Služby Azure Maps. Informace o použití zabezpečení Microsoft Entra ID v Azure Maps najdete v následujících článcích .

Odpovědi

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

Zabezpečení

AADToken

Toto jsou toky Microsoft Entra 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 rozhraním Azure Maps REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika účtům prostředků nebo dílčím prostředkům Azure Maps. 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 několika oprávnění k rozhraním REST API služby Azure Maps.

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í prostředku Azure Maps, 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 webu 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 platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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 vytváření účtu Azure Maps na webu 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 rozhraním Rest API služby Azure Maps použít přístup k důvěrným klientským aplikacím , aby se váš klíč mohl bezpečně uložit.

Typ: apiKey
V: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy 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.

Typ: apiKey
V: header

Příklady

Get Current Air Quality

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

{
  "results": [
    {
      "dateTime": "2021-07-19T02:00:00+00:00",
      "index": 21.6,
      "globalIndex": 22.1,
      "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.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 6.7,
          "globalIndex": 6.7,
          "concentration": {
            "value": 13.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 21.6,
          "globalIndex": 22.1,
          "concentration": {
            "value": 53.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 11.3,
          "globalIndex": 12.2,
          "concentration": {
            "value": 12.2,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 13.5,
          "globalIndex": 6.5,
          "concentration": {
            "value": 3.2,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.2,
          "globalIndex": 0.6,
          "concentration": {
            "value": 118.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.6,
          "globalIndex": 1.1,
          "concentration": {
            "value": 1.1,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    }
  ]
}

Definice

Name	Description
AirQuality	Informace o kvalitě ovzduší v určitém místě v určitém čase.
AirQualityResult	Tento objekt se vrátí z úspěšného volání Get Air Quality.
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.
Pollutant	Podrobné informace o jednotlivých znečišťujících látek. Nevrátí se, pokud `pollutants`=false.
PollutantType	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ší.
UnitType	Číselná hodnota ID přidružená k typu zobrazené jednotky. Lze použít k překladu jednotek. Podrobnosti najdete v tématu Služby Počasí v Azure Maps .
WeatherUnit	Konkrétní hodnota dané jednotky související s počasím.

AirQuality

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 .
pollutants	Pollutant[]	Informace o jednotlivých znečišťujících látek.

AirQualityResult

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

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	AirQuality[]	Seznam všech výsledků kvality ovzduší pro dotazovanou lokalitu.

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

Pollutant

Podrobné informace o jednotlivých znečišťujících látek. Nevrátí se, pokud pollutants=false.

Name	Typ	Description
concentration	WeatherUnit	Objekt obsahující počet částic znečišťujících látek na objem vzduchu.
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 .
name	string	Název znečišťujících látek v angličtině.
type	PollutantType	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ší.

PollutantType