Beskrivning

Med detta API kan du få information om närliggande hållplatser till en försedd plats baserad på lat och long. Använd denna metod för att hitta stationer och hållplatser inom ett givet geografiskt område. Ange koordinater och inom vilken radie man ska söka efter stationer så får man tillbaka en lista på stationer, inklusive vilken typ av trafik (tåg, buss etc). Koordinater kan man få genom att använda metoden Platsuppslag eller så kan man använda andra geocodingtjänster, tex OpenStreetMap eller Google Maps.

Koordinater anges på WGS84 format vilket är europeisk standard.

Kom ihåg att informera era användare om att att koordinater (personuppgift) används vid sökningar :)

URL

https://api.resrobot.se/v2/location.nearbystops?Parametrar

Exempel

https://api.resrobot.se/v2/location.nearbystops?key=<DIN NYCKEL>&originCoordLat=59.329630&originCoordLong=18.059338&format=xml

Format

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

Parametrar

Namn

Datatyp

Obligatorisk

Beskrivning

key

String

Ja

Din API nyckel.

originCoordLat

String

Ja

Latitud (WGS84, decimal degree), ex 59.293611

originCoordLong

String

Ja

Longitud (WGS84, decimal degree), ex 18.083056

maxNo

Integer

Nej

Maximalt antal resultat som önskas. 10 är defaultvärde, 1,000 är max

r

Integer

Nej

Radie i meter för det cirkulära området kring koordinaten som närliggande hållplatser skall hämtas ut för. 1,000m är defaultvärde, 10,000m är max.

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

location_nearbystops-xsd-graph.png

Svarsdata

Namn

Datatyp

Beskrivning

LocationList

Array StopLocation object

Lista med de hållplatser som hittats. Se ”StopLocation” nedan.

StopLocation

Object

 

name

String

Namn för hållplats.

extId

String

RikshållplatsId för hållplatsen.

id

String

Internt id för hållplatsen. Detta id används för att söka vidare i Resrobots APIer, id överensstämmer med extId, men kan komma att ändras i framtiden.

dist

Integer

Distans i meter från angivna koordinater i anropet

lat

String

Latitud (WGS84, decimal degree), ex 59.293611

lon

String

Longitud (WGS84, decimal degree), ex 18.083056

products

Integer

Anger trafikslag som trafikerar hållplatsen (binär kod), summeras ihop om fler än ett. Möjliga värden:

1 – Flyg

2 - Snabbtåg

4 - Tåg

8 - Expressbuss

16 - Lokaltåg

32 - Tunnelbana

64 – Spårvagn

128 – Buss

256 – Båt

512 – Taxi

(160 – Tunnelbana och Buss)

weight

Integer

Vikten av hållplatsen, visar hur trafikerad hållplatsen är, vikten ökar antalet resor, kan användas i sorteringssyfte

Spannet är mellan 0 och 32767

 

Xsd-tjänst

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

Url

Exempel:

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