Skip to content

Commit c938f39

Browse files
avatarneilthekaveman
avatarneil
authored and
thekaveman
committed
Add GBFS statuses
1 parent aa1652e commit c938f39

1 file changed

Lines changed: 30 additions & 30 deletions

File tree

‎general-information.md‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -108,36 +108,36 @@ All String fields, such as `vehicle_id`, are limited to a maximum of 255 charact
108108

109109
## Stops
110110

111-
| Field | Type | Required/Optional | Description |
112-
|------------------------|-----------------------------------------------------------------------------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
113-
| stop_id | UUID | Required | Unique ID for stop |
114-
| stop_name | String | Required | Name of stop |
115-
| last_reported | Timestamp | Required | Date/Time that the stop was last updated |
116-
| location | GeoJSON [Point Feature](provider/README.md#geographic-data) | Required | Location of the Stop |
117-
| status | Enum | Required | Status of the Stop. See [Stop Statuses](#stop-statuses) table. |
118-
| capacity | {vehicle_type: number} | Required | Number of total spots per vehicle_type |
119-
| num_vehicles_available | {vehicle_type: number} | Required | How many vehicles are available per vehicle_type at this stop? |
120-
| num_vehicles_disabled | {vehicle_type: number} | Required | How many vehicles are unavailable/reserved per vehicle_type at this stop? |
121-
| managed_by | UUID | Optional | `provider_id` for the provider which manages this stop. null/undefined if city managed. |
122-
| geography_id | UUID | Optional | Pointer to the Geography that represents the Stop geospatially |
123-
| region_id | string | Optional | ID of the region where station is located, see [GBFS Station Information](https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_informationjson) |
124-
| short_name | String | Optional | Abbreviated stop name |
125-
| address | String | Optional | Postal address (useful for directions) |
126-
| post_code | String | Optional | Postal code (e.g. `10036`) |
127-
| rental_methods | [Enum](https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_informationjson) | Optional | Payment methods accepted at stop, see [GBFS Rental Methods](https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_informationjson) |
128-
| cross_street | String | Optional | Cross street of where the station is located. |
129-
| num_spots_available | {vehicle_type: number} | Optional | How many spots are free to be populated with vehicles at this stop? |
130-
| num_spots_disabled | {vehicle_type: number} | Optional | How many docks are disabled and unable to accept vehicles at this stop? |
131-
| parent_stop | UUID | Optional | Describe a basic hierarchy of stops (e.g.a stop inside of a greater stop) |
132-
| vehicle_ids | UUID[] | Optional | List of device_ids for vehicles which are currently at this stop |
133-
134-
### Stop Statuses
135-
136-
| `status` | Description |
137-
|------------------|------------------------------------------------------------------------------------------|
138-
| `open` | The station is open and available to rent out or accept vehicles |
139-
| `closed` | The station is closed. Either because of operating hours, repairs, or a seasonal closure |
140-
| `decommissioned` | The station is permanently closed and will be removed from the system |
111+
| Field | Type | Required/Optional | Description |
112+
|------------------------|-----------------------------------------------------------------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
113+
| stop_id | UUID | Required | Unique ID for stop |
114+
| stop_name | String | Required | Name of stop |
115+
| last_reported | Timestamp | Required | Date/Time that the stop was last updated |
116+
| location | GeoJSON [Point Feature](provider/README.md#geographic-data) | Required | Location of the Stop |
117+
| status | [Stop Status](#stop-status) | Required | Object representing the status of the Stop. See [Stop Status](#stop-status). |
118+
| capacity | {vehicle_type: number} | Required | Number of total spots per vehicle_type |
119+
| num_vehicles_available | {vehicle_type: number} | Required | How many vehicles are available per vehicle_type at this stop? |
120+
| num_vehicles_disabled | {vehicle_type: number} | Required | How many vehicles are unavailable/reserved per vehicle_type at this stop? |
121+
| managed_by | UUID | Optional | `provider_id` for the provider which manages this stop. null/undefined if city managed. |
122+
| geography_id | UUID | Optional | Pointer to the Geography that represents the Stop geospatially |
123+
| region_id | string | Optional | ID of the region where station is located, see [GBFS Station Information](https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_informationjson) |
124+
| short_name | String | Optional | Abbreviated stop name |
125+
| address | String | Optional | Postal address (useful for directions) |
126+
| post_code | String | Optional | Postal code (e.g. `10036`) |
127+
| rental_methods | [Enum](https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_informationjson) | Optional | Payment methods accepted at stop, see [GBFS Rental Methods](https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_informationjson) |
128+
| cross_street | String | Optional | Cross street of where the station is located. |
129+
| num_spots_available | {vehicle_type: number} | Optional | How many spots are free to be populated with vehicles at this stop? |
130+
| num_spots_disabled | {vehicle_type: number} | Optional | How many docks are disabled and unable to accept vehicles at this stop? |
131+
| parent_stop | UUID | Optional | Describe a basic hierarchy of stops (e.g.a stop inside of a greater stop) |
132+
| vehicle_ids | UUID[] | Optional | List of device_ids for vehicles which are currently at this stop |
133+
134+
### Stop Status
135+
136+
| Field | Type | Required/Optional | Description |
137+
|--------------|---------|-------------------|-----------------------------------------------------------------------------------|
138+
| is_installed | Boolean | Required | See [GBFS](https://github.com/NABSA/gbfs/blob/v2.1-RC/gbfs.md#station_statusjson) |
139+
| is_renting | Boolean | Required | See [GBFS](https://github.com/NABSA/gbfs/blob/v2.1-RC/gbfs.md#station_statusjson) |
140+
| is_returning | Boolean | Required | See [GBFS](https://github.com/NABSA/gbfs/blob/v2.1-RC/gbfs.md#station_statusjson) |
141141

142142
### GBFS Compatibility
143143

0 commit comments

Comments
 (0)