SL Realtidsinformation 3

Beskrivning

Realtidsinformation gällande buss, tunnelbana, pendeltåg och lokalbana. Detta API innehåller liknande information som SL Realtidsinformation, men gör det möjligt att komma åt informationen via en metod istället för olika metoder beroende på trafikslag. Dessutom innehåller svaret störningsinformation när sådan finns för avgångarna/hållplatserna som presenteras.

URL

http://api.sl.se/api2/realtimedepartures.<FORMAT>?key=<DIN API NYCKEL>&siteid=<SITEID>&timewindow=<TIMEWINDOW>

Format

Json eller xml enligt ändelse till serviceanropet.

Parametrar

Parametrar

Datatyp

Tvingande

Beskrivning

Format

Integer

Ja

Format på svarsdatat. Giltiga värden är “json” eller “xml”.

SiteId

Integer

Ja

Unikt identifikationsnummer för den plats som aktuella avgångar skall hämtas för, t.ex. 9192 för Slussen. Detta id fås från tjänsten SL Platsuppslag.

TimeWindow

Integer

Ja

Hämta avgångar inom önskat tidsfönster. Där tidsfönstret är antalet minuter från och med nu. Max 60.

Key

String

Ja

En giltig API-nyckel.

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

Departure

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

Svarsdata

Namn

Datatyp

Beskrivning

LatestUpdate

DateTime

Anger när realtidsinformationen (DPS) senast uppdaterades.

DataAge

Integer

Antal sekunder sedan tidsstämpeln LatestUpdate.

Buses

List

Lista över samtliga bussavgångar för givet siteId (se nedan för detaljer).

Metros

List

Lista över samtliga tunnelbaneavgångar för givet siteId (se nedan för detaljer).

Trains

List

Lista över samtliga pendeltågsavgångar för givet siteId (se nedan för detaljer).

Trams

List

Lista över samtliga lokalbaneavgångar för givet siteId (se nedan för detaljer).

Ships

List

Lista över samtliga båtavgångar för givet siteId (se nedan för detaljer).

StopPointDeviations

List

Lista över hållplatsområdesspecifika avvikelser/störningar. D.v.s. störningar som inte är knutna till en specifik avgång.

Gemensamt för Bussar, Pendeltåg, Lokalbana och Båt

Namn

Datatyp

Beskrivning

SiteId

Integer

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

TransportMode

String

Trafikslag: ”BUS”, ”TRAIN”, ”TRAM” eller ”SHIP”.

StopAreaName

String

Hållplatsnamn.

StopAreaNumber

Integer

Id för aktuell hållplats.

StopPointNumber

Integer

Id för aktuellt stoppställe.

LineNumber

String

Linjebeteckning/nummer.

Destination

String

Slutstation för avgången.

TimeTabledDateTime

DateTime

Avgångstid enligt tidtabell.

ExpectedDateTime

DateTime

Förväntad avgångstid.

Om det finns tillhörande störning med tillräckligt hög prioritet så kan denna ha null/tomt värde. Detta fram till ett par minuter innan avgång.

DisplayTime

String

Avgångstid för presentation. Kan anta formaten x min, HH:mm eller Nu. Om det finns tillhörande störning med tillräckligt hög prioritet så kan denna ha värdet ”-”. Detta fram till ett par minuter innan avgång.

Deviations

List

Innehåller typen ”Deviation” nedan. Denna kan vara tom, eller innehålla 1 till flera avvikelser.

JourneyDirection

Integer

Reseriktnings-id.

Deviation

Namn

Datatyp

Beskrivning

Consequence

String

Konsekvensbeskrivning för aktuell avvikelse.

ImportanceLevel

Integer

Signifikationsnivå för aktuell avvikelse. 0-9 där 9 är mest allvarlig.

Text

String

Beskrivning av aktuell avvikelse.

Tillägg för Bussar

Namn

Datatyp

Beskrivning

GroupOfLine

String

