SL 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).

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%c3%b6rningsinformation

Metod deviations

URL

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

Format

Json eller xml enligt ändelse till serviceanropet.

Parametrar

Namn

Typ

Tvingande

Beskrivning

TransportMode

String          

Nej

Aktuella trafikslag. Tillåtna värden är bus, metro, train, ship och tram. Kommaseparerad sträng.

LineNumber

String

Nej

Max 10 linjer. Kommaseparerad sträng.

SiteId

Integer

Nej

Id för sökt hållplatsområde.

FromDate

String

Nej default, men Ja om ToDate angivits

Startdatum för aktuell giltighetsperiod. 

ToDate

String

Nej default, men Ja om FromDate angivits

Slutdatum för aktuell giltighetsperiod.

Key

String

Ja

Din API nyckel. Under mockupdataperioden så kan nyckeln vara vad som helst.

Resultat

Svarsstruktur                                                                       

Namn

Datatyp

Beskrivning

StatusCode

Integer

Innehåller statuskod för det eventuella meddelandet.

Message

String

Innehåller eventuellt anropsrelaterade meddelanden som t.ex. felmeddelanden. Se ”Felmeddelanden” nedan.

ExecutionTime

long

Anger hur lång tid (i ms) det tog för servern att generera svaret.

ResponseData

Deviations

Innehåller själva svarsdata från tjänsten. Se ”Svarsdata” nedan.

Svarsdata

Namn

Datatyp

Beskrivning

Created

DateTime

När ärendet blev publicerad.

MainNews

Boolean

Boolean som indikerar om ärendet är en huvudnyhet.

SortOrder

Integer

Förslag på sorteringsordning av ärendena.

Header

String

Rubrik.

Details 

String

Detaljer, samma som presenteras på webbplatsen för resp. ärende.

Scope

String

Ett alias för ScopeElements.

DevCaseGid

Integer

Ärendets id.

DevMessageVersionNumber

Integer

Anger aktuell version för ärendet.

ScopeElements

String

Beskrivning av vilka linjer eller hållplatser ärendet gäller för.

FromDateTime

DateTime

När ärendet börjar vara aktivt.

UpToDateTime

DateTime

När ärendet slutar att vara aktivt.

Updated

DateTime

Senast ä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

Namn

Datatyp

Tvingande

Beskrivning

TransportMode

String       

Nej

Aktuella trafikslag. Tillåtna värden är ”bus”, ”metro”, ”train”, "ship" och ”tram”. Kommaseparerad sträng.

LineNumber

String

Nej

Max 10 linjer. Kommaseparerad sträng.

SiteId

Integer

Nej

Id för sökt hållplatsområde.

Key

String

Ja

Din API nyckel. Under mockupdataperioden så kan nyckeln vara vad som helst.

 

 

 

 

 

 

 

 

Resultat

Svarsstruktur

Namn

Datatyp

Beskrivning

StatusCode

Integer

Innehåller statuskod för det eventuella meddelandet.

Message

String

Innehåller eventuellt anropsrelaterade meddelanden som t.ex. felmeddelanden. Se ”Felmeddelanden” nedan.

ExecutionTime

Long

Anger hur lång tid (i ms) det tog för servern att generera svaret.

ResponseData

Deviations

Innehåller själva svarsdata från tjänsten. Se ”Svarsdata” nedan.

Svarsdata

Namn

Datatyp

Beskrivning

Created 

DateTime

När ärendet blev publicerad.

MainNews

Boolean

Boolean som indikerar om ärendet är en huvudnyhet.

SortOrder

Integer

Förslag på sorteringsordning av ärendena.

Header

String

Rubrik.

Details 

String

Detaljer, samma som presenteras på webbplatsen för resp. ärende.

Scope 

String

Ett beskrivande alias för ScopeElements.

DevCaseGid

Integer

Ärendets id.

DevMessageVersionNumber

Integer

Anger aktuell version för ärendet.

ScopeElements

String

Uppräkning av vilka linjer eller hållplatser ärendet gäller för.

FromDateTime

DateTime

När ärendet börjar vara aktivt.

UpToDateTime

DateTime

När ärendet slutar att vara aktivt.

Updated

DateTime

Senast ärendet blev uppdaterat.

Priority

Integer

Prioriteringsordning för ärendet.

LineNumber

String

Linje där ärendet är gällande.

SiteId

String

Id för hållplatsområde. Kan vara tom.

TransportMode

String

Trafikslag för ärendet.

Felmeddelanden

Statuskod

Meddelande

1001

problem with request: Key is undefined

Nyckel hare ej skickats med.

1002

problem with request: Key is invalid

Nyckel är ogiltig

1003

Invalid api

Ogiltigt api

1004

problem with request: This api is currently not available for keys with priority above 2

1005

Nyckel finns, men ej för detta api

problem with request: Invalid api for key

1006

To many requests per minute

För många anrop per minut, för den profil som används

1007

To many requests per month

För många anrop per månad, för den profil som används

4002

Fråndatum angett utan tilldatum. Båda datumen måste vara angivna vid filtrering på datum.

4002

Tilldatum angett utan fråndatum. Båda datumen måste vara angivna vid filtrering på datum.

5000

Ogiltigt formaterad parameter.

FEL! 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.