Weather - Get Severe Weather Alerts

Referens

Service:: Maps

API Version:: 1.1

Använd för att få information om svåra väderförhållanden som orkaner, åska, översvämningar, blixtnedslag, värmeböljor eller skogsbränder för en viss plats.

Ovädersfenomen kan påverka vår vardag och verksamhet avsevärt. Till exempel kan svåra väderförhållanden som tropiska stormar, kraftiga vindar eller översvämningar stänga vägar och tvinga logistikföretag att omdirigera sin flotta, vilket orsakar förseningar i att nå destinationer och bryta den kalla kedjan av kylda livsmedelsprodukter.

API:et Get Severe Weather Alerts är en HTTP-begäran GET som returnerar aviseringar om oväder som är tillgängliga över hela världen från både officiella statliga meteorologiska myndigheter och som leder till globala till regionala vädervarningsleverantörer. Tjänsten kan returnera information som aviseringstyp, kategori, nivå och detaljerad beskrivning av aktiva allvarliga aviseringar för den begärda platsen, till exempel orkaner, åskväder, blixtnedslag, värmeböljor eller skogsbränder. Mer information finns i Begära aviseringar om oväder

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

With optional parameters:

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query={query}&language={language}&details={details}

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".
details	query		string	Returnera fullständig information för varningar om oväder. Tillgängliga värden är `true` – Returnerar fullständig information. Som standard returneras all information. `false` – Returnerar en trunkerad version av aviseringsdata, som exkluderar den områdesspecifika fullständiga beskrivningen av aviseringsinformationen (`alertDetails`).
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 .

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. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från konto-API:et för Azure Maps hanteringsplan. 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	SevereWeatherAlertsResult	OKEJ
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 ett 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 ha å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-hanterings-API :et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Rollbaserad åtkomstkontroll i Azure 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 huvudnyckel i det konto som de har utfärdats 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 säkrare 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 återgivningsmissbruket och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

Successfully retrieve severe weather alerts

Sample Request

HTTP

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query=48.057,-81.091

Sample Response

Status code:: 200

{
  "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"
        }
      ]
    }
  ]
}

Definitioner

Name	Description
AlertArea	Information om en ovädersvarning som utfärdats inom ett eller flera berörda områden. Om flera aviseringar är aktiva för samma plats returneras aviseringarna `priority` i ordning i API-svaret, där den högsta prioritetsaviseringen returneras överst i svaret.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
JsonFormat	Önskat format för svaret. Endast `json` format stöds.
LatestStatus	Den senaste statusen för aviseringen i det aktuella området.
LatestStatusKeyword	Nyckelord för den senaste statusen för aviseringen.
SevereWeatherAlert	Information om en varning om oväder.
SevereWeatherAlertDescription	Beskrivning av en varning om oväder.
SevereWeatherAlertsResult	Det här objektet returneras från ett lyckat Get Severe Weather Alerts-anrop.

AlertArea

Information om en ovädersvarning som utfärdats inom ett eller flera berörda områden. Om flera aviseringar är aktiva för samma plats returneras aviseringarna priority i ordning i API-svaret, där den högsta prioritetsaviseringen returneras överst i svaret.

Name	Typ	Description
alertDetails	string	Fullständig information som är associerad med aviseringen. Returneras om `details`=Sant. Det här fältet returneras alltid på det eller de språk som den utfärdande providern väljer och Azure Maps returnerar bara det som skapas av providern. Observera att vissa länder/regioner kan erbjuda sitt eget språk och sin engelska. Språkparametern gäller inte för det här fältet.
alertDetailsLanguageCode	string	Språk för `alertDetails`. Det här fältet hjälper till att påpeka att språket i `alertDetails` kan skilja sig från den begärda språkparametern. Returneras om `details`=Sant. Språkkoden har härletts från ISO 639-1 Alpha-2-koderna.
endTime	string	Slutdatum och tid för aviseringen i ISO 8601-format, till exempel 2019-10-27T19:39:57-08:00. Om aviseringen korsar flera tidszoner är den returnerade tiden i svaret den lokala tiden till den begärda koordinatplatsen.
latestStatus	LatestStatus	Den senaste statusen för aviseringen i det aktuella området.
name	string	Namnet på ett område som påverkas av aviseringen. Platsen som begärdes hamnar under aviseringsområdet.
startTime	string	Startdatum och tid för aviseringen i ISO 8601-format, till exempel 2019-10-27T19:39:57-08:00. Om aviseringen korsar flera tidszoner är den returnerade tiden i svaret den lokala tiden till den begärda koordinatplatsen.
summary	string	Text som sammanfattar aviseringen i det returnerade området.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

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

