Weather - Get Air Quality Daily Forecasts

Referens

Tjänst:: Maps

API-version:: 1.1

Använd 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".
duration	query		DailyDuration int32	Anger hur många dagar från nu vi vill veta om luftkvaliteten. Tillgängliga värden är 1, 2, 3, 4, 5, 6 och 7. Standardvärdet är 1.
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 vilket konto som är avsett för användning tillsammans med Microsoft Entra ID-säkerhetsmodellen. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar .

Svar

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

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till REST-API:er för Azure Maps. 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 Rest-API:er för Azure Maps.

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 ha åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API :et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet 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 skapar ett Azure Maps-konto i Azure-portalen eller använder PowerShell, CLI, Azure SDK:er eller REST API.

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

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att få åtkomst till REST-API:er för Azure Maps 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 åtgärden List SAS 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 av 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 säkrare 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	Anger hur många dagar från nu vi vill veta om luftkvaliteten. Tillgängliga värden är 1, 2, 3, 4, 5, 6 och 7. Standardvärdet är 1.
DominantPollutant	Typ av förorening. Observera att fler kan läggas till när som helst.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
JsonFormat	Önskat format för svaret. Endast `json` format stöds.

DailyAirQuality

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

Name	Typ	Description
category	string	En ordbeskrivning av luftkvaliteten på det begärda språket. Till exempel "Utmärkt".
categoryColor	string	En unik färg som motsvarar kategorin för det här luftkvalitetsresultatet.
dateTime	string	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 luftkvaliteten resulterar i det begärda språket.
dominantPollutant	DominantPollutant	Föroreningen med den högsta koncentrationen.
globalIndex	number	Internationellt normaliserat luftkvalitetsbetyg på en skala från 0 till 300 och uppåt, med högre siffror som representerar sämre luftkvalitet.
index	number	Luftkvalitetsklassificering på en skala som fastställts av lokala regleringsorgan. Skalor kan variera mycket beroende på plats. Mer information finns i Wikipedia .

DailyAirQualityForecastResult

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 i 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

Anger hur många dagar från nu vi vill veta om luftkvaliteten. Tillgängliga värden är 1, 2, 3, 4, 5, 6 och 7. Standardvärdet är 1.

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

DominantPollutant

Typ av förorening. Observera att fler kan läggas till när som helst.

Name	Typ	Description
Carbon Monoxide	string	Kolmonoxid ("CO")
Nitrogen Dioxide	string	Kvävedioxid ("NO2")
Ozone	string	Ozone ("O3")
Particulate Matter 10	string	Partiklar 10 ("PM10")
Particulate Matter 2.5	string	Partiklar 2,5 ("PM2.5")
Sulfur Dioxide	string	Svaveldioxid ("SO2")

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

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

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

JsonFormat

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

Name	Typ	Description
json	string	Datautbytesformat för JavaScript-objektnotation

Dela via