Med detta API kan du få fram ankomststider för en viss hållplats eller station i Sverige.

URL

https://api.resrobot.se/v2/arrivalBoard?Parametrar

Exempel

https://api.resrobot.se/v2/arrivalBoard?key=<DIN NYCKEL>&id=<HÅLLPLATSID>&maxJourneys=<MAX ANTAL SVAR>

Format

Json eller xml enligt ändelse till serviceanropet. Xml är default.

Parametrar

Namn

Datatyp

Obligatorisk

Beskrivning

key

String

Ja

Din API nyckel.

id

String

Ja

Id för hållplatsen. Detta id kan erhållas från Platsuppslag eller Närliggande Hållplats APIet. 

direction

String

Nej

Filtrerar svar på hållplats som färdmedlet kommer från. Ange rikshållplatsid.

date

Date

Nej

YYYY-MM-DD Exempel date=2017-12-20, default idag

time

String

Nej

HH:MM, Exempel time=19:05, default nu

maxJourneys

Integer

Nej

Minimerar antalet svar i anropet. Default 20 svar

operators

String

Nej

Filtrerar svaret på operatör/-er

Exempel: operators=275,287

(275=SL, 287=Arlanda Express)

 

products

Integer

Nej

Filtrerar svaret på produktsnivå

Anger trafikslag som trafikerar hållplatsen, summerar ihop om fler än ett. Möjliga värden:

2 - Snabbtåg, Expresståg, Arlanda Express

4 - Regionaltåg, InterCitytåg

8 - Expressbuss, Flygbussar

16 - Lokaltåg, Pågatåg, Öresundståg

32 - Tunnelbana

64 – Spårvagn

128 – Buss

256 – Färja, Utrikes Färja

(inte en fullständig lista)

Exempel: 6 = 2 (Snabbtåg, Expresståg, Arlanda Express) + 4 (Regionaltåg, InterCitytåg)

passlist

Integer

Nej

Om passlist = 0 erhålles inga mellanliggande hållplatser i svaret

lang

String

Nej

Språk (sv/en/de), default sv. Påverkar språket i bl.a. felmeddelanden.

format

String

Nej

Ett andra sätt att välja svarsformat.

Möjliga val: json, xml

Default=xml

jsonpCallback

String

Nej

Namn på javafunktion som tar emot svarsdatat

 

Resultat

Svarsdata – Ankommande Trafik

arrivalboard-xsd-graph.png

Namn

Datatyp

Beskrivning

ArrivalBoard

Array Arrival Objects

Lista med de ankomster som hittats. Se ”Arrival” nedan.

 

xmls

String

Hafas_instans

Arrival

Objects

 

time

String

Tid på HH:MM:SS format

date

Date

Datum på YY-MM-DD format

stop

String

Hållplatsnamnet

stopId

String

Internt id för hållplatsen. Detta id används för att söka vidare i Resrobots APIer.

 

Notera: id överensstämmer med extId, men kan komma att ändras i framtiden.

 

stopExtId

String

Rikshållplatsid

type

String

S=Hållplats

transportNumber

String

Samma som num i Product

Exempel:"19"

transportCategory

String

Kategorikod

Exempel: ”ULT”

name

String

Kategorikod + Linjenummer 

Exempel: ”ULT 19” (Tunnelbana linje 19)

Samma som name i Product

origin

String

Rikshållplatsnamn på startstation

Exempel: ”Vällingby T-bana (Stockholm kn)”

Product

Object

 

name

String

Samma som name i Arrival

operator

String

Operatörsnamn

Exempel: “SL”,”Skånetrafiken”

num

Integer

Internt Samtrafiken turnummer, unikt per producent Samma som transportNumber i Arrival

catOutS

String

Kort Kategorikod

Exempel:

"BLT" (Buss Länstrafik)

”BXB” (Buss Express)

"ULT" (Tunnelbana Länstrafik)

"JAX" (Järnväg Arlanda Express)

"JLT" Järnväg Länstrafik),

"JRE" (Järnväg Regionaltrafik)

"JIC" (Järnväg InterCity),

”JPT” (Järnväg PågaTåg)

”JEX” (Järnväg Express)

”SLT” (Spårvagn Länstrafik)

”FLT” (Färja Länstrafik)

”FUT” (Färja Utrikes)

catOutL

String

Kategorinamn

Exempel: "Buss", "Tåg", "Intercity", "Tunnelbana", "Arlanda Express","Regional" ,"InterCity", ”PågaTåg”

catOutCode

Integer

Kategorikod

Exempel:

1="SnabbTåg", ”Express”, "Arlanda Express"

2="Regional", "InterCity"

3=”Expressbuss”, ”Flygbussar”

4="Tåg", ”PågaTåg”, ”Öresundståg”

5="Tunnelbana"

6=”Spårvagn”  

7="Buss",

8=”Färja”, ”Utrikes Färja”

 

Stops

Array

Lista av Stop element

Stop

Object

 

name

String

Namnet på ankomsthållplatsen

depTime

String

Avgångstid på HH:MM:SS format

 

depDate

Datum

Avgångsdatum på YY-MM-DD format

 

lat

String

Latitud (WGS84, decimal degree), ex 59.293611

lon

String

Longitud (WGS84, decimal degree), ex 18.083056

id

String

Internt id för hållplatsen. Detta id används för att söka vidare i Resrobots APIer.

Notera: Id överensstämmer med extId, men kan komma att ändras i framtiden

extId

String

RikshållplatsId

routeIdx

Integer

Tur-index på hållplatsen (0=första hållplats på turen)

      Xsd-tjänst Xsd-tjänsten kan användas för att hämta ut en xsd-beskrivning av Avgående Trafik. Xsd beskrivningen innehåller fält (markerade optional) som inte används idag, men som kan inkluderas i framtiden då data finns tillgängligt.

Url

Exempel:

https://api.resrobot.se/xsd?hafasRestArrivalBoard.xsd