vehicle_types.json (added in v2.1-RC)
The following fields are all attributes within the main "data" object for this feed.
| Field Name | Required | Type | Defines |
|---|---|---|---|
vehicle_types | Yes | Array | Array that contains one object per vehicle type in the system as defined below. |
- vehicle_type_id
| Yes | ID | Unique identifier of a vehicle type. See Field Types above for ID field requirements. |
- form_factor
| Yes | Enum | The vehicle's general form factor. Current valid values are:
|
- propulsion_type
| Yes | Enum | The primary propulsion type of the vehicle. Current valid values are:
|
- max_range_meters
| Conditionally Required | Non-negative float | If the vehicle has a motor (as indicated by having a value other than human in the propulsion_type field), this field is required. This represents the furthest distance in meters that the vehicle can travel without recharging or refueling when it has the maximum amount of energy potential (for example, a full battery or full tank of gas). |
- name
| Optional | String | The public name of this vehicle type. |
| Field Name | Required | Type | Defines |
|---|---|---|---|
vehicle_types | Yes | Array | Array that contains one object per vehicle type in the system as defined below. |
- vehicle_type_id
| Yes | ID | Unique identifier of a vehicle type. See Field Types above for ID field requirements. |
- form_factor
| Yes | Enum | The vehicle's general form factor. Current valid values are:
|
- car_type
| Optional | Enum | The type of car. Current valid issues are:
|
- rider_capacity
| Optional | Non-negative integer | The number of riders the vehicle can legally accommodate. |
- propulsion_type
| Yes | Enum | The primary propulsion type of the vehicle. Current valid values are:
combustion_diesel (Contains throttle mode with a diesel engine-powered motor) |
- min_fuel_level
| Optional | Enum | Minimum amount of fuel that must be left in the vehicle at the end of a trip. Current valid values are:
|
- max_range_meters
| Conditionally Required | Non-negative float | If the vehicle has a motor (as indicated by having a value other than human in the propulsion_type field), this field is required. This represents the furthest distance in meters that the vehicle can travel without recharging or refueling when it has the maximum amount of energy potential (for example, a full battery or full tank of gas). |
- name
| Optional | String | The public name of this vehicle type. |
- vehicle_desc
| Optional | String | Description of the vehicle that provides useful, quality information. Do not simply duplicate the information already specified. |
- use_conditions
| Optional | String | Conditions of use for this vehicle (e.g. age restrictions, license restrictions). |
Example:
{ "last_updated": 1434054678, "ttl": 0, "version": "3.0", "data": { "vehicle_types": [ { "vehicle_type_id": "abc123", "form_factor": "bicycle", "propulsion_type": "human", "name": "Example Basic Bike" }, { "vehicle_type_id": "def456", "form_factor": "scooter", "propulsion_type": "electric", "name": "Example E-scooter V2", "max_range_meters": 12345 }, { "vehicle_type_id": "car1", "form_factor": "car", "car_type": "full_size", "rider_capacity": 5, "propulsion_type": "combustion", "min_fuel_level": "half_full", "name": "Mercedes E 450", "max_range_meters": 523992, "vehicle_desc": "Four-door black sedan""name": "Foor-door Sedan","max_range_meters": 523992} ] } }
station_information.json
All stations included in station_information.json are considered public (e.g., can be shown on a map for public use). If there are private stations (such as Capital Bikeshare’s White House station), these should not be included here.
| Field Name | Required | Type | Defines |
|---|---|---|---|
stations | Yes | Array | Array that contains one object per station as defined below. |
- station_id
| Yes | ID | Identifier of a station. |
- name
| Yes | String | Public name of the station. |
- short_name
| Optional | String | Short name or other type of identifier. |
- lat
| Yes | Latitude | The latitude of station. |
- lon
| Yes | Longitude | The longitude of station. |
- address
| Optional | String | Address (street number and name) where station is located. This must be a valid address, not a free-form text description (see "cross_street" below). |
- cross_street
| Optional | String | Cross street or landmark where the station is located. |
- region_id
| Optional | ID | Identifier of the region where station is located. See system_regions.json. |
- post_code
| Optional | String | Postal code where station is located. |
- rental_methods
| Optional | Array | Payment methods accepted at this station. Current valid values are:
|
- is_virtual_station (added in v2.1-RC) | Optional | Boolean | Is this station a location with or without physical infrastructures (docks)? true - The station is a location without physical infrastructure, defined by a point (lat/lon) and/or station_area (below). false - The station consists of physical infrastructure (docks). If this field is empty, it means the station consists of physical infrastructure (docks). |
- station_area (added in v2.1-RC) | Optional | GeoJSON Multipolygon | A multipolygon that describes the area of a virtual station. If station_area is supplied then the record describes a virtual station. If lat/lon and 'station_area' are both defined, the lat/lon is the significant coordinate of the station (e.g. dock facility or valet drop-off and pick up point). |
- capacity
| Optional | Non-negative integer | Number of total docking points installed at this station, both available and unavailable, regardless of what vehicle types are allowed at each dock. Empty indicates unlimited capacity. |
- vehicle_capacity (added in v2.1-RC) | Optional | ID | An object where each key is a vehicle_type_id as described in vehicle_types.json and the value is a number representing the total number of vehicles of this type that can park within the area defined in the station_area field. If the field station_area is defined and a particular vehicle type id is not defined in this object, then an unlimited virtual capacity is assumed for that vehicle type. |
- is_valet_station (added in v2.1-RC) | Optional | Boolean | Are valet services provided at this station? true - Valet services are provided at this station. false - Valet services are not provided at this station. If this field is empty, it means valet services are not provided at this station. |
- rental_uris (added in v1.1) | Optional | Object | Contains rental URIs for Android, iOS, and web in the android, ios, and web fields. See examples of how to use these fields and supported analytics. |
- android (added in v1.1) | Optional | URI | URI that can be passed to an Android app with an android.intent.action.VIEW Android intent to support Android Deep Links (https://developer.android.com/training/app-links/deep-linking). Please use Android App Links (https://developer.android.com/training/app-links) if possible so viewing apps don’t need to manually manage the redirect of the user to the app store if the user doesn’t have the application installed. This URI should be a deep link specific to this station, and should not be a general rental page that includes information for more than one station. The deep link should take users directly to this station, without any prompts, interstitial pages, or logins. Make sure that users can see this station even if they never previously opened the application. If this field is empty, it means deep linking isn’t supported in the native Android rental app. Note that URIs do not necessarily include the station_id for this station - other identifiers can be used by the rental app within the URI to uniquely identify this station. See the Analytics section for how viewing apps can report the origin of the deep link to rental apps. Android App Links example value: https://www.abc.com/app?sid=1234567890&platform=android Deep Link (without App Links) example value: com.abcrental.android://open.abc.app/app?sid=1234567890
|
- ios (added in v1.1) | Optional | URI | URI that can be used on iOS to launch the rental app for this station. More information on this iOS feature can be found here. Please use iOS Universal Links (https://developer.apple.com/ios/universal-links/) if possible so viewing apps don’t need to manually manage the redirect of the user to the app store if the user doesn’t have the application installed. This URI should be a deep link specific to this station, and should not be a general rental page that includes information for more than one station. The deep link should take users directly to this station, without any prompts, interstitial pages, or logins. Make sure that users can see this station even if they never previously opened the application. If this field is empty, it means deep linking isn’t supported in the native iOS rental app. Note that the URI does not necessarily include the station_id - other identifiers can be used by the rental app within the URL to uniquely identify this station. See the Analytics section for how viewing apps can report the origin of the deep link to rental apps. iOS Universal Links example value: https://www.abc.com/app?sid=1234567890&platform=ios Deep Link (without Universal Links) example value: com.abcrental.ios://open.abc.app/app?sid=1234567890
|
- web (added in v1.1) | Optional | URL | URL that can be used by a web browser to show more information about renting a vehicle at this station. This URL should be a deep link specific to this station, and should not be a general rental page that includes information for more than one station. The deep link should take users directly to this station, without any prompts, interstitial pages, or logins. Make sure that users can see this station even if they never previously opened the application. If this field is empty, it means deep linking isn’t supported for web browsers. Example value: https://www.abc.com/app?sid=1234567890
|
- vehicle_type_capacity (added in v2.1-RC) | Optional | Object | An object where each key is a vehicle_type_id as described in vehicle_types.json and the value is a number representing the total docking points installed at this station, both available and unavailable for the specified vehicle type. |
| Field Name | Required | Type | Defines |
|---|---|---|---|
stations | Yes | Array | Array that contains one object per station as defined below. |
- station_id
| Yes | ID | Identifier of a station. |
- name
| Yes | String | Public name of the station. |
- short_name
| Optional | String | Short name or other type of identifier. |
- lat
| Yes | Latitude | The latitude of station. |
- lon
| Yes | Longitude | The longitude of station. |
- address
| Optional | String | Address (street number and name) where station is located. This must be a valid address, not a free-form text description (see "cross_street" below). |
- cross_street
| Optional | String | Cross street or landmark where the station is located. |
- region_id
| Optional | ID | Identifier of the region where station is located. See system_regions.json. |
- post_code
| Optional | String | Postal code where station is located. |
- rental_methods
| Optional | Array | Payment methods accepted at this station. Current valid values are:
|
- is_virtual_station (added in v2.1-RC) | Optional | Boolean | Is this station a location with or without physical infrastructures? true - The station is a location without physical infrastructure, defined by a point (lat/lon) and/or station_area (below). false - The station consists of physical infrastructure (docks, charging stations, dropbox, operator branch, gate arm, parking hoop, etc.). If this field is empty, it means the station consists of physical infrastructure. |
- station_area (added in v2.1-RC) | Optional | GeoJSON Multipolygon | A multipolygon that describes the area of a virtual station. If station_area is supplied then the record describes a virtual station. If lat/lon and 'station_area' are both defined, the lat/lon is the significant coordinate of the station (e.g. dock facility or valet drop-off and pick up point). |
- station_type
| Optional | Enum | Type of station. Current valid values are:
|
- parking_hoop
| Optional | Boolean | Are parking hoops present at this station? If this field is empty, it means this station does not have parking hoops. true - This station has parking hoops.false - This station does not have parking hoops. |
- step_free_access
| Optional | Boolean | Can this station be accessed without having to take stairs? If this field is empty it means this station is not step free.true - This station has step free access.false - This station does not have step free access. |
- night_light
| Optional | Boolean | Does this station have nighttime lighting?true - This station does have nighttime lighting.false - This station does not have nighttime lighting. |
- station_desc
| Optional | String | Description of the station that provides useful, quality information. Do not simply duplicate the information already specified. |
- capacity
| Optional | Non-negative integer | Number of total docking points installed at this station, both available and unavailable, regardless of what vehicle types are allowed at each dock. Empty indicates unlimited capacity. |
- vehicle_capacity (added in v2.1-RC) | Optional | ID | An object where each key is a vehicle_type_id as described in vehicle_types.json and the value is a number representing the total number of vehicles of this type that can park within the area defined in the station_area field. If the field station_area is defined and a particular vehicle type id is not defined in this object, then an unlimited virtual capacity is assumed for that vehicle type. |
- is_valet_station (added in v2.1-RC) | Optional | Boolean | Are valet services provided at this station? true - Valet services are provided at this station. false - Valet services are not provided at this station. If this field is empty, it means valet services are not provided at this station. |
- rental_uris (added in v1.1) | Optional | Object | Contains rental URIs for Android, iOS, and web in the android, ios, and web fields. See examples of how to use these fields and supported analytics. |
- android (added in v1.1) | Optional | URI | URI that can be passed to an Android app with an android.intent.action.VIEW Android intent to support Android Deep Links (https://developer.android.com/training/app-links/deep-linking). Please use Android App Links (https://developer.android.com/training/app-links) if possible so viewing apps don’t need to manually manage the redirect of the user to the app store if the user doesn’t have the application installed. This URI should be a deep link specific to this station, and should not be a general rental page that includes information for more than one station. The deep link should take users directly to this station, without any prompts, interstitial pages, or logins. Make sure that users can see this station even if they never previously opened the application. If this field is empty, it means deep linking isn’t supported in the native Android rental app. Note that URIs do not necessarily include the station_id for this station - other identifiers can be used by the rental app within the URI to uniquely identify this station. See the Analytics section for how viewing apps can report the origin of the deep link to rental apps. Android App Links example value: https://www.abc.com/app?sid=1234567890&platform=android Deep Link (without App Links) example value: com.abcrental.android://open.abc.app/app?sid=1234567890
|
- ios (added in v1.1) | Optional | URI | URI that can be used on iOS to launch the rental app for this station. More information on this iOS feature can be found here. Please use iOS Universal Links (https://developer.apple.com/ios/universal-links/) if possible so viewing apps don’t need to manually manage the redirect of the user to the app store if the user doesn’t have the application installed. This URI should be a deep link specific to this station, and should not be a general rental page that includes information for more than one station. The deep link should take users directly to this station, without any prompts, interstitial pages, or logins. Make sure that users can see this station even if they never previously opened the application. If this field is empty, it means deep linking isn’t supported in the native iOS rental app. Note that the URI does not necessarily include the station_id - other identifiers can be used by the rental app within the URL to uniquely identify this station. See the Analytics section for how viewing apps can report the origin of the deep link to rental apps. iOS Universal Links example value: https://www.abc.com/app?sid=1234567890&platform=ios Deep Link (without Universal Links) example value: com.abcrental.ios://open.abc.app/app?sid=1234567890
|
- web (added in v1.1) | Optional | URL | URL that can be used by a web browser to show more information about renting a vehicle at this station. This URL should be a deep link specific to this station, and should not be a general rental page that includes information for more than one station. The deep link should take users directly to this station, without any prompts, interstitial pages, or logins. Make sure that users can see this station even if they never previously opened the application. If this field is empty, it means deep linking isn’t supported for web browsers. Example value: https://www.abc.com/app?sid=1234567890
|
- vehicle_type_capacity (added in v2.1-RC) | Optional | Object | An object where each key is a vehicle_type_id as described in vehicle_types.json and the value is a number representing the total docking points installed at this station, both available and unavailable for the specified vehicle type. |
Example:
{
"last_updated": 1434054678,
"ttl": 0,
"version": "3.0",
"data": {
"stations": [
{
"station_id": "pga",
"name": "Parking garage A",
"lat": 12.34,
"lon": 45.67,
"is_virtual_station": false,
"station_type": "underground_parking",
"parking_hoop": false,
"step_free_access": true,
"night_light": true,
"vehicle_type_capacity": {
"abc123": 7,
"def456": 9
}
}
]
}
}
station_status.json
Describes the capacity and rental availability of a station.
free_bike_status.json
Describes vehicles that are not at a station and are not currently in the middle of an active ride.
| 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 (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
| Yes | Latitude | Latitude of the vehicle. |
- lon
| Yes | Longitude | Longitude of the vehicle. |
- is_reserved
| Yes | Boolean | Is the vehicle currently reserved? true - Vehicle is currently reserved. false - Vehicle is not currently reserved. |
- is_disabled
| Yes | Boolean | Is the vehicle currently disabled (broken)? true - Vehicle is currently disabled. false - Vehicle is not currently disabled. |
- rental_uris (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 of how to use these fields and supported analytics. |
- android (added in v1.1) | Optional | URI | URI that can be passed to an Android app with an android.intent.action.VIEW Android intent to support Android Deep Links (https://developer.android.com/training/app-links/deep-linking). Please use Android App Links (https://developer.android.com/training/app-links) if possible so viewing apps don’t need to manually manage the redirect of the user to the app store if the user doesn’t have the application installed. This URI should be a deep link specific to this vehicle, and should not be a general rental page that includes information for more than one vehicle. The deep link should take users directly to this vehicle, without any prompts, interstitial pages, or logins. Make sure that users can see this vehicle even if they never previously opened the application. Note that as a best practice providers should rotate identifiers within deep links after each rental to avoid unintentionally exposing private vehicle trip origins and destinations. If this field is empty, it means deep linking isn’t supported in the native Android rental app. Note that URIs do not necessarily include the bike_id for this vehicle - other identifiers can be used by the rental app within the URI to uniquely identify this vehicle. See the Analytics section for how viewing apps can report the origin of the deep link to rental apps. Android App Links example value: https://www.abc.com/app?sid=1234567890&platform=android Deep Link (without App Links) example value: com.abcrental.android://open.abc.app/app?sid=1234567890
|
- ios (added in v1.1) | Optional | URI | URI that can be used on iOS to launch the rental app for this vehicle. More information on this iOS feature can be found here. Please use iOS Universal Links (https://developer.apple.com/ios/universal-links/) if possible so viewing apps don’t need to manually manage the redirect of the user to the app store if the user doesn’t have the application installed. This URI should be a deep link specific to this vehicle, and should not be a general rental page that includes information for more than one vehicle. The deep link should take users directly to this vehicle, without any prompts, interstitial pages, or logins. Make sure that users can see this vehicle even if they never previously opened the application. Note that as a best practice providers should rotate identifiers within deep links after each rental to avoid unintentionally exposing private vehicle trip origins and destinations. If this field is empty, it means deep linking isn’t supported in the native iOS rental app. Note that the URI does not necessarily include the bike_id - other identifiers can be used by the rental app within the URL to uniquely identify this vehicle. See the Analytics section for how viewing apps can report the origin of the deep link to rental apps. iOS Universal Links example value: https://www.abc.com/app?sid=1234567890&platform=ios Deep Link (without Universal Links) example value: com.abcrental.ios://open.abc.app/app?sid=1234567890
|
- web (added in v1.1) | Optional | URL | URL that can be used by a web browser to show more information about renting a vehicle at this vehicle. This URL should be a deep link specific to this vehicle, and should not be a general rental page that includes information for more than one vehicle. The deep link should take users directly to this vehicle, without any prompts, interstitial pages, or logins. Make sure that users can see this vehicle even if they never previously opened the application. Note that as a best practice providers should rotate identifiers within deep links after each rental to avoid unintentionally exposing private vehicle trip origins and destinations. If this field is empty, it means deep linking isn’t supported for web browsers. Example value: https://www.abc.com/app?sid=1234567890 |
- vehicle_type_id (added in v2.1-RC) | Conditionally Required | ID | The vehicle_type_id of this vehicle as described in vehicle_types.json. This field is required if the vehicle_types.json is defined. |
- last_reported (added in v2.1-RC) | Optional | Timestamp | The last time this vehicle reported its status to the operator's backend. |
- current_range_meters (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. |
Example:
| 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 (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
| Yes | Latitude | Latitude of the vehicle. |
- lon
| Yes | Longitude | Longitude of the vehicle. |
- is_reserved
| Yes | Boolean | Is the vehicle currently reserved? true - Vehicle is currently reserved. false - Vehicle is not currently reserved. |
- is_disabled
| Yes | Boolean | Is the vehicle currently disabled (broken)? true - Vehicle is currently disabled. false - Vehicle is not currently disabled. |
- rental_uris (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 of how to use these fields and supported analytics. |
- android (added in v1.1) | Optional | URI | URI that can be passed to an Android app with an android.intent.action.VIEW Android intent to support Android Deep Links (https://developer.android.com/training/app-links/deep-linking). Please use Android App Links (https://developer.android.com/training/app-links) if possible so viewing apps don’t need to manually manage the redirect of the user to the app store if the user doesn’t have the application installed. This URI should be a deep link specific to this vehicle, and should not be a general rental page that includes information for more than one vehicle. The deep link should take users directly to this vehicle, without any prompts, interstitial pages, or logins. Make sure that users can see this vehicle even if they never previously opened the application. Note that as a best practice providers should rotate identifiers within deep links after each rental to avoid unintentionally exposing private vehicle trip origins and destinations. If this field is empty, it means deep linking isn’t supported in the native Android rental app. Note that URIs do not necessarily include the bike_id for this vehicle - other identifiers can be used by the rental app within the URI to uniquely identify this vehicle. See the Analytics section for how viewing apps can report the origin of the deep link to rental apps. Android App Links example value: https://www.abc.com/app?sid=1234567890&platform=android Deep Link (without App Links) example value: com.abcrental.android://open.abc.app/app?sid=1234567890
|
- ios (added in v1.1) | Optional | URI | URI that can be used on iOS to launch the rental app for this vehicle. More information on this iOS feature can be found here. Please use iOS Universal Links (https://developer.apple.com/ios/universal-links/) if possible so viewing apps don’t need to manually manage the redirect of the user to the app store if the user doesn’t have the application installed. This URI should be a deep link specific to this vehicle, and should not be a general rental page that includes information for more than one vehicle. The deep link should take users directly to this vehicle, without any prompts, interstitial pages, or logins. Make sure that users can see this vehicle even if they never previously opened the application. Note that as a best practice providers should rotate identifiers within deep links after each rental to avoid unintentionally exposing private vehicle trip origins and destinations. If this field is empty, it means deep linking isn’t supported in the native iOS rental app. Note that the URI does not necessarily include the bike_id - other identifiers can be used by the rental app within the URL to uniquely identify this vehicle. See the Analytics section for how viewing apps can report the origin of the deep link to rental apps. iOS Universal Links example value: https://www.abc.com/app?sid=1234567890&platform=ios Deep Link (without Universal Links) example value: com.abcrental.ios://open.abc.app/app?sid=1234567890
|
- web (added in v1.1) | Optional | URL | URL that can be used by a web browser to show more information about renting a vehicle at this vehicle. This URL should be a deep link specific to this vehicle, and should not be a general rental page that includes information for more than one vehicle. The deep link should take users directly to this vehicle, without any prompts, interstitial pages, or logins. Make sure that users can see this vehicle even if they never previously opened the application. Note that as a best practice providers should rotate identifiers within deep links after each rental to avoid unintentionally exposing private vehicle trip origins and destinations. If this field is empty, it means deep linking isn’t supported for web browsers. Example value: https://www.abc.com/app?sid=1234567890 |
- vehicle_type_id (added in v2.1-RC) | Conditionally Required | ID | The vehicle_type_id of this vehicle as described in vehicle_types.json. This field is required if the vehicle_types.json is defined. |
- last_reported (added in v2.1-RC) | Optional | Timestamp | The last time this vehicle reported its status to the operator's backend. |
- current_range_meters (added in v2.1-RC) | Conditionally Required | Non-negative float | If the corresponding vehicle_type definition for this vehicle has a motor, and current_range_percent is not defined, 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. |
- current_range_percent
| Conditionally Required | Non-negative float | If the corresponding vehicle_type definition for this vehicle has a motor, and current_range_meters is not defined, then this field is required. This value represents the percentage, expressed from 0 to 1 of fuel or battery power remaining with the vehicle's current charge or fuel level. |
- vehicle_accessories
| Optional | Array | Description of accessories available in the vehicle. Current valid issues are:
|
- vehicle_image
| Optional | URL | URL to image that would assist the user in identifying the vehicle (e.g. logo, image of vehicle). |
| Example: |
{ "last_updated": 1434054678, "ttl": 0, "version": "3.0", "data": { "bikes": [ { "bike_id": "ghi789", "last_reported": 1434054678, "lat": 12.34, "lon": 56.78, "is_reserved": false, "is_disabled": false, "vehicle_type_id": "abc123" }, { "bike_id": "jkl012", "last_reported": 1434054687, "lat": 12.34, "lon": 56.78, "is_reserved": false, "is_disabled": false, "vehicle_type_id": "def456", "current_range_meters": 6543, "vehicle_accessories" [ "child_seat", "gps" ]"current_range_meters": 6543} ] } }
system_hours.json
Describes the system hours of operation.
system_pricing_plans.json
Describes pricing for the system.
| Field Name | Required | Type | Defines |
|---|---|---|---|
plans | Yes | Array | Array of objects as defined below. |
- plan_id
| Yes | ID | Identifier for a pricing plan in the system. |
- url
| Optional | URL | URL where the customer can learn more about this pricing plan. |
- name
| Yes | String | Name of this pricing plan. |
- currency
| Yes | String | Currency used to pay the fare. This pricing is in ISO 4217 code: http://en.wikipedia.org/wiki/ISO_4217 (e.g. CAD for Canadian dollars, EUR for euros, or JPY for Japanese yen.) |
- price
| Yes | Non-negative float OR String | Fare price, in the unit specified by currency. If String, must be in decimal monetary value. |
- is_taxable
| Yes | Boolean | Will additional tax be added to the base price?true - Yes.false - No. false may be used to indicate that tax is not charged or that tax is included in the base price. |
- description
| Yes | String | Customer-readable description of the pricing plan. This should include the duration, price, conditions, etc. that the publisher would like users to see. |
| Field Name | Required | Type | Defines |
|---|---|---|---|
plans | Yes | Array | Array of objects as defined below. |
- plan_id
| Yes | ID | Identifier for a pricing plan in the system. |
- url
| Optional | URL | URL where the customer can learn more about this pricing plan. |
- name
| Yes | String | Name of this pricing plan. |
- currency
| Yes | String | Currency used to pay the fare. This pricing is in ISO 4217 code: http://en.wikipedia.org/wiki/ISO_4217 (e.g. CAD for Canadian dollars, EUR for euros, or JPY for Japanese yen.) |
- price
| Yes | Non-negative float OR String | Fare price, in the unit specified by currency. If String, must be in decimal monetary value. |
- is_taxable
| Yes | Boolean | Will additional tax be added to the base price?true - Yes.false - No. false may be used to indicate that tax is not charged or that tax is included in the base price. |
- description
| Yes | String | Customer-readable description of the pricing plan. This should include the duration, price, conditions, etc. that the publisher would like users to see. |
- reservation
| Optional | Array | Array of reservation price information in minutes. |
- min_duration
| Optional | Non-negative integer | Minimum number of minutes the vehicle must be reserved for. If this field is empty, it means there is no minimum reservation time. |
- max_duration
| Optional | Non-negative integer | Maximum number of minutes the reservation is valid for. After this duration, the vehicle is no longer reserved. |
- price
| Optional | Non-negative float | Flat price to reserve a vehicle. If this field is empty, there is no price to reserve a vehicle. |
- start
| Optional | Non-negative integer | Number of minutes that must elapse after reservation is made for price to be applied. |
- interval
| Optional | Non-negative integer | Interval in minutes at which price is reapplied. |
system_alerts.json
This feed is intended to inform customers about changes to the system that do not fall within the normal system operations. For example, system closures due to weather would be listed here, but a system that only operated for part of the year would have that schedule listed in the system_calendar.json feed.
Obsolete alerts should be removed so the client application can safely present to the end user everything present in the feed.
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.
Should this say "Current valid values are:" instead of "Current valid issues are:"?