Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add fare media #355

Merged
merged 39 commits into from
Mar 14, 2023
Merged
Changes from 1 commit
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
b279149
Add fare containers to reference.md
omar-kabbani Aug 4, 2022
a1eb24e
Update documentation
omar-kabbani Aug 5, 2022
7a978bb
Update primary key of fare_products.txt
isabelle-dr Nov 1, 2022
58dd6bb
improve definitions
isabelle-dr Nov 10, 2022
c946316
fare_container_type
isabelle-dr Nov 10, 2022
ee8c670
add digital card option
isabelle-dr Nov 10, 2022
06c00e9
replace with new proposal
isabelle-dr Dec 8, 2022
4a5d329
typo
isabelle-dr Dec 8, 2022
5474fbd
improve descriptions
isabelle-dr Dec 9, 2022
c9724c6
Fix primary key of fare_payment_types.txt
isabelle-dr Dec 12, 2022
1da7691
Update descriptions
isabelle-dr Dec 19, 2022
6b13217
format table
isabelle-dr Dec 19, 2022
82d0605
add space
isabelle-dr Dec 19, 2022
e30461e
Change fare payment type to fare payment option
isabelle-dr Dec 20, 2022
e22b458
Update reference.md
isabelle-dr Dec 20, 2022
ce6a42b
small fix
isabelle-dr Dec 20, 2022
a47d325
small fix
isabelle-dr Dec 20, 2022
4ed5631
update fare_payment_option_name description
isabelle-dr Jan 17, 2023
0ea63c0
Update description of fare_payment_options.txt
isabelle-dr Jan 20, 2023
9dad005
Update with fare_payment_option_groups.txt design
isabelle-dr Jan 26, 2023
7e259fa
Update proposal
isabelle-dr Feb 14, 2023
c8f2d24
typo
isabelle-dr Feb 14, 2023
18ec06f
Update reference.md
isabelle-dr Feb 14, 2023
6b2110f
update description of fare medium name
isabelle-dr Feb 14, 2023
ee6cb96
small fix
isabelle-dr Feb 15, 2023
37293b3
Change fare media from "ID" to "Unique ID"
isabelle-dr Feb 17, 2023
68c98db
Remove "or empty" in fare_media_type because
isabelle-dr Feb 17, 2023
83d6e06
fix typo and add cEMV acronym
isabelle-dr Feb 21, 2023
f127803
remove paper ticket (not produced)
isabelle-dr Feb 28, 2023
7327c2f
Fix typos
isabelle-dr Mar 6, 2023
9840f03
Update fare media definition
isabelle-dr Mar 6, 2023
5bd9410
Merge branch 'master' into GTFS-Fares-v2-fare-containers
isabelle-dr Mar 6, 2023
e31ac5f
solve merge conflicts
isabelle-dr Mar 6, 2023
8ae6f60
Add line break
isabelle-dr Mar 6, 2023
f8008dc
remove line break
isabelle-dr Mar 6, 2023
7f08600
fix typo (additional "for)
isabelle-dr Mar 14, 2023
05dc9a9
Update revision history
isabelle-dr Mar 14, 2023
cc728f7
formatting fix
isabelle-dr Mar 14, 2023
481e4c1
formatting issue
isabelle-dr Mar 14, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix typos
- "used to use" in fare media description
- reference to fare_payment_options that wasn't removed
- replace "have"with "has" in fare_media_type 2 description
  • Loading branch information
isabelle-dr committed Mar 6, 2023
commit 7327c2f05af7b1116e8d095e2c3e10b062a82db4
14 changes: 7 additions & 7 deletions gtfs/spec/en/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ File: **Optional**
Primary key (`fare_id`)

**Versions**<br>
There are two modelling options for describing fares. GTFS-Fares V1 is the legacy option for describing minimal fare information. GTFS-Fares V2 is an updated method that allows for a more detailed account of an agency's fare structure. Both are allowed to be present in a dataset, but only one method should be used by a data consumer for a given dataset. It is recommended that GTFS-Fares V2 takes precedence over GTFS-Fares V1. <br><br>The files associated with GTFS-Fares V1 are: <br>- [fare_attributes.txt](#fare_attributestxt)<br>- [fare_rules.txt](#fare_rulestxt)<br><br>The files associated with GTFS-Fares V2 are: <br>- [fare_payment_options.txt](#fare_payment_optionstxt)<br>- [fare_products.txt](#fare_productstxt)<br>- [fare_leg_rules.txt](#fare_leg_rulestxt)<br>- [fare_transfer_rules.txt](#fare_transfer_rulestxt)
There are two modelling options for describing fares. GTFS-Fares V1 is the legacy option for describing minimal fare information. GTFS-Fares V2 is an updated method that allows for a more detailed account of an agency's fare structure. Both are allowed to be present in a dataset, but only one method should be used by a data consumer for a given dataset. It is recommended that GTFS-Fares V2 takes precedence over GTFS-Fares V1. <br><br>The files associated with GTFS-Fares V1 are: <br>- [fare_attributes.txt](#fare_attributestxt)<br>- [fare_rules.txt](#fare_rulestxt)<br><br>The files associated with GTFS-Fares V2 are: <br>- [fare_media.txt](#fare_mediatxt)<br>- [fare_products.txt](#fare_productstxt)<br>- [fare_leg_rules.txt](#fare_leg_rulestxt)<br>- [fare_transfer_rules.txt](#fare_transfer_rulestxt)

<br>

Expand Down Expand Up @@ -349,29 +349,29 @@ For examples that demonstrate how to specify a fare structure with [fare_rules.t

File: **Optional**

Primary Key (`fare_medium_id`)
Primary Key (`fare_media_id`)

To describe the different fare media that can be employed to use fare products. Fare media are physical or virtual holders used for the representation and/or validation of a fare product.

| Field Name | Type | Presence | Description |
| ------ | ------ | ------ | ------ |
| `fare_medium_id` | Unique ID | **Required** | Identifies a fare medium. |
| `fare_medium_name` | Text | Optional | Name of the fare medium.<br>For fare media which are transit cards (`fare_medium_type =2`) or mobile apps (`fare_medium_type =4`), the `fare_medium_name` should be included and should match the rider-facing name used by the organizations delivering them. |
| `fare_medium_type` | Enum | **Required** | The type of fare medium. <br>Valid options are:<br><br>`0` - None.<br>`2` - Physical transit card that have stored tickets, passes or monetary value.<br>`3` - cEMV (contactless Europay, Mastercard and Visa) as an open-loop token container for account-based ticketing.<br>`4` - Mobile app that have stored virtual transit cards, tickets, passes, or monetary value.|
| `fare_media_id` | Unique ID | **Required** | Identifies a fare media. |
| `fare_media_name` | Text | Optional | Name of the fare media.<br>For fare media which are transit cards (`fare_media_type =2`) or mobile apps (`fare_media_type =4`), the `fare_media_name` should be included and should match the rider-facing name used by the organizations delivering them. |
| `fare_media_type` | Enum | **Required** | The type of fare media. <br>Valid options are:<br><br>`0` - None.<br>`2` - Physical transit card that has stored tickets, passes or monetary value.<br>`3` - cEMV (contactless Europay, Mastercard and Visa) as an open-loop token container for account-based ticketing.<br>`4` - Mobile app that have stored virtual transit cards, tickets, passes, or monetary value.|

### fare_products.txt

File: **Optional**

Primary Key (`fare_product_id`, `fare_medium_id`)
Primary Key (`fare_product_id`, `fare_media_id`)

To describe the different types of tickets or fares that can be purchased by riders.

| Field Name | Type | Presence | Description |
| ------ | ------ | ------ | ------ |
| `fare_product_id` | ID | **Required** | Identifies a fare product. |
| `fare_product_name` | Text | Optional | The name of the fare product as displayed to riders. |
| `fare_medium_id` | Foreign ID referencing `fare_media.fare_medium_id` | Optional | Identifies a fare medium that can be employed used to use the `fare product` during the trip. When `fare_medium_id`is empty, it is considered that the fare media is unknown.|
| `fare_media_id` | Foreign ID referencing `fare_media.fare_media_id` | Optional | Identifies a fare media that can be employed to use the `fare product` during the trip. When `fare_media_id`is empty, it is considered that the fare media is unknown.|
| `amount` | Currency amount | **Required** | The cost of the fare product. May be negative to represent transfer discounts. May be zero to represent a fare product that is free.|
| `currency` | Currency code | **Required** | The currency of the cost of the fare product. |

Expand Down