Skip to content

Latest commit

 

History

History
119 lines (86 loc) · 3.07 KB

ROUTES.md

File metadata and controls

119 lines (86 loc) · 3.07 KB

FastFeet

Routes from FastFeet API

GitHub language count Made by Léu Almeida License

No secure routes

POST /login

Body params (Login session)

{
	"email": "admin@fastfeet.com",
	"password": "123456"
}

GET /deliveryman/:id/deliveries

Query params:

end = true // will list all ended deliveries
// or empty to list all deliveries (ended or not)

PUT /deliveryman/:id/deliveries

Query params (Finish delivery):

deliveryId = 1
end_date = 2020-01-29T18:16:00.000Z

Multipart form (Finish delivery):

file = // upload file image

PUT /deliveryman/:id/deliveries

Body params (Start delivery):

{
	"start_date": "2020-01-31T18:00:00.000Z"
}

Query param (Start delivery):

deliveryId = 1

POST /delivery/:id/problems

Body params (Register a problem)

{
	"description": "Destinatário ausente"
}

Secure routes

// Upload file route routes.post('/files', upload.single('file'), FileController.store);

// Admin user routes routes.post('/users', UserController.store); routes.get('/users', UserController.index); routes.put('/users/:id', UserController.update); routes.delete('/users/:id', UserController.delete);

// Recipients routes routes.post('/recipients', RecipientController.store); routes.get('/recipients', RecipientController.index); routes.put('/recipients/:id', RecipientController.update); routes.delete('/recipients/:id', RecipientController.delete);

// Deliveryman routes routes.post('/deliveryman', DeliverymanController.store); routes.get('/deliveryman', DeliverymanController.index); routes.put('/deliveryman/:id', DeliverymanController.update); routes.delete('/deliveryman/:id', DeliverymanController.delete);

// Delivery routes routes.post('/delivery', DeliveryController.store); routes.get('/delivery', DeliveryController.index); routes.put('/delivery/:id', DeliveryController.update); routes.delete('/delivery/:id', DeliveryController.delete);

// Delivery problems routes routes.get('/delivery/problems', DeliveryProblemController.index); routes.get('/delivery/:id/problems', DeliveryProblemController.index); routes.put('/delivery/problems/:id', DeliveryProblemController.update); routes.delete('/delivery/problems/:id', DeliveryProblemController.delete);

// Cancel delivery based in a problem routes.post('/problems/:id/cancel-delivery', DeliveryStatusController.store);

export default routes;