Skip to content

Commit ec1c5e9

Browse files
avatarneilthekaveman
authored andcommitted
Update event_location comment
1 parent 6cf57c8 commit ec1c5e9

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

provider/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,11 +273,15 @@ Unless stated otherwise by the municipality, this endpoint must return only thos
273273
| `event_types` | Enum[] | Required | [Vehicle event(s)][vehicle-events] for state change, allowable values determined by `vehicle_state` |
274274
| `event_time` | [timestamp][ts] | Required | Date/time that event occurred at. See [Event Times][event-times] |
275275
| `publication_time` | [timestamp][ts] | Optional | Date/time that event became available through the status changes endpoint |
276-
| `event_location` | GeoJSON [Point Feature][geo] | Required | |
276+
| `event_location` | GeoJSON [Point Feature][geo] | Required | See [event_locations](#event-locations)|
277277
| `battery_pct` | Float | Required if Applicable | Percent battery charge of device, expressed between 0 and 1 |
278278
| `trip_id` | UUID | Required if Applicable | Trip UUID (foreign key to Trips API), required if `event_types` contains `trip_start`, `trip_end`, `trip_cancel`, `trip_enter_jurisdiction`, or `trip_leave_jurisdiction` |
279279
| `associated_ticket` | String | Optional | Identifier for an associated ticket inside an Agency-maintained 311 or CRM system. |
280280

281+
### Event Locations
282+
283+
*Docked* mobility providers must include a `stop_id` in the Point Feature of each `event_location` that occurs at a `Stop` by embedding the `stop_id` property in the Feature's `properties` object.
284+
281285
### Status Changes Query Parameters
282286

283287
The `/status_changes` API should allow querying status changes with the following query parameters:

0 commit comments

Comments
 (0)