Weather - Get Severe Weather Alerts
Gebruik dit voor informatie over ernstige weersomstandigheden zoals orkanen, onweer, overstromingen, bliksem, hittegolven of bosbranden voor een bepaalde locatie.
Het weerfenomeen kan een aanzienlijke invloed hebben op ons dagelijks leven en bedrijfsactiviteiten. Zware weersomstandigheden zoals tropische stormen, harde wind of overstromingen kunnen bijvoorbeeld wegen sluiten en logistieke bedrijven dwingen hun vloot om te leiden, waardoor vertragingen ontstaan bij het bereiken van bestemmingen en het breken van de koudeketen van gekoelde voedingsmiddelen.
De Get Severe Weather Alerts
API is een HTTP-aanvraag GET
die de waarschuwingen voor ernstig weer retourneert die wereldwijd beschikbaar zijn van zowel officiële meteorologische overheidsinstanties als toonaangevende wereldwijde weerwaarschuwingsproviders. De service kan details retourneren zoals waarschuwingstype, categorie, niveau en gedetailleerde beschrijving van de actieve ernstige waarschuwingen voor de aangevraagde locatie, zoals orkanen, onweer, bliksem, hittegolven of bosbranden. Zie Waarschuwingen voor ernstig weer aanvragen voor meer informatie
GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query={query}
GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query={query}&language={language}&details={details}
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,-122,125679'. |
details
|
query |
string |
Retourneer de volledige details voor de waarschuwingen voor ernstig weer. Beschikbare waarden zijn
|
|
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 |
OK |
|
Other Status Codes |
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 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
Successfully retrieve severe weather alerts
Voorbeeldaanvraag
GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query=48.057,-81.091
Voorbeeldrespons
{
"results": [
{
"countryCode": "CA",
"alertId": 242621,
"description": {
"localized": "Heat Warning",
"english": "Heat Warning"
},
"category": "NON-PRECIPITATION",
"priority": 31,
"source": "Environment Canada",
"sourceId": 3,
"alertAreas": [
{
"name": "Kirkland Lake - Englehart",
"summary": "Heat Warning in effect until Thursday, 3:16 AM EDT. Source: Environment Canada",
"startTime": "2020-06-29T19:44:00+00:00",
"endTime": "2020-07-02T07:16:03+00:00",
"latestStatus": {
"localized": "Continue",
"english": "Continue"
},
"alertDetails": "\nA heat event continues through Thursday.\n\nDaytime high temperatures in the low thirties with overnight lows near 18 degrees Celsius are expected to continue until Thursday. Humidex values are expected to reach between 36 and 40 today. Cooler air will move into the region Thursday night. \n\nPlease refer to your public forecast for further details on expected temperatures.\n\nHot and humid air can also bring deteriorating air quality and can result in the air quality health index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nWatch for the effects of heat illness: swelling, rash, cramps, fainting, heat exhaustion, heat stroke and the worsening of some health conditions.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n",
"alertDetailsLanguageCode": "en-CA"
}
]
},
{
"countryCode": "CA",
"alertId": 242633,
"description": {
"localized": "Heat Warning",
"english": "Heat Warning"
},
"category": "NON-PRECIPITATION",
"priority": 31,
"source": "Environment Canada",
"sourceId": 3,
"alertAreas": [
{
"name": "Kirkland Lake - Englehart",
"summary": "Heat Warning in effect until 9:25 PM EDT. Source: Environment Canada",
"startTime": "2020-07-01T09:25:59+00:00",
"endTime": "2020-07-02T01:25:59+00:00",
"latestStatus": {
"localized": "New",
"english": "New"
},
"alertDetails": "\nA heat event is expected through Thursday. \n\nDaytime high temperatures in the low thirties on Wednesday and Thursday with overnight lows near 18 degrees Celsius are expected. This heat event may be extended into the weekend with daytime high temperatures near 30 degrees Celsius. \n\nPlease refer to your public forecast for further details on expected temperatures. \n\nHot and humid air can also bring deteriorating air quality and can result in the Air Quality Health Index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n",
"alertDetailsLanguageCode": "en-CA"
}
]
}
]
}
Definities
Name | Description |
---|---|
Alert |
Informatie over een waarschuwing voor ernstig weer dat is uitgegeven binnen een of meer getroffen gebieden. Als er meerdere waarschuwingen actief zijn voor dezelfde locatie, worden de waarschuwingen geretourneerd in volgorde van |
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
De foutdetails. |
Error |
Foutreactie |
Json |
Gewenste indeling van het antwoord. Alleen |
Latest |
De meest recente status van de waarschuwing in het huidige gebied. |
Latest |
Trefwoord voor de meest recente status van de waarschuwing. |
Severe |
Informatie over een waarschuwing voor ernstig weer. |
Severe |
Beschrijving van een waarschuwing voor ernstig weer. |
Severe |
Dit object wordt geretourneerd na een geslaagde aanroep Waarschuwingen voor ernstig weer ophalen. |
AlertArea
Informatie over een waarschuwing voor ernstig weer dat is uitgegeven binnen een of meer getroffen gebieden. Als er meerdere waarschuwingen actief zijn voor dezelfde locatie, worden de waarschuwingen geretourneerd in volgorde van priority
binnen het API-antwoord, waarbij de waarschuwing met de hoogste prioriteit boven aan het antwoord wordt geretourneerd.
Name | Type | Description |
---|---|---|
alertDetails |
string |
Volledige details die zijn gekoppeld aan de waarschuwing. Geretourneerd als |
alertDetailsLanguageCode |
string |
Taal van de |
endTime |
string |
De einddatum en -tijd van de waarschuwing in ISO 8601-indeling, bijvoorbeeld 2019-10-27T19:39:57-08:00. Als de waarschuwing meerdere tijdzones overschrijdt, is de geretourneerde tijd in het antwoord de lokale tijd naar de aangevraagde coördinaatlocatie. |
latestStatus |
De meest recente status van de waarschuwing in het huidige gebied. |
|
name |
string |
De naam van een gebied dat wordt beïnvloed door de waarschuwing. De locatie die is aangevraagd, valt onder het waarschuwingsgebied. |
startTime |
string |
De begindatum en -tijd van de waarschuwing in ISO 8601-indeling, bijvoorbeeld 2019-10-27T19:39:57-08:00. Als de waarschuwing meerdere tijdzones overschrijdt, is de geretourneerde tijd in het antwoord de lokale tijd naar de aangevraagde coördinaatlocatie. |
summary |
string |
Tekst waarin de waarschuwing in het geretourneerde gebied wordt samengevat. |
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 |
De fout 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
de indeling wordt ondersteund.
Name | Type | Description |
---|---|---|
json |
string |
LatestStatus
De meest recente status van de waarschuwing in het huidige gebied.
Name | Type | Description |
---|---|---|
english |
Meest recente status trefwoord voor de waarschuwing, in het Engels (en-US). |
|
localized |
string |
Het meest recente status trefwoord voor de waarschuwing, in de opgegeven taal. Standaard geretourneerd in het Engels (en-US). |
LatestStatusKeyword
Trefwoord voor de meest recente status van de waarschuwing.
Name | Type | Description |
---|---|---|
Cancel |
string |
'Annuleren': de waarschuwing is geannuleerd vóór de oorspronkelijke verlooptijd. |
Continue |
string |
'Doorgaan': de waarschuwing is bijgewerkt sinds de eerste uitgifte, maar er zijn geen wijzigingen aangebracht in |
Correct |
string |
'Correct': de waarschuwing is gewijzigd om een eerdere fout te corrigeren. |
Expire |
string |
Verlopen: de waarschuwing is verlopen en is niet meer actief. |
Extend |
string |
'Uitbreiden': de waarschuwing is verlengd in tijd, in gebied of beide sinds de eerste uitgifte. |
New |
string |
'Nieuw': de status van een waarschuwing bij de eerste uitgifte. |
Update |
string |
'Update': de waarschuwing is bijgewerkt sinds de eerste uitgifte. |
Upgrade |
string |
'Upgraden': de waarschuwing is geüpgraded naar een hogere klasse of categorie sinds de eerste uitgifte. |
SevereWeatherAlert
Informatie over een waarschuwing voor ernstig weer.
Name | Type | Description |
---|---|---|
alertAreas |
Informatie over de waarschuwing die specifiek is voor de betrokken gebieden. |
|
alertId |
integer |
Een unieke numerieke id voor een weerwaarschuwing. |
category |
string |
Categorie van de waarschuwing. |
class |
string |
Classificatie van de waarschuwing. Dit veld is niet voor alle landen beschikbaar en wordt daarom niet altijd geretourneerd. |
countryCode |
string |
ISO 3166-1 Alpha-2-landcode van twee tekens, bijvoorbeeld 'US'. |
description |
Beschrijving van de waarschuwing. |
|
disclaimer |
string |
Een vrijwaring met betrekking tot de bron van de waarschuwingsinformatie. Dit veld is niet altijd beschikbaar. Disclaimer kan bijvoorbeeld details bevatten over de vertragingen of mogelijke problemen met betrekking tot het alarm. |
level |
string |
Ernstniveau van de waarschuwing. Dit veld is niet voor alle landen beschikbaar en wordt daarom niet altijd geretourneerd. |
priority |
integer |
Nummer dat het belang of de rangschikkingsvolgorde van de opgegeven waarschuwing aangeeft binnen het land/de regio waarvan de waarschuwing afkomstig is. Een lager getal geeft een hogere prioriteit aan. 1 is bijvoorbeeld de hoogste prioriteit. Het aantal verschilt per land/regio en kan in de loop van de tijd veranderen naarmate elk land/elke regio zijn waarschuwingssystemen ontwikkelt. |
source |
string |
De provider van de waarschuwingsgegevens. De bron wordt standaard geretourneerd in het Engels (en-US). De waarschuwingen zijn afkomstig van officiële meteorologische overheidsinstanties en toonaangevende wereldwijde weerwaarschuwingsproviders. |
sourceId |
integer |
Een numerieke id die is gekoppeld aan de naam van de bronprovider van de waarschuwingsgegevens. |
SevereWeatherAlertDescription
Beschrijving van een waarschuwing voor ernstig weer.
Name | Type | Description |
---|---|---|
english |
string |
Beschrijving van de waarschuwing in het Engels (en-US). |
localized |
string |
Beschrijving van de waarschuwing in de opgegeven taal. Standaard wordt Engels (en-US) geretourneerd als de taalparameter niet is opgegeven in de aanvraag. |
SevereWeatherAlertsResult
Dit object wordt geretourneerd na een geslaagde aanroep Waarschuwingen voor ernstig weer ophalen.
Name | Type | Description |
---|---|---|
results |
Een lijst met alle waarschuwingen voor noodweer voor de opgevraagde locatie. |