SL Realtidsinformation 4

Beskrivning

Realtidsinformation gällande buss, tunnelbana, pendeltåg och lokalbana. Detta API innehåller liknande information som SL Realtidsinformation 3.

Vissa ändringar har gjorts i svarsstrukturen för att få den mer enhetlig mellan tunnelbaneavgångar och övriga trafikslag, samt att man har påbörjat hämtning av all tunnelbaneinformation från samma källa som övriga trafikslagsavgångar. Detta medför att man kommer att kunna få ut lika mycket information om en tunnelbaneavgång som för övriga.

Övergången till den nya trafikkällan för tunnelbaneavgångar sker i flera steg. De gröna och blå tunnelbanelinjerna har övergått till att hämta data på samma sätt som för övriga trafikslag. Röd linje återstår och det finns ännu ingen färdig tidplan för när övergången sker, men i dagsläget är en rimlig gissning att det kan ske under 2017.

I dokumentationen nedan kommer svarselement som gäller för tunnelbana före övergång till nytt informationssystem noteras med Tunnelbana före övergång.

Best Practice

URL

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

Format

Json eller xml enligt ändelse till serviceanropet.

Parametrar

Parametrar

Datatyp

Tvingande

Beskrivning

Format

String

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.

Bus

Boolean Nej Default = true. Om false, så exkluderas trafikslaget från svaret.

Metro

Boolean Nej Default = true. Om false, så exkluderas trafikslaget från svaret.

Train

Boolean Nej Default = true. Om false, så exkluderas trafikslaget från svaret.

Tram

Boolean Nej Default = true. Om false, så exkluderas trafikslaget från svaret.

Ship

Boolean Nej Default = true. Om false, så exkluderas trafikslaget från svaret.

Resultat

Resultat från realtidssökning. Vid xml-format är rotelementets namn ResponseOfDepartures.

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/ResponseData

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 svarsstruktur

Metros

List

Lista över samtliga tunnelbaneavgångar för givet siteId, se svarsstruktur

Trains

List

Lista över samtliga pendeltågsavgångar för givet siteId, se svarsstruktur.

Trams

List

Lista över samtliga lokalbaneavgångar för givet siteId, se svarsstruktur

Ships

List

Lista över samtliga båtavgångar för givet siteId, se svarsstruktur

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 alla trafikslag

Namn

Datatyp

Beskrivning

TransportMode

String

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

LineNumber

String

Linjebeteckning/nummer.

Destination

String

Namn på linjens ändhållplats.

JourneyDirection

Integer

Reseriktnings-id. 0 vid okänd riktning, annars 1 eller 2.

GroupOfLine

String

För buss: Anger om det är en blå buss. Om det är en blå buss står det ”blåbuss”, annars saknas elementet(xml) eller är null(json).

För lokalbana: Linjegrupp, t.ex. “Tvärbanan” eller “Roslagsbanan”.

För tunnelbana: Linjegruppering. Röd/grön/blå linje.

För båt: Anger om det är pendlarbåt eller Waxholmsbolaget.

StopAreaName

String

Hållplatsnamn.

StopAreaNumber

Integer

Id för aktuell hållplats.

Tunnelbana före övergång: 0

StopPointNumber

Integer

Id för aktuellt stoppställe.

Tunnelbana före övergång: 0

StopPointDesignation

String

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

TimeTabledDateTime

DateTime

Avgångstid enligt tidtabell.

Tunnelbana före övergång: null

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.

Tunnelbana före övergång: null

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.

Tunnelbana före övergång:Beräknad avgång från hållplatsen, t.ex. ”2 min” eller ”Nu”.

JourneyNumber

Integer

Turnummer för avgången.

Tunnelbana före övergång: 0.

Deviations

List

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

Tunnelbana före övergång: Saknas.

SecondaryDestinationName

String

Finns bara för:Pendeltåg.

Namn på delmål

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.

StopPointDeviations

Namn

Datatyp

Beskrivning

StopInfo

StopInfo

StopInfo. Kan vara tom. Se StopInfo

Deviation

Deviation

Deviation. Kan vara tom. Se Deviation.

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.