Drivers & Cars Api API documentation version v0.1

http://localhost:8000/api/

/drivers

/drivers get

get

Get a list of drivers

get /drivers

Get a list of drivers

Request

Query Parameters

name: (string)
A like search over driver names
Example:
```
Mary Roach
```
gender: (string)
Lists all drivers with a specific gender
Example:
```
female
```
language: (string)
Lists all drivers with a specific language
Example:
```
en
```

/drivers/{driverName} get

get

Get the driver where name = {driverName}

get /drivers/{driverName}

Get the driver where name = {driverName}

Request

URI Parameters

driverName: required (string)

/drivers/{driverName}/skillmap get

get

Get the skillmap for driver name = {driverName}

get /drivers/{driverName}/skillmap

Get the skillmap for driver name = {driverName}

Request

URI Parameters

driverName: required (string)

/drivers/{driverName}/car get

get

Get the car for driver name = {driverName}

get /drivers/{driverName}/car

Get the car for driver name = {driverName}

Request

URI Parameters

driverName: required (string)

/cars

/cars get

get

List of all Cars

get /cars

List of all Cars

Request

Query Parameters

name: (string)
Lists all cars with a specific name
Example:
```
Awesome Car
```
manufacturer: (string)
Lists all cars with specific name
Example:
```
Volkswagen
```
kmDriven: (number)
Lists all cars with specific km
Example:
```
100000
```

/cars/update post

post

Updates the positions of the cars (changes ever few seconds)

post /cars/update

Updates the positions of the cars (changes ever few seconds)

/cars/{carName} get

get

Get the car with name = {carName}

get /cars/{carName}

Get the car with name = {carName}

Request

URI Parameters

carName: required (string)

/cars/{carName}/positions get

get

Get all cars position for name = {carName}

get /cars/{carName}/positions

Get all cars position for name = {carName}

Request

URI Parameters

carName: required (string)

/cars/{carName}/current_position get

get

Get current car position for name = {carName}

get /cars/{carName}/current_position

Get current car position for name = {carName}

Request

URI Parameters

carName: required (string)

/favorites

/favorites get

get

Get a list of all favorites (cars and drivers)

get /favorites

Get a list of all favorites (cars and drivers)

/favorites/drivers get

get

Get a list of all driver favorites

get /favorites/drivers

Get a list of all driver favorites

/favorites/drivers/{name} post delete

post

Add a driver to the favorite list. If the driver already exists, do nothing

delete

Remove a driver from the favorite list. If not registed, do nothing

post /favorites/drivers/{name}

Add a driver to the favorite list. If the driver already exists, do nothing

Request

URI Parameters

name: required (string)

delete /favorites/drivers/{name}

Remove a driver from the favorite list. If not registed, do nothing

Request

URI Parameters

name: required (string)

/favorites/cars get

get

Get a list of all car favorites

get /favorites/cars

Get a list of all car favorites

/favorites/cars/{name} post delete

post

Add a car to the favorite list. If the driver already exists, do nothing

delete

Remove a car from the favorite list. If not registed, do nothing

post /favorites/cars/{name}

Add a car to the favorite list. If the driver already exists, do nothing

Request

URI Parameters

name: required (string)

delete /favorites/cars/{name}

Remove a car from the favorite list. If not registed, do nothing

Request

URI Parameters

name: required (string)