Skip to content

Commit

Permalink
Include full purchase_url URL in GBFS station_information and free_bi…
Browse files Browse the repository at this point in the history
…ke_status

* Based on #25 (comment).
  • Loading branch information
barbeau committed May 11, 2016
1 parent 979cfa2 commit c6eab6e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions gbfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ stations | Yes | Array that contains one object per station in th
- post_code | Optional | Postal code where station is located
- rental_methods | Optional | Array of enumerables containing the payment methods accepted at this station. <br />Current valid values (in CAPS) are:<br /><ul><li>KEY _(i.e. operator issued bike key / fob / card)_</li> <li>CREDITCARD</li> <li>PAYPASS</li> <li>APPLEPAY</li> <li>APPLEPAY</li> <li>ANDROIDPAY</li> <li>TRANSITCARD</li> <li>ACCOUNTNUMBER</li> <li>PHONE</li> </ul> This list is intended to be as comprehensive at the time of publication as possible but is subject to change, as defined in [File Requirements](#file-requirements) above
- capacity | Optional | Number of total docking points installed at this station, both available and unavailable
- purchase_url | Optional | A fully qualified and encoded URL where a user can rent a bike at this station_id. This URL should be a deep link specific to this station_id, and should not be a general rental page that includes information for more than one station.

### station_status.json

Expand All @@ -204,7 +205,6 @@ stations | Yes | Array that contains one object per station i
- is_renting | Yes | 1/0 boolean - is the station currently renting bikes (even if the station is empty, if it is set to allow rentals this value should be 1)
- is_returning | Yes | 1/0 boolean - is the station accepting bike returns (if a station is full but would allow a return if it was not full then this value should be 1)
- last_reported | Yes | Timestamp of the last time this station reported its status to the backend
- purchase_url | Optional | A fully qualified URL, to which the station_id can be passed as a parameter, where a user can rent a bike at this station_id. For example, if a fully qualified URL to a rental webpage for this station is http://app.socialbicycles.com/map?station_id=1219, then the value of purchase_url would be http://app.socialbicycles.com/map, and station_id would be 1219.

### free_bike_status.json
Describes bikes that are not at a station and are not currently in the middle of an active ride.
Expand All @@ -217,7 +217,7 @@ bikes | Yes | Array that contains one object per bike that is
- lon | Yes | Longitude of the bike. The field value must be a valid WGS 84 latitude. See: http://en.wikipedia.org/wiki/World_Geodetic_System
- is_reserved | Yes | 1/0 value - is the bike currently reserved for someone else
- is_disabled | Yes | 1/0 value - is the bike currently disabled (broken)
- purchase_url | Optional | A fully qualified URL, to which the bike_id can be passed as a parameter, where a user can rent this bike_id. For example, if a fully qualified URL to a rental webpage for this bike is http://app.socialbicycles.com/map?bike_id=3503, then the value of purchase_url would be http://app.socialbicycles.com/map, and bike_id would be 3503.
- purchase_url | Optional | A fully qualified and encoded URL where a user can rent this bike_id. This URL should be a deep link specific to this bike_id, and should not be a general rental page that includes information for more than one bike.

### system_hours.json
Describes the system hours of operation. A JSON array of hours defined as follows:
Expand Down

0 comments on commit c6eab6e

Please sign in to comment.