TOMP API for dummies
Welcome to the TOMP-API WIKI pages. This page contains the information for implementing the TOMP-API. The Blueprint describes in free format the idea how the TOMP API was set up.
The latest released version is Dragonfly - 1.0.0. The OpenApi (former: swagger) file can be found here.
- Roadmap
- Semantic versioning
- Changes per version
- Contribution
- Participants (short descriptions per organisation)
The actual workflow of the TOMP-API is simple. The scenario for a planned trip: gather information about the known TOs, create best routes, propose them to the end user, book and go! Payment as dessert.
If the end user doesn't want to plan ("pick up and go"), the actual activity diagram stays the same, the only thing that changes is that the planning doesn't need to look for availability, but can directly request an asset with booking-intent, providing the asset it wants to use.
Information about the operator. Where does it operate, what are its opening hours. Most of these endpoints contain static data, except for the available-assets. more...
The planning phase actually consists out of 1 endpoint, but has 2 modi: one for the routing (returns options, without registrating anything) and one for getting offers (creates offers that can be booked, with a generated id for the complete life cycle). Completely controlled by one query parameter: booking-intent. more...
The booking is a transactional process. One of the offers of the planning phase is booked (using the generated id). After all the TOs have responded positively to the bookings, each TO has to be confirmed by a commit. more...
Starting a booked 'leg' is dependant of the type of transport ('modality'). A taxi company will send start information indirectly to the end user, while opening a bike will be initiated by the end user. more...
While using the asset, there are all kinds of events possible. E.g. the end user can pause the asset. more...
The leg ends, the asset has to be returned, closed etc. more...
During the trip execution, incidents or accidents may happen. To handle these kind of situations, the support module is added. more...
To get an overview of the payments, this module offers an endpoint, but also to report the non-fare based payments (like fines). more...