Skip to content

Hasherino/inventor_system

BranchesTags

Repository files navigation

Inventor system

A system that lets you keep track of inventory

To launch the API on your local machine:

  • composer update
  • php artisan jwt:secret
  • php artisan key:generate
  • Launch a local MySQL server and create .env file based on .env.example and edit it to match your configuration
  • php artisan migrate
  • php artisan DB:seed
  • php artisan serve

Routes

User

GET

URI: GET http://localhost:8000/api/users/all

Function: Returns all users in the database. Only for users with role: 1

Parameters:

Parameter Type Description Required
search string Search query false
company string Company of users false
  • Success response:
    • Code: 200 OK
    • Content: a list of all users
  • Error response:
    • Code: 401 Unauthorized
    • Content: Unauthorized

URI: GET http://localhost:8000/api/users

Function: Returns all users within the user company

Parameters:

Parameter Type Description Required
search string Search query false
  • Success response:
    • Code: 200 OK
    • Content: a list of all users

URI: GET http://localhost:8000/api/users/{id}

Function: Returns the user with the specified id.

  • Success response:
    • Code: 200 OK
    • Content: user with the specified id
  • Error response:
    • Code: 404 Not found
    • Content: "Sorry, user not found"

POST

URI: POST http://localhost:8000/api/users

Function: Adds a user to the database and emails him to set a password. Only for users with roles: 1.

Parameters:

Parameter Type Description Required
first_name string The first name of the user true
last_name string The last name of the user true
email string Email of the user. Has to be unique true
company_id int User's company id true
role int User's role (0: regular, 1: admin) true
  • Success response:
    • Code: 201 Created
    • Content: "Password creation email has been sent."
  • Error response (unauthorized):
    • Code: 401 Unauthorized
    • Content: Unauthorized
  • Error response (bad parameters):
    • Code: 400 Bad request
    • Content: Error specification

PUT

URI: PUT http://localhost:8000/api/users/{id}

Function: Updates the user with the specified id.

Parameters:

Parameter Type Description Required
first_name string The first name of the user false
last_name string The last name of the user false
email string Email of the user. Has to be unique false
role int User's role (0: regular, 1: admin) false
  • Success response:
    • Code: 200 OK
    • Content: The updated user
  • Error response (user not found):
    • Code: 404 Not found
    • Content: "Sorry, user not found"
  • Error response (bad parameters):
    • Code: 400 Bad request
    • Content: Error specification

DELETE

URI: DELETE http://localhost:8000/api/users/{id}

Function: Deletes the user with the specified id. Only for users with role: 1.

  • Success response:
    • Code: 200 OK
    • Content: "User deleted successfully"
  • Error response (unauthorized):
    • Code: 401 Unauthorized
    • Content: "Not authorized"
  • Error response (user not found):
    • Code: 404 Not found
    • Content: "Sorry, user not found"
  • Error response (user has gear):
    • Code: 400 Bad request
    • Content: "User cannot be deleted, because user has gear"

Authorization

POST

URI: POST http://localhost:8000/api/auth/login

Function: Logs in the user and provides a bearer token.

Parameters:

Parameter Type Description Required
email string Email of the user true
password string Password of the user true
  • Success response:
    • Code: 200 OK
    • Content: Access token and user's data
  • Error response:
    • Code: 401 Unauthorized
    • Content: "Not authorized"

URI: POST http://localhost:8000/api/auth/logout

Function: Logs out the user.

  • Success response:
    • Code: 200 OK
    • Content: "User successfully signed out"

URI: POST http://localhost:8000/api/auth/refresh

Function: Refreshes user's token.

  • Success response:
    • Code: 200 OK
    • Content: New access token and user's data

Company

GET

URI: GET http://localhost:8000/api/companies

Function: Returns all companies' data. Only for users with role: 1.

Parameters:

Parameter Type Description Required
search string Search query false
  • Success response:
    • Code: 200 OK
    • Content: A list of all companies
  • Error response:
    • Code: 401 Unauthorized
    • Content: "Not authorized"

POST

URI: POST http://localhost:8000/api/companies

Function: Creates a new company. Only for users with role: 1.

Parameters:

