Weather - Get Current Air Quality

Referens

Service:: Maps

API Version:: 1.1

Använd för att hämta aktuell luftkvalitetsinformation som innehåller potentiella risker och föreslagna försiktighetsåtgärder.

API:et Get Current Air Quality är en HTTP-begäran GET som returnerar detaljerad information om koncentrationen av föroreningar och övergripande status för den aktuella luftkvaliteten, inklusive föroreningsnivåer, indexvärden för luftkvalitet, 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/current/json?api-version=1.1&query={query}

With optional parameters:

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

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".
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 .
pollutants	query		boolean	Booleskt värde som returnerar detaljerad information om varje förorening. Som standard är Sant.

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äkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps hanteringsplans konto-API. 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	AirQualityResult	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 Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto 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 för att 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.

Kommentarer

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

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, 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 Microsofts identitetsplattform översikt.

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

Det här är en delad nyckel som etableras när du Skapa ett Azure Maps-konto i Azure Portal 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:et. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de utfärdas i.

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

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, 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 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 återgivningsmissbruk och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

Get Current Air Quality

Sample Request

HTTP

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

Sample Response

Status code:: 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
          }
        }
      ]
    }
  ]
}

Definitioner

Name	Description
AirQuality	Information om luftkvaliteten på en viss plats vid en viss tidpunkt.
AirQualityResult	Det här objektet returneras från ett lyckat Get Air Quality-anrop.
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.
Pollutant	Detaljerad information om en enskild förorening. Returneras inte om `pollutants`=false.
PollutantType	Typ av förorening. Observera att fler kan läggas till när som helst.
UnitType	Numeriskt ID-värde som är associerat med den typ av enhet som visas. Kan användas för enhetsöversättning. Mer information finns i Vädertjänster i Azure Maps.
WeatherUnit	Specifikt värde för en viss enhet som är relaterad till väder.

AirQuality

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

Name	Typ	Description
category	string	En ord beskrivning 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 som 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 reglerande organ. Skalor kan variera mycket beroende på plats. Mer information finns i Wikipedia .
pollutants	Pollutant[]	Information om enskilda föroreningar.

AirQualityResult

Det här objektet returneras från ett lyckat Get Air Quality-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	AirQuality[]	En lista över alla luftkvalitetsresultat för den efterfrågade platsen.

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	Ozon ("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	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

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

Pollutant

Detaljerad information om en enskild förorening. Returneras inte om pollutants=false.

Name	Typ	Description
concentration	WeatherUnit	Ett objekt som innehåller antalet föroreningspartiklar per luftvolym.
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 reglerande organ. Skalor kan variera mycket beroende på plats. Mer information finns i Wikipedia .
name	string	Namnet på föroreningen på engelska.
type	PollutantType	Typ av förorening. Observera att fler kan läggas till när som helst.

PollutantType