Skip to content

richardmarllon/capstone-q3

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

156 Commits
app
app
 
 
migrations
migrations
 
 
.editorconfig
.editorconfig
 
 
.env.example
.env.example
 
 
.gitignore
.gitignore
 
 
Procfile
Procfile
 
 
README.md
README.md
 
 
requirements.txt
requirements.txt
 
 

Repository files navigation

HTTP status

201 -> Request was successful and that a new resource was created.

204 -> The request was successful and the user does not need to leave the current page

200 -> This request was successful.

401 -> User I don't have valid credentials to access the route

400 -> Server is unable to process the request due to a user error, either by syntax or any other reason

404 -> The server cannot find the requested resource.

403 -> The user does not have access rights to the content so the server is refusing to respond.

Record Lessee

table to get the record of the lessee

Schemas

key type description
id int id of the record
lessee_id int id of the lessee
car_id int id of the car
avaliation int car and lessee avaliation
comment str user experience comment
date str record date

Endpoints and methods:

Get record lessee by id

-> URL and method:

GET: https://capstone-q3.herokuapp.com/record/lessee/<id>

Response example:

Request: GET https://capstone-q3.herokuapp.com/record/lessee/1

{
"id": 1,
"lessee_id": 1,
"car_id": 3,
"avaliation": 5,
"comment": "clean and comfortable car",
"date": "2021/07/13"
}

Update record lessee by id

-> URL

PATCH https://capstone-q3.herokuapp.com/record/lessee/update/<int:user_id>

-> Example

Request: PATCH https://capstone-q3.herokuapp.com/record/lessee/update/1

Body request example:

{
"comment": "adorable lessee"
}

Response example:

{
"id": 1,
"lessee_id": 1,
"car_id": 3,
"avaliation": 5,
"comment": "adorable lessee",
"date": "2021/07/13"
}

Delete record lessee by id

-> URL

DEL https://capstone-q3.herokuapp.com/record/lessee/delete/<id>

-> Example

Request: DEL https://capstone-q3.herokuapp.com/record/lessee/delete/1

Response example:

" "

Create record lessee

-> URL

POST https://capstone-q3.herokuapp.com/record/lessee/register

-> Example

Request: POST https://capstone-q3.herokuapp.com/record/lessee/register

Body request example:

{
"lessee_id": 5,
"car_id": 10,
"avaliation": 3,
"comment": "DIRTY CAR",
"date": "2021/07/15"
}

Response example:

{
"id": 2,
"lessee_id": 5,
"car_id": 10,
"avaliation": 3,
"comment": "DIRTY CAR",
"date": "2021/07/15"
}

Record Locator

table to get the record of the lessee

Schemas

key type description
id int id of the record
user_locator_id int id of the locator
user_lessee_id int id of the lessee
avaliation int locator avaliation
comment str locator experience comment
date str record date

Endpoints and methods:

Get record locator by id

-> URL and method:

GET: https://capstone-q3.herokuapp.com/record/locator/<id>

Response example:

Request: GET https://capstone-q3.herokuapp.com/record/locator/1

{
"id": 1,
"user_locator_id": 3,
"user_lessee_id" : 2,
"avaliation": 5,
"comment": "great client",
"date": "2021/02/14"
}

Update record locator by id

-> URL

PATCH https://capstone-q3.herokuapp.com/record/locator/update/<int:user_id>

-> Example

Request: PATCH https://capstone-q3.herokuapp.com/record/locator/update/1

Body request example:

{
"comment": "adorable cliente"
}

Response example:

{
"id": 1,
"user_locator_id": 3,
"user_lessee_id" : 2,
"avaliation": 5,
"comment": "adorable cliente",
"date": "2021/02/14"
}

Delete record lessee by id

-> URL

DEL https://capstone-q3.herokuapp.com/record/locator/delete/<id>

-> Example

Request: DEL https://capstone-q3.herokuapp.com/record/locator/delete/1

Response example:

" "

Create record lessee

-> URL

POST https://capstone-q3.herokuapp.com/record/locator/register

-> Example

Request: POST https://capstone-q3.herokuapp.com/record/locator/register

Body request example:

{
"user_locator_id" : 1,
"user_lessee_id" : 1,
"date" : "2021/08/05",
"comment" : "don't suport me",
"avaliation" : 2
}

