Weather - Get Current Air Quality

Referentie

Service:: Maps

API-versie:: 1.1

Gebruik om actuele informatie over de luchtkwaliteit op te halen met mogelijke risico's en voorgestelde voorzorgsmaatregelen.

De Get Current Air Quality API is een HTTP-aanvraag GET die gedetailleerde informatie retourneert over de concentratie van verontreinigende stoffen en de algemene status van de huidige luchtkwaliteit, waaronder verontreinigingsniveaus, indexwaarden van de luchtkwaliteit, de dominante verontreinigende stof en een korte verklaring met een samenvatting van het risiconiveau en voorgestelde voorzorgsmaatregelen.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
format	path	True	JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
api-version	query	True	string	Versienummer van Azure Maps-API.
query	query	True	number[]	De toepasselijke query die is opgegeven als een door komma's gescheiden tekenreeks, samengesteld door breedtegraad gevolgd door lengtegraad, bijvoorbeeld '47,641268,-122,125679'.
language	query		string	Taal waarin zoekresultaten moeten worden geretourneerd. Moet een van de ondersteunde IETF-taaltags zijn, niet hoofdlettergevoelig. Wanneer gegevens in de opgegeven taal niet beschikbaar zijn voor een specifiek veld, wordt de standaardtaal gebruikt. Raadpleeg Ondersteunde talen voor meer informatie.
pollutants	query		boolean	Booleaanse waarde die gedetailleerde informatie over elke verontreinigende stof retourneert. Standaard is True.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps-beheervlak Account-API. Als u Microsoft Entra ID-beveiliging in Azure Maps wilt gebruiken, raadpleegt u de volgende artikelen voor hulp.

Antwoorden

Name	Type	Description
200 OK	AirQualityResult	OK
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen . Wanneer het wordt gekoppeld met op rollen gebaseerd toegangsbeheer van Azure , kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps-resourceaccounts of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API .

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt het mogelijk om een toepassing op basis van configuraties in te stellen voor meerdere gebruiksvoorbeelden.

Zie Overzicht van Microsoft Identity Platform voor meer informatie over Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account maakt in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een Shared Access Signature-token dat is gemaakt op basis van de SAS-bewerking List op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Get Current Air Quality

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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
          }
        }
      ]
    }
  ]
}

Definities

Name	Description
AirQuality	Informatie over de luchtkwaliteit op een specifieke locatie op een bepaald tijdstip.
AirQualityResult	Dit object wordt geretourneerd na een geslaagde aanroep Luchtkwaliteit ophalen.
DominantPollutant	Type verontreinigende stof. Houd er rekening mee dat er op elk gewenst moment meer kunnen worden toegevoegd.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
JsonFormat	Gewenste indeling van het antwoord. Alleen `json` de indeling wordt ondersteund.
Pollutant	Gedetailleerde informatie over een individuele verontreinigende stof. Niet geretourneerd als `pollutants`=onwaar.
PollutantType	Type verontreinigende stof. Houd er rekening mee dat er op elk gewenst moment meer kunnen worden toegevoegd.
UnitType	Numerieke id-waarde die is gekoppeld aan het type eenheid dat wordt weergegeven. Kan worden gebruikt voor eenheidsvertaling. Raadpleeg Weerservices in Azure Maps voor meer informatie.
WeatherUnit	Specifieke waarde van een bepaalde eenheid met betrekking tot het weer.

AirQuality

Informatie over de luchtkwaliteit op een specifieke locatie op een bepaald tijdstip.

Name	Type	Description
category	string	Eén woord beschrijving van de luchtkwaliteit in de aangevraagde taal. Bijvoorbeeld 'Uitstekend'.
categoryColor	string	Een unieke kleur die overeenkomt met de categorie van dit luchtkwaliteitsresultaat.
dateTime	string	Datum en tijd van de huidige waarneming weergegeven in ISO 8601-notatie, bijvoorbeeld 2019-10-27T19:39:57-08:00.
description	string	Een tekstuele uitleg van deze luchtkwaliteit resulteert in de aangevraagde taal.
dominantPollutant	DominantPollutant	De verontreinigende stof met de hoogste concentratie.
globalIndex	number	Internationaal genormaliseerde luchtkwaliteitsclassificatie op een schaal van 0 tot 300 en hoger, met hogere aantallen die een slechtere luchtkwaliteit vertegenwoordigen.
index	number	Classificatie van de luchtkwaliteit op een schaalset door lokale regulerende instanties. De schalen kunnen sterk variëren, afhankelijk van de locatie. Zie Wikipedia voor meer informatie.
pollutants	Pollutant[]	Informatie over afzonderlijke verontreinigende stoffen.

AirQualityResult

Dit object wordt geretourneerd na een geslaagde aanroep Luchtkwaliteit ophalen.

Name	Type	Description
nextLink	string	De is de koppeling naar de volgende pagina van de geretourneerde functies. Als het de laatste pagina is, geen dit veld.
results	AirQuality[]	Een lijst met alle resultaten van de luchtkwaliteit voor de opgevraagde locatie.

DominantPollutant

Type verontreinigende stof. Houd er rekening mee dat er op elk gewenst moment meer kunnen worden toegevoegd.

Name	Type	Description
Carbon Monoxide	string	Koolmonoxide ("CO")
Nitrogen Dioxide	string	Stikstofdioxide ("NO2")
Ozone	string	Ozon ('O3')
Particulate Matter 10	string	Deeltjes 10 ('PM10')
Particulate Matter 2.5	string	Deeltjes 2,5 ("PM2.5")
Sulfur Dioxide	string	Zwaveldioxide ("SO2")

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

JsonFormat

Gewenste indeling van het antwoord. Alleen json de indeling wordt ondersteund.

Name	Type	Description
json	string	De JavaScript Object Notation Data Interchange-indeling

Pollutant

Gedetailleerde informatie over een individuele verontreinigende stof. Niet geretourneerd als pollutants=onwaar.

Name	Type	Description
concentration	WeatherUnit	Een object met het aantal verontreinigende deeltjes per volume lucht.
globalIndex	number	Internationaal genormaliseerde luchtkwaliteitsclassificatie op een schaal van 0 tot 300 en hoger, met hogere aantallen die een slechtere luchtkwaliteit vertegenwoordigen.
index	number	Classificatie van de luchtkwaliteit op een schaalset door lokale regulerende instanties. De schalen kunnen sterk variëren, afhankelijk van de locatie. Zie Wikipedia voor meer informatie.
name	string	De naam van de verontreinigende stof in het Engels.
type	PollutantType	Type verontreinigende stof. Houd er rekening mee dat er op elk gewenst moment meer kunnen worden toegevoegd.

PollutantType