Weather - Get Air Quality Daily Forecasts

Tjänst:: Maps

API-version:: 1.1

Används för att få dagliga luftkvalitetsprognoser för de kommande en till sju dagarna som inkluderar föroreningsnivåer, potentiella risker och föreslagna försiktighetsåtgärder.

API:et Get Air Quality Daily Forecasts är en HTTP-begäran GET som returnerar detaljerad information om koncentrationen av föroreningar och övergripande status för den prognostiserade dagliga luftkvaliteten. Tjänsten kan tillhandahålla prognostiserad daglig luftkvalitetsinformation för de kommande 1 till 7 dagarna, inklusive föroreningsnivåer, luftkvalitetsindexvärden, den dominerande föroreningen och ett kort uttalande som sammanfattar risknivån och föreslagna försiktighetsåtgärder.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
format	path	True	JsonFormat	Önskat format för svaret. Endast `json` format stöds.
api-version	query	True	string	Versionsnummer för Azure Maps API.
query	query	True	number[]	Den tillämpliga frågan som anges som en kommaavgränsad sträng som består av latitud följt av longitud, t.ex. "47.641268,-122.125679". Väderinformation är i allmänhet tillgänglig för platser på land, vattendrag omgivna av land och områden i havet som ligger inom cirka 50 nautiska mil från en kustlinje.
duration	query		DailyDuration (int32)	Definierar varaktigheten för luftkvalitetsprognosen, med alternativ som sträcker sig från 1 till 7 dagar. Standardvaraktigheten är 1 dag.
language	query		string	Språk där sökresultat ska returneras. Bör vara en av IETF-språktaggar som stöds, skiftlägesokänsliga. När data på angivet språk inte är tillgängliga för ett visst fält används standardspråket. Mer information finns i språk som stöds.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger det konto som är avsett att användas med Microsoft Entra ID-säkerhetsmodellen. Det här unika ID:t för Azure Maps-kontot kan hämtas från Azure Maps konto-API:et för hanteringsplanet. Mer information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i Hantera autentisering i Azure Maps.

Svar

Name	Typ	Description
200 OK	DailyAirQualityForecastResult	OK
Other Status Codes	ErrorResponse	Ett oväntat fel uppstod.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Notes

Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hantering-API:et.

Authorization URL är specifik för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer. * Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

subscription-key

Det här är en delad nyckel som etableras när du Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST API:er. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder konfidentiella klientprogram metod för åtkomst till Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Typ: apiKey
I: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll till förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på Map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Get Daily Air Quality Forecasts

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
DailyAirQuality	Information om luftkvaliteten på en viss plats vid en viss tidpunkt.
DailyAirQualityForecastResult	Det här objektet returneras från ett lyckat Get Daily Air Quality Forecast-anrop.
DailyDuration	Definierar varaktigheten för luftkvalitetsprognosen, med alternativ som sträcker sig från 1 till 7 dagar. Standardvaraktigheten är 1 dag.
DominantPollutant	Identifierar den förorening som har den högsta koncentrationen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
JsonFormat	Önskat format för svaret. Endast `json` format stöds.

DailyAirQuality

Objekt

Information om luftkvaliteten på en viss plats vid en viss tidpunkt.

Name	Typ	Description
category	string	Beskrivning av luftkvaliteten med ett ord på det begärda språket. Till exempel "Utmärkt".
categoryColor	string	En unik färg som motsvarar kategorin för detta luftkvalitetsresultat.
dateTime	string (date-time)	Datum och tid för den aktuella observationen visas i ISO 8601-format, till exempel 2019-10-27T19:39:57-08:00.
description	string	En textförklaring av denna luftkvalitet resulterar i det begärda språket.
dominantPollutant	DominantPollutant	Den förorening som har den högsta koncentrationen.
globalIndex	number (float)	Internationellt normaliserad luftkvalitetsklassificering på en skala från 0 till 300 och uppåt, där högre siffror representerar sämre luftkvalitet.
index	number (float)	Luftkvalitetsklassificering på en skala som fastställs av lokala tillsynsorgan. Vågen kan variera mycket beroende på plats. Se Wikipedia för mer information.

DailyAirQualityForecastResult

Objekt

Det här objektet returneras från ett lyckat Get Daily Air Quality Forecast-anrop.

Name	Typ	Description
nextLink	string	är länken till nästa sida av de funktioner som returneras. Om det är den sista sidan, nej det här fältet.
results	DailyAirQuality[]	En lista över alla dagliga luftkvalitetsprognoser för den efterfrågade platsen.

DailyDuration

Uppräkning

Definierar varaktigheten för luftkvalitetsprognosen, med alternativ som sträcker sig från 1 till 7 dagar. Standardvaraktigheten är 1 dag.

Värde	Description
1	1 dag
2	2 dagar
3	3 dagar
4	4 dagar
5	5 dagar
6	6 dagar
7	7 dagar

DominantPollutant

Uppräkning

Identifierar den förorening som har den högsta koncentrationen.

Värde	Description
Carbon Monoxide	Kolmonoxid (CO) är en färglös, luktfri och smaklös men mycket giftig gas som produceras genom ofullständig förbränning av kolhaltiga bränslen. Vanliga källor är fordonsavgaser, gasspisar, ugnar och vedeldar.
Nitrogen Dioxide	Kvävedioxid (NO2) är en betydande luftförorening. Det är reglerat och omfattas av rekommenderade gränsriktlinjer som fastställts av Världshälsoorganisationen (WHO).
Ozone	Ozon (O3) är en nyckelkomponent i fotokemisk smog, det bruna, skadliga dis som omsluter många stora städer och är resultatet av en fotokemisk reaktion mellan solljus och vissa specifika föroreningar.
Particulate Matter 2.5	Partiklar 2,5 (PM2,5) avser fina partiklar med diametrar som i allmänhet är 2,5 mikrometer och mindre. Dessa partiklar är mer än 100 gånger tunnare än ett mänskligt hårstrå och kan förbli svävande i luften under långa perioder
Particulate Matter 10	Med partiklar 10 (PM10) avses partiklar med en diameter som i allmänhet är 10 mikrometer eller mindre. Dessa partiklar kan inkludera damm, pollen, sot, rök och vätskedroppar.
Sulfur Dioxide	Svaveldioxid (SO2) är en tung, färglös oorganisk gas med en skarp, irriterande lukt. Det produceras främst genom förbränning av fossila bränslen vid kraftverk och industrianläggningar, men det kan också släppas ut från naturliga källor som vulkaner.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

JsonFormat

Uppräkning

Önskat format för svaret. Endast json format stöds.

Värde	Description
json	JavaScript-objekt notationens datautbytesformat

Dela via

Weather - Get Air Quality Daily Forecasts

URI-parametrar

Begärandehuvud

Svar

Säkerhet

AADToken

Notes

Omfattningar

subscription-key

SAS Token

Exempel

Get Daily Air Quality Forecasts

Exempelbegäran

Exempelsvar

Definitioner

DailyAirQuality

DailyAirQualityForecastResult

DailyDuration

DominantPollutant

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat