Report API - masai-oss/Masai_Refresh GitHub Wiki

Report question

PATCH /api/question/report/:id // user can report a question only once.

PARAMS

  • Header: Bearer Token
  • PARAMS: Id // question id
  • Body:
{
    reason: ["Question Unclear", "Wrong Options", "Insufficient Data", "Explanation not clear"] // length : min 1, max 4,
    description: "Lorem ipsum, Lorem ipsum" // length : min 1, max: 255
}

RESPONSE

Success : (Status Code: 200)

    { 
       error: false, 
       message: "Successfully Reported"
    }

Failure : (Status code: 400)

    {
      error: true,
      message: "Something Went Wrong",
      reason: err,
    }

Get All Reports

GET /api/question/report // Only accessed by Admin

PARAMS

  • Header: Bearer Token

RESPONSE

Success : (Status Code: 200)

   {
    
    "error": false,
    "data": [
        {
            "status": {
                "solved": false,
                "by": null,
                "description": null,
                "time": null
            },
            "reason": [
                "Question Unclear",
                "Wrong Options",
                "Insufficient Data",
                "Explanation not clear"
            ],
            "_id": "605856cddb63dea5094e582c", // Report Id
            "description": "Lorem ipsum, Lorem ipsum",
            "user_id": "605588c023c97f7141c574e0",
            "time": "2021-03-22T08:35:25.665Z",
            "name": "NODE_JS"
        },
        {
            "status": {
                "solved": false,
                "by": null,
                "description": null,
                "time": null
            },
            "reason": [
                "Question Unclear",
                "Wrong Options",
                "Insufficient Data",
                "Explanation not clear"
            ],
            "_id": "6058534c5e00fda09fa42315", // Report Id
            "description": "Lorem ipsum, Lorem ipsum",
            "user_id": "605588c023c97f7141c574e0",
            "questionId": "60560aa2316a9fbe18377599",
            "time": "2021-03-22T08:20:28.815Z",
            "name": "HTML"
        }]
    }

Success : (Status Code: 200) // If no report present

    {
        error: false,
        message: "There are no reports",
    }

Failure : (Status code: 400)

    {
      error: true,
      reason: err,
    }

Get Reported Question By Report Id

GET /api/question/reportedQuestion/:id // Only accessed by Admin

PARAMS

  • Header: Bearer Token
  • Params: Id // Report Id

RESPONSE

Success : (Status Code: 200)

    { 
       error: false, 
       question: question(SHORT || TF || MCQ) 
    }

Failure : (Status code: 400)

    {
      error: true,
      reason: err,
    }

Solve Report

PATCH /api/question/solveReport/:id // Only accessed by Admin

PARAMS

  • Header: Bearer Token
  • Params: Id // Report Id
  • Body:
{
    "description": "Statement mentioning solution reason"
}

RESPONSE

Success : (Status Code: 200)

    { 
       error: false, 
       "message": "Report solved successfully"
    }

Failure : (Status code: 400)

    {
      error: true,
      reason: err,
    }