Skip to content

Commit 3f13def

Browse files
avatarneilthekaveman
avatarneil
authored and
thekaveman
committed
Remove agency stops specification
1 parent 18dc26f commit 3f13def

1 file changed

Lines changed: 0 additions & 62 deletions

File tree

‎agency/README.md‎

Lines changed: 0 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -232,68 +232,6 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
232232
| `gps.satellites` | Integer | Required if Available | Number of GPS or GNSS satellites
233233
| `charge` | Float | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 1 |
234234

235-
## Stops
236-
237-
The `/stops` endpoint allows an agency to register Stops.
238-
239-
Endpoint: `/stops`
240-
Method: `POST`
241-
242-
| Field | Type | Required/Optional | Description |
243-
|---------------------|-----------------------------------------------------------------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
244-
| stop_id | UUID | Required | Unique ID for stop |
245-
| stop_name | String | Required | Name of stop |
246-
| lat | Double | Required | Latitude of the location |
247-
| lng | Double | Required | Longitude of the location |
248-
| capacity | {vehicle_type: number} | Required | Number of total spots per vehicle_type |
249-
| geography_id | UUID | Optional | Pointer to the Geography that represents the stop geospatially |
250-
| 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) |
251-
| short_name | String | Optional | Abbreviated stop name |
252-
| address | String | Optional | Postal address (useful for directions) |
253-
| post_code | String | Optional | Postal code (e.g. `10036`) |
254-
| 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) |
255-
| timezone | String | Optional | Timezone stop is located in |
256-
| cross_street | String | Optional | Cross street of where the station is located. |
257-
| wheelchair_boarding | Boolean | Optional | Is this stop handicap accessible? |
258-
| parent_stop | UUID | Optional | Describe a basic hierarchy of stops (e.g.a stop inside of a greater stop) |
259-
260-
Endpoint: `/stops`
261-
Method: `PUT`
262-
263-
| Field | Type | Required/Optional | Description |
264-
|---------------------|------------------------|-------------------|-------------------------------------------------------------------------|
265-
| stop_id | UUID | Required | Unique ID for stop |
266-
| num_spots_available | {vehicle_type: number} | Optional | How many spots are free to be populated with vehicles at this stop? |
267-
| num_spots_disabled | {vehicle_type: number} | Optional | How many docks are disabled and unable to accept vehicles at this stop? |
268-
269-
Endpoint: `/stops/{stop_id}`
270-
Method: `GET`
271-
272-
| Field | Type | Required/Optional | Description |
273-
|------------------------|-----------------------------------------------------------------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
274-
| stop_id | UUID | Required | Unique ID for stop |
275-
| stop_name | String | Required | Name of stop |
276-
| lat | Double | Required | Latitude of the location |
277-
| lng | Double | Required | Longitude of the location |
278-
| capacity | {vehicle_type: number} | Required | Number of total spots per vehicle_type |
279-
| num_vehicles_available | {vehicle_type: number} | Required | How many vehicles are available per vehicle_type at this stop? |
280-
| 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 |
282-
| 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) |
283-
| short_name | String | Optional | Abbreviated stop name |
284-
| address | String | Optional | Postal address (useful for directions) |
285-
| post_code | String | Optional | Postal code (e.g. `10036`) |
286-
| 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) |
287-
| cross_street | String | Optional | Cross street of where the station is located. |
288-
| num_spots_available | {vehicle_type: number} | Optional | How many spots are free to be populated with vehicles at this stop? |
289-
| 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) |
292-
293-
### GBFS Compatibility
294-
295-
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.
296-
297235
## Enum Definitions
298236

299237
### Area Types

0 commit comments

Comments
 (0)