Weather - Get Air Quality Daily Forecasts

Referentie

Service:: Maps

API-versie:: 1.1

Gebruik om dagelijkse prognoses voor de luchtkwaliteit te krijgen voor de komende één tot zeven dagen, met daarin de niveaus van verontreinigende stoffen, mogelijke risico's en voorgestelde voorzorgsmaatregelen.

De Get Air Quality Daily Forecasts API is een HTTP-aanvraag GET die gedetailleerde informatie retourneert over de concentratie van verontreinigende stoffen en de algehele status van de voorspelde dagelijkse luchtkwaliteit. De service kan de verwachte dagelijkse informatie over de luchtkwaliteit voor de komende 1 tot 7 dagen verstrekken, waaronder vervuilingsniveaus, indexwaarden voor de luchtkwaliteit, de dominante verontreinigende stof en een korte samenvatting van het risiconiveau en voorgestelde voorzorgsmaatregelen.

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

Met optionele parameters:

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

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'.
duration	query		DailyDuration int32	Hiermee geeft u op hoeveel dagen we over nu willen weten over de luchtkwaliteit. Beschikbare waarden zijn 1, 2, 3, 4, 5, 6 en 7. De standaardwaarde is 1.
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.

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	DailyAirQualityForecastResult	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 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 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.

Als u scenario's wilt implementeren, raden we u aan om 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 moet de x-ms-client-id header worden gebruikt om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps .

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 configuratie van een toepassing mogelijk voor meerdere use cases.

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 beschikbare toepassingen wordt aanbevolen om de benadering 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 over het verloop, de snelheid en de 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 oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Get Daily Air Quality Forecasts

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
DailyAirQuality	Informatie over de luchtkwaliteit op een specifieke locatie op een specifiek tijdstip.
DailyAirQualityForecastResult	Dit object wordt geretourneerd na een geslaagde aanroep Get Daily Air Quality Forecast.
DailyDuration	Hiermee geeft u op hoeveel dagen we over nu willen weten over de luchtkwaliteit. Beschikbare waarden zijn 1, 2, 3, 4, 5, 6 en 7. De standaardwaarde is 1.
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.

DailyAirQuality

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

Name	Type	Description
category	string	Een beschrijving van de luchtkwaliteit in de gewenste taal. Bijvoorbeeld 'Uitstekend'.
categoryColor	string	Een unieke kleur die overeenkomt met de categorie van dit luchtkwaliteitsresultaat.
dateTime	string	De datum en tijd van de huidige waarneming weergegeven in ISO 8601-indeling, bijvoorbeeld 2019-10-27T19:39:57-08:00.
description	string	Een tekstuele uitleg van dit luchtkwaliteitsresultaat in de gewenste 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	Beoordeling van de luchtkwaliteit op een schaalset door lokale regulerende instanties. De schaal kan sterk variëren, afhankelijk van de locatie. Zie Wikipedia voor meer informatie.

DailyAirQualityForecastResult

Dit object wordt geretourneerd na een geslaagde aanroep Get Daily Air Quality Forecast.

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	DailyAirQuality[]	Een lijst met alle dagelijkse prognoses voor de luchtkwaliteit voor de opgevraagde locatie.

DailyDuration

Hiermee geeft u op hoeveel dagen we over nu willen weten over de luchtkwaliteit. Beschikbare waarden zijn 1, 2, 3, 4, 5, 6 en 7. De standaardwaarde is 1.

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

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[]	De fout aanvullende informatie.
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

Delen via