Skip to content

Commit 658f941

Browse files
avatarneilthekaveman
avatarneil
authored and
thekaveman
committed
Alignment with recent changes in Provider version
1 parent 42b46ff commit 658f941

1 file changed

Lines changed: 25 additions & 9 deletions

File tree

‎agency/README.md‎

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -236,8 +236,10 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
236236

237237
The `/stops` endpoint allows an agency to register Stops.
238238

239-
Endpoint: `/stops`
240-
Method: `POST`
239+
**Endpoint:** `/stops`
240+
**Method:** `POST`
241+
**[Beta feature](/general-information.md#beta-features):** Yes (as of 1.0.0)
242+
241243

242244
| Field | Type | Required/Optional | Description |
243245
|---------------------|-----------------------------------------------------------------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -257,28 +259,33 @@ Method: `POST`
257259
| wheelchair_boarding | Boolean | Optional | Is this stop handicap accessible? |
258260
| parent_stop | UUID | Optional | Describe a basic hierarchy of stops (e.g.a stop inside of a greater stop) |
259261

260-
Endpoint: `/stops`
261-
Method: `PUT`
262+
**Endpoint:** `/stops`
263+
**Method:** `PUT`
264+
**[Beta feature](/general-information.md#beta-features):** Yes (as of 1.0.0)
262265

263266
| Field | Type | Required/Optional | Description |
264267
|---------------------|------------------------|-------------------|-------------------------------------------------------------------------|
265268
| stop_id | UUID | Required | Unique ID for stop |
269+
| status | Enum | Required | Status of the Stop. See [Stop Statuses](#stop-statuses) table. |
266270
| num_spots_available | {vehicle_type: number} | Optional | How many spots are free to be populated with vehicles at this stop? |
267271
| num_spots_disabled | {vehicle_type: number} | Optional | How many docks are disabled and unable to accept vehicles at this stop? |
268272

269-
Endpoint: `/stops/{stop_id}`
270-
Method: `GET`
273+
**Endpoint:** `/stops/:stop_id`
274+
**Method:** `GET`
275+
**[Beta feature](/general-information.md#beta-features):** Yes (as of 1.0.0)
276+
**`data` Payload:** `{ "stops": [] }`, an array of objects with the following structure
271277

272278
| Field | Type | Required/Optional | Description |
273279
|------------------------|-----------------------------------------------------------------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
274280
| stop_id | UUID | Required | Unique ID for stop |
275281
| stop_name | String | Required | Name of stop |
276282
| lat | Double | Required | Latitude of the location |
277283
| lng | Double | Required | Longitude of the location |
284+
| status | Enum | Required | Status of the Stop. See [Stop Statuses](#stop-statuses) table. |
278285
| capacity | {vehicle_type: number} | Required | Number of total spots per vehicle_type |
279286
| num_vehicles_available | {vehicle_type: number} | Required | How many vehicles are available per vehicle_type at this stop? |
280287
| num_vehicles_disabled | {vehicle_type: number} | Required | How many vehicles are unavailable/reserved per vehicle_type at this stop? |
281-
| geography_id | UUID | Optional | Pointer to the Geography that represents the stop geospatially |
288+
| geography_id | UUID | Optional | Pointer to the Geography that represents the Stop geospatially |
282289
| 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) |
283290
| short_name | String | Optional | Abbreviated stop name |
284291
| address | String | Optional | Postal address (useful for directions) |
@@ -287,8 +294,17 @@ Method: `GET`
287294
| cross_street | String | Optional | Cross street of where the station is located. |
288295
| num_spots_available | {vehicle_type: number} | Optional | How many spots are free to be populated with vehicles at this stop? |
289296
| num_spots_disabled | {vehicle_type: number} | Optional | How many docks are disabled and unable to accept vehicles at this stop? |
290-
| wheelchair_boarding | Boolean | Optional | Is this stop handicap accessible? |
291-
| parent_stop | UUID | Optional | Describe a basic hierarchy of stops (e.g.a stop inside of a greater stop) |
297+
| parent_stop | UUID | Optional | Describe a basic hierarchy of stops (e.g.a stop inside of a greater stop) |
298+
299+
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.
300+
301+
#### Stop Statuses
302+
303+
| `status` | Description |
304+
| ---------------- | ---------------------------------------------------------------------------------------- |
305+
| `open` | The station is open and available to rent out or accept vehicles |
306+
| `closed` | The station is closed. Either because of operating hours, repairs, or a seasonal closure |
307+
| `decommissioned` | The station is permanently closed and will be removed from the system | |
292308

293309
### GBFS Compatibility
294310
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)