YouQuiz API

YouQuiz is An interactive platform that empowers trainers to design engaging quizzes, while providing students the opportunity to take and excel in these quizzes.
Click here to visit the front end repository of this project.

Tech Stack

API Reference

Response

Success

When fetching the data successfully, you will receive this response:

{
    "data": {/* Fetched data */},
    "message": "Success message",
    "status": 200 // HTTP status code (201 for creating new resource, else 200)
}

Errors

In case of exception:

When an unexpected error occurs during request processing, you will receive this response:

{
    "cause": {/* Optional: The cause of this exception, if available */},
    "message": "Exception message",
    "status": 404 // HTTP status code (can be adjusted for specific exceptions)
}

In case of invalid data:

When submitting invalid data in a request, you will receive this response:

{
    "errors": {/* The invalid fields with specific error messages */},
    "message": "Error message",
    "status": 422 // HTTP status code (can be adjusted for specific errors)
}

Answers

The answer request object:

An example of the answer request object when creating or updating an answer:

{
    "id": 3, // Required only when updating an answer
    "answer": "A software development platform that provides all the tools and libraries ..."
}

Get an answer:
```
  GET /api/answers/:id
```
Parameters Description

No parameter Returns an answer object if a valid identifier was provided, and throws an error otherwise.

Get all answers:

  GET /api/answers

Query Parameters Description

text: string
page: integer
size: integer
sortBy: string
sortOrder: string text: To search for an answer, default is "".
page: Number of the page (starting from 0), default is 0.
size: Number of answers in a single page, default is 24.
sortBy: name of the attribute to sort by (id or answer), default is "id".
sortOrder: Sorting in ascending (ASC) or descending (DESC) order, default is "ASC".
Returns an object that contains all the data about pagination & array of answers.

Create an answer:
```
  POST /api/answers/add
```
Parameters Description

answer: object Returns an answer object if a valid object was provided, and throws an error or exception otherwise.
Update an answer:
```
  PUT /api/answers/update
```
Parameters Description

answer: object Returns an answer object if a valid object was provided, and throws an error or exception otherwise.
Delete an answer:
```
  DELETE /api/answers/:id
```
Parameters Description

No parameter Returns an object of the deleted answer if a valid identifier was provided, and throws an error otherwise.

Answer Validations

The answer-validation request object:

An example of the answer-validation request object when creating an answer-validation:
```
{
    "points": 3.4,
    "answerId": 2,
    "questionId": 1
}
```
Get an answer-validation:
- Get by ID:
```
  GET /api/answers-assignment/pk/:id
```
  Parameters Description
  
  No parameter Returns an answer-validation object if a valid identifier was provided, and throws an error otherwise.
- Get by question & answer IDs:
```
  GET /api/answers-assignment/fk/:questionId/:answerId
```
  Parameters Description
  
  No parameter Returns an answer-validation object if a valid identifiers were provided, and throws an error otherwise.
Get a list of answer-validation objects:
- Get by question:
```
  GET /api/answers-assignment/by-question/:questionId
```
  Parameters Description
  
  No parameter Returns a list of answer-validation objects if a valid identifier was provided, and throws an error otherwise.
- Get by answer:
```
  GET /api/answers-assignment/by-answer/:answerId
```
  Parameters Description
  
  No parameter Returns a list of answer-validation objects if a valid identifier was provided, and throws an error otherwise.
Create an answer-validation:
```
  POST /api/answers-assignment/add
```
Parameters Description

AnswerValidation: object Returns an answer-validation object if a valid object was provided, and throws an error or exception otherwise.
Delete an answer-validation:
- Delete by ID:
```
  DELETE /api/answers-assignment/pk/:id
```
  Parameters Description
  
  No parameter Returns an object of the deleted answer-validation if a valid identifier was provided, and throws an error otherwise.
- Delete by question & answer IDs:
```
  DELETE /api/answers-assignment/fk/:questionId/:answerId
```
  Parameters Description
  
  No parameter Returns an object of the deleted answer-validation if a valid identifiers were provided, and throws an error otherwise.

