GET route_patterns
Operation ID: ApiWeb.RoutePatternController.index
Auth: unknown
Parameters (11)
(string, query, optional)
Fields to include with the response. Multiple fields **MUST** be a comma-separated (U+002C COMMA, ",") list. Note that fields can also be selected for included data types: see the [V3 API Best Practices](https://www.mbta.com/developers/v3-api/best-practices) for an example.
(boolean, query, optional)
Filter by canonical true: Route pattern should be considered canonical for this route in this direction. If branching regularly occurs, this route-direction may have more than one canonical pattern. false: Route pattern should be not considered canonical for this route in this direction.
(string, query, optional)
Filter by date that route pattern is active The active date is the service date. Trips that begin between midnight and 3am are considered part of the previous service day. The format is ISO8601 with the template of YYYY-MM-DD.
(string, query, optional)
Filter by direction of travel along the route. Must be used in conjuction with `filter[route]` to apply. The meaning of `direction_id` varies based on the route. You can programmatically get the direction names from `/routes` `/data/{index}/attributes/direction_names` or `/routes/{id}` `/data/attri...
Constraints: {'enum': ['0', '1']}
(string, query, optional)
Filter by multiple IDs. **MUST** be a comma-separated (U+002C COMMA, ",") list.
(string, query, optional)
Filter by `/data/{index}/relationships/route/data/id`. Multiple IDs **MUST** be a comma-separated (U+002C COMMA, ",") list.
(string, query, optional)
Filter by `/data/{index}/relationships/stop/data/id`. Multiple IDs **MUST** be a comma-separated (U+002C COMMA, ",") list. Parent station IDs are treated as though their child stops were also included.
(string, query, optional)
Relationships to include. * `route` * `representative_trip` The value of the include parameter **MUST** be a comma-separated (U+002C COMMA, ",") list of relationship paths. A relationship path is a dot-separated (U+002E FULL-STOP, ".") list of relationship names. [JSONAPI "include" behavior](http:...
(integer, query, optional)
Max number of elements to return
(integer, query, optional)
Offset (0-based) of first element in the page
(string, query, optional)
Results can be [sorted](http://jsonapi.org/format/#fetching-sorting) by the id or any `/data/{index}/attributes` key. Assumes ascending; may be prefixed with '-' for descending | JSON pointer | Direction | `sort` | |--------------|-----------|------------| | `/data/{index}/attributes/canonical`...
Constraints: {'enum': ['canonical', '-canonical', 'direction_id', '-direction_id', 'name', '-name', 'sort_order', '-sort_order', 'time_desc', '-time_desc', 'typicality', '-typicality']}
No probe data for this endpoint yet.