Skip to content

Commit

Permalink
Merge pull request #478 from jfh01/vehicles-clarification-patch
Browse files Browse the repository at this point in the history
Clarified that /vehicles is not intended to replace GBFS
  • Loading branch information
schnuerle authored May 18, 2020
2 parents 8ea8388 + 32ed91a commit c620c82
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion provider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ Should either side of the requested time range be greater than 2 weeks before th

### Vehicles

The `/vehicles` endpoint returns the current status of vehicles on the PROW. Only vehicles that are currently in available, unavailable, or reserved states should be returned in this payload. Data in this endpoint should reconcile with data from the `/status_changes` enpdoint. The data returned by this endpoint should be as close to realtime as possible, but in no case should it be more than 5 minutes out-of-date.
The `/vehicles` endpoint returns the current status of vehicles on the PROW. Only vehicles that are currently in available, unavailable, or reserved states should be returned in this payload. Data in this endpoint should reconcile with data from the `/status_changes` enpdoint. The data returned by this endpoint should be as close to realtime as possible, but in no case should it be more than 5 minutes out-of-date. As with other MDS APIs, `/vehicles` is intended for use by regulators, not by the general public. It does not replace the role of a [GBFS](https://github.com/NABSA/gbfs) feed in enabling consumer-facing applications.

In addition to the standard [Provider payload wrapper](#response-format), responses from this endpoint should contain the last update timestamp and amount of time until the next update:

Expand Down

0 comments on commit c620c82

Please sign in to comment.