Skip to content

Latest commit

 

History

History
713 lines (632 loc) · 11.9 KB

response.md

File metadata and controls

713 lines (632 loc) · 11.9 KB

API Endpoint

Table of Content

Auth

Login

  • Auth : Not Required
  • Method : POST
  • URL : /login
  • Request:
{
    "email": "[email protected]",
    "password": "userpassword"
}
  • Response:
Status Code: 200
{
    "success": true,
    "message": "User logged in successfully.",
    "authResult": {
        "id": "",
        "fullName": "John Doe",
        "email": "[email protected]",
        "token": ""
    }
}
Status Code: 400
{
    "success": false,
    "message": "Invalid email or password"
}
Status Code: 500
{
    "success": false,
    "message": "Internal Server Error",
}

Register

  • Auth : Not Required

  • Method : POST

  • URL : /register

  • Request:

{
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "password": "securepassword"
}
  • Response:
Status Code: 200
{
    "success": true,
    "message": "User registered successfully",
    "authResult": {
        "id": "123",
        "fullName": "John Doe",
        "email": "[email protected]",
        "token": "token",
      }
}
Status Code: 400
{
    "success": false,
    "message": "Register failed"
}
Status Code: 500
{
    "success": false,
    "message": "Internal Server Error",
}

Logout

  • Auth : Required

  • Method : POST

  • URL : /logout

  • Headers : Authorization : Bearer <token>

  • Response: 

Status Code: 200
{
    "success": true,
    "message": "Logout successful"
}
Status Code: 400
{
    "success": false,
    "message": "Logout failed",
    "token": null
}
Status Code: 500
{
    "success": false,
    "message": "Internal Server Error",
}

Profile

  • Auth : Required

  • Method :

  • URL : /profile

  • Headers : Authorization : Bearer <token>

  • Response:

Status Code: 200
{
    "success": true,
    "message": "Profile obtain successfuly"
    "data": {
        "id": "",
        "fullName": "",
        "firstName": "",
        "lastName": "",
        "email": "",
        "createdAt": ""
    }
}
Status Code: 400
{
    "success": false,
    "message": "User failed to obtain"
}
Status Code: 500
{
    "success": false,
    "message": "Internal Server Error",
}

Dictionary

Dictionary Alphabet

  • Auth : Required

  • Method : GET

  • URL : /dictionary/alphabet

  • Headers : Authorization : Bearer <token>

  • Response:

Status Code: 200
{
    "success": true,
    "message": "Dictionary alphabet obtain succesfully",
    "data": {
        "_id": "",
        "type": "alphabet",
        "createdAt": "",
        "updatedAt": "",
        "wordList" [
            {
            "_id": "",
            "value": "",
            "urlImage": "",
            "description": ""
            },
            {
            "_id": "",
            "value": "",
            "urlImage": "",
            "description": ""
            },
        ]
    }
}
Status Code:400
{
    "success": true,
    "message": "Dictionary failed to obtain",
}
Status Code: 500
{
    "success": false,
    "message": "Internal Server Error",
}

Dictionary Number

  • Auth : Required

  • Method : GET

  • URL : /dictionary/number

  • Headers : Authorization : Bearer <token>

  • Response:

Status Code: 200
{
    "success": true,
    "message": "Dictionary number obtain succesfully",
    "data": {
        "_id": "",
        "type": "number",
        "createdAt": "",
        "updatedAt": "",
        "wordList" [
            {
            "_id": "",
            "value": "",
            "urlImage": "",
            "description": ""
            },
            {
            "_id": "",
            "value": "",
            "urlImage": "",
            "description": ""
            },
        ]
    }
}
Status Code:400
{
    "success": true,
    "message": "Dictionary failed to obtain",
}
Status Code: 500
{
    "success": false,
    "message": "Internal Server Error",
}

Dictionary Detail

  • Auth : Required

  • Method : GET

  • URL : /dictionary/{{ type }}/{{ word }}

  • Headers : Authorization : Bearer <token>

  • Response:

Status Code: 200
{
    "success": true,
    "message": "Dictionary detail obtain succesfully",
    "data": {
        "_id": "",
        "value": "",
        "urlImage": "",
        "description": ""
    }
}
Status Code:400
{
    "success": false,
    "message": "Dictionary detail failed to obtain",
}
Status Code: 500
{
    "success": false,
    "message": "Internal Server Error",
}

Quizzes

Get Quiz Alphabet

  • Auth : Required

  • Method : GET

  • URL : /quizzes/type/alphabet

  • Headers : Authorization : Bearer <token>

  • Response:

