From 8f44f0ac5e87956a46cc183a5ae19bea411bfc1b Mon Sep 17 00:00:00 2001 From: Matthew Wigginton Conway Date: Sat, 15 Sep 2018 10:20:17 -0700 Subject: [PATCH 1/5] Add access_method, #71 --- provider/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/provider/README.md b/provider/README.md index a628b602..e8173ce5 100644 --- a/provider/README.md +++ b/provider/README.md @@ -95,6 +95,7 @@ Data: `{ "trips": [] }`, an array of objects with the following structure | `trip_duration` | Integer | Required | Time, in Seconds | | `trip_distance` | Integer | Required | Trip Distance, in Meters | | `route` | Route | Required | See detail below | +| `access_method` | Enum | Required | How the user gained access to the vehicle | | `accuracy` | Integer | Required | The approximate level of accuracy, in meters, of `Points` within `route` | | `start_time` | Unix Timestamp | Required | | | `end_time` | Unix Timestamp | Required | | @@ -156,6 +157,23 @@ Routes must include at least 2 points: the start point and end point. Additional } ``` +### Access methods + +| `access_method` | meaning | +|-----------------|--------------------------------------------------------------------------------| +| `qr_code` | The user scanned a QR code with their mobile device | +| `keypad` | The user entered an identification number on a keypad | +| `transit_card` | The user used a transit card to unlock the vehicle | +| `rfid` | The user unlocked the vehicle with an RFID card or fob that is not a transit card | +| `mobile_id` | The user entered the ID of the device on their mobile phone | +| `other_mobile` | The user used a mobile phone, but did not scan a QR code or enter a vehicle ID | +| `credit_card_pay` | The user swiped/inserted/tapped their credit card to pay for the ride | +| `credit_card_id` | The user swiped/inserted/tapped their credit card to identify themselves, but their card was not charged an additional amount | +| `cash_attendant` | The user paid an attendant or operator cash to use the vehicle | +| `cash_automated` | The user paid cash using an automated system | +| `no_security` | The vehicles are unsecured and can be used by anyone without charge | +|------------------|-------------------------------------------------------------------------------| + [Top][toc] ## Status Changes From 6b5d71faee9ce10290ef58d48ca4f9a59a5d7c2a Mon Sep 17 00:00:00 2001 From: Matthew Wigginton Conway Date: Sat, 15 Sep 2018 10:23:07 -0700 Subject: [PATCH 2/5] Add access_methods call_center, ivr, and sms (#71) --- provider/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/provider/README.md b/provider/README.md index e8173ce5..311fecd2 100644 --- a/provider/README.md +++ b/provider/README.md @@ -164,13 +164,16 @@ Routes must include at least 2 points: the start point and end point. Additional | `qr_code` | The user scanned a QR code with their mobile device | | `keypad` | The user entered an identification number on a keypad | | `transit_card` | The user used a transit card to unlock the vehicle | -| `rfid` | The user unlocked the vehicle with an RFID card or fob that is not a transit card | +| `rfid` | The user accessed the vehicle with an RFID card or fob that is not a transit card | | `mobile_id` | The user entered the ID of the device on their mobile phone | | `other_mobile` | The user used a mobile phone, but did not scan a QR code or enter a vehicle ID | | `credit_card_pay` | The user swiped/inserted/tapped their credit card to pay for the ride | | `credit_card_id` | The user swiped/inserted/tapped their credit card to identify themselves, but their card was not charged an additional amount | | `cash_attendant` | The user paid an attendant or operator cash to use the vehicle | | `cash_automated` | The user paid cash using an automated system | +| `call_center` | The user accessed the vehicle by calling a call center operated by humans | +| `ivr` | An interactive voice response system was used to access the vehicle | +| `sms` | An SMS system was used to access the vehicle | | `no_security` | The vehicles are unsecured and can be used by anyone without charge | |------------------|-------------------------------------------------------------------------------| From ba91276124d1214bf74a8af2ad47377e5e93e898 Mon Sep 17 00:00:00 2001 From: Matthew Wigginton Conway Date: Tue, 2 Oct 2018 16:44:35 -0700 Subject: [PATCH 3/5] address comments in #76. --- provider/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/provider/README.md b/provider/README.md index ca883cc7..3d654090 100644 --- a/provider/README.md +++ b/provider/README.md @@ -125,7 +125,7 @@ Response: See the [`trips` schema][trips-schema] for the expected format. | `trip_duration` | Integer | Required | Time, in Seconds | | `trip_distance` | Integer | Required | Trip Distance, in Meters | | `route` | GeoJSON `FeatureCollection` | Required | See [Routes](#routes) detail below | -| `access_method` | Enum | Required | How the user gained access to the vehicle | +| `access_method` | Enum | Required | Array of [access methods](#access-methods): how the user gained access to the vehicle | | `accuracy` | Integer | Required | The approximate level of accuracy, in meters, of `Points` within `route` | | `start_time` | [timestamp][ts] | Required | | | `end_time` | [timestamp][ts] | Required | | From 55fa11222b30f84c9a6b8d7191193ff42819a010 Mon Sep 17 00:00:00 2001 From: Matthew Wigginton Conway Date: Tue, 2 Oct 2018 16:45:48 -0700 Subject: [PATCH 4/5] rm spurious horizontal line. --- provider/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/provider/README.md b/provider/README.md index 3d654090..f3ad982d 100644 --- a/provider/README.md +++ b/provider/README.md @@ -225,7 +225,6 @@ Routes must include at least 2 points: the start point and end point. Additional | `ivr` | An interactive voice response system was used to access the vehicle | | `sms` | An SMS system was used to access the vehicle | | `no_security` | The vehicles are unsecured and can be used by anyone without charge | -|------------------|-------------------------------------------------------------------------------| [Top][toc] From d332132b944d0ad97dd74b62520aa12e219f658b Mon Sep 17 00:00:00 2001 From: Matthew Wigginton Conway Date: Wed, 3 Oct 2018 23:03:21 -0700 Subject: [PATCH 5/5] correct array of access methods to be single access method. --- provider/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/provider/README.md b/provider/README.md index 1d943d5a..257a6d19 100644 --- a/provider/README.md +++ b/provider/README.md @@ -125,7 +125,7 @@ Response: See the [`trips` schema][trips-schema] for the expected format. | `trip_duration` | Integer | Required | Time, in Seconds | | `trip_distance` | Integer | Required | Trip Distance, in Meters | | `route` | GeoJSON `FeatureCollection` | Required | See [Routes](#routes) detail below | -| `access_method` | Enum | Required | Array of [access methods](#access-methods): how the user gained access to the vehicle | +| `access_method` | Enum | Required | An [access method](#access-methods): how the user gained access to the vehicle | | `accuracy` | Integer | Required | The approximate level of accuracy, in meters, of `Points` within `route` | | `start_time` | [timestamp][ts] | Required | | | `end_time` | [timestamp][ts] | Required | |