Aggregate available vehicle_types at a station #261
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -380,12 +380,7 @@ Field Name | Required | Type | Defines | |
| \- `vehicle_docks_available` <br/>*(added in v2.1-RC)* | Conditionally Required | Array | This field is required in feeds where the [vehicle_types.json](#vehicle_typesjson) is defined and where certain docks are only able to accept certain vehicle types. If every dock at the station is able to accept any vehicle type, then this field is not required. This field's value is an array of objects. Each of these objects is used to model the number of docks available for certain vehicle types. The total number of docks from each of these objects should add up to match the value specified in the `num_docks_available` field. | ||
|  \- `vehicle_type_ids` <br/>*(added in v2.1-RC)* | Yes | Array of Strings | An array of strings where each string represents a vehicle_type_id that is able to use a particular type of dock at the station | ||
|  \- `count` <br/>*(added in v2.1-RC)* | Yes | Non-negative integer | A number representing the total number of available docks at the station that can accept vehicles of the specified types in the `vehicle_types` array. | ||
| \- `vehicle_types_available` <br/>*(added in v2.1-RC)* | Conditionally Required | Object | This field is required if the [vehicle_types.json](#vehicle_typesjson) file has been defined. This field is an object where each key is a `vehicle_type_id` as described in [vehicle_types.json](#vehicle_typesjson) and the value is a number representing the total number of available vehicle at this station for the specified vehicle type. | ||
|
|
||
|
|
||
| Example: | ||
|
|
@@ -404,18 +399,11 @@ Example: | |
| "is_returning": true, | ||
| "last_reported": 1434054678, | ||
| "num_docks_available": 3, | ||
| "num_bikes_available": 1, | ||
| "vehicle_types_available": { | ||
| "abc123": 1, | ||
| "def456": 0 | ||
| }, | ||
| "vehicle_docks_available": [{ | ||
| "vehicle_type_ids": ["abc123"], | ||
| "count": 2 | ||
|
|
@@ -430,18 +418,11 @@ Example: | |
| "is_returning": true, | ||
| "last_reported": 1434054678, | ||
| "num_docks_available": 8, | ||
| "num_bikes_available": 6, | ||
| "vehicle_types_available": { | ||
| "abc123": 4, | ||
| "def456": 2 | ||
| } | ||
| } | ||
| ] | ||
| } | ||
|
|
@@ -450,15 +431,15 @@ Example: | |
|
|
||
| ### free_bike_status.json | ||
|
|
||
| Describes all vehicles that are not at a station and are not currently in the middle of an active ride. From v2.1-RC, also provides more information about vehicles that are at a station if the [vehicle_types.json](#vehicle_typesjson) file has been defined. | ||
|
There was a problem hiding this comment. Would like to clarify this definition and add line about vehicles in active rental from Best Practices. Suggesting this: "Describes all vehicles that are not currently in active rental. Required of free floating (dockless) vehicles. Conditionally required of station based (docked) vehicles when vehicle_types.json has been defined. Vehicles that are part of an active rental must not appear in this feed." There was a problem hiding this comment. This definition should also be updated under "Files" above on line 71. There was a problem hiding this comment. Yes that's more clear, thanks! Updated at both places. |
||
|
|
||
| Field Name | Required | Type | Defines | ||
| ---|---|---|--- | ||
| `bikes` | Yes | Array | Array that contains one object per vehicle that is currently stopped as defined below. | ||
| \- `bike_id` | Yes | ID | Identifier of a vehicle, rotated to a random string, at minimum, after each trip to protect privacy *(as of v2.0)*. Note: Persistent bike_id, published publicly, could pose a threat to individual traveler privacy. | ||
| \- `system_id` <br/>*(added in v3.0-RC)* | Conditionally required | ID | Identifier referencing the system_id field in system_information.json. Required in the case of feeds that specify free (undocked) bikes and define systems in system_information.json. | ||
| \- `lat` | Conditionally required | Latitude | Latitude of the vehicle. This field is required if station_id is not provided for this vehicle (free floating). | ||
| \- `lon` | Conditionally required | Longitude | Longitude of the vehicle. This field is required if station_id is not provided for this vehicle (free floating). | ||
| \- `is_reserved` | Yes | Boolean | Is the vehicle currently reserved? <br /><br /> `true` - Vehicle is currently reserved. <br /> `false` - Vehicle is not currently reserved. | ||
| \- `is_disabled` | Yes | Boolean | Is the vehicle currently disabled (broken)? <br /><br /> `true` - Vehicle is currently disabled. <br /> `false` - Vehicle is not currently disabled. | ||
| \- `rental_uris` <br/>*(added in v1.1)* | Optional | Object | JSON object that contains rental URIs for Android, iOS, and web in the android, ios, and web fields. See [examples](#examples-added-in-v11) of how to use these fields and [supported analytics](#analytics-added-in-v11). | ||
|
|
@@ -468,6 +449,7 @@ Field Name | Required | Type | Defines | |
| \- `vehicle_type_id` <br/>*(added in v2.1-RC)* | Conditionally Required | ID | The vehicle_type_id of this vehicle as described in [vehicle_types.json](#vehicle_typesjson-added-in-v21-rc). This field is required if the [vehicle_types.json](#vehicle_typesjson-added-in-v21-rc) is defined. | ||
| \- `last_reported` <br/>*(added in v2.1-RC)* | Optional | Timestamp | The last time this vehicle reported its status to the operator's backend. | ||
| \- `current_range_meters` <br/>*(added in v2.1-RC)* | Conditionally Required | Non-negative float | If the corresponding vehicle_type definition for this vehicle has a motor, then this field is required. This value represents the furthest distance in meters that the vehicle can travel without recharging or refueling with the vehicle's current charge or fuel. | ||
| \- `station_id` <br/>*(added in v2.1-RC)* | Conditionally required | ID | Identifier referencing the station_id field in system_information.json. Required only if the vehicle is currently at a station and the [vehicle_types.json](#vehicle_typesjson) file has been defined. | ||
|
|
||
| Example: | ||
|
|
||
|
|
@@ -489,12 +471,11 @@ Example: | |
| }, { | ||
| "bike_id": "jkl012", | ||
| "last_reported": 1434054687, | ||
| "is_reserved": false, | ||
| "is_disabled": false, | ||
| "vehicle_type_id": "def456", | ||
| "current_range_meters": 6543, | ||
| "station_id": 86 | ||
| } | ||
| ] | ||
| } | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vehicles should be plural: available vehicles
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
now changed, thanks for letting me know