Parameter Type Description Required
name string Name of the company true
  • Success response:
    • Code: 201 Created
    • Content: The created company
  • Error response (unauthorized):
    • Code: 401 Unauthorized
    • Content: "Not authorized"
  • Error response (bad parameters):
    • Code: 400 Bad request
    • Content: Error specification

PUT

URI: PUT http://localhost:8000/api/companies/{id}

Function: Updates the company with the specified id.

Parameters:

Parameter Type Description Required
name string Name of the company false
  • Success response:
    • Code: 200 OK
    • Content: The updated company
  • Error response (unauthorized):
    • Code: 401 Unauthorized
    • Content: "Not authorized"
  • Error response (company not found):
    • Code: 404 Not found
    • Content: "Sorry, company not found"
  • Error response (bad parameters):
    • Code: 400 Bad request
    • Content: Error specification

DELETE

URI: GET http://localhost:8000/api/companies/{id}

Function: Deletes the company with the specified id. Only for users with role: 1.

  • Success response:
    • Code: 200 OK
    • Content: "Company deleted successfully"
  • Error response (unauthorized):
    • Code: 401 Unauthorized
    • Content: "Not authorized"
  • Error response (company not found):
    • Code: 404 Not found
    • Content: "Sorry, company not found"
  • Error response (company has users):
    • Code: 400 Company still has users"

Gear

GET

URI: GET http://localhost:8000/api/gear/all

Function: Returns all gear. Only for users with role: 1.

Parameters:

Parameter Type Description Required
search string Search query false
  • Success response:
    • Code: 200 OK
    • Content: A list of all gear
  • Error response:
    • Code: 401 Unauthorized
    • Content: "Not authorized"

URI: GET http://localhost:8000/api/gear

Function: Returns all user's gear

Parameters:

Parameter Type Description Required
search string Search query false
  • Success response:
    • Code: 200 OK
    • Content: A list of all user's gear

URI: GET http://localhost:8000/api/gear/user/{id}

Function: Returns all user's with the specified id gear. Only for users with role: 1.

  • Success response:
    • Code: 200 OK
    • Content: A list of all user's gear
  • Error response (unauthorized):
    • Code: 401 Unauthorized
    • Content: "Not authorized"
  • Error response (user not found):
    • Code: 404 Not Found
    • Content: "Sorry, user not found"

URI: GET http://localhost:8000/api/gear/all/{id}

Function: Returns the gear with the specified id. Only for users with role: 1.

  • Success response:
    • Code: 200 OK
    • Content: The gear with the specified id
  • Error response (unauthorized):
    • Code: 401 Unauthorized
    • Content: "Not authorized"
  • Error response (gear not found):
    • Code: 404 Not Found
    • Content: "Sorry, gear not found"

URI: GET http://localhost:8000/api/gear/code/{code}

Function: Returns gear with the specified code

  • Success response:
    • Code: 200 OK
    • Content: The gear with the specified code
  • Error response:
    • Code: 404 Not Found
    • Content: "Sorry, gear not found"

URI: GET http://localhost:8000/api/gear/{id}

Function: Returns the user's gear with the specified id

  • Success response:
    • Code: 200 OK
    • Content: The gear with the specified id
  • Error response:
    • Code: 404 Not Found
    • Content: "Sorry, gear not found"

URI: GET http://localhost:8000/api/gear/pdf/{id}

Function: Generates a pdf of gear with the selected id.

  • Success response:
    • Code: 200 OK
    • Content: The generated pdf
  • Error response (if you're not an admin and selected gear that isn't yours):
    • Code: 401 Unauthorized
    • Content: "Not authorized"

POST

URI: POST http://localhost:8000/api/gear

Function: Creates a new gear.

Parameters:

Parameter Type Description Required
name string Gear's name true
code string Gear's code true
description string Gear's description. Max length: 255 true
serial_number string Gear's serial number. Unique. Can be listed as csv for adding multiple gear true
unit_price double Unit price of the gear true
long_term bool Is the gear long-term true
user_id int Gear's owner's id true
amount int Quantity of the gear. Max: 50 true
  • Success response:
    • Code: 201 Created
    • Content: The created gear
  • Error response:
    • Code: 400 Bad request
    • Content: Error specification

PUT

URI: PUT http://localhost:8000/api/gear/{id}

Function: Updates all the gear's data with the specified id.

Parameters:

Parameter Type Description Required
name string Gear's name false
code string Gear's code false
description string Gear's description. Max length: 255 false
serial_number string Gear's serial number. Unique false
unit_price double Unit price of the gear false
long_term bool Is the gear long-term false
user_id int Gear's owner's id false
  • Success response:
    • Code: 200 OK
    • Content: The updated gear
  • Error response (gear not found):
    • Code: 404 Not found
    • Content: "Sorry, gear not found"
  • Error response (bad parameters):
    • Code: 400 Bad request
    • Content: Error specification

DELETE

URI: DELETE http://localhost:8000/api/gear/delete

Function: Deletes the gear with the specified id's. Only for users with role: 1.

Parameter Type Description Required
gear_id int array Gear's name true
  • Success response:
    • Code: 200 OK
    • Content: "Gear deleted successfully"
  • Error response (unauthorized):
    • Code: 401 Unauthorized
    • Content: "Not authorized"
  • Error response (gear not found):
    • Code: 404 Not found
    • Content: "Sorry, gear not found"
  • Error response (gear is lent):
    • Code: 400 Bad request
    • Content: "You cannot delete lent gear"
  • Error response (gear has a request):
    • Code: 400 Bad request
    • Content: "Gear has a request"

Requests

GET

Status reference: 0 = pending lend 1 = lent 2 = pending return 3 = pending giveaway

URI: GET http://localhost:8000/api/requests/pending

Function: Returns all user's pending requests

  • Success response:
    • Code: 200 OK
    • Content: A list of all user's pending requests

POST

URI: POST http://localhost:8000/api/requests/lend

Function: Creates a request to lend gear

Parameters:

Parameter Type Description Required
user_id int Id of the user that the gear is being lent to. Has to exist true
gear_id int array Array of gear, that is being lent, ids true
  • Success response:
    • Code: 200 OK
    • Content: "Lend request sent."
  • Error response (gear not found):
    • Code: 404 Not found
    • Content: "Sorry, gear not found"
  • Error response (lending to yourself):
    • Code: 400 Bad request
    • Content: "You cannot lend gear to yourself."
  • Error response (user owns the gear):
    • Code: 400 Bad request
    • Content: "This user owns this gear."
  • Error response (not holding the gear):
    • Code: 400 Bad request
    • Content: "You do not currently hold this gear."
  • Error response (gear already has a request):
    • Code: 400 Bad request
    • Content: "Gear already has a request"
  • Error response (trying to lend back):
    • Code: 400 Bad request
    • Content: "User lent you this gear"
  • Error response (bad parameters):
    • Code: 400 Bad request
    • Content: Error specification

URI: POST http://localhost:8000/api/requests/accept-lend/{id}

Function: Accepts a lend request (id in URI is the id of the lend request)

  • Success response:
    • Code: 200 OK
    • Content: "Lend request accepted."
  • Error response:
    • Code: 404 Not found
    • Content: "Sorry, request not found"

URI: POST http://localhost:8000/api/requests/return

Function: Returns lent gear

Parameters:

Parameter Type Description Required
gear_id int array Array of gear, that is being returned, ids true
  • Success response:
    • Code: 200 OK
    • Content: "Return request created"
  • Error response (not found):
    • Code: 404 Not found
    • Content: "Sorry, request/gear not found"
  • Error response (request already sent):
    • Code: 400 Bad request
    • Content: "Return request is already sent."
  • Error response (gear is not in lent stage):
    • Code: 400 Bad request
    • Content: "Gear is not in lent stage."
  • Error response (bad parameters):
    • Code: 400 Bad request
    • Content: Error message

URI: POST http://localhost:8000/api/requests/accept-return/{id}

Function: Accepts return request (id in URI is the id of the request that is being accepted)

  • Success response:
    • Code: 200 OK
    • Content: "Gear returned"
  • Error response:
    • Code: 404 Not found
    • Content: "Sorry, request/gear not found"

URI: POST http://localhost:8000/api/requests/decline-return/{id}

Function: Declines return request (id in URI is the id of the request that is being accepted)

  • Success response:
    • Code: 200 OK
    • Content: "Return declined"
  • Error response:
    • Code: 404 Not found
    • Content: "Sorry, request/gear not found"

URI: POST http://localhost:8000/api/requests/giveaway