Levels

The level request object:

An example of the level request object when creating or updating a level:

{
    "id": 3, // Required only when updating a level
    "title": "Medium",
    "description": "Optional description, can be empty.",
    "maxPoints": 29.9,
    "minPoints": 21.1
}

Get a level:
```
  GET /api/levels/:id
```
Parameters Description

No parameter Returns a level object if a valid identifier was provided, and throws an error otherwise.

Get all levels:

  GET /api/levels

Query Parameters Description

title: string
page: integer
size: integer
sortBy: string
sortOrder: string title: To search for a level, default is "".
page: Number of the page (starting from 0), default is 0.
size: Number of levels in a single page, default is 24.
sortBy: name of the attribute to sort by (id, title, description, maxPoints or minPoints), default is "id".
sortOrder: Sorting in ascending (ASC) or descending (DESC) order, default is "ASC".
Returns an object that contains all the data about pagination & array of levels.

Create a level:
```
  POST /api/levels/add
```
Parameters Description

level: object Returns a level object if a valid object was provided, and throws an error or exception otherwise.
Update a level:
```
  PUT /api/levels/update
```
Parameters Description

level: object Returns a level object if a valid object was provided, and throws an error or exception otherwise.
Delete a level:
```
  DELETE /api/levels/:id
```
Parameters Description

No parameter Returns an object of the deleted level if a valid identifier was provided, and throws an error otherwise.

Media

The media request object:

An example of the media request object when creating a media:

{
    "title": "A beautiful sunset",
    "type": "VIDEO" // 'type' must be either "VIDEO", "IMAGE" or "AUDIO"
    "file": {/* Attached file with the request */},
    "questionId": 1
}

Get a media:
```
  GET /api/media/:id
```
Parameters Description

No parameter Returns a media object if a valid identifier was provided, and throws an error otherwise.
Get media file:
```
  GET /api/media/get/:file-name
```
Parameters Description

No parameter Returns a file if a valid file name was provided, and throws an error otherwise.
Create a media:

⚠️ NB: You must use FormData in order to submit a post request.
```
  POST /api/media/add
```
Parameters Description

media: object Returns a media object if a valid object was provided, and throws an error or exception otherwise.
Delete a media:
```
  DELETE /api/media/:id
```
Parameters Description

No parameter Returns an object of the deleted media if a valid identifier was provided, and throws an error otherwise.

Questions

The question request object:

An example of the question request object when creating or updating a question:

{
    "id": 3, // Required only when updating a level
    "question": "What is JDK?",
    "description": "Optional description, can be empty.",
    "type": "SINGLE", // 'type' must be either "SINGLE", "MULTI" or "DIRECT"
    "levelId": 3
    "subjectId": 4
}

Get a question:
```
  GET /api/questions/:id
```
Parameters Description

No parameter Returns a question object if a valid identifier was provided, and throws an error otherwise.

Get all questions:

  GET /api/questions

Query Parameters Description

question: string
type: enum
level: long
subject: long
page: integer
size: integer
sortBy: string
sortOrder: string question: To search for a question, default is "".
type: To filter questions by their types (SINGLE, MULTI, DIRECT or empty string), default is "".
level: To filter questions by the level, default is 0.
subject: To filter questions by the subject, default is 0.
page: Number of the page (starting from 0), default is 0.
size: Number of questions in a single page, default is 24.
sortBy: name of the attribute to sort by (id, question, description), default is "id".
sortOrder: Sorting in ascending (ASC) or descending (DESC) order, default is "ASC".
Returns an object that contains all the data about pagination & array of questions.

Create a question:
```
  POST /api/questions/add
```
Parameters Description

question: object Returns a question object if a valid object was provided, and throws an error or exception otherwise.
Update a question:
```
  PUT /api/questions/update
```
Parameters Description

question: object Returns a question object if a valid object was provided, and throws an error or exception otherwise.
Delete a question:
```
  DELETE /api/questions/:id
```
Parameters Description