Response example:

{
"id": 2,
"user_locator_id" : 1,
"user_lessee_id" : 1,
"date" : "2021/08/05",
"comment" : "don't suport me",
"avaliation" : 2
}

User locator

table to get the data of user locator

Schemas

key type description
id int id of the user
name str user name
last_name str user's last name
email str user's email
adreess str pick-up car adreess
cpf str user's CPF number
password str user's password
cep str pick-up car cep

Endpoints and methods:

Register

-> URL and method:

POST: https://capstone-q3.herokuapp.com/locator/register

Body request example:

{
	"email": "[email protected]",
	"password": "123aA",
	"name": "user",
	"last_name": "test",
	"cpf": "111.222.333-44",
	"address": "shooping paralela em frente ao meu delicioso freezer de salgados",
	"cep": "48004-124",
    "phone_number": "(44)99988-5544",
}

Response: status 201 - CREATED

{
    "id": 1,
    "name": "user",
    "last_name": "test",
    "email": "[email protected]",
    "address": "shooping paralela em frente ao meu delicioso freezer de salgados",
	"cep": "48004-124",
    "phone_number": "(44)99988-5544",
}

Login

-> URL and method:

POST: https://capstone-q3.herokuapp.com/locator/login

Body request example:

{
	"cpf": "111.222.333-44",
	"password": "123aA"

}

Response: status 200 - OK

{
    "user": {
        "id": 1,
        "name": "user",
        "last_name": "test",
        "email": "[email protected]",
         "address": "shooping paralela em frente ao meu delicioso freezer de salgados",
	    "cep": "48004-124",
        "phone_number": "(44)99988-5544",
    },
    "access_token": "eyJUzI1NiJ9.eyJmcmVzaCI6ZmFsc2Us2VyINnOSwiZXhwIjoxNjI2NTkxMTE5fQ.AOpSzar1EoWt2Uyp0jZM"
}

Get user

-> URL and method:

GET: https://capstone-q3.herokuapp.com/locator/user/<id>

Request example:

GET without a body: https://capstone-q3.herokuapp.com/locator/user/1

Response: status 200 - OK

{
    "user": {
        "id": 1,
        "name": "user",
        "last_name": "test",
        "email": "[email protected]",
        "address": "shooping paralela em frente ao meu delicioso freezer de salgados",
	    "cep": "48004-124",
        "phone_number": "(44)99988-5544",
    },
    "avaliations_received": [],
    "avaliations_give": []
}

Update user

You need to own the resource and be logged to update.

You can change any key from your own user.

URL and method:

PATCH: https://capstone-q3.herokuapp.com/locator/update/<id>

Request example:

PATCH: https://capstone-q3.herokuapp.com/locator/update/1

Authorization:

{
    headers: {
        Authorization: "Bearer access_token";
    }
}

Body:

{
	"email": "[email protected]",
	"password": "anotherPass"
}

Response: status 200 - OK

{
    "id": 1,
    "name": "user",
    "last_name": "test",
    "address": "shooping paralela em frente ao meu delicioso freezer de salgados",
	"cep": "48004-124",
    "email": "[email protected]",
    "phone_number": "(44)99988-5544",
}

Delete user

You need to own the resource and be logged to delete.

-> URL and method:

DELETE: https://capstone-q3.herokuapp.com/locator/update/<id>

Request example:

DELETE without a body: https://capstone-q3.herokuapp.com/locator/update/1

Authorization:

{
    headers: {
        Authorization: "Bearer access_token";
    }
}

Response: status 204 - NO CONTENT

User Lesse

Table to get the user lessee

Schemas

key type description
id int id of the user
name str user name
last_name str user's last name
phone_number str user's phone number
email str user's email
city str user's city
state str user's state
cnh str user's CNH number
cpf str user's CPF number
password str user's password

Endpoints and methods:

Register

-> URL and method:

POST: https://capstone-q3.herokuapp.com/lessee/register

Body request example:

{
	"email": "[email protected]",
	"password": "123aA",
	"name": "user",
	"last_name": "test",
    "phone_number": "(44)99988-5544",
	"cpf": "111.222.333-44",
	"city": "Rio de Janeiro",
	"state": "RJ",
	"cnh": "12345678911"
}

