Shapes endpoint and route relationships

[Brian Runck]

I can't seem to get route information included with the Shapes endpoint, although I think it used to work.

If I do this:

curl -X GET "https://api-v3.mbta.com/shapes?include=route&filter%5Broute%5D=Red%2CMattapan%2COrange%2CGreen-B%2CGreen-C%2CGreen-D%2CGreen-E%2CBlue%2CCR-Fairmount%2CCR-Fitchburg%2CCR-Worcester%2CCR-Franklin%2CCR-Greenbush%2CCR-Haverhill%2CCR-Kingston%2CCR-Lowell%2CCR-Middleborough%2CCR-Needham%2CCR-Newburyport%2CCR-Providence%2CCR-Foxboro%2CBoat-F4%2CBoat-F1" -H "accept: application/vnd.api+json"

I get results with only Shapes but no route relationships are returned.

Am I doing something wrong?

[Developer at MBTA]

Hi Brian,

Shapes have "route" and "stops" relationships only in versions of the API before 2020-05-01, as mentioned in the Changelog. These were removed because RoutePatterns now provide a better way to get the same information (what "patterns of service" exist on each route). If you need to go back to a previous version for compatibility with older code, there are ways to specify this: see our Versioning page. Locking your requests to a specific version is generally recommended, otherwise you may be surprised by backwards-incompatible changes.

Separately, there is a known issue where a request is allowed to `include` a relationship that doesn't exist, if the relationship does exist in past API versions. Instead of an error, a normal response is returned with an "empty" relationship. We are working on addressing this, but thank you for bringing this instance to our attention.

—Developer@MBTA