No parameter Returns an object of the deleted question if a valid identifier was provided, and throws an error otherwise.

Subjects

The subject request object:

An example of the subject request object when creating or updating a subject:

{
    "id": 3, // Required only when updating a subject
    "title": "Mathematics",
    "parent": 1 // Can be null
}

Get a subject:
```
  GET /api/subjects/:id
```
Parameters Description

No parameter Returns a subject object if a valid identifier was provided, and throws an error otherwise.

Get all subjects:

  GET /api/subjects

Query Parameters Description

title: string
page: integer
size: integer
sortBy: string
sortOrder: string title: To search for a subject, default is "".
page: Number of the page (starting from 0), default is 0.
size: Number of subjects in a single page, default is 24.
sortBy: name of the attribute to sort by (id, title), default is "id".
sortOrder: Sorting in ascending (ASC) or descending (DESC) order, default is "ASC".
Returns an object that contains all the data about pagination & array of subjects.

Create a subject:
```
  POST /api/subjects/add
```
Parameters Description

subject: object Returns a subject object if a valid object was provided, and throws an error or exception otherwise.
Update a subject:
```
  PUT /api/subjects/update
```
Parameters Description

subject: object Returns a subject object if a valid object was provided, and throws an error or exception otherwise.
Delete a subject:
```
  DELETE /api/subjects/:id
```
Parameters Description

No parameter Returns an object of the deleted subject if a valid identifier was provided, and throws an error otherwise.

Students

The student request object:

An example of the student request object when creating or updating a student:

{
    "id": 3, // Required only when updating a student
    "name": "Margaret",
    "familyName": "Hamilton",
    "address": "Paoli, Indiana, United States",
    "birthdate": "1936-08-17", // yyyy-MM-dd
    "registrationDate": "2022-12-31" // yyyy-MM-dd
}

Get a student:
```
  GET /api/students/:id
```
Parameters Description

No parameter Returns a student object if a valid identifier was provided, and throws an error otherwise.

Get all students:

  GET /api/students

Query Parameters Description

fullName: string
page: integer
size: integer
sortBy: string
sortOrder: string fullName: To search for a student, default is "".
page: Number of the page (starting from 0), default is 0.
size: Number of students in a single page, default is 24.
sortBy: name of the attribute to sort by (id, name, familyName, address, birthdate, registrationDate), default is "id".
sortOrder: Sorting in ascending (ASC) or descending (DESC) order, default is "ASC".
Returns an object that contains all the data about pagination & array of students.

Create a student:
```
  POST /api/students/add
```
Parameters Description

student: object Returns a student object if a valid object was provided, and throws an error or exception otherwise.
Update a student:
```
  PUT /api/students/update
```
Parameters Description

student: object Returns a student object if a valid object was provided, and throws an error or exception otherwise.
Delete a student:
```
  DELETE /api/students/:id
```
Parameters Description

No parameter Returns an object of the deleted student if a valid identifier was provided, and throws an error otherwise.

Trainers

The trainer request object:

An example of the trainer request object when creating or updating a trainer:

{
    "id": 3, // Required only when updating a trainer
    "name": "Margaret",
    "familyName": "Hamilton",
    "address": "Paoli, Indiana, United States",
    "birthdate": "1936-08-17", // yyyy-MM-dd
    "speciality": "Software Engineering"
}

Get a trainer:
```
  GET /api/trainers/:id
```
Parameters Description

No parameter Returns a trainer object if a valid identifier was provided, and throws an error otherwise.

Get all trainers:

  GET /api/trainers

Query Parameters Description

fullName: string
page: integer
size: integer
sortBy: string
sortOrder: string fullName: To search for a trainer, default is "".
page: Number of the page (starting from 0), default is 0.
size: Number of trainers in a single page, default is 24.
sortBy: name of the attribute to sort by (id, name, familyName, address, birthdate, speciality), default is "id".
sortOrder: Sorting in ascending (ASC) or descending (DESC) order, default is "ASC".
Returns an object that contains all the data about pagination & array of trainers.

