Polylines for a route via the REST API

[Brandon Perdue]

I'm trying to add a map to all of our route pages on our site and I'm running into some issues. 

How do you get the polylines for a specific route?  I've been using the stops-for-route endpoint and showing the polylines that are in the StopGroups, but it only partially works.  Half of our routes show correct but some have the lines running way off.  I thought our initial data may be wrong so I compared what the Android app is showing to what my test script is displaying on a map and they were different.  The Android app looked fine and only has the actual route shown. 

Is there some other place to get that data?  Where is the Android app getting it from?

[Sean Barbeau]

Brandon,

stops-for-route should be the correct API, as that's what OBA Android uses to show stops on the map in RouteMapController:

https://github.com/OneBusAway/onebusaway-android/blob/master/onebusaway-android/src/main/java/org/onebusaway/android/map/RouteMapController.java

Are you including the "includePolylines=true" parameter?

Here's where the request is set up in OBA Android:

https://github.com/OneBusAway/onebusaway-android/blob/master/onebusaway-android/src/main/java/org/onebusaway/android/map/RouteMapController.java#L398

And the ObaStopsForRouteRequest class that makes the request:

https://github.com/OneBusAway/onebusaway-android/blob/80893c93652d98cb053441b4b620052b0f9899b9/onebusaway-android/src/main/java/org/onebusaway/android/io/request/ObaStopsForRouteRequest.java

See the REST API docs here too:

http://developer.onebusaway.org/modules/onebusaway-application-modules/current/api/where/methods/stops-for-route.html

Please take a look and let me know if that doesn't help.

Sean

[Brandon Perdue]

The includePolylines=true is on by default, but just to be sure I tried it with it there and it didn't change anything.  Looking at the android code I see that it is pulling in the shapes from the data.entry.polylines element in the response (https://github.com/OneBusAway/onebusaway-android/blob/80893c93652d98cb053441b4b620052b0f9899b9/onebusaway-android/src/main/java/org/onebusaway/android/io/request/ObaStopsForRouteResponse.java#L88).  Right now I'm adding both those and the stopgroup polylines just to be sure I'm not missing anything and it is off.  We are seeing a lot of extra lines but also some missing.  The screen grab below is actually one of the better ones, but it still has a random line going south and doesn't have the full loop on the left hand side.  Others are missing way larger chunks of data.

[Brandon Perdue]

I finally figured this out.  In case anybody else runs into this, the issue was with escape characters in the polyline data.  PHP was automatically converting \\ to \ and that was making subtle changes to the polyline when I decoded and added it to the map.  Doing a simple str_replace("\\","\\\\", $polyline) when I added the polyline to the JS for the map fixed it.

[Sean Barbeau]

Thanks, good to know!

Sean