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.

Sign up for GitHub

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

Jump to bottom

Access method #76

Closed
wants to merge 7 commits into from
Closed

Access method #76

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8f44f0a
Add access_method, #71
mattwigway Sep 15, 2018
6b5d71f
Add access_methods call_center, ivr, and sms (#71)
mattwigway Sep 15, 2018
1685ce6
Merge branch 'master' into patch-1
mattwigway Oct 2, 2018
ba91276
address comments in #76.
mattwigway Oct 2, 2018
55fa112
rm spurious horizontal line.
mattwigway Oct 2, 2018
0c17e7c
Merge remote-tracking branch 'upstream/dev' into patch-1
mattwigway Oct 4, 2018
d332132
correct array of access methods to be single access method.
mattwigway Oct 4, 2018
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
24 changes: 22 additions & 2 deletions provider/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +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 |
Copy link
Contributor

@oderby oderby Oct 4, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would there be a multiple access methods for a single trip? (Thinking comments should just say "One of access method...")

| `accuracy` | Integer | Required | The approximate level of accuracy, in meters, of `Points` within `route` |
| `start_time` | [timestamp][ts] | Required | |
| `end_time` | [timestamp][ts] | Required | |
Expand Down Expand Up @@ -206,6 +207,25 @@ 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 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 |

[Top][toc]

## Status Changes
Expand Down Expand Up @@ -241,15 +261,15 @@ The status_changes API should allow querying status changes with a combination o
* `end_time`
* `bbox`

The `time` parameters can be provided as timestamps individually or together.
The `time` parameters can be provided as timestamps individually or together.

`bbox` is the bounding-box, for example:

```
bbox=-122.4183,37.7758,-122.4120,37.7858
```

Gets all status changes with an `event_location` within that bounding-box. The order is definied as: southwest longitude, southwest latitude, northeast longitude, northeast latitude (separated by commas).
Gets all status changes with an `event_location` within that bounding-box. The order is definied as: southwest longitude, southwest latitude, northeast longitude, northeast latitude (separated by commas).


### Event Types
Expand Down