Create a trainer:
```
  POST /api/trainers/add
```
Parameters Description

trainer: object Returns a trainer object if a valid object was provided, and throws an error or exception otherwise.
Update a trainer:
```
  PUT /api/trainers/update
```
Parameters Description

trainer: object Returns a trainer object if a valid object was provided, and throws an error or exception otherwise.
Delete a trainer:
```
  DELETE /api/trainers/:id
```
Parameters Description

No parameter Returns an object of the deleted trainer if a valid identifier was provided, and throws an error otherwise.

Quizzes

The quiz request object:

An example of the quiz request object when creating or updating a quiz:

{
    "id": 3, // Required only when updating a quiz
    "title": "Java quiz",
    "duration": 45, // In minutes
    "successScore": 80.5,
    "canSeeAnswers": true, // Choose if the student can see the correct answer after answering the question
    "canSeeResult": true, // Choose if the student can see the result after finishing the quiz
    "chances": 5,
    "remark": "Remark about the quiz",
    "trainerId": 1
}

Get a quiz:
```
  GET /api/quizzes/:id
```
Parameters Description

No parameter Returns a quiz object if a valid identifier was provided, and throws an error otherwise.

Get all quizzes:

  GET /api/quizzes

Query Parameters Description

title: string
page: integer
size: integer
sortBy: string
sortOrder: string title: To search for a quiz, default is "".
page: Number of the page (starting from 0), default is 0.
size: Number of quizzes in a single page, default is 24.
sortBy: name of the attribute to sort by (id, title, duration, successScore, chances, remark, trainerId), default is "id".
sortOrder: Sorting in ascending (ASC) or descending (DESC) order, default is "ASC".
Returns an object that contains all the data about pagination & array of quizzes.

Create a quiz:
```
  POST /api/quizzes/add
```
Parameters Description

quiz: object Returns a quiz object if a valid object was provided, and throws an error or exception otherwise.
Update a quiz:
```
  PUT /api/quizzes/update
```
Parameters Description

quiz: object Returns a quiz object if a valid object was provided, and throws an error or exception otherwise.
Delete a quiz:
```
  DELETE /api/quizzes/:id
```
Parameters Description

No parameter Returns an object of the deleted quiz if a valid identifier was provided, and throws an error otherwise.

QuizQuestions

The quiz-question request object:

An example of the quiz-question request object when creating or updating a quiz-question:

{
    "timer": 20, // In seconds
    "allowPartialPoints": false, // Choose whether to allow partial points for each question or not
    "questionId": 5,
    "quizId": 1
}

Get a quiz-question:
```
  GET /api/quiz-questions/:quizId/:questionId
```
Parameters Description

No parameter Returns a quiz-question object if a valid identifiers were provided, and throws an error otherwise.
Get all quiz-questions by quiz:
```
  GET /api/quiz-questions/quiz/:quizId
```
Parameters Description

No parameter Returns an array of quiz-question objects if a valid identifier was provided, and throws an error otherwise.
Get all quiz-questions by question:
```
  GET /api/quiz-questions/question/:questionId
```
Parameters Description

No parameter Returns an array of quiz-question objects if a valid identifier was provided, and throws an error otherwise.
Create a quiz-question:
```
  POST /api/quiz-questions/add
```
Parameters Description

quiz-question: object Returns a quiz-question object if a valid object was provided, and throws an error or exception otherwise.
Delete a quiz-question:
```
  DELETE /api/quiz-questions/:quizId/:questionId
```
Parameters Description

No parameter Returns an object of the deleted quiz-question if a valid identifier was provided, and throws an error otherwise.

QuizAssignments

The quiz-assignment request object:

An example of the quiz-assignment request object when creating a quiz-assignment:

{
    "reason": "Margaret",
    "startingTime": "2023-12-14 18:45:00.000",
    "endingTime": "2023-12-14 23:45:00.000",
    "studentId": 4,
    "quizId": 32
}

Get a quiz-assignment:

Get with or without result & score:

  GET /api/quiz-assignments/:id

