View Source MBTA.Api.Trip (mbta_sdk v0.1.0)

API calls for all endpoints tagged Trip.

Summary

Functions

api_web_trip_controller_index(connection, opts \\ [])

NOTE: A id, route, route_pattern, or name filter MUST be present for any trips to be returned. List of trips, the journies of a particular vehicle through a set of stops on a primary route and zero or more alternative routes that can be filtered on. ## Accessibility Wheelchair accessibility (/data/{index}/attributes/wheelchair_accessible) as defined in GTFS: | Value | Meaning | |-------|----------------------------------------------------| | 0 | No information | | 1 | Accessible (at stops allowing wheelchair_boarding) | | 2 | Inaccessible | ## Grouping Multiple trips may be grouped together using /data/{index}/attributes/block_id. A block represents a series of trips scheduled to be operated by the same vehicle. ## Naming There are 3 names associated with a trip. | API Field | GTFS | Show users? | |-----------------------------|-------------------|-------------| | /data/attributes/headsign | trip_headsign | Yes | | /data/attributes/name | trip_short_name | Yes | | /data/id | trip_id | No |

api_web_trip_controller_show(connection, id, opts \\ [])

Single trip - the journey of a particular vehicle through a set of stops ## Accessibility Wheelchair accessibility (/data/attributes/wheelchair_accessible) as defined in GTFS: | Value | Meaning | |-------|----------------------------------------------------| | 0 | No information | | 1 | Accessible (at stops allowing wheelchair_boarding) | | 2 | Inaccessible | ## Grouping Multiple trips may be grouped together using /data/attributes/block_id. A block represents a series of trips scheduled to be operated by the same vehicle. ## Naming There are 3 names associated with a trip. | API Field | GTFS | Show users? | |-----------------------------|-------------------|-------------| | /data/attributes/headsign | trip_headsign | Yes | | /data/attributes/name | trip_short_name | Yes | | /data/id | trip_id | No |

Functions

Link to this function

api_web_trip_controller_index(connection, opts \\ [])

View Source 
@spec api_web_trip_controller_index(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, MBTA.Model.Forbidden.t()}
  | {:ok, MBTA.Model.TooManyRequests.t()}
  | {:ok, MBTA.Model.Trips.t()}
  | {:ok, MBTA.Model.BadRequest.t()}
  | {:error, Tesla.Env.t()}

NOTE: A id, route, route_pattern, or name filter MUST be present for any trips to be returned. List of trips, the journies of a particular vehicle through a set of stops on a primary route and zero or more alternative routes that can be filtered on. ## Accessibility Wheelchair accessibility (/data/{index}/attributes/wheelchair_accessible) as defined in GTFS: | Value | Meaning | |-------|----------------------------------------------------| | 0 | No information | | 1 | Accessible (at stops allowing wheelchair_boarding) | | 2 | Inaccessible | ## Grouping Multiple trips may be grouped together using /data/{index}/attributes/block_id. A block represents a series of trips scheduled to be operated by the same vehicle. ## Naming There are 3 names associated with a trip. | API Field | GTFS | Show users? | |-----------------------------|-------------------|-------------| | /data/attributes/headsign | trip_headsign | Yes | | /data/attributes/name | trip_short_name | Yes | | /data/id | trip_id | No |

