SL Närliggande hållplatser

URL

http://api.sl.se/api2/nearbystops.<FORMAT>?key=<DIN NYCKEL>&originCoordLat=<LAT>& originCoordLong=<LONG>&maxresults=<MAX ANTAL SVAR>&radius=<RADIUS I METER>

 

Format

Json eller xml enligt ändelse till serviceanropet.

Parametrar

Namn

Datatyp

Tvingande

Beskrivning

Key

String

Ja

Din API nyckel.

originCoordLat

String

Ja

Lat (WGS, decimal degree), ex 59.293611

originCoordLong

String

Ja

Long (WGS, decimal degree), ex 18.083056

maxResults

Integer

Nej

Maximalt antal resultat som önskas. 9 är default, max är 1000.

radius

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. 1000 m är defaultvärde, max är 2000 m.

lang

String

Nej

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

Resultat

Svarsstruktur (xml)

Namn

Datatyp

Tvingande

Beskrivning

LocationList

Element

Ja

Ett Element med de StopLocation som hittats. Se ”StopLocation” nedan.

noNamespaceSchemaLocation

Attribut

Sträng

Ja

Attribut refererar till en XML-schema som inte har ett namespace.

xmlns:xsi

Attribut

Strängt

Ja

Xml namespace

errorCode

Attribut

Sträng

Nej Innehåller API-specifik felkod för anropet. Ex R0001  Se ”Felmeddelanden” nedan.
errorText

Attribut

Sträng

Nej

Innehåller API-specifik felmeddelande för anropet. Ex "Invalid or missing request parameters/Felaktiga eller saknade inparametrar" 

Se ”Felmeddelanden” nedan.

StopLocation 

Element

Nej

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

idx

Attribut

Integer

Nej Sorterings id. Löpnummer för sortering enligt avstånd till koordinaten. Lägst idx är närmast koordinaten.
name

Attribut

Strängt

Nej Namn för hållplats.
id

Attribut

Heltal

Nej HafasId för hållplatsen. Läs mer om HafasId i sektionen HafasId och SiteId.
lat

Attribut

Flyttal

Nej Lat (WGS, decimal degree), ex 59.293611
lon

Attribut

Flyttal

Nej Long (WGS, decimal degree), ex 18.293611
dist

Attribut

Heltal

Nej Distans i meter från försedd koordinat i anropet.

Svarsstruktur (json)

Namn

Datatyp

Tvingande

Beskrivning

LocationList

Object

Ja

Ett Element med de StopLocation som hittats. Se ”StopLocation” nedan.

noNamespaceSchemaLocation

Data

Sträng

Ja

Attribut refererar till en XML-schema som inte har ett namespace.

errorCode

Data

Sträng

Nej Innehåller API-specifik felkod för anropet. Ex R0001  Se ”Felmeddelanden” nedan.
errorText

Data

Sträng

Nej

Innehåller API-specifik felmeddelande för anropet. Ex "Invalid or missing request parameters/Felaktiga eller saknade inparametrar" 

Se ”Felmeddelanden” nedan.

StopLocation 

Array eller Object

Nej

Innehåller ett objekt eller en lista med information om hållplatsen. 

Om det bara finns en stopLocation så blir det ett JSON object annars är det en JSON array.

idx

Data

Integer

Nej Sorterings id. Löpnummer för sortering enligt avstånd till koordinaten. Lägst idx är närmast koordinaten.
name

Data

Strängt

Nej Namn för hållplats.
id

Data

Heltal

Nej HafasId för hållplatsen. Läs mer om HafasId i sektionen HafasId och SiteId.
lat

Data

Flyttal

Nej Lat (WGS, decimal degree), ex 59.293611
lon

Data

Flyttal

Nej Long (WGS, decimal degree), ex 18.293611
dist

Data

Heltal

Nej Distans i meter från försedd koordinat i anropet.  

 

HafasId och SiteId

Information om hur HafasId byggs på SiteId.

HafasId nyttjas bland annat i Reseplanerar api’et.

Typ

Beskrivning

Exempel

SiteId

3001EDCBA där EDCBA är SiteId

SiteId: 9600

HafasId: 300109600

Xsd-tjänst

Xsd-tjänsten kan användas för att hämta ut en xsd-beskrivning av närliggande hållplatser.

 

Url

Exempel:

api.sl.se/api2/nearbystops/xsd.xml?key=<DIN API NYCKEL>&xsdname= hafasRestLocation.xsd

 

Felmeddelanden

Det kan uppkomma två olika typer av felmeddelanden och dessa returneras tillbaka på lite olika sätt.

Nedanstående lista beskriver de API-specifika fel som kan uppstå i anrop till tjänsten närliggande hållplatser. Felmeddelanden returneras på engelska eller svenska beroende på lang-parametern.

Statuskod

Meddelande

R0001

Unknown service method/Ogiltigt anrop

R0002

Invalid or missing request parameters/Felaktiga eller saknade inparametrar

R0007

Internal communication error/Internt kommunikationsfel

Generella felmeddelanden

I anrop till SL:s API:er så kan generella fel uppstå. Beroende på vilken svarstyp som efterfrågats så kan detta fel genereras i XML eller JSON. Dessa fel är inte översättningsbara.

Format på generellt felmeddelande i XML:

<Error> <StatusCode>1002</StatusCode><Message>problem with request: Key is invalid</Message> </Error>

Format på generellt felmeddelande i JSON:

{"StatusCode":1002,"Message":"problem with request: Key is invalid"}

Nedanstående lista beskriver de generella felen som kan uppstå. Meddelandetexterna returneras endast på engelska.

Statuskod

Meddelande

1001

problem with request: Key is undefined

Nyckel har 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 Api:et är tillfälligt avstängt för din nyckels prioritetsnivå.

1005

Nyckel finns, men gäller 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

1008

Proxy error Ett ospecificerat fel har genererats i bakomloggande api.

Support

Long (WGS, decimal degree), ex 18.083056

Innehåller API-specifik felkod för anropet. Ex R0001  Se ”Felmeddelanden” nedan.

Om det bara finns en stopLocation så blir det ett JSON object annars är det en JSON array.