LatestStatus

Den senaste statusen för aviseringen i det aktuella området.

Name	Typ	Description
english	LatestStatusKeyword	Senaste statusnyckelordet för aviseringen på engelska (en-US).
localized	string	Det senaste statusnyckelordet för aviseringen på det angivna språket. Som standard returneras på engelska (en-US).

LatestStatusKeyword

Nyckelord för den senaste statusen för aviseringen.

Name	Typ	Description
Cancel	string	"Avbryt" – aviseringen har avbrutits före den ursprungliga förfallotiden.
Continue	string	"Fortsätt" – aviseringen har uppdaterats sedan den första utfärdandet, men inga ändringar har gjorts i `alertDetails`, `startTime`, `endTime`eller `class`.
Correct	string	"Rätt" – aviseringen har ändrats för att korrigera ett tidigare fel.
Expire	string	"Upphör" – aviseringen har upphört att gälla och är inte längre aktiv.
Extend	string	"Utöka" – aviseringen har utökats i tid, i område eller båda sedan den första utfärdandet.
New	string	"Ny" – status för en avisering vid inledande utfärdande.
Update	string	"Update" – aviseringen har uppdaterats sedan den första utfärdandet.
Upgrade	string	"Uppgradera" – aviseringen har uppgraderats till en högre klass eller kategori sedan den första utfärdandet.

SevereWeatherAlert

Information om en varning om oväder.

Name	Typ	Description
alertAreas	AlertArea[]	Information om aviseringen som är specifik för de berörda områden.
alertId	integer	En unik numerisk identifierare för en vädervarning.
category	string	Aviseringens kategori.
class	string	Klassificering av aviseringen. Det här fältet är inte tillgängligt för alla länder och returneras därför inte alltid.
countryCode	string	2 tecken ISO 3166-1 Alpha-2 landskod, till exempel "US".
description	SevereWeatherAlertDescription	Beskrivning av aviseringen.
disclaimer	string	En ansvarsfriskrivning om källan till aviseringsinformationen. Det här fältet är inte alltid tillgängligt. Till exempel kan ansvarsfriskrivning innehålla information om fördröjningar eller potentiella problem som rör larmet.
level	string	Allvarlighetsgrad för aviseringen. Det här fältet är inte tillgängligt för alla länder och returneras därför inte alltid.
priority	integer	Tal som anger prioriteten eller rangordningen för den angivna aviseringen inom det land/den region som den har sitt ursprung i. Ett lägre tal innebär en högre prioritet. Till exempel är 1 den högsta prioriteten. Antalet varierar beroende på land/region och kan ändras med tiden när varje land/region utvecklar sina aviseringssystem.
source	string	Leverantören av aviseringsinformationen. Som standard returneras källan på engelska (en-US). Aviseringarna kommer från officiella statliga meteorologiska myndigheter och ledande globala vädervarningsleverantörer.
sourceId	integer	En numerisk identifierare som är associerad med källproviderns namn på aviseringsdata.

SevereWeatherAlertDescription

Beskrivning av en varning om oväder.

Name	Typ	Description
english	string	Beskrivning av aviseringen på engelska (en-US).
localized	string	Beskrivning av aviseringen på det angivna språket. Som standard returneras engelska (en-US) om språkparametern inte anges i begäran.

SevereWeatherAlertsResult

Det här objektet returneras från ett lyckat Get Severe Weather Alerts-anrop.

Name	Typ	Description
results	SevereWeatherAlert[]	En lista över alla ovädersaviseringar för den efterfrågade platsen.