Response: status 201 - CREATED

{
    "id": 1,
    "name": "user",
    "last_name": "test",
    "city": "Rio de Janeiro",
    "state": "RJ",
    "phone_number": "44999885544",
    "email": "[email protected]"
}

Login

-> URL and method:

POST: https://capstone-q3.herokuapp.com/lessee/login

Body request example:

{
	"cpf": "111.222.333-44",
	"password": "123aA"

}

Response: status 200 - OK

{
    "user": {
        "id": 1,
        "name": "user",
        "last_name": "test",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "email": "[email protected]",
        "phone_number": "44999885544"
    },
    "access_token": "eyJUzI1NiJ9.eyJmcmVzaCI6ZmFsc2Us2VyINnOSwiZXhwIjoxNjI2NTkxMTE5fQ.AOpSzar1EoWt2Uyp0jZM"
}

Get user

-> URL and method:

GET: https://capstone-q3.herokuapp.com/lessee/user/<id>

Request example:

GET without a body: https://capstone-q3.herokuapp.com/lessee/user/1

Response: status 200 - OK

{
    "user": {
        "id": 6,
        "name": "user",
        "last_name": "test",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "phone_number": "44999885544",
        "email": "[email protected]"
    },
    "avaliations_received": [],
    "avaliations_give": []
}

Update user

You need to own the resource and be logged to update. You can change any key from your own user.

URL and method:

PATCH: https://capstone-q3.herokuapp.com/lessee/update/<id>

Request example:

PATCH: https://capstone-q3.herokuapp.com/lessee/update/1

Authorization:

{
    headers: {
        Authorization: "Bearer access_token";
    }
}

Body:

{
	"email": "[email protected]",
	"password": "anotherPass"
}

Response: status 200 - OK

{
    "id": 1,
    "name": "user",
    "last_name": "test",
    "city": "Rio de Janeiro",
    "state": "RJ",
    "phone_number": "44999885544",
    "email": "[email protected]"
}

Delete user

You need to own the resource and be logged to delete.

-> URL and method:

DELETE: https://capstone-q3.herokuapp.com/lessee/update/<id>

Request example:

DELETE without a body: https://capstone-q3.herokuapp.com/lessee/update/1

Authorization:

{
    headers: {
        Authorization: "Bearer access_token";
    }
}

Response: status 204 - NO CONTENT

Car

Table to get the car

Schemas

key type description
id int id of the car
year int year of the car
license_plate str car license_plate
model str car model
trunk_volume int car trunk capacity
insurer str car insurance company name
insurer_number str car insurance company phone
review_date str date of last car review
withdrawal_place str car withdrawal place
city str car city
state str car state
user_id int id of the locator

Endpoints and methods:

Every route needs authorization

Authorization:

{
    headers: {
        Authorization: "Bearer access_token";
    }
}

Routes that need permission

Register

You need be the locator user and be logged in to register

-> URL and method:

POST: https://capstone-q3.herokuapp.com/car/register

Body request example:

{
	"year": 2019,
	"license_plate": "abc-1234",
	"model": "Prisma",
	"trunk_volume": 54,
	"insurer": "Teste Seguros",
	"insurer_number": "(12) 1234-56789",
	"review_date": "2001-07-12",
	"withdrawal_place": "Shopping Curitiba",
	"city": "Curitiba",
	"state": "pr"
}

Response: status 201 - CREATED

{
    "id": 1,
    "year": 2019,
    "model": "PRISMA",
    "trunk_volume": 54,
    "insurer": "TESTE SEGUROS",
    "insurer_number": "12123456789",
    "review_date": "Thu, 12 Jul 2001 00:00:00 GMT",
    "withdrawal_place": "SHOPPING CURITIBA",
    "city": "CURITIBA",
    "state": "PR",
    "license_plate": "ABC1234"
}

Update car

You need to own the resource to update. You can change any key from your own user.

URL and method:

PATCH: https://capstone-q3.herokuapp.com/car/update/<id>

Request example:

PATCH: https://capstone-q3.herokuapp.com/car/update/1

Body:

{
	"review_date": "2021-07-12",
	"withdrawal_place": "Shopping Palladium"
}

Response: status 200 - OK