Parameters	Description
No parameter	Get a quiz-assignment object with or without result & score, depends if the student is allowed to see the result & score of a quiz. Returns a quiz-assignment object if a valid identifier was provided, and throws an error otherwise.

Get with result & score:

  GET /api/quiz-assignments/with-results/:id

Parameters	Description
No parameter	Get a quiz-assignment object with result & score, regardless if the student is allowed to see the result & score of a quiz or not. Returns a quiz-assignment object if a valid identifier was provided, and throws an error otherwise.

Get quiz-assignments of a student (/w or /wo result & score):

Get with or without result & score:

  GET /api/quiz-assignments/by-student/:studentId

Parameters	Description
No parameter	Get a list of quiz-assignment objects of a student with or without result & score, depends if the student is allowed to see the result & score of a quiz. Returns a list quiz-assignment objects if a valid identifier was provided, and throws an error otherwise.

Get with result & score:

  GET /api/quiz-assignments/by-student-with-results/:studentId

Parameters	Description
No parameter	Get a list of quiz-assignment objects of a student with result & score, regardless if the student is allowed to see the result & score of a quiz or not. Returns a list quiz-assignment objects if a valid identifier was provided, and throws an error otherwise.

Create a quiz-assignment:
```
  POST /api/quiz-assignments/add
```
Parameters Description

quiz-assignment: object Returns a quiz-assignment object if a valid object was provided, and throws an error or exception otherwise.
Save a selected answer:
```
  POST /api/quiz-assignments/selected-answer/:quizAssignmentId/:answerValidationId
```
Parameters Description

No parameter Returns a quiz-assignment object if a valid identifiers were provided, and throws an error or exception otherwise.

Close a quiz-assignment:

  POST /api/quiz-assignments/close-quiz-assignment/:id

Parameters	Description
No parameter	Closes & calculate the score of the quiz after passing the quiz. Returns a quiz-assignment object if a valid identifier was provided, and throws an error or exception otherwise.

Delete a quiz-assignment:
```
  DELETE /api/quiz-assignments/:id
```
Parameters Description

No parameter Returns an object of the deleted quiz-assignment if a valid identifier was provided, and throws an error otherwise.

Name		Name	Last commit message	Last commit date
Latest commit History 156 Commits
.mvn/wrapper		.mvn/wrapper
src		src
.editorconfig		.editorconfig
.gitignore		.gitignore
Dockerfile		Dockerfile
README.md		README.md
docker-compose.yaml		docker-compose.yaml
mvnw		mvnw
mvnw.cmd		mvnw.cmd
pom.xml		pom.xml
script.sql		script.sql

ThisMSH/YouQuiz

Folders and files

Latest commit

History

Repository files navigation

YouQuiz API

Tech Stack

API Reference

Response

Success

Errors

In case of exception:

In case of invalid data:

Answers

The answer request object:

Get an answer:

Get all answers:

Create an answer:

Update an answer:

Delete an answer:

Answer Validations

The answer-validation request object:

Get an answer-validation:

Get by ID:

Get by question & answer IDs:

Get a list of answer-validation objects:

Get by question:

Get by answer:

Create an answer-validation:

Delete an answer-validation:

Delete by ID:

Delete by question & answer IDs:

Levels

The level request object:

Get a level:

Get all levels:

Create a level:

Update a level:

Delete a level:

Media

The media request object:

Get a media:

Get media file:

Create a media:

Delete a media:

Questions

The question request object:

Get a question:

Get all questions:

Create a question:

Update a question:

Delete a question:

Subjects

The subject request object:

Get a subject:

Get all subjects:

Create a subject:

Update a subject:

Delete a subject:

Students

The student request object:

Get a student:

Get all students:

Create a student:

Update a student:

Delete a student:

Trainers

The trainer request object:

Get a trainer:

Get all trainers:

Create a trainer:

Update a trainer:

Delete a trainer:

Quizzes

The quiz request object:

Get a quiz:

Get all quizzes:

Create a quiz:

Update a quiz:

Delete a quiz:

Packages