Warehouse-Delivery-Tracking-(WDT-API-Only)/Overview.md

 # Overview
 
-WDT is created to deal with the AMTI deliveries
+WDT (Warehouse Delivery Tracking) is created to track the AMTI deliveries.
 
 ---
-#### ✔️ Module Releases:
+#### 📁 KNOWN WDT Related files:
+This is only the WDT related files that I am familiar of.
 
+* controllers/**Api.php** - Controller for the WDT Mobile App. This is used by the `WDT Mobile App (any version)` which is responsible for providing requests of the App.
+* controllers/**Api_dev.php** - Controller for testing WDT Mobile App.
+  > Api_dev.php is deprecated and was only used on the initial development of the App
+* controllers/**Wdt_configuration.php** - Controller for WDT Config module.
+* controllers/**Wdt_trade.php** - Controller for WDT Delivery trade module.
+* pages/wdt_config/**wdt_configuration_view.php** - Page for the WDT Configuration module. This is where the driver and plate number is set.
+  > Note that the WDT Config table in the AIS is already existing when I took over. So we will have to deal with this.
+* pages/wdt_trade/**wdt_trade_transaction.php** - Pag for the WDT Trade module. This is where the deliveries can be traded into different DTR numbers in real time. This is currently useful with the latest `WDT Mobile App ver 2021` as it check the deliveries on sync.
 
----
-#### 📁 WDT Related files:
+--------
 
+### WDT Flow
 
---------
-### WDT Flow
\ No newline at end of file
+
+#### Overview of the WDT Api to Mobile App Flow
+- Process of WDT API to Mobile App's request
+```mermaid
+graph LR;
+
+app[WDT Mobile App]--1. Request DTR-->server[Server Side API]
+
+server--2. Return DTR-->app
+
+app--3. Update DTR and Deliveries-->server--4. Receive Update response-->app
+```
+
+----
+
+#### POST API: retrieveDtr
+- Used when WDT Mobile app requests a DTR
+
+```mermaid 
+graph TD;
+
+
+
+subgraph "Client side"
+  app[1. WDT Mobile App]
+end
+subgraph "Server side"
+  app--Request DTR using DTR Number-->a[2. Get DTR Number]
+  a
+  -->b[3. Check if DTR does exist]
+  b--Return Error response No DTR Found-->app
+  b-->c[4. Check if DTR is already finished]
+  c--Return Error response No DTR Found-->app
+  
+  c-->d[5. Retrieve the DTR along with the deliveries from AIS Db]
+  d--Return response with DTR & Deliveries-->app
+end
+```
+
+
+----
+
+#### POST API: deliveryUpdate
+- Process of WDT API to update the Delivery
+
+
+``` mermaid
+graph TD;
+
+app[1. WDT Mobile app]-->app1[1.1 App updates the delivery]
+--Send POST Request to the server and WAITS FOR 30 SEC. TO RECEIVE THE RESPONSE
+-->b[2. Server receives the request and process the delivery updates]
+-->c[3. Server checks if the request is valid and correct]
+
+--Send Error if update fails-->app
+
+c-->d[4. Update is committed, will now send notifications to related personnel]
+--Return Response 200 Ok-->app
+d--Pass Data Parameters DTR,PSN and Delivery updates
+-->e[5. Run Oracle Script to retrieve the related parties of the Delivery->PSN]
+--Run 3 Separate scripts. Get the Warehouse, Sales and Logistics department
+-->f[6. For each personnel send composed notification according to the parameters provided]
+--// Sometimes messages are sent 2 seconds per personnel
+-->g[7. All message sent]
+
+```
+
+
+### Developer Note:
+
+Most Documentation of how the **WDT Mobile App** is located to this [link](##).
\ No newline at end of file