Skip to content

Operator information

Edwin van den Belt edited this page Nov 28, 2023 · 9 revisions

home > Operator information

The Operator information module provides more or less static data about the operator, its regions, stations, opening hours, pricing and 'terms and conditions' (since version 1.1). The most important endpoints are described here.

Meta Information

Meta information contains per version the implemented endpoints, the supported scenarios, the process identifiers, and process steps. This endpoint is introduced for discovery reasons.

Information

This endpoint contains generic information about the TO.

Regions

Regions contains named polygons. These regions can be used to filter other items in the operator module.

Stations

The public stations the TO publishes.

Pricing information

Published pricing plans.

Available assets

The only 'realtime' endpoint in this module. Provides information about classes of assets (like 'Men's bike' or 'e-bike')

Operating hours and calendar

Describes the default opening hours per day of the week. Is GBFS compliant, an extension for 'specific days' is on the roadmap.

Alerts

For compliancy reasons with GBFS. Public notifications/alerts can be done using this endpoint, but peer-to-peer notifications (f.x. communication about support or ETAs) should be done using the /bookings/{id}/notification endpoint.

Clone this wiki locally