Till senaste kommentaren
Detta inlägg är gammalt och kan innehålla inaktuell information.

Dokumentationen för datastrukturen borde ses över för Närliggande hållplatser (json)

Kul med nytt api! Jag börjar med det som funkar bra, felmeddelanden levereras enligt dokumentationen:

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

Men som ett sidospår så funkar inte felmeddelandena på samma sätt när man skickar en ogiltigt formaterad begäran (t.ex. ett %20 på fel ställe):

{
"LocationList":{
"noNamespaceSchemaLocation":"",
"errorCode":"R0002",
"errorText":"Ogiltiga eller saknade parametrar"
}
}

Det stora problemet är att strukturen på resultatet inte stämmer med dokumentationen. Om jag inte läser fel så har ResponseData här bytt namn till LocationList, och LocationList bytt namn till StopLocation:

{
"LocationList":{
"noNamespaceSchemaLocation":"hafasRestLocation.xsd",
"StopLocation":[{
"idx":"1",
"name":"Slakthuset (Globen) (Stockholm)",
"id":"300101519",
"lat":"59.293666",
"lon":"18.076039",
"dist":"398"
},{
"idx":"2",
"name":"Globen (Stockholm)",
"id":"300109168",
"lat":"59.293666",
"lon":"18.076039",
"dist":"398"
},{
"idx":"3",
"name":"Gullmarsplan (Stockholm)",
"id":"300109189",
"lat":"59.298421",
"lon":"18.080938",
"dist":"549"
}]
}
}

Det blir ett stort problem p.g.a. att man blir osäker på ifall strukturen snart kommer att ändras till att matcha dokumentationen. Ser ju iofs mest ut som ett kopiera/klista in-fel i tabellerna

Kommentarer

  • Det är dokumentationen som är felaktig.
    Som du har observerat så används inte meddelandetypen som innehåller ResponseData alls. Vi ska försöka uppdatera detta så snart som möjligt.

    //Erik B.

  • Hej,

    Det har gått 10 månader och vad jag kan se så har ingen ändring skett, trots att den inte behöver ta mer än en kvart.

    Är ert budskap att vi bör sluta lägga tid på att rapportera problem med API/dokumentation? Det är tyvärr det budskapet som går fram. Om ni inte längre har tid att underhålla dokumentationen så föreslår jag att ni gör den till en wiki, så att andra kan redigera.

  • Förlåt, det har gått ett helt år.

  • Hej Ano!

    Får verkligen be om ursäkt att det har tagit så långt tid att få det fixat. Men nu är dokumentationen för närliggande hållplatser uppdaterad.

    Har även skrivit att det finns två olika typer av felmeddelanden. Finns beskrivet under felmeddelanden.

    Jag kommer även föra vidare ditt förslag om att göra om dokumentationen till en wiki.

    Med vänliga hälsningar
    Daniel

    Team Trafiklab

Kommentera eller skriv ett nytt inlägg

Ditt namn och inlägg kan ses av alla. Din e-post visas aldrig publikt.