Status Code: 200
{
    "success": true,
    "message": "Quiz obtained successfully",
    "data": {
        "id": "",
        "score" : "",
        "type" : "alphabet"
        "questions": [
            {
                "question": "",
                "correct": false,
                "urlImage": "",
                "userAnswer": "",
                "answers": [
                    {
                        "option": "A",
                        "answer": "Paris",
                        "correct": true
                    },
                    {
                        "option": "B",
                        "answer": "London",
                        "correct": false
                    },
                    {
                        "option": "C",
                        "answer": "Berlin",
                        "correct": false
                    },
                    {
                        "option": "D",
                        "answer": "Madrid",
                        "correct": false
                    }
                ]
            }
        ],
        "createdAt": "",
        "updatedAt": ""
    }
}
Status Code:400
{
    "success" : false
    "message": "Quiz failed to obtain"
}
Status Code: 500
{
    "success": false,
    "message": "Internal Server Error",
}

Get Quiz Number

  • Auth : Required

  • Method : GET

  • URL : /quizzes/type/number

  • Headers : Authorization : Bearer <token>

  • Response:

Status Code: 200
{
    "success": true,
    "message": "Quiz obtained successfully",
    "data": {
        "id": "",
        "score" : "",
        "type" : "number"
        "questions": [
            {
                "question": "",
                "correct": false,
                "urlImage": "",
                "userAnswer": "",
                "answers": [
                    {
                        "option": "A",
                        "answer": "Paris",
                        "correct": true
                    },
                    {
                        "option": "B",
                        "answer": "London",
                        "correct": false
                    },
                    {
                        "option": "C",
                        "answer": "Berlin",
                        "correct": false
                    },
                    {
                        "option": "D",
                        "answer": "Madrid",
                        "correct": false
                    }
                ]
            }
        ],
        "createdAt": "",
        "updatedAt": ""
    }
}
Status Code:400
{
    "success" : false
    "message": "Quiz failed to obtain"
}
Status Code: 500
{
    "success": false,
    "message": "Internal Server Error",
}

Post Quiz

  • Auth : Required

  • Method : POST

  • URL : /quiz

  • Headers : Authorization : Bearer <token>

  • Request:

{
    "id": "",
    "score": "",
        "type": "alphabet",
        "questions":[
            {
                "question": "v",
                "urlImage": "",
                "userAnswer": "q",
                "answers": [
                    {
                        "value": "r",
                        "correct": false
                    },
                    {
                        "value": "q",
                        "correct": false
                    },
                    {
                        "value": "f",
                        "correct": false
                    },
                    {
                        "value": "v",
                        "correct": true
                    }
                    ...
                ]
            }
        ],
    "createdAt": "",
    "updatedAt": ""
}
  • Response:
Status Code:201
{
    "success" : false
    "message": "Quiz submited successfully"
}
Status Code:400
{
    "success" : true
    "message": "Quiz failed to submit"
}
Status Code: 500
{
    "success": false,
    "message": "Internal Server Error",
}

Get Quiz History User

  • Auth : Recquired

  • Method : GET

  • URL : /quizzes/history

  • Headers : Authorization : Bearer <token>

  • Parameters : count (optional): Gets the number of historical entries (0-9999).

  • Response:

Status Code: 200
{
    "success" : true
    "message": "Quiz history obtain successfully"
    "data" : {
    "_id": "",
    "email": "",
    "firstName": "",
    "lastName": "",
    "createdAt": "",
    "updatedAt": "",
    "quiz": [
        {
        "_id": "",
        "score" : "",
        "type" : "number/alphabet"
        "questions": [
          {
            "question": "",
            "correct": false,
            "urlImage": "",
            "userAnswer": "",
            "answers": [
              {
                "option": "A",
                "answer": "Paris",
                "correct": true
              },
              {
                "option": "B",
                "answer": "Londres",
                "correct": false
              },
              {
                "option": "C",
                "answer": "Berlin",
                "correct": false
              },
              {
                "option": "D",
                "answer": "Madrid",
                "correct": false
              }
            ]
          }
        ],
        "createdAt": "",
        "updatedAt": ""
      }
    ]
}
}
Status Code:400
{
    "success" : false
    "message": "Quiz failed to obtain"
}
Status Code: 500
{
    "success": false,
    "message": "Internal Server Error",
}

Get Quiz Detail

  • Auth : Required

  • Method : GET

  • URL : /quizzes/{{ quizId }}

  • Headers : Authorization : Bearer <token>

  • Response:

Status Code: 201
{
    "success" : true
    "message" : "Quiz obtain succesfully"
    "data" :
    {
    "_id": "",
    "score": "",
    "type" : "number/alphabet"
    "questions": [
        {
            "question": "",
            "urlImage": "",
            "userAnswer": "",
            "answers": [
        {
            "option": "A",
            "answer": "Paris",
            "correct": true
        },
        {
            "option": "B",
            "answer": "Londres",
            "correct": false
        },
        {
            "option": "C",
            "answer": "Berlin",
            "correct": false
        },
        {
            "option": "D",
            "answer": "Madrid",
            "correct": false
        }
    ]
    }
    ],
    "createdAt": "",
    "updatedAt": ""
}
}
Status Code:400
{
    "success" : false
    "message": "Quiz failed to obtain"
}
Status Code: 500
{
    "success": false,
    "message": "Internal Server Error",
}