My App API Documentation

Instructions for /auth Route

• To login a user, send a POST request to the /auth route.
• The body of this request should contain a JSON object with the following properties: {username, password}
• To register a new user, send a POST request to the /auth/register route.
• The body of this request should contain a JSON object with the following properties: {username, password, role, first_name, last_name, email, phone}
• To refresh a user's access token, send a GET request to the /auth/refresh route.
• To logout a user, send a GET request to the /auth/logout route.

Instructions for /users Routes

GET /users

Fetches all users from the database.

• Access: Private
• Method: GET
• Endpoint: /users

GET /users/:id

Fetches a user by their ID from the database.

• Access: Private
• Method: GET
• Endpoint: /users/:id
• Parameters:
  • id (required): The ID of the user to retrieve.

POST /users

Creates a new user.

• Access: Private
• Method: POST
• Endpoint: /users
• Request Body:
  • username (required): The username of the new user.
  • password (required): The password of the new user.
  • role (required): The role of the new user.
  • first_name (required): The first name of the new user.
  • last_name (required): The last name of the new user.
  • email (optional): The email of the new user. If not provided, it will default to "N/A".
  • phone (optional): The phone number of the new user. If not provided, it will default to "N/A".

PATCH /users

Updates an existing user.

• Access: Private
• Method: PATCH
• Endpoint: /users
• Request Body:
  • id (required): The ID of the user to update.
  • username (required): The new username for the user.
  • password (optional): The new password for the user.
  • role (required): The new role for the user.
  • first_name (required): The new first name for the user.
  • last_name (required): The new last name for the user.
  • email (required): The new email for the user.
  • phone (required): The new phone number for the user.

PATCH /users/:id

Updates a user's children.

• Access: Private
• Method: PATCH
• Endpoint: /users/:id
• Parameters:
  • id (required): The ID of the user to update.
• Request Body:
  • children (required): An array of children objects containing their names and ages.

DELETE /users/:id

Deletes a user from the database.

• Access: Private
• Method: DELETE
• Endpoint: /users/:id
• Parameters:
  • id (required): The ID of the user to delete.

Instructions for /students Routes

GET /students

Fetches all students from the database.

• Access: Private
• Method: GET
• Endpoint: /students

GET /students/:id

Fetches a student by their ID from the database.

• Access: Private
• Method: GET
• Endpoint: /students/:id
• Parameters:
  • id (required): The ID of the student to retrieve.

POST /students

Creates a new student.

• Access: Private
• Method: POST
• Endpoint: /students
• Request Body:
  • first_name (required): The first name of the new student.
  • last_name (required): The last name of the new student.
  • parent_id (required): The ID of the parent user.
  • email (required): The email of the new student.
  • phone (required): The phone number of the new student.

PATCH /students

Updates an existing student.

• Access: Private
• Method: PATCH
• Endpoint: /students
• Request Body:
  • id (required): The ID of the student to update.
  • first_name (required): The new first name for the student.
  • last_name (required): The new last name for the student.
  • parent_id (required): The new ID of the parent user.
  • email (required): The new email for the student.
  • phone (required): The new phone number for the student.
  • changed_classes_count (required): The number of changed classes for the student.

PATCH /students/:id

Updates a student's enrolled classes.

• Access: Private
• Method: PATCH
• Endpoint: /students/:id
• Parameters:
  • id (required): The ID of the student to update.
• Request Body:
  • class_id (required): The ID of the class to add or remove.
  • action (required): The action to perform, either "add" or "remove".

DELETE /students

Deletes a student from the database.

• Access: Private
• Method: DELETE
• Endpoint: /students
• Request Body:
  • id (required): The ID of the student to delete.

Instructions for /classes Routes

GET /classes

Fetches all classes from the database.

• Access: Private
• Method: GET
• Endpoint: /classes

GET /classes/:id

Fetches a class by its ID from the database.

• Access: Private
• Method: GET
• Endpoint: /classes/:id
• Parameters:
  • id (required): The ID of the class to retrieve.

POST /classes

Creates a new class.

• Access: Private
• Method: POST
• Endpoint: /classes
• Request Body:
  • name (required): The name of the new class.
  • teacher (required): The name of the teacher for the new class.
  • timing (required): The timing of the new class.

PATCH /classes

Updates an existing class.

• Access: Private
• Method: PATCH
• Endpoint: /classes
• Request Body:
  • id (required): The ID of the class to update.
  • name (required): The new name for the class.
  • teacher (required): The new teacher for the class.
  • timing (required): The new timing for the class.

PATCH /classes/:id

Updates a class's enrollments.

• Access: Private
• Method: PATCH
• Endpoint: /classes/:id
• Parameters:
  • id (required): The ID of the class to update.
• Request Body:
  • studentId (required): The ID of the student to add or remove.
  • action (required): The action to perform, either "add" or "remove".

DELETE /classes

Deletes a class from the database.

• Access: Private
• Method: DELETE
• Endpoint: /classes
• Request Body:
  • id (required): The ID of the class to delete.