transports 22
DESCRIPTION
TRANSPORTS 22. An easy way to serve orders. INDEX. INTRODUCTION API MOTIVATION GUI. 1 INTRODUCTION. TOPIC: TRANSPORTS COMPANY API URL - http://group22aiss.appspot.com/api/ API DOC URL - http://group22aiss.appspot.com AUTHORS Alberto Rincón Borreguero - [email protected] - PowerPoint PPT PresentationTRANSCRIPT
![Page 1: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/1.jpg)
TRANSPORTS 22An easy way to serve orders
![Page 2: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/2.jpg)
INDEX
1. INTRODUCTION
2. API
3. MOTIVATION
4. GUI
![Page 3: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/3.jpg)
1 INTRODUCTION
• TOPIC: TRANSPORTS COMPANY
• API URL - http://group22aiss.appspot.com/api/
• API DOC URL - http://group22aiss.appspot.com
• AUTHORSo Alberto Rincón Borreguero - [email protected] Rafael Vázquez Sánchez - [email protected] Francisco García Moreno - [email protected]
![Page 4: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/4.jpg)
2 API - RESOURCES
Order:{
"destinationAddress": "Akresh 8",
"sourceAddress": "Aluham, 14",
"refNumber": 7,
"driverID": 0,
"productType": "coffee",
"productQuantity": 20,
"status": "PENDING"
}
Driver:{
"surname": "Baskes","name": "Raphael","id": 1
}
![Page 5: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/5.jpg)
2 API - STATE MACHINE
![Page 6: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/6.jpg)
2 API - USES CASES
![Page 7: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/7.jpg)
2 API - AUTHENTICATION
![Page 8: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/8.jpg)
2 API - METHODS (Auth)
Logging in:• GET - /auth• Parameters (header):
o username: <the user's name here>o password: <the user's password here>
• Response:o The user's auth tokeno E.g.: PPRUD8844200LK3J4JGB22MI444JN1R
![Page 9: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/9.jpg)
2 API - METHODS (Orders)
Create a new order:• POST - /orders/• Request:
{
"destinationAddress": "Sevilla",
"sourceAddress": "Marrakech",
"productType": "drink",
"productQuantity": 1000,
"driverID": 0,
"refNumber": 0,
"status": "PENDING"
}
![Page 10: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/10.jpg)
2 API - METHODS (Orders)
Show a single order:• GET - /orders/{refNumber}• Response:
{
"destinationAddress": "Akresh 8",
"sourceAddress": "Aluham, 14",
"refNumber": 7,
"driverID": 0,
"productType": "coffee",
"productQuantity": 20,
"status": "PENDING“
}
![Page 11: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/11.jpg)
2 API - METHODS (Orders)
List all orders:• GET - /orders/• Response:
[{ "destinationAddress": "Akresh 8", "sourceAddress": "Aluham, 14", "refNumber": 7, "driverID": 0, "productType": "coffee", "productQuantity": 20, "status": "PENDING"},
{ "destinationAddress": "Alame, 7", "sourceAddress": "Hamkinel, 23", "refNumber": 8, "driverID": 0, "productType": "fruit", "productQuantity": 20, "status": "PENDING"}]
![Page 12: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/12.jpg)
2 API - METHODS (Orders)
Update an existing order: *auth required (driver/admin)
• PUT - /orders/{refNumber}• Request:
{
"destinationAddress": "Sevilla",
"sourceAddress": "Marrakech",
"productType": "drink",
"productQuantity": 1000,
"driverID": 2, <-- admin only
"refNumber": 5,
"status": "SHIPPED“ <-- driver only
}
![Page 13: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/13.jpg)
2 API - METHODS (Drivers)
Show a single driver: *auth required (driver/admin)
• GET - /drivers/{driverID}• Response:
{
"surname": "Baskes",
"name": "Rafa",
"id": 1
}
![Page 14: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/14.jpg)
2 API - METHODS (Drivers)
List all drivers: *auth required (admin)
• GET - /drivers/• Response:
[{ "surname": "Baskes", "name": "Rafa", "id": 1},{ "surname": "Garmo", "name": "Fran", "id": 2},
{ "surname": "Rinco", "name": "Albertitou", "id": 3}]
![Page 15: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/15.jpg)
2 API - METHODS (Drivers)
List orders assigned to a driver: *auth required (driver)
• GET - /drivers/{driverID}/orders/• Response:
[{ "destinationAddress": "Alame, 7", "sourceAddress": "Hamkinel, 23", "refNumber": 8, "driverID": 1, "productType": "fruit", "productQuantity": 20, "status": "PENDING"},
{ "destinationAddress": "Krantiun, 8", "sourceAddress": "khonkraniu, 9", "refNumber": 18, "driverID": 3, "productType": "fish", "productQuantity": 20, "status": "PENDING"}]
![Page 16: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/16.jpg)
3 MOTIVATION
WHY TO USE OUR API?
SECURITY: LOG IN TO MANAGE ADVANCED OPTIONS
PERSISTENCE: HAVE ALWAYS YOUR DATA AVAILABLE
IMPLEMENTATION: VERY EASY TO IMPLEMENT
WITH A GREAT DOCUMENTATION
![Page 17: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/17.jpg)
4 GUI - NAVIGATION GRAPH
![Page 18: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/18.jpg)
4 GUI
![Page 19: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/19.jpg)
4 GUI
![Page 20: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/20.jpg)
4 GUI
![Page 21: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/21.jpg)
4 GUI
![Page 22: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/22.jpg)
4 GUI
![Page 23: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/23.jpg)
4 GUI
![Page 24: TRANSPORTS 22](https://reader036.vdocument.in/reader036/viewer/2022062321/56812c2c550346895d90ad95/html5/thumbnails/24.jpg)
That’s it
THE END