Skip to main content

Introduction

Dott's MaaS (Mobility as a Service) API empowers external partners to be able to provide Dott's offering withing their own service.

Design​

Dott's MaaS API follows the Resource Oriented Design guide so as to provide a simple, consistent and easy-to-use set of APIs.

Resources​

As expected of any resource-oriented API, this one is modeled hierarchically. The API is divided in different services, each service contains nodes which can be either a simple resource or a collection resource.

  • A collection contains a list of resources of the same type.
  • A resource has some state and zero or more sub-resources. Each sub-resource can be either a simple resource or a collection resource.

The available resources in Dott's MaaS API are the following:

Regions Service model overview​

  • Regions Collection (/regions/*)
    • Configuration Resource (/regions/*/configuration)
    • DocumentVerificationRequirements Resource (regions/*/document_verification_requirements)
    • RequiredLegalAgreements Resource (regions/*/required_legal_agreements)
    • PriceLists Resource (regions/*/price_lists)
    • RequiredUserData Resource (regions/*/required_user_data)

Trips Service model overview​

  • Trips Collection (trips/*)
    • TripInvoice Resource (trips/*/trip_invoice)
    • ParkingPhoto Resource (trips/*/parking_photo)

Users Service model overview​

  • Users Collection (users/*)
    • DocumentVerifications Resource (users/*/document_verifications)
    • LegalAgreements Resource (users/*/legal_agreements)

Vehicles Service model overview​

  • Vehicles Collection (vehicles/*)

Methods​

Most resources have standard methods which are List, Get, Create, Update, and Delete.

However in special cases such as the Trips resource collection, Dott has implemented some custom methods such as :start and :end.

warning

Dott's MaaS API is currently in Alpha stage (currently in version v2alpha1), meaning that changes to the specification can be introduced without proper version bumps.