SL Nearby stops v2.0 (Närliggande hållplatser 2)
Obs: Detta innehåll finns inte tillgängligt på svenska. Därför ser du engelska versionen. Om du tycker att denna sida borde översättas till svenska, kan du skriva till oss på support.trafiklab.se.
Om du vill se webbsidan på engelska, klicka här.
Beskrivning
Med detta API kan du få information om närliggande hållplatser till en försedd plats baserad på lat och long.
URL
api.sl.se/api2/nearbystopsv2.<FORMAT>?key=<DIN NYCKEL>&originCoordLat=<LAT>&originCoordLong=<LONG>&maxNo=<MAX ANTAL SVAR>&r=<RADIUS I METER>
API-nyckelnivåer
| Nivå | Max anrop/minut | Max anrop/månad |
|---|---|---|
| Brons | 30 | 10 000 |
| Silver | 60 | 500 000 |
| Guld | Efter behov |
Format
Json eller xml enligt ändelse till serviceanropet.
Parametrar
Namn | Datatyp | Tvingande | Beskrivning |
Key | String | Ja | Din API nyckel. |
originCoordLat | String | Ja | Lat |
originCoordLong | String | Ja | Long |
maxNo | Integer | Nej | Maximalt antal resultat som önskas. 9 är default, max är 1000. |
r | Integer | Nej | Radius runt försedd koordinat som närliggande hållplatser skall hämtas ut för. 1000 är default, max är 2000. |
products | Nej | Produktfilter, Kombinationsvärde av önskade trafikslag om inte alla ska användas vid utsökning av resor. Bitmask enligt följande: Värdes anges som heltalsvärdet av den kombinerade bitmasken, ex Buss och båt, 8+64 = 72 | |
type | Nej | Typfilter för platser, |
Resultat
Svarsstruktur
Namn | Datatyp | Beskrivning |
serverVersion | String | Versionsinformation. |
dialectVersion | String | Versionsinformation. |
requestId | Long | En id som identifierar anropen. |
stopLocationOrCoordLocation | StopLocation | Innehåller själva svarsdata från tjänsten. Se ”Svarsdata” nedan. |
Svarsdata
Namn | Datatyp | Beskrivning |
stopLocationOrCoordLocation | Lista av element | Lista med de platser som hittats. Se ”StopLocation” och ”CoordLocation” nedan. |
StopLocation
Namn | Datatyp | Beskrivning |
Id | String | Reconstruction Id, se reseplanerarens dokumentation |
Name | String | Namn för hållplats. |
extId | String | HafasId för hållplatsen. Läs mer om HafasId i sektionen HafasId och SiteId. |
Lat | Double | Lat. |
Lon | Double | Long. |
Weight | Integer | Anger hur mycket en station används, ju högre värde desto större användning. |
Dist | Integer | Distans i meter från försedd koordinat i anropet. |
Products | Integer | Se beskrivning för anropsparametrar |
CoordLocation
Namn | Datatyp | Beskrivning |
Id | String | Reseplanerar reconstruction Id, se reseplanerarens documentation |
Name | String | Namn för POI. |
Lat | String | Lat. |
Lon | String | Long. |
Dist | String | Distans i meter från försedd koordinat i anropet. |
Type | String | Visar i nuläget endast ”POI” |
LocationNotes | Lista av element | Se nedan |
LocationNote
Namn/värde lista.
Dessa värden gäller för närvarande men kan komma att ändras utan att information skickas i förväg.
Key | Value |
PI | Unikt id |
PC | POI kategori: |
PT | POI typ: Hospital, School, Theatre, University, Castle, Park, Library, Mall, Attraction, Chalet, Museum, Viewpoint eller Zoo |
CN | Namnet på kommunen som POI:en befinner sig i. |
HafasId och SiteId
Information om hur HafasId byggs på SiteId, StopId och StopAreaId.
HafasId nyttjas bland annat i Reseplanerar api’et.
Typ | Beskrivning | Exempel |
SiteId | 3FG1EDCBA där där FGEDCBA är de 7 sista sifforna i site.number utfyllt med nollor. | SiteId: 9600 HafasId: 300109600 |
StopId | 4FG1EDCBA där GFEDCBA är journeyPatternPoint utfyllt med nollor. | JourneyPatternPoint.Number: 56789 HafasId: 400156789 |
StopAreaId | 2FG1EDCBA där FEDCBA är stopArea.number utfyllt med nollor | StopArea.number: 81025 HafasId: 200181025 |
XSD
Url
Exempel:
https://api.sl.se/api2/nearbystops/xsd.xml?key=<DIN API NYCKEL>&xsdname= hafasRestLocation.xsd
Felmeddelanden
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 |
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 |
Övriga felmeddelanden
Felmeddelanden från api’et är idag på svenska eller engelska beroende på vilket språk som efterfrågats i urlanropet.
Statuskod | Meddelande |
R0001 | Unknown service method |
R0002 | Invalid or missing request parameters. |
R0007 | Internal communication error. |