Function: Gives away gear

Parameters:

Parameter Type Description Required
user_id int Id of the user that the gear is being given away to. Has to exist true
gear_id int array Array of gear, that is being given away, ids true
  • Success response:
    • Code: 200 OK
    • Content: "Giveaway request created"
  • Error response (not found):
    • Code: 404 Not found
    • Content: "Sorry, gear not found"
  • Error response (gear is lent):
    • Code: 400 Bad request
    • Content: "You cannot give away lent gear."
  • Error response (gear already has a request):
    • Code: 400 Bad request
    • Content: "Gear already has a request"
  • Error response (trying to giveaway to yourself):
    • Code: 400 Bad request
    • Content: "You cannot giveaway gear to yourself."
  • Error response (bad parameters):
    • Code: 400 Bad request
    • Content: Error message

URI: POST http://localhost:8000/api/requests/accept-giveaway/{id}

Function: Accepts giveaway request (id in URI is the id of the request that is being accepted)

  • Success response:
    • Code: 200 OK
    • Content: "Giveaway request accepted"
  • Error response:
    • Code: 404 Not found
    • Content: "Sorry, request/gear not found"

URI: POST http://localhost:8000/api/requests/give-yourself

Function: Give yourself any gear. Only for users with role: 1.

Parameters:

Parameter Type Description Required
gear_id int array Array of gear, that is being taken, ids true
  • Success response:
    • Code: 200 OK
    • Content: "Giveaway request accepted"
  • Error response (not found):
    • Code: 404 Not found
    • Content: "Sorry, gear not found"
  • Error response (gear is lent):
    • Code: 400 Bad request
    • Content: "You cannot give away lent gear."
  • Error response (gear already has a request):
    • Code: 400 Bad request
    • Content: "Gear already has a request"
  • Error response (already have the gear):
    • Code: 400 Bad request
    • Content: "You already own that gear."
  • Error response (bad parameters):
    • Code: 400 Bad request
    • Content: Error message

DELETE

URI: DELETE http://localhost:8000/api/requests/{id}

Function: Deletes the request with the specified id (if the request belongs to the user or user's gear).

  • Success response:
    • Code: 200 OK
    • Content: "Request deleted successfully."
  • Error response (status = 1 or 2):
    • Code: 400 Bad request
    • Content: "Cannot delete this request."
  • Error response (not found):
    • Code: 404 Not found
    • Content: "Sorry, request not found."

Password reset

POST

URI: POST http://localhost:8000/api/reset-password-email

Function: Sends a password reset link to the specified email

Parameter Type Description Required
email string The email of the user, who wants his password reset true
  • Success response:
    • Code: 200 OK
    • Content: "Password reset email has been sent."
  • Error response:
    • Code: 404 Not found
    • Content: "Email does not exist."

URI: POST http://localhost:8000/api/change-password

Function: Changes user's password to a new one

Parameter Type Description Required
email string The email of the user, who wants his password reset true
token string Token, which is given with the link to reset/set password true
password string The new password true
  • Success response:
    • Code: 201 Created
    • Content: "Password has been updated."
  • Error response:
    • Code: 422 Unprocessable Content
    • Content: "Either your email or token is wrong."

URI: POST http://localhost:8000/api/change-password

Function: Changes user's password to a new one

Parameter Type Description Required
password string The new password. Min: 6 true
confirm_password string The same password repeated true
old_password string The old user's password true
  • Success response:
    • Code: 200 OK
    • Content: "Password changed successfully"
  • Error response (passwords do not match):
    • Code: 400 Bad request
    • Content: "Passwords do not match"
  • Error response (old password is incorrect):
    • Code: 400 Bad request
    • Content: "Password is incorrect"
  • Error response (bad parameters):
    • Code: 400 Bad request
    • Content: Error message

History

GET

Event parameter explanation:
0 = lent 1 = returned 2 = gave away 3 = deleted

URI: GET http://localhost:8000/api/history

Function: Returns user's history

  • Success response:
    • Code: 200 OK
    • Content: User's history

URI: GET http://localhost:8000/api/gear-history/{id}

Function: Returns gear's with specified id history

  • Success response:
    • Code: 200 OK
    • Content: Gear's History

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

 
 
 

Contributors

Languages