This API will update as new important public announcements are made available by Sveriges Radio.
There are two versions of this API running in parallel. The real version, which you can identify by the /api part of the URL, and a development version which is available under /testapi. The development API will be regularly updated with dummy data to allow you to see how your application will react on real events.
URL
/api/v2/alerts
/api/v2/alerts/index.{ext}
/api/v2/alerts/{geoCode}
/api/v2/alerts/{geoCode}/index.{ext}
Supported extensions are: .rss, .atom, .json, .xml
GeoCodes are 2 or 4-digit numbers representing areas in Sweden, as specified by SCB.
The default format for alerts is: .json
Method
GET
URL Parameters
None
Data Parameters
None
Responses And Errors
This call should always return 200 OK
and contain valid content.
Comments
When using the formats .json or .xml, all content about the alerts will be included in the result.
When using the format .atom or .rss, the result will include basic information about the respective alert, along with a link to the full message in CAP format.
It is important to check the alert status. An alert marked actual
is and actual, currently active important public announcement. An alert marked test
is an active test announcement. An alert marked cancel
is a previous actual or test announcement that no longer applies.
Each announcement will have two alerts associated with it. First an actual
message will be emitted. When the announcement no longer applies, the previous message will be replaced by the cancel
message. The actual
and cancel
messages will have different CAP identifiers, but the same incident identifier (beginning with SRVMA).
Sample Call
fetch('http://<url>/api/v2/alerts/25').then(data => data.json()).then((data) => console.log(data));
URL
/api/v2/cap/{identifier}
Identifiers look like this: SRCAPXXXXXXXXXXXXXXI
, where all X:es have been replaced by digits. The identifier is used to match on the value given in the Identifier or Incidents fields.
Method
GET
URL Parameters
None
Data Parameters
None
Responses And Errors
Code:200 OK
Returns the matching CAP Alert/Cancel message. Content will be of type application/cap+xml
.
Code:404 NOT FOUND
If the identifier is invalid or not found, 404 will be returned.
Sample Call
fetch('http://<url>/api/v2/cap/SRCAPXXXXXXXXXXXXXXI');
<alert>
Element | Giltiga värden / Kommentar | Fält i VMA |
---|---|---|
Alert | Omsluter alla element i varningsmeddelandet | |
Identifier | Unikt ID för varningsmeddelandet, förslagsvis ska man ur ID:t kunna utläsa om det är Varning eller Information | Måste skapas i samband med publicering och avpublicering |
Sender | URI för SR:s API "https://vma.sverigesradio.se" | Läggs som en ServiceParameter |
Sent | Tid och datum då varningsmeddelandet utfärdades | Hämtas från property PubliceratDateTime |
Status | "Actual" för varning och avslutad varning, "Test" för tester (t.ex regelbundet test 4 ggr år) | ”Test” om VmaTyp är ”Tyfonprov”, annars ”Actual” (kan också vara Test för meddelanden som skapas i testläge eller i utvecklingsmiljön) |
msgType | "Alert" för gällande VMA, "Cancel" för avslutat VMA (identifier anges i references) | ”Alert” eller ”Cancel” beroende på publicering eller avpublicering |
Scope | "Public" Alltid public | |
references | Kommaseparerat (sender,identifier,sent) för det meddelande som avslutas (”Cancel”) | |
incidents | Unikt ID för samtliga meddelanden som hör till ett VMA (originalmeddelande och ”Cancel”) | PublicId från VmaMessage |
<info>
Element | Giltiga värden / Kommentar | Fält i VMA |
---|---|---|
Info | Omsluter alla element i ett info-block i ett varningsmeddelande. | |
language | Språkkod, "sv-SE", ”en-US” | Vilka språk som ska följa med lägger vi som ServiceParameter |
category | Alltid "Safety" | |
Event | Alltid "Viktigt meddelande till allmänheten (VMA)", utom vid test ”Kvartalstest av utomhussignal för viktigt meddelande till allmänheten (VMA)” | Event för olika vmatyper och språk lägger vi som ServiceParameter |
urgency | Alltid "Immediate" | |
severity | Alltid "Severe" | |
certainty | Alltid "Observed" | |
senderName | Alltid "Sveriges Radio" | |
description | Varningsmeddelandet i klartext | För sv-SE tar vi texten från property ”MeddelandeText” (att det där den propertyn som ska användas kan vara en ServiceParameter) För en-US tar vi text från ?? |
web | Fast länk till sida på sverigesradio.se med generell information om VMA och lista med aktuella VMA | ServiceParameter |
<area>
Element | Giltiga värden / Kommentar | Fält i VMA |
---|---|---|
area | Omsluter alla element i ett area-block i ett info-block. I ett info-block finns alltid ett area-block med geokoder för de områden som varningsmeddelandet påverkar | |
areaDesc | Området som varningen är utfärdat för i klartext som det uttrycks i VMA | |
geocode | Geokod för område som påverkas av varningen. Ett geocode-block för varje område. Typ av geocode och värde anges i "valueName" / "value" par i geocode-blocket | |
valueName | Typ av geokod: ”Län” = SCB länsnummer, "Kommun" = SCB kommunnummer | |
value | Värdet/koden |