Beskrivning

Använd denna metod för att söka efter stationer och hållplatser baserat på ett namn. Det går att söka efter stationer för både avresor och ankomst med ett anrop. De stationer som hittas kan sedan presenteras för en användare så att de kan välja exakt vilken station de vill resa till eller från.

Notera att denna metod inte är gjord för att användas för autocompletelösningar, dvs där en sökning görs medans användaren skriver in namnet på en station.

 

URL

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

Exempel

https://api.resrobot.se/v2/location.name?key=<DIN NYCKEL>&input=Centralen

Söker man på städer kan det hända att en perfekt matchning finns, i så fall får man endast ett svar tillbaka.

Ett tips är att lägga på ett ? i slutet på inputsträngen för att undvika perfekt matchning.

Format

Json eller xml enligt ändelse till serviceanropet.

Relaterade metoder

Den främsta användningen för denna metod är att hitta stationer för att använda i Sök Resa när man ska hitta möjliga resor mellan två punkter. Ett alternativ till Platsuppslag är Närliggande Hållplatser, där man söker efter stationer inom ett geografiskt område.

Parametrar

Namn

Datatyp

Obligatorisk

Beskrivning

key

String

Ja

Din API nyckel.

input

String

Ja

Ex: bromapl””, “Luleå” (URL-encodas till “Lule%C3%A5”)

maxNo

Integer

Nej

Maximalt antal resultat som önskas. 10 är default, max är 50.

lang

String

Nej

Språk (sv/en/de), default sv. Påverkar språket i 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-xsd-graph.png

Svarsdata

Namn

Datatyp

Beskrivning

LocationList

Array StopLocation element

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.

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, summerar 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

weigth

Integer

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

Spannet ligger mellan 0 och 32767

Sortering av svaren i Resrobots Platsuppslag sker på vikt-parametern. Vikten är en måttstock på hur trafikikerad hållplatsen är  och hur många olika transportslag som trafikerar på hållplatsen. Högst vikt kommer först.

Svar givna i versaler som exempelvis HANDEN, HANINGE, STOCKHOLM  är namn som Samtrafiken hittat på för att göra det lättare för en resenär att söka sina hållplatser vilka namn inte alltid är så lätta att komma ihåg. Bakom ett versalt namn kan det finnas en eller flera närliggande hållplatser. Önskar man inte denna funktionalitet så kan det vara bäst att filtrera bort versala hållplatsnamn vid display eller vid vidare resesökning.

Xsd-tjänst Xsd-tjänsten kan användas för att hämta ut en xsd-beskrivning av Platsuppslag. 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?hafasRestLocation.xsd