Skip to content

Latest commit

 

History

History
135 lines (119 loc) · 4.4 KB

README.md

File metadata and controls

135 lines (119 loc) · 4.4 KB
Raw

Car-Rental-Agency

API endpoints for a Car Rental Agency built using Django REST Framework. An assignment given by ClinicSpots.

API hosted on:

https://car149.herokuapp.com/

Note: DB schema can be found in db-schema.pdf file.

API endpoints according to tasks:

I. Add new cars to the system, which could be used for renting

POST:
Desc: API to add new cars
Live link: https://car149.herokuapp.com/car/add/
Expects:
{
  "vehicle_number": "8585",
  "model": "Etios",
  "seating_capacity": 5,
  "rent_per_day": 5000
}

II. Book an available car.

POST method:
Live link: https://car149.herokuapp.com/rent/book/
Expects:
{
    "customer": 2,
    "car": 3,
    "issue_date": "2020-02-20",
    "return_date": "2020-02-22"
}

III. Show the details of a particular car with its availability and its currently active booking details if not available.

GET method:
Format: https://car149.herokuapp.com/car/<int:car_pk>/active_booking/
Live link: https://car149.herokuapp.com/car/1/active_booking/

IV. Show the cars with their availability status on a given date. This API should have the feature to filter the cars based on various fields.

GET method:
Desc: Returns list of all cars with status on given date. When the date is not given then it takes today's date. User can filter by fields like model, seating_capacity, availability. 
Format: https://car149.herokuapp.com/car/status/?date=YYYY-MM-DD&model=STR&capacity=NUM&availability=BOOL
Live link 1: https://car149.herokuapp.com/car/status/?date=2020-03-04
Live link 2: https://car149.herokuapp.com/car/status/?model=Scorpio&capacity=8
Live link 3: https://car149.herokuapp.com/car/status/?availability=True

V. Extend the booking of the car, if the car is not already reserved for the dates user wants to extend the booking.

PUT method:
Desc: Extends the return date.
Format: https://car149.herokuapp.com/rent/<int:rent_pk>/extend/
Live link: https://car149.herokuapp.com/rent/3/extend/
Expects:
{
    "customer": 5,
    "car": 1,
    "issue_date": "2020-02-26",
    "return_date": "2020-02-30"
}

VI. Cancel a specific Booking.

DELETE method: 
Format: https://car149.herokuapp.com/rent/<int:rent_pk>/cancel/
Live link: https://car149.herokuapp.com/rent/5/cancel/

Other useful API endpoints:

1. For Car

View all cars
GET method:
Live Link: https://car149.herokuapp.com/car/
View particular car details
GET method:
Format: https://car149.herokuapp.com/car/<int:car_pk>/
Live link: https://car149.herokuapp.com/car/2/
Update Car details
PUT method:
Format : https://car149.herokuapp.com/car/<int:car_pk>/update/
Live link: https://car149.herokuapp.com/car/2/update/
Expects:
{
    "vehicle_number": "7888",
    "model": "Swift",
    "seating_capacity": 5,
    "rent_per_day": 3000
}
Delete car
DELETE method:
Format: https://car149.herokuapp.com/car/<int:car_pk>/delete/
Live link: https://car149.herokuapp.com/car/4/delete/

2. For Customer

View all customer
GET method:
Live link: https://car149.herokuapp.com/customer/
View particular customer details
GET method:
Format: https://car149.herokuapp.com/customer/<int:cust_pk>/
Live link: https://car149.herokuapp.com/customer/2/
Add customer
POST method:
Live link: https://car149.herokuapp.com/customer/add/
Expects:
{
    "name": "Steven Holt",
    "email": "[email protected]",
    "phone": "9855754754"
}
Update customer details
PUT method:
Format : https://car149.herokuapp.com/customer/<int:pk>/update/
Live link: https://car149.herokuapp.com/customer/2/update/
Expects:
{
    "vehicle_number": "7888",
    "model": "Swift",
    "seating_capacity": 5,
    "rent_per_day": 3000
}
Delete customer
DELETE method:
Format: https://car149.herokuapp.com/customer/<int:cust_pk>/delete/
Live link: https://car149.herokuapp.com/customer/4/delete/

3. For Reservation

View all reservations
GET method:
Live link: https://car149.herokuapp.com/rent/
View particular reservation details
GET method:
Format: https://car149.herokuapp.com/rent/<int:rent_pk>/
Live link: https://car149.herokuapp.com/rent/2/