{
    "id": 1,
    "year": 2019,
    "model": "PRISMA",
    "trunk_volume": 54,
    "insurer": "TESTE SEGUROS",
    "insurer_number": "12123456789",
    "review_date": "Mon, 12 Jul 2021 00:00:00 GMT",
    "withdrawal_place": "SHOPPING PALLADIUM",
    "city": "CURITIBA",
    "state": "PR",
    "license_plate": "ABC1234"
}

Delete user

You need to own the resource to delete.

-> URL and method:

DELETE: https://capstone-q3.herokuapp.com/car/delete/<id>

Request example:

DELETE without a body: https://capstone-q3.herokuapp.com/car/delete/1

Response: status 204 - NO CONTENT

Routes don't that need permission

All GET Routes don't need permission.

In response header are the information about total cars quantity, pagination, next_page that access the next page and prev_page that access the previous page. The number pages in default is 15 per page.

Response header:

{
    "info": {
    "count": 11,
    "pages": 1,
    "next_page": null,
    "prev_page": null
  },

Get cars

-> URL and method to get all cars:

GET: https://capstone-q3.herokuapp.com/car/

Response: status 200 - OK

{
  "result": [
    {
       "id": 1,
       "year": 2019,
       "model": "PRISMA",
       "trunk_volume": 54,
       "insurer": "TESTE SEGUROS",
       "insurer_number": "12123456789",
       "review_date": "Thu, 12 Jul 2001 00:00:00     GMT",
       "withdrawal_place": "SHOPPING CURITIBA",
       "city": "CURITIBA",
       "state": "PR",
       "license_plate": "ABC1234"
    },
  ]
}

-> URL and method to get cars with parameters:

GET: https://capstone-q3.herokuapp.com/car?<parameters=values>

Request example:

GET without a body: https://capstone-q3.herokuapp.com/car?model=prisma&withdrawal_place=curitiba

Response: status 200 - OK

  "result": [
    {
      "id": 1,
      "year": 2019,
      "model": "PRISMA",
      "trunk_volume": 54,
      "insurer": "TESTE SEGUROS",
      "insurer_number": "12123456789",
      "review_date": "Thu, 12 Jul 2001 00:00:00 GMT",
      "withdrawal_place": "SHOPPING CURITIBA",
      "city": "CURITIBA",
      "state": "PR",
      "license_plate": "ABC1234"
    }
  ]

Get cars by id

-> URL and method to get by id:

GET: https://capstone-q3.herokuapp.com/car/<id>

Request example:

GET without a body: https://capstone-q3.herokuapp.com/car/1

Response: status 200 - OK

{
    "car": {
    "id": 1,
    "year": 2019,
    "model": "PRISMA",
    "trunk_volume": 54,
    "insurer": "TESTE SEGUROS",
    "insurer_number": "12123456789",
    "review_date": "Thu, 12 Jul 2001 00:00:00 GMT",
    "withdrawal_place": "SHOPPING CURITIBA",
    "city": "CURITIBA",
    "state": "PR",
    "license_plate": "ABC1234"
  },
  "date_ocupied": [],
  "avaliations": []
}

Date Ocupied

Table to get the Date Ocupied

Schemas

key type description
id int id of date ocupied
car_id int id of the car
unavaliable_date_id int id of the unavaliable date

Endpoints and methods:

Every route needs authorization

Authorization:

{
    headers: {
        Authorization: "Bearer access_token";
    }
}

Routes that need permission

Register

You need be the lessee user and be logged in to register

-> URL and method:

POST: https://capstone-q3.herokuapp.com/date-ocupied/register

Body request example:

{
	"car_id": 1,
	"unavaliable_date_id": 2
}

Response: status 201 - CREATED

{
    "id": 1,
    "car_id": 1,
	"unavaliable_date_id": 2

}

Delete Date Ocupied

You need to own the resource to delete.

-> URL and method:

DELETE: https://capstone-q3.herokuapp.com/date-ocupied/delete/<id>

Request example:

DELETE without a body: https://capstone-q3.herokuapp.com/date-ocupied/delete/1

Response: status 204 - NO CONTENT

Routes don't that need permission

All GET Routes don't need permission.

In response header are the information about total dates quantity, pagination, next_page that access the next page and prev_page that access the previous page

Response header:

{
    "info": {
    "count": 11,
    "pages": 1,
    "next_page": null,
    "prev_page": null
  },

Get dates ocupieds

-> URL and method to get all dates:

GET: https://capstone-q3.herokuapp.com/date-ocupied/

Response: status 200 - OK

{
  "info": {
    "count": 1,
    "pages": 1,
    "next_page": null,
    "prev_page": null
  },
  "result": [
    {
      "id": 4,
      "car_id": 1,
      "unavaliable_date": {
        "id": 1,
        "date": "Fri, 12 Dec 2014 00:00:00 GMT"
      }
    }
  ]
}
}

-> URL and method to get dates with parameters:

GET: https://capstone-q3.herokuapp.com/date-ocupied/?<parameters=values>

Request example:

GET without a body: https://capstone-q3.herokuapp.com/date-ocupied/?car_id=1

Response: status 200 - OK

  {
  "info": {
    "count": 3,
    "pages": 1,
    "next_page": null,
    "prev_page": null
  },
  "result": [
    {
      "id": 4,
      "car_id": 1,
      "unavaliable_date": {
        "id": 1,
        "date": "Fri, 12 Dec 2014 00:00:00 GMT"
      }
    },
    {
      "id": 5,
      "car_id": 1,
      "unavaliable_date": {
        "id": 1,
        "date": "Fri, 12 Dec 2014 00:00:00 GMT"
      }
    },
    {
      "id": 6,
      "car_id": 1,
      "unavaliable_date": {
        "id": 1,
        "date": "Fri, 12 Dec 2014 00:00:00 GMT"
      }
    }
  ]
}

Unavaliable Date

Table to get the Unavaliable Date

Schemas

key type description
id int id of date ocupied
date str atual date

Endpoints and methods:

Every route needs authorization

Authorization:

{
    headers: {
        Authorization: "Bearer access_token";
    }
}

Routes that need permission

Register

You need be the lessee user and be logged in to register

-> URL and method:

POST: https://capstone-q3.herokuapp.com/unavaliable-date/register

Body request example:

{
	"date": "12/12/2014"
}

Response: status 201 - CREATED

{
  "id": 2,
  "date": "Fri, 12 Dec 2014 00:00:00 GMT"
}

Delete Unavaliable Date

You need to own the resource to delete.

-> URL and method:

DELETE: https://capstone-q3.herokuapp.com/unavaliable-date/delete/<id>

Request example:

DELETE without a body: https://capstone-q3.herokuapp.com/unavaliable-date/delete/1

Response: status 204 - NO CONTENT

Routes don't that need permission

All GET Routes don't need permission.

In response header are the information about total dates quantity, pagination, next_page that access the next page and prev_page that access the previous page

Response header:

{
    "info": {
    "count": 11,
    "pages": 1,
    "next_page": null,
    "prev_page": null
  },

Get unavaliable dates

-> URL and method to get all dates:

GET: https://capstone-q3.herokuapp.com/unavaliable-date/

Response: status 200 - OK

{
  "info": {
    "count": 2,
    "pages": 1,
    "next_page": null,
    "prev_page": null
  },
  "result": [
    {
      "id": 1,
      "date": "Fri, 12 Dec 2014 00:00:00 GMT"
    },
    {
      "id": 2,
      "date": "Mon, 12 Dec 2016 00:00:00 GMT"
    }
  ]
}

-> URL and method to get unavaliable dates with parameters:

GET: https://capstone-q3.herokuapp.com/car/cars?<parameters=values>

Request example:

GET without a body: http://127.0.0.1:5001/unavaliable-date/?date=12%2F12%2F2015

Response: status 200 - OK

{
  "info": {
    "count": 1,
    "pages": 1,
    "next_page": null,
    "prev_page": null
  },
  "result": [
    {
      "id": 2,
      "date": "Mon, 12 Dec 2016 00:00:00 GMT"
    }
  ]
}

Get Unavaliable Date

-> URL and method:

GET: https://capstone-q3.herokuapp.com/locator/unavaliable-date/<id>

Request example:

GET without a body: https://capstone-q3.herokuapp.com/locator/unavaliable-date/1

Response: status 200 - OK

{
  "id": 1,
  "date": "Fri, 12 Dec 2014 00:00:00 GMT"
}

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages