Weather - Get Current Air Quality
Gebruik dit om actuele informatie over de luchtkwaliteit te krijgen, inclusief mogelijke risico's en voorgestelde voorzorgsmaatregelen.
De Get Current Air Quality API is een HTTP-verzoek GET dat gedetailleerde informatie retourneert over de concentratie van verontreinigende stoffen en de algehele status van de huidige luchtkwaliteit, inclusief vervuilingsniveaus, luchtkwaliteitsindexwaarden, de dominante verontreinigende stof, en een korte verklaring met een samenvatting van het risiconiveau en de voorgestelde voorzorgsmaatregelen.
GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query={query}
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 |
Gewenste indeling van het antwoord. Alleen |
|
|
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 die is samengesteld door breedtegraad gevolgd door lengtegraad, bijvoorbeeld '47,641268,-125679'. Weersinformatie is over het algemeen beschikbaar voor locaties op het land, watermassa's omgeven door land en delen van de oceaan die zich binnen ongeveer 50 zeemijl van een kustlijn bevinden. |
|
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 Waar. |
Aanvraagkoptekst
| Name | Vereist | Type | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Geeft het account aan dat bedoeld is voor gebruik met het Microsoft Entra ID-beveiligingsmodel. Deze unieke id voor het Azure Maps-account kan worden verkregen uit de account-API van het Azure Maps-beheervlak. Zie Verificatie beheren in Azure Maps voor meer informatie over het gebruik van Microsoft Entra ID-beveiliging in Azure Maps. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Er is een onverwachte fout opgetreden. |
Beveiliging
AADToken
Dit zijn de Microsoft Entra OAuth 2.0 Flows. Wanneer deze is gekoppeld aan 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 aan te wijzen tot een of meer Azure Maps-resourceaccounts of subresources. 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 om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.
Notes
- Deze beveiligingsdefinitie vereist het gebruik van de
x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Maps Management-API.
De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties.
* Het op rollen gebaseerde 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 configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.
- Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het 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 maken 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 worden uitgegeven.
Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering 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 wordt gemaakt op basis van de bewerking List SAS 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 voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.
Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.
Type:
apiKey
In:
header
Voorbeelden
Get Current Air Quality
Voorbeeldaanvraag
GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query=47.632346,-122.13887
Voorbeeldrespons
{
"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 |
|---|---|
|
Air |
Het AirQuality-object biedt uitgebreide informatie over de huidige luchtkwaliteit op de opgegeven locatie. Dit omvat de concentratieniveaus van verschillende verontreinigende stoffen, numerieke Air Quality Index (AQI)-waarden die de algehele luchtkwaliteit aangeven, en identificatie van de dominante verontreinigende stof die de luchtkwaliteit beïnvloedt. Daarnaast biedt het een samenvatting van het risiconiveau, waarin mogelijke gezondheidsrisico's kort worden uiteengezet en voorzorgsmaatregelen worden voorgesteld. |
|
Air |
Een reeks Airquality-objecten , elk met uitgebreide informatie over de huidige luchtkwaliteit op de opgegeven locatie. |
|
Dominant |
Identificeert de verontreinigende stof met de hoogste concentratie. |
|
Error |
Aanvullende informatie over de resourcebeheerfout. |
|
Error |
De foutdetails. |
|
Error |
Foutreactie |
|
Json |
Gewenste indeling van het antwoord. Alleen |
| Pollutant |
Gedetailleerde informatie over een individuele verontreinigende stof. Niet geretourneerd als |
|
Pollutant |
Specificeert de zes typen verontreinigende stoffen die worden bijgehouden door de Azure Maps Weather-service. |
|
Unit |
Een geheel getal dat het eenheidstype voorstelt. Bijvoorbeeld 17 voor Celsius, 18 voor Fahrenheit. Kan worden gebruikt voor unitvertaling. Zie Weerservices in Azure Maps voor een volledige lijst. |
|
Weather |
Specifieke waarde van een bepaalde eenheid met betrekking tot het weer. |
AirQuality
Het AirQuality-object biedt uitgebreide informatie over de huidige luchtkwaliteit op de opgegeven locatie. Dit omvat de concentratieniveaus van verschillende verontreinigende stoffen, numerieke Air Quality Index (AQI)-waarden die de algehele luchtkwaliteit aangeven, en identificatie van de dominante verontreinigende stof die de luchtkwaliteit beïnvloedt. Daarnaast biedt het een samenvatting van het risiconiveau, waarin mogelijke gezondheidsrisico's kort worden uiteengezet en voorzorgsmaatregelen worden voorgesteld.
| Name | Type | Description |
|---|---|---|
| category |
string |
Geeft een éénwoordige beschrijving van de luchtkwaliteit voor de voorspellingsperiode in de opgegeven taal, zoals Slecht, Matig of Uitstekend. |
| categoryColor |
string |
Biedt een unieke hexadecimale kleurcode die overeenkomt met de luchtkwaliteitscategorie voor elke dag in de voorspellingsperiode. Deze kleur helpt gebruikers snel het luchtkwaliteitsniveau visueel te identificeren, waarbij elke kleur overeenkomt met een categorie zoals Slecht, Matig of Uitstekend. |
| dateTime |
string (date-time) |
Datum en tijd van de huidige waarneming, weergegeven in ISO 8601-formaat (yyyy-mm-ddThh:mm:ss-hh:mm). Bijvoorbeeld, 2025-04-29T07:00:00-07:00. |
| description |
string |
Een tekstuele uitleg van deze luchtkwaliteit resulteert in de gevraagde taal. |
| dominantPollutant |
Identificeert de verontreinigende stof met de hoogste concentratie. |
|
| globalIndex |
number (float) |
Biedt een internationaal gestandaardiseerde manier om de concentratie van verontreinigende stoffen in de lucht te begrijpen. Beoordelingen variëren van 0 tot 300 en hoger, waarbij hogere cijfers een slechtere luchtkwaliteit aangeven. De gemeten verontreinigende stoffen zijn onder andere PM2.5, PM10, NO2, SO2, CO en O3. |
| index |
number (float) |
De luchtkwaliteitsindex (AQI) is een luchtkwaliteitsbeoordelingsschaal die wordt vastgesteld door lokale regulerende instanties. Schalen kunnen sterk variëren, afhankelijk van de locatie. Voor meer informatie, zie Luchtkwaliteitsindex op Wikipedia. |
| pollutants |
Een array met gedetailleerde informatie over elke verontreinigende stof in de respons. Teruggegeven wanneer de |
AirQualityResult
Een reeks Airquality-objecten , elk met uitgebreide informatie over de huidige luchtkwaliteit op de opgegeven locatie.
| Name | Type | Description |
|---|---|---|
| nextLink |
string |
Bevat de URL om de volgende pagina met resultaten op te halen als het antwoord gepagineerd is. Dit is handig wanneer het antwoord te groot is om in één oproep te worden beantwoord, waardoor gebruikers door meerdere pagina's met resultaten kunnen navigeren. |
| results |
Gedetailleerde luchtkwaliteitsresultaten binnen de opgegeven locatie, inclusief eigenschappen zoals de luchtkwaliteitsindex (AQI), dominante verontreiniging, verontreinigingsniveaus, risiconiveau en voorgestelde voorzorgsmaatregelen. |
DominantPollutant
Identificeert de verontreinigende stof met de hoogste concentratie.
| Waarde | Description |
|---|---|
| Carbon Monoxide |
Koolmonoxide (CO) is een kleurloos, geurloos en smaakloos maar zeer giftig gas dat wordt geproduceerd door de onvolledige verbranding van koolstofhoudende brandstoffen. Veelvoorkomende bronnen zijn uitlaatgassen van voertuigen, gasfornuizen, ovens en houtvuren. |
| Nitrogen Dioxide |
Stikstofdioxide (NO2) is een belangrijke atmosferische verontreinigende stof. Het is gereguleerd en onderworpen aan de aanbevolen limietrichtlijnen die zijn opgesteld door de Wereldgezondheidsorganisatie (WHO). |
| Ozone |
Ozon (O3) is een belangrijk bestanddeel van fotochemische smog, de bruine, schadelijke waas die veel grote steden omhult en die het gevolg is van een fotochemische reactie tussen zonlicht en bepaalde specifieke verontreinigende stoffen. |
| Particulate Matter 2.5 |
Fijnstof 2.5 (PM2.5) verwijst naar fijne deeltjes met een diameter die over het algemeen 2.5 micrometer en kleiner is. Deze deeltjes zijn meer dan 100 keer dunner dan een mensenhaar en kunnen langere tijd in de lucht blijven zweven |
| Particulate Matter 10 |
Fijnstof 10 (PM10) verwijst naar deeltjes met een diameter die over het algemeen 10 micrometer en kleiner is. Deze deeltjes kunnen stof, pollen, roet, rook en vloeistofdruppels bevatten. |
| Sulfur Dioxide |
Zwaveldioxide (SO2) is een zwaar, kleurloos anorganisch gas met een doordringende, irriterende geur. Het wordt voornamelijk geproduceerd door het verbranden van fossiele brandstoffen in energiecentrales en industriële faciliteiten, maar het kan ook worden uitgestoten door natuurlijke bronnen zoals vulkanen. |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
| Name | Type | Description |
|---|---|---|
| info |
object |
De aanvullende informatie. |
| type |
string |
Het extra informatietype. |
ErrorDetail
De foutdetails.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
De fout bevat aanvullende informatie. |
|
| code |
string |
De foutcode. |
| details |
De foutdetails. |
|
| message |
string |
Het foutbericht. |
| target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
| Name | Type | Description |
|---|---|---|
| error |
Het foutobject. |
JsonFormat
Gewenste indeling van het antwoord. Alleen json indeling wordt ondersteund.
| Waarde | Description |
|---|---|
| json |
De Notatie Data Interchange-indeling voor JavaScript-objecten |
Pollutant
Gedetailleerde informatie over een individuele verontreinigende stof. Niet geretourneerd als pollutants=onwaar.
| Name | Type | Description |
|---|---|---|
| concentration |
Een object met het aantal vervuilende deeltjes per volume lucht. |
|
| globalIndex |
number (float) |
Internationaal genormaliseerde luchtkwaliteitsclassificatie op een schaal van 0 tot 300 en hoger, waarbij hogere getallen staan voor een slechtere luchtkwaliteit. |
| index |
number (float) |
Luchtkwaliteitsclassificatie op een schaal die is vastgesteld door lokale regelgevende instanties. 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 |
Type verontreinigende stof. Houd er rekening mee dat er op elk moment meer kan worden toegevoegd. |
PollutantType
Specificeert de zes typen verontreinigende stoffen die worden bijgehouden door de Azure Maps Weather-service.
| Waarde | Description |
|---|---|
| CO |
Koolmonoxide |
| NO2 |
Stikstofdioxide |
| O3 |
Ozon |
| PM2.5 |
Fijnstof 2.5 |
| PM10 |
Fijnstof 10 |
| SO2 |
Zwaveldioxide |
UnitType
Een geheel getal dat het eenheidstype voorstelt. Bijvoorbeeld 17 voor Celsius, 18 voor Fahrenheit. Kan worden gebruikt voor unitvertaling. Zie Weerservices in Azure Maps voor een volledige lijst.
| Waarde | Description |
|---|---|
| 0 |
feet |
| 1 |
inches |
| 2 |
miles |
| 3 |
millimeter |
| 4 |
centimeter |
| 5 |
meter |
| 6 |
kilometer |
| 7 |
kilometersPerHour |
| 8 |
knots |
| 9 |
milesPerHour |
| 10 |
metersPerSecond |
| 11 |
hectoPascals |
| 12 |
inchesOfMercury |
| 13 |
kiloPascals |
| 14 |
millibars |
| 15 |
millimetersOfMercury |
| 16 |
poundsPerSquareInch |
| 17 |
Celsius |
| 18 |
Fahrenheit |
| 19 |
kelvin |
| 20 |
percent |
| 21 |
float |
| 22 |
integer |
| 31 |
MicrogramsPerCubicMeterOfAir |
WeatherUnit
Specifieke waarde van een bepaalde eenheid met betrekking tot het weer.
| Name | Type | Description |
|---|---|---|
| unit |
string |
Type eenheid voor de geretourneerde waarde. |
| unitType |
Unit |
Een geheel getal dat het eenheidstype voorstelt. Bijvoorbeeld 17 voor Celsius, 18 voor Fahrenheit. Kan worden gebruikt voor unitvertaling. Zie Weerservices in Azure Maps voor een volledige lijst. |
| value |
number (float) |
Afgeronde waarde. |