Anger om det är en blå buss. Om det är en blå buss står det ”blåbuss”, annars är strängen tom.

StopPointDesignation

String

Ytterligare identifierare för stoppställe, t.ex. bokstav för busskur eller spår för pendeltåg.

Tillägg för Pendeltåg

Namn

Datatyp

Beskrivning

SecondaryDestinationName

String

Namn på delmål.

StopPointDesignation

String

Ytterligare identifierare för stoppställe, t.ex. bokstav för busskur eller spår för pendeltåg.

Tillägg för Lokalbana

Namn

Datatyp

Beskrivning

GroupOfLine

String

Linjegrupp, t.ex. “Tvärbanan” eller “Roslagsbanan”.

StopPointDesignation

String

Ytterligare identifierare för stoppställe, t.ex. bokstav för busskur eller spår för pendeltåg.

Tillägg för Båtar

Namn

Datatyp

Beskrivning

GroupOfLine

String

Anger om det är pendlarbåt eller Waxholmsbolaget.

Tunnelbana

Namn

Datatyp

Beskrivning

DepartureGroupId

Integer

Gruppering av metroavgångar per fysisk färdriktningsskylt på en plattform. T.ex. grön linje vid tcentralen har två riktningar. Denna parameter kommer ha 1 eller 2 för de olika riktningarna. Samma för röd och blå.

Destination

String

Destination för aktuell avgång.

DisplayTime

String

Beräknad avgång från hållplatsen.

GroupOfLine

String

Linjegruppering. Röd/grön/blå linje.

GroupOfLineId

Integer

Linjegrupperingsid. Grön = 1. Röd = 2. Blå = 3.

JourneyDirection

Integer

Reseriktnings-id. Fungerar som DepartureGroupId.

LineNumber

String

Linjenummer för aktuell avgång.

PlatformMessage

String

Informationsmeddelande för aktuell linjegrupp. Detta är det som syns på en riktig skylt på en plattform. T.ex. ”Vänligen lämna plats för avstigande..”.

SiteId

Integer

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

StopAreaName

String

Hållplatsnamn.

TransportMode

String

Trafikslag: ”METRO”.

StopPointDeviations

Namn

Datatyp

Beskrivning

StopInfo

StopInfo

1 StopInfo. Kan vara tom. ”StopInfo” finns nedan.

Deviation

Deviation

1 Deviation. Kan vara tom. ”Deviation” finns nedan.

Deviation

Namn

Datatyp

Beskrivning

Consequence

String

Konsekvensbeskrivning för aktuell avvikelse.

ImportanceLevel

Integer

Signifikationsnivå för aktuell avvikelse. 0-9 där 9 är mest allvarlig.

Text

String

Beskrivning av aktuell avvikelse.

StopInfo

Namn

Datatyp

Beskrivning

GroupOfLine

String

Om TransportMode är ”TRAM” så innehåller noden något av följande värden: ”Lidingöbanan”, ”Nockebybanan”, ”Roslagsbanan”, ”Saltsjöbanan”, ”Spårväg City”, ”Tvärbanan”. Annars blankt(kan komma att ändras).

StopAreaName

String

Namn på hållplatsen som avvikelsen gäller.

StopAreaNumber

Integer

Id för hållplatsen som avvikelsen gäller. Är noll om TransportMode inte är BUS.

TransportMode

String

”METRO”, ”BUS”, ”TRAIN”, ”TRAM” eller ospecificerat.

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

4001

SiteId måste gå att konvertera till heltal.

5321

Kunde varken hämta information från TPI (tunnelbanan) eller DPS (övriga trafikslag).

5322

Kunde inte hämta information från DPS.

5323

Kunde inte hämta information från TPI.

5324

Kunde varken hämta information från TPI (tunnelbanan) eller DPS (övriga trafikslag) p.g.a. inaktuell DPS-data. Detta uppstår om DPS-datan är äldre än 2 minuter vid svarstillfället.

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.