-
Notifications
You must be signed in to change notification settings - Fork 41
Simple Operator information
Q: What should I implement of the Operator Information module?
A: Actually everything. More shared information increases the possibility that your API will be used.
The operator information normally doesn't need authorization nor authentication.
You can simply create endpoints (tip: generate them with editor.swagger.io. Attach them to a database/file system you have. Deploy the server code to a server, configure the database access and off you go!
The available endpoints are (comparable with GBFS, extended with extra fare information):
- stations
- regions (just names)
- information (information about the TO, can be extended later on)
- calendar (opening days)
- opening hours
- pricing plan (extended regarding GFBS, all pricing parts can be described now)
- available assets (returning asset-types & amounts that are available, per location). This should be as realtime as possible!
- alerts
For planning purposes the available-assets MUST be implemented. You have to provide more accurate information during the planning phase, calling the planning-options endpoint.
Introduction
- Roadmap
- Semantic versioning
- Use cases
- Changes per version
- Contribution
- Participants
Workflow
- Operator information
- Planning phase
- Booking phase
- Trip execution phase - start
- Trip execution phase - on route
- Trip execution phase - end
- Support
- Payment
Points of attention
- Modalities
- Specifying locations
- GDPR
Eco system
- Relations
Introduction
Scope of the TOMP-API
Versioning and releases
Process Flows
- Authentication
- Operator Information
- Privacy and Registration
- Planning Module
- Booking Module
- Trip Execution Module
- Payment Module
- Support Module
Meta-Information
Reference implementations
To-dos and risks
Technical Specifications
A1 List of terms and definitions
A2 Passenger characteristics dictionary
A3 APIs available on the transportation ecosystem
A4 Overview of the User stories
A5 Authors, Architects, collaborators and stakeholders involved
A6 Adoption and Implementation of the TOMP-API