Skip to content

Commit 62c1d50

Browse files
schnuerlethekaveman
authored andcommitted
Added Stops + Stop Status description/example
1 parent e432f60 commit 62c1d50

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

general-information.md

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

109109
## Stops
110110

111+
**Stops** describe vehicle trip end locations in a pre-designated physical place. They can vary from docking stations with our without charging, corrals with lock-to railings, or suggested parking areas marked with spray paint. **Stops** are used in both [Provider](/provider#stops) (including routes and event locations) and [Agency](/agency#stops) (including telemetry data).
112+
111113
| Field | Type | Required/Optional | Description |
112114
|------------------------|-------------------------------------------------------------|-------------------|----------------------------------------------------------------------------------------------|
113115
| stop_id | UUID | Required | Unique ID for stop |
@@ -133,12 +135,24 @@ All String fields, such as `vehicle_id`, are limited to a maximum of 255 charact
133135

134136
### Stop Status
135137

138+
**Stop Status** returns information about the current status of a **[Stop](#stops)**.
139+
136140
| Field | Type | Required/Optional | Description |
137141
|--------------|---------|-------------------|-----------------------------------------------------|
138142
| is_installed | Boolean | Required | See GBFS [station_status.json][gbfs-station-status] |
139143
| is_renting | Boolean | Required | See GBFS [station_status.json][gbfs-station-status] |
140144
| is_returning | Boolean | Required | See GBFS [station_status.json][gbfs-station-status] |
141145

146+
Example of the **Stop Status** object with properties listed:
147+
148+
```json
149+
{
150+
"is_installed": true,
151+
"is_renting": false,
152+
"is_returning": true
153+
}
154+
```
155+
142156
### GBFS Compatibility
143157

144158
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)