Overview

What is People Mobility Booking

Use the People Mobility Booking API to manage travellers’ bookings within an organization. This API allows both travellers and operators to request quotes, place bookings, and retrieve the associated information. Integrators lists the completed and scheduled bookings applying various filters.

Why use People Mobility Booking

Purpose I: Create quotes

• Travelers can request non-binding quotes when planning a trip. By providing basic information such as the origin and destination, the API returns fare and duration estimates for the journey.
• If multiple services are active, the API generates a separate quote for each service.

Purpose II: Create and cancel bookings

• Travelers can place a binding booking after selecting one of the provided quotes. The booking request is processed based on current availability and may either be accepted or rejected.
• If the booking is accepted, a ride is created, and a vehicle is assigned to it.

📘

Note:

If the ride hasn’t started yet, the booking can be cancelled.

Purpose III: Retrieve bookings and vehicles

Travellers can retrieve:

• the list of completed and scheduled bookings applying multiple filters, such as traveller id, booking status, and time ranges.
• the position and orientation of all the vehicles that belong to the organization.

Use Cases

Use case I: Manage bookings

After a traveller requests a quote and places a binding booking (which operators can create using the SCALAR Dashboard - People Mobility module), the booking details can be retrieved.

📘

Note:

The booking can be cancelled.

Use case II: Vehicles position

• Track the position of the vehicle associated to a ride and trace its route on a map.
• Retrieve all the organization’s vehicles, together with their position and orientation.

Use case III: List bookings

• Travellers can view historical and upcoming bookings associated to their account.
• Operators can retrieve historical and upcoming bookings for the entire organization.