Parameters

  • connection (MBTA.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :"page[offset]" (integer()): Offset (0-based) of first element in the page
    • :"page[limit]" (integer()): Max number of elements to return

    • :sort (String.t): Results can be sorted by the id or any /data/{index}/attributes key. Assumes ascending; may be prefixed with '-' for descending | JSON pointer | Direction | sort | |--------------|-----------|------------| | /data/{index}/attributes/percentage | ascending | percentage | | /data/{index}/attributes/percentage | descending | -percentage | | /data/{index}/attributes/status | ascending | status | | /data/{index}/attributes/status | descending | -status | | /data/{index}/attributes/bikes_allowed | ascending | bikes_allowed | | /data/{index}/attributes/bikes_allowed | descending | -bikes_allowed | | /data/{index}/attributes/block_id | ascending | block_id | | /data/{index}/attributes/block_id | descending | -block_id | | /data/{index}/attributes/direction_id | ascending | direction_id | | /data/{index}/attributes/direction_id | descending | -direction_id | | /data/{index}/attributes/headsign | ascending | headsign | | /data/{index}/attributes/headsign | descending | -headsign | | /data/{index}/attributes/name | ascending | name | | /data/{index}/attributes/name | descending | -name | | /data/{index}/attributes/wheelchair_accessible | ascending | wheelchair_accessible | | /data/{index}/attributes/wheelchair_accessible | descending | -wheelchair_accessible |

    • :"fields[trip]" (String.t): 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 for an example.

    • :include (String.t): Relationships to include. route vehicle service shape predictions route_pattern stops occupancies 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 | include | Description | |-----------------|-------------| | route | The primary route for the trip. | | vehicle | The vehicle on this trip. | | service | The service controlling when this trip is active. | | shape | The shape of the trip. | | route_pattern | The route pattern for the trip. | | predictions | Predictions of when the vehicle on this trip will arrive at or depart from each stop on the route(s) on the trip. | | stops | The stops this trip goes through. | | occupancies | EXPERIMENTAL: The trip's static occupancy data. For information on experimental features, see: https://www.mbta.com/developers/v3-api/versioning.|

    • :"filter[date]" (Date.t): Filter by trips on a particular date 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.
    • :"filter[direction_id]" (String.t): 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/attributes/direction_names.
    • :"filter[route]" (String.t): Filter by /data/{index}/relationships/route/data/id. Multiple IDs MUST be a comma-separated (U+002C COMMA, ",") list.
    • :"filter[route_pattern]" (String.t): Filter by route pattern IDs MUST be a comma-separated (U+002C COMMA, ",") list.
    • :"filter[id]" (String.t): Filter by multiple IDs. MUST be a comma-separated (U+002C COMMA, ",") list.
    • :"filter[name]" (String.t): Filter by multiple names. MUST be a comma-separated (U+002C COMMA, ",") list.

Returns

  • {:ok, MBTA.Model.Trips.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

api_web_trip_controller_show(connection, id, opts \\ [])

View Source 
@spec api_web_trip_controller_show(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MBTA.Model.NotAcceptable.t()}
  | {:ok, MBTA.Model.Forbidden.t()}
  | {:ok, MBTA.Model.TooManyRequests.t()}
  | {:ok, MBTA.Model.NotFound.t()}
  | {:ok, MBTA.Model.Trip.t()}
  | {:error, Tesla.Env.t()}

Single trip - the journey of a particular vehicle through a set of stops ## Accessibility Wheelchair accessibility (/data/attributes/wheelchair_accessible) as defined in GTFS: | Value | Meaning | |-------|----------------------------------------------------| | 0 | No information | | 1 | Accessible (at stops allowing wheelchair_boarding) | | 2 | Inaccessible | ## Grouping Multiple trips may be grouped together using /data/attributes/block_id. A block represents a series of trips scheduled to be operated by the same vehicle. ## Naming There are 3 names associated with a trip. | API Field | GTFS | Show users? | |-----------------------------|-------------------|-------------| | /data/attributes/headsign | trip_headsign | Yes | | /data/attributes/name | trip_short_name | Yes | | /data/id | trip_id | No |

Parameters

  • connection (MBTA.Connection): Connection to server
  • id (String.t): Unique identifier for a trip
  • opts (keyword): Optional parameters
    • :"fields[trip]" (String.t): 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 for an example.

    • :include (String.t): Relationships to include. route vehicle service shape predictions route_pattern stops occupancies 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 | include | Description | |-----------------|-------------| | route | The primary route for the trip. | | vehicle | The vehicle on this trip. | | service | The service controlling when this trip is active. | | shape | The shape of the trip. | | route_pattern | The route pattern for the trip. | | predictions | Predictions of when the vehicle on this trip will arrive at or depart from each stop on the route(s) on the trip. | | stops | The stops this trip goes through. | | occupancies | EXPERIMENTAL: The trip's static occupancy data. For information on experimental features, see: https://www.mbta.com/developers/v3-api/versioning.|

Returns

  • {:ok, MBTA.Model.Trip.t} on success
  • {:error, Tesla.Env.t} on failure