Skip to content

Commit 29e5982

Browse files
avatarneilthekaveman
avatarneil
authored and
thekaveman
committed
Add Stop Statuses enum
1 parent 7646491 commit 29e5982

1 file changed

Lines changed: 28 additions & 20 deletions

File tree

‎provider/README.md‎

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -358,29 +358,37 @@ In addition to the standard [Provider payload wrapper](#response-format), respon
358358
**[Beta feature](/general-information.md#beta-features):** Yes (as of 1.0.0)
359359
**`data` Payload:** `{ "stops": [] }`, an array of objects with the following structure
360360

361-
| Field | Type | Required/Optional | Description |
362-
|------------------------|------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
363-
| stop_id | UUID | Required | Unique ID for stop |
364-
| stop_name | String | Required | Name of stop |
365-
| lat | Double | Required | Latitude of the location |
366-
| lng | Double | Required | Longitude of the location |
367-
| capacity | {vehicle_type: number} | Required | Number of total spots per vehicle_type |
368-
| num_vehicles_available | {vehicle_type: number} | Required | How many vehicles are available per vehicle_type at this stop? |
369-
| num_vehicles_disabled | {vehicle_type: number} | Required | How many vehicles are unavailable/reserved per vehicle_type at this stop? |
370-
| geography_id | UUID | Optional | Pointer to the Geography that represents the Stop geospatially |
371-
| 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) |
372-
| short_name | String | Optional | Abbreviated stop name |
373-
| address | String | Optional | Postal address (useful for directions) |
374-
| post_code | String | Optional | Postal code (e.g. `10036`) |
375-
| 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) |
376-
| cross_street | String | Optional | Cross street of where the station is located. |
377-
| num_spots_available | {vehicle_type: number} | Optional | How many spots are free to be populated with vehicles at this stop? |
378-
| num_spots_disabled | {vehicle_type: number} | Optional | How many docks are disabled and unable to accept vehicles at this stop? |
379-
| wheelchair_boarding | Boolean | Optional | Is this stop handicap accessible? |
380-
| parent_stop | UUID | Optional | Describe a basic hierarchy of stops (e.g.a stop inside of a greater stop) |
361+
| Field | Type | Required/Optional | Description |
362+
|------------------------|-----------------------------------------------------------------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
363+
| stop_id | UUID | Required | Unique ID for stop |
364+
| stop_name | String | Required | Name of stop |
365+
| lat | Double | Required | Latitude of the location |
366+
| lng | Double | Required | Longitude of the location |
367+
| status | Enum | Required | Status of the Stop. See [Stop Statuses](#stop-statuses) table. |
368+
| capacity | {vehicle_type: number} | Required | Number of total spots per vehicle_type |
369+
| num_vehicles_available | {vehicle_type: number} | Required | How many vehicles are available per vehicle_type at this stop? |
370+
| num_vehicles_disabled | {vehicle_type: number} | Required | How many vehicles are unavailable/reserved per vehicle_type at this stop? |
371+
| geography_id | UUID | Optional | Pointer to the Geography that represents the Stop geospatially |
372+
| 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) |
373+
| short_name | String | Optional | Abbreviated stop name |
374+
| address | String | Optional | Postal address (useful for directions) |
375+
| post_code | String | Optional | Postal code (e.g. `10036`) |
376+
| 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) |
377+
| cross_street | String | Optional | Cross street of where the station is located. |
378+
| num_spots_available | {vehicle_type: number} | Optional | How many spots are free to be populated with vehicles at this stop? |
379+
| num_spots_disabled | {vehicle_type: number} | Optional | How many docks are disabled and unable to accept vehicles at this stop? |
380+
| parent_stop | UUID | Optional | Describe a basic hierarchy of stops (e.g.a stop inside of a greater stop) |
381381

382382
In the case that a `stop_id` query parameter is specified, the `stops` array returned will only have one entry. In the case that no `stop_id` query parameter is specified, all stops will be returned.
383383

384+
#### Stop Statuses
385+
386+
| `status` | Description |
387+
| ---------------- | ---------------------------------------------------------------------------------------- |
388+
| `open` | The station is open and available to rent out or accept vehicles |
389+
| `closed` | The station is closed. Either because of operating hours, repairs, or a seasonal closure |
390+
| `decommissioned` | The station is permanently closed and will be removed from the system |
391+
384392
### GBFS Compatibility
385393

386394
Some of the fields in the `Stops` definition are using notions which are currently not in MDS, such as `rental_methods`. These fields are included for compatibility with GBFS.

0 commit comments

Comments
 (0)