SL Service alerts v2.0 (Störningsinformation 2)

Beskrivning

Med detta API kan du få fram information om aktuella och planerade störningar i SL-trafiken. Med API ‘et kan du ställa frågor om störningar på till exempel en viss linje eller ett visst trafikslag. Svaret består av störningsmeddelanden med viss metainformation.

För att se informationen som returneras av detta API, se https://api.sl.se/ta (detta är en störningsinformationssida som är anpassad för SL:s interna behov och inte avsedd att användas av resenärerna).

SL will replace this API with a new, similar API in the near future. The documentation for the current API has therefore not been translated for the new Trafiklab website.

Om ingen av parametrarna ”TransportMode”, ”LineNumber” och ”SiteId” skickas med anropet skickas samtliga avvikelser tillbaks som svar.

Är du intresserad av Störningar här och nu i SL trafiken se https://sl.se/sv/find/?query=Störningsinformation

Metod deviations

URL

https://api.sl.se/api2/deviations.<FORMAT>?key=<DIN API NYCKEL>&transportMode=<TRANSPORTMODE>&lineNumber=<LINENUMBER>&siteId=<SITEID>&fromDate=<FROMDATE>&toDate=<TODATE>

API-nyckelnivåer

NivåMax anrop/minutMax anrop/månad
Brons3010 000
Silver60100 000
GuldEfter behov

Format

Json eller xml enligt ändelse till serviceanropet.

Parametrar

NamnTypTvingandeBeskrivning
TransportModeStringNejAktuella trafikslag. Tillåtna värden är bus, metro, train, shipoch tram. Kommaseparerad sträng.
LineNumberStringNejMax 10 linjer. Kommaseparerad sträng.
SiteIdIntegerNejId för sökt hållplatsområde.
FromDateStringNej default, men Ja om ToDate angivitsStartdatum för aktuell giltighetsperiod.
ToDateStringNej default, men Ja om FromDate angivitsSlutdatum för aktuell giltighetsperiod.
KeyStringJaDin API nyckel. Under mockupdataperioden så kan nyckeln vara vad som helst.

Svarsstruktur

NamnDatatypBeskrivning
StatusCodeIntegerInnehåller statuskod för det eventuella meddelandet.
MessageStringInnehåller eventuellt anropsrelaterade meddelanden som t.ex. felmeddelanden. Se ”Felmeddelanden” nedan.
ExecutionTimelongAnger hur lång tid (i ms) det tog för servern att generera svaret.
ResponseDataDeviationsInnehåller själva svarsdata från tjänsten. Se ”Svarsdata” nedan.

Svarsdata

NamnDatatypBeskrivning
CreatedDateTimeNär ärendet blev publicerad.
MainNewsBooleanBoolean som indikerar om ärendet är en huvudnyhet.
SortOrderIntegerFörslag på sorteringsordning av ärendena. Denna returneras som 1. Är man ute efter sortering på prioritet bör denna tas från Deviationsrawdata och återfinns i svarsstrukturen under priority.
HeaderStringRubrik.
DetailsStringDetaljer, samma som presenteras på webbplatsen för resp. ärende.
ScopeStringEtt alias för ScopeElements.
DevCaseGidIntegerÄrendets id.
DevMessageVersionNumberIntegerAnger aktuell version för ärendet.
ScopeElementsStringBeskrivning av vilka linjer eller hållplatser ärendet gäller för.
FromDateTimeDateTimeNär ärendet börjar vara aktivt.
UpToDateTimeDateTimeNär ärendet slutar att vara aktivt.
UpdatedDateTimeSenast ärendet blev uppdaterat.

Metod deviationsrawdata

URL

api.sl.se/api2/deviationsrawdata.<FORMAT>?key=<DIN API NYCKEL>&transportMode=<TRANSPORTMODE>&lineNumber=<LINENUMBER>&siteId=<SITEID>

Om ingen av parametrarna ”TransportMode” och ”LineNumber” skickas med anropet skickas samtliga avvikelser tillbaks som svar.

Format

Json eller xml enligt ändelse till serviceanropet.

Parametrar

NamnDatatypTvingandeBeskrivning
TransportModeStringNejAktuella trafikslag. Tillåtna värden är ”bus”, ”metro”, ”train”, “ship"och ”tram”. Kommaseparerad sträng.
LineNumberStringNejMax 10 linjer. Kommaseparerad sträng.
SiteIdIntegerNejId för sökt hållplatsområde.
KeyStringJaDin API nyckel. Under mockupdataperioden så kan nyckeln vara vad som helst.

Svarsstruktur

NamnDatatypBeskrivning
StatusCodeIntegerInnehåller statuskod för det eventuella meddelandet.
MessageStringInnehåller eventuellt anropsrelaterade meddelanden som t.ex. felmeddelanden. Se ”Felmeddelanden” nedan.
ExecutionTimeLongAnger hur lång tid (i ms) det tog för servern att generera svaret.
ResponseDataDeviationsInnehåller själva svarsdata från tjänsten. Se ”Svarsdata” nedan.

Svarsdata

NamnDatatypBeskrivning
CreatedDateTimeNär ärendet blev publicerad.
MainNewsBooleanBoolean som indikerar om ärendet är en huvudnyhet.
SortOrderIntegerFörslag på sorteringsordning av ärendena.
HeaderStringRubrik.
DetailsStringDetaljer, samma som presenteras på webbplatsen för resp. ärende.
ScopeStringEtt beskrivande alias för ScopeElements.
DevCaseGidIntegerÄrendets id.
DevMessageVersionNumberIntegerAnger aktuell version för ärendet.
ScopeElementsStringUppräkning av vilka linjer eller hållplatser ärendet gäller för.
FromDateTimeDateTimeNär ärendet börjar vara aktivt.
UpToDateTimeDateTimeNär ärendet slutar att vara aktivt.
UpdatedDateTimeSenast ärendet blev uppdaterat.
PriorityIntegerPrioriteringsordning för ärendet.
LineNumberStringLinje där ärendet är gällande.
SiteIdStringId för hållplatsområde. Kan vara tom.
TransportModeStringTrafikslag för ärendet.

Felmeddelanden

StatuskodMeddelande
1001problem with request: Key is undefined.Nyckel hare ej skickats med.
1002problem with request: Key is invalid. Nyckel är ogiltig
1003Invalid api. Ogiltigt api
1004problem with request: This api is currently not available for keys with priority above 2
1005Nyckel finns, men ej för detta api. problem with request: Invalid api for key
1006To many requests per minute. För många anrop per minut, för den profil som används
1007To many requests per month. För många anrop per månad, för den profil som används
4002Fråndatum angett utan tilldatum. Båda datumen måste vara angivna vid filtrering på datum.
4002Tilldatum angett utan fråndatum. Båda datumen måste vara angivna vid filtrering på datum.
5000Ogiltigt formaterad parameter.Serverfel, var god försök lite senare. Ogiltigt formaterat datum, datumet ska formateras YYYY-MM-DD.

Support

Räcker inte dokumentationen så sök gärna bland alla de hundratals inlägg som finns på vårt supportforum. Det är troligt att någon redan har hittat och löst samma problem som du har.

Hittar du fortfarande inte svar på din fråga så skriv ett eget inlägg på forumet så hjälper vi dig.