From f943119a51065efd87c777237a59b3ad959ec40f Mon Sep 17 00:00:00 2001 From: sbouaram Date: Fri, 20 Oct 2023 14:10:56 +0200 Subject: [PATCH] readme --- readme.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..63b940f --- /dev/null +++ b/readme.md @@ -0,0 +1,21 @@ +# Coopgo Solidarity-Service + + + +Coopgo Solidarity Service is a part of the coopgo MaaS platform, it implements the Solidarity mobility API and communicate via gRPC internally ton handle Silvermobi application trips bookings. + +- API Documentation can be found here: + + https://git.coopgo.io/documentation/Solidarity_Mobility_API/wiki + +## Flow: +- The driver enters his availabilities that can be regular or punctual as well as his address, radius and additional infos such as car infos and preferences. +- The passenger enters his desired trip date , the trip route and additional infos such as preferences. +- The available drivers can be than listed via the DriverJourneys request that includes the desired departure date and the departure pickup point, if the departure is the same as the driver departure point or is included in the driver defined radius, the driver will be listed. +- After listing the drivers the passenger can initiate a booking with the desired driver. + + + +## Interoperability Rest API: +- The operator FQDN string param is required in every request and should correspond to the mobility operator defined API key. +