Ubuntu 20.04.5 LTS
Python 3.9.15
Flask 2.2.2
Werkzeug 2.2.2
From within the project directory, run the following line:
$ pip install -r requirements.txt
Once dependancies are installed (which may require adding --no-deps), run the following to start the server:
$ flask --app av-fms --debug run
The DB will be initialized automatically.
Once the server is running, navigate to localhost:5000/auth/register to create an account. After the account has been created, login with the credentials that you just created.
To login with as a staff user with full privileges, simply go to localhost:5000/auth/login. The server will automatically generate a staff user for testing purposes. The staff user is able to add or delete vehicles. The login info for the staff user is:
username: staffUser
password: staffpass
Before sending any requests to the API (aside from requests to api/register), a token must be obtained. This is done with the api/login endpoint. All requests must contain the "Content-Type": "application/json" header. After obtaining an API token, it should be put in the header as "x-access-token": token.
This endpoint takes a username and password in the message body and creates a new user in the database. The message body should look like:
{
"username": string,
"password": string
}This endpoint takes a username and password in the message body and authenticates the user, returning an API token for use with other endpoints if authenticated. The message body should look like this:
{
"username": string,
"password": string
}This will return a list of all vehicle objects, each one serialized in JSON as:
{
"id": int,
"manufacturer": string,
"license_plate_number": string,
"available": bool,
}Any combination of optional filter parameters are allowed in the request body as well, in the form of:
{
"filter": {
"manufacturer": string,
"license_plate_number": string,
"available": bool
}
}For example, if a user wished to see only Mercedes vehicles, the following filter could be used:
{
"filter": {
"manufacturer": "Ford",
"license_plate_number": "1234567",
"available": true
}
}If no filter is provided, an unfiltered list of vehicles will be returned.
This will register a vehicle as having been taken by a user and will not be available for use by other users until it is returned.
This will register a vehicle as having been returned by a user and will then be available once more to other users.
This is only available to a user with staff privileges. This will create a new vehicle record in the DB using the information provided in the request body as follows:
{
"manufacturer": string,
"license_plate_number": string
}This is only available to a user with staff privileges. This will delete a vehicle from the DB.
This will return the task history of a vehicle in a list of JSON objects of the form:
{
"task_id": int,
"taken_by": string,
"start_time": string,
"end_time": string,
}If a vehicle is still in the middle of a task and has not been returned yet, the end_time will show as a null value.
A vehicle is looked up by checking for a particular license plate value, carried in the request body as:
{
"license_plate_number": string
}I should note that this is not the way I would have preferred to do this. I would have preferred to have an endpoint of the structure:
/vehicles/<int:id>/task_history However, the task requirements were: "The API should get a vehicle's license and return its history of availability (tasks)
that includes the date and time and the user who caught it." Putting the license plate number in the URL would have too
clunky for my liking, so I decided to put it in the request body instead.