Skip to content

Latest commit

 

History

History
1963 lines (1879 loc) · 53 KB

API_DOCS.md

File metadata and controls

1963 lines (1879 loc) · 53 KB

API Documentation

User Endpoints /users

1. Get Message to Sign

GET /session/get-message-to-sign/:walletAddress

  • Description: Retrieves a message for the user to sign. This message is generated using the provided wallet address and will be used for session authentication.
  • Parameters:
    • walletAddress (string, required): The wallet address of the user.
  • Middleware:
    • validateRequest: Validates the walletAddress parameter to ensure it meets the required format.
  • Response:

    • 200 OK: Returns the generated message for signing.

      {
  "message": "0liaatB62qqVs4eJbEFKLHLt4VeneazmpBajJkHyC9nFTvj9PDnZkeePJpcVz"
}

    • 400 Bad Request: Wallet address is missing or invalid.

      {
  "message": "Wallet address is required"
}

    • 500 Internal Server Error: Server encountered an unexpected error.

      {
  "message": "Internal server error"
}

2. Register User

POST /register

  • Description: Registers a new user or logs in an existing user. This process involves verifying the provided signature and associating it with the user's wallet address.
  • Body: 
    {
  "walletAddress": "B62qqVs4eJbEFKLHLt4VeneazmpBajJkHyC9nFTvj9PDnZkeePJpcVz",
  "signature": {
      "field": "12859573947900662149645682361760179861575462838272703039731442082711813003129",
      "scalar": "375304190722010790954289571569010696976451004955850209127840435539089126739"
  }
}
    • signature (string, required): The signature of the user for verification.
    • walletAddress (string, required): The wallet address of the user.
  • Headers:
    • Session-Token (Bearer Token, required): Token used to validate the session.
  • Middleware:
    • validateSessionToken: Checks for the presence of a valid session token.
    • validateRequest: Ensures the request body contains valid signature and walletAddress fields.
    • verifyUserSignature: Verifies the provided signature matches the generated message.
  • Response:
    • 201 Created: User successfully registered or logged in. 
      {
  "success": true,
  "session": {
    "userId": "6724c914bd890efb03a9166f",
    "walletAddress": "B62qqVs4eJbEFKLHLt4VeneazmpBajJkHyC9nFTvj9PDnZkeePJpcVz",
    "isAdmin": false
  },
  "user": {
    "isAdmin": false,
    "_id": "6724c914bd890efb03a9166f",
    "username": "B62qqVs4eJbEFKLHLt4VeneazmpBajJkHyC9nFTvj9PDnZkeePJpcVz",
    "walletAddress": "B62qqVs4eJbEFKLHLt4VeneazmpBajJkHyC9nFTvj9PDnZkeePJpcVz",
    "__v": 0,
    "email": "abc@example.com",
    "updatedAt": "2024-11-21T17:41:02.419Z"
  }
}
    • 400 Bad Request: Invalid signature or missing required fields. 
      {
  "success": false,
  "message": "Invalid signature"
}
    • 401 Unauthorized: Session token is missing or invalid. 
      {
  "message": "No session token found"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

3. Register User (Development Mode)

POST /register/dev

  • Description: Registers a new user in development mode. This endpoint bypasses session token and signature validation.
  • Body:
    • Same as /register.
  • Middleware:
    • None (this endpoint bypasses middleware checks in development mode).
  • Response:
    • 201 Created: User successfully registered.
    • 500 Internal Server Error: Server encountered an unexpected error.

4. Get Session

GET /session

  • Description: Retrieves the current session information for the authenticated user.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Middleware:
    • None.
  • Response:
    • 200 OK: Returns the session information. 
      {
  "success": true,
  "session": {
    "userId": "66fa6bb1c58f93ea0cd0912c",
    "walletAddress": "Z62aa9ssZH8zQaasVr53ApUBrtwt8odZ7hXVXguhq6udpUYQVbRnpVJ",
    "isAdmin": false
  }
}
    • 401 Unauthorized: No active session found. 
      {
  "message": "No active session"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

5. Logout

POST /logout

  • Description: Logs out the authenticated user by destroying the current session.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Middleware:
    • ensureAuthenticated: Ensures the user is authenticated before proceeding.
  • Response:
    • 200 OK: User successfully logged out. 
      {
  "success": true,
  "message": "Logged out"
}
    • 500 Internal Server Error: Failed to destroy the session. 
      {
  "message": "Failed to logout"
}

6. Get All Users

GET /

  • Description: Retrieves a list of all registered users. This endpoint is restricted to admin users.
  • Headers:
    • Session-Token (Bearer Token, required): Admin authentication token.
  • Middleware:
    • ensureAuthenticated: Ensures the user is authenticated.
    • ensureAdmin: Ensures the user has admin privileges.
  • Response:
    • 200 OK: Returns a list of users. 
      [
  {
    "isAdmin": false,
    "_id": "66cf70cb320d7d2190ce0d68",
    "username": "B62aa9ssZH8zQaasVr53ApUBrtwt8odZ7hXVXguhq6udpUYQVbRnpVJ",
    "walletAddress": "B62aa9ssZH8zQaasVr53ApUBrtwt8odZ7hXVXguhq6udpUYQVbRnpVJ",
    "__v": 0,
    "email": "def@example.com"
  },
  {
    "isAdmin": false,
    "_id": "66fa6bb1c58f93ea0cd0912c",
    "username": "B62qmCGGG98iPmNEeFLByG3tPdnR6UvVvrXbkDPAC7DYJUvJVHFm1B3",
    "email": "abc@example.com",
    "walletAddress": "B62qmCGGG98iPmNEeFLByG3tPdnR6UvVvrXbkDPAC7DYJUvJVHFm1B3",
    "__v": 0,
    "updatedAt": "2024-11-21T13:29:29.833Z"
  }
]
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 403 Forbidden: User does not have admin privileges. 
      {
  "message": "Admin access required"
}
    • 404 Not Found: No users found. 
      {
  "message": "No users found"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

7. Update Email

POST /put/email

  • Description: Updates the email address of the authenticated user.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Body: 
      {
    "email": "example@example.com"
  }
    • email (string, required): New email address of the user.
  • Middleware:
    • ensureAuthenticated: Ensures the user is authenticated.
    • validateRequest: Validates the email field in the request body.
    • validateRequestedEmail: Ensures the provided email is in a valid format.
  • Response:
    • 200 OK: Email updated successfully. 
      {
  "message": "Email updated successfully"
}
    • 400 Bad Request: Invalid or missing email format. 
      {
  "error": "ValidationException",
  "message": "Validation failed",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email input"
    }
  ]
}
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

Exam Endpoints /exams

1. Create Exam

POST /create

  • Description: Creates a new exam along with its metadata and questions. Rewarded exams require additional fields for rewards configuration.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Body: 
    {
    "title": "Testing Exam",
    "description": "This is a description",
    "questions": [
      {
        "number": 1,
        "text": "Bqqnt",
        "difficulty": 1,
        "options": [
          {
            "number": 1,
            "text": "Nsaaikep"
          },
          {
            "number": 2,
            "text": "Alexiod"
          },
          {
            "number": 3,
            "text": "John IIs"
          },
          {
            "number": 4,
            "text": "Manuel Is"
          },
          {
            "number": 5,
            "text": "Manuel IIss"
          }
        ],
        "correctAnswer": 2
      },
      {
        "number": 2,
        "text": "Ottwqqoman",
        "difficulty": 5,
        "options": [
          {
            "number": 1,
            "text": "Bayasaaad I"
          },
          {
            "number": 2,
            "text": "Mehdsdsmed I"
          },
          {
            "number": 3,
            "text": "Murad II"
          },
          {
            "number": 4,
            "text": "Mehmed II"
          },
          {
            "number": 5,
            "text": "Mehmed III"
          }
        ],
        "correctAnswer": 2
      }
    ],
    "startDate": "2025-02-19T16:30:50.244Z",
    "duration": 2,
    "rootHash": "0x0",
    "secretKey": "SIOSDajksa",
    "questionCount": 3,
    "isPrivate": false,
    "isWinnerlistRequested": true,
    "isRewarded": true,
    "contractAddress": "0x0",
    "rewardPerWinner": 1,
    "passingScore": 80,
    "deployJobId": "zkCWuZbPl0YFGXdtbf3Z2jgZOyYFpnzvZHQDJjP0rQTSfVqw"
  }

    • title (string, required): Title of the exam.

    • description (string, required): Description of the exam.

    • startDate (string, required): Starting date and time of the exam (ISO format).

    • duration (number, required): Duration of the exam in minutes.

    • rootHash (string, required): Root hash of the exam.

    • secretKey (string, required): Secret key for verifying exam participation.

    • questionCount (number, required): Number of questions in the exam.

    • questions (array of objects, required): List of questions in the exam.

      • number (number, required): The question number.
      • text (string, required): The question text.
      • difficulty (number, optional): The question difficulty (between 1-5).
      • options (array of objects, required): List of answer options.
        • number (number, required): The option number.
        • text (string, required): The option text.
      • correctAnswer (number, required): The correct option number.

    • isPrivate (boolean, required): Indicates whether the exam is private.

    • isWinnerlistRequested (boolean, required): Indicates if the list of winners is requested.

    • Optional fields for rewarded exams:

      • isRewarded (boolean, optional): Indicates whether the exam offers rewards.
      • rewardPerWinner (number, optional): Reward amount per winner (required if isRewarded is true).
      • passingScore (number, optional): Minimum score required to win (required if isRewarded is true).
      • deployJobId (string, optional): Deployment job ID (required if isRewarded is true).
      • contractAddress (string, optional): Smart contract address (required if isRewarded is true).
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • validateRequest: Validates the request body.
  • Response:
    • 201 Created: Exam successfully created. 
      {
  "creator": "66fa6bb1c58f93ea0cd0912c",
  "title": "Testing Exam",
  "description": "This is a description",
  "startDate": "2025-01-30T10:09:43.547Z",
  "duration": 10,
  "rootHash": "0x0",
  "secretKey": "SIOSDajksa",
  "questionCount": 3,
  "isRewarded": true,
  "rewardPerWinner": 1,
  "passingScore": 80,
  "contractAddress": "0x0",
  "deployJobId": "zkCWuZbPl0YFGXdtbf3Z2jgZOyYFpnzvZHQDJjP0rQTSfVqw",
  "isCompleted": false,
  "isDistributed": false,
  "isPrivate": false,
  "isWinnerlistRequested": true,
  "_id": "679b4fe7feb5dfd7e868e5f9",
  "createdAt": "2025-01-30T10:09:43.580Z",
  "updatedAt": "2025-01-30T10:09:43.580Z",
  "__v": 0
}
    • 400 Bad Request: Missing or invalid data. 
      {
  "error":"ValidationException",
  "message":"Validation failed",
  "errors":
  [
    {
      "field":"title",
      "message":"Title must be at least 3 characters"
    },
    {
      "field":"duration",
      "message":"Expected number, received string"
    }
  ]
}
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

2. Generate Exam Links

POST /generateExamLinks

  • Description: Generates unique participation links for an exam and emails them to participants.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Body: 
    {
  "examId": "679ba93a31ae46ad07b67085",
  "emailList": [
    "abc@example.com",
    "xvyz@example.com"
  ]
}
    • examId (string, required): ID of the exam.
    • emailList (array of strings, required): List of participant emails.
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • validateRequest: Validates the request body.
  • Response:
    • 201 Created: Links successfully generated and sent to participants. 
      {
  "success": true,
  "result": [
    {
      "email": "abc@example.com",
      "link": "https://choz.io/app/exams/get-started/679b5278feb5dfd7e868e710/4ee0f073-31a9-42f3-9033-b146785469e0"
    },
    {
      "email": "def@mexample.com",
      "link": "https://choz.io/app/exams/get-started/679b5278feb5dfd7e868e710/9cee46cc-435d-4b7b-adee-d54d990e88b8"
    }
  ]
}
    • 400 Bad Request: Invalid exam ID or email list. 
      {
  "error": "ValidationException",
  "message": "Validation failed",
  "errors": [
    {
      "field": "examId",
      "message": "Invalid ObjectId format"
    }
  ]
}
    • 403 Forbidden: User is not the creator of the exam. 
      {
  "message": "Only creator can access"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

3. Get Created Exams

GET /myExams/created

  • Description: Retrieves all exams created by the authenticated user.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Query Parameters:
    • filter (string, optional): all, upcoming, active, or ended (default: all).
    • sortBy (string, optional): Field to sort by (e.g., startDate, duration, title, default: createdAt).
    • sortOrder (string, optional): asc or desc (default: asc).
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
  • Response:
    • 200 OK: Returns the list of created exams. 
      [
  {
    "_id": "673f369944e8c1ef46638105",
    "title": "Testing Exam",
    "description": "This is a description",
    "startDate": "2024-11-21T13:32:57.000Z",
    "duration": 2,
    "endDate": "2024-11-21T13:34:57.000Z",
    "totalParticipants": 25,
    "status": "ended",
    "pincode": "U2XT0H"
  }
]
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

4. Get Joined Exams

GET /myExams/joined

  • Description: Retrieves all exams that the authenticated user has participated in.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Query Parameters:
    • filter (string, optional): all, active, or ended (default: all).
    • sortBy (string, optional): Field to sort by (e.g., startDate, duration, title, default: createdAt).
    • sortOrder (string, optional): asc or desc (default: asc).
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
  • Response:
    • 200 OK: Returns the list of joined exams. 
      [
  {
    "_id": "673f369944e8c1ef46638105",
    "title": "Testing Exam",
    "description": "This is a description",
    "examStartDate": "2024-11-21T13:32:57.000Z",
    "examEndDate": "2024-11-21T13:34:57.000Z",
    "examDuration": 2,
    "examFinishedAt": "2024-11-21T13:34:57.000Z",
    "status": "ended",
    "userStartedAt": "2024-11-21T13:33:00.000Z",
    "userFinishedAt": "2024-11-21T13:34:30.000Z",
    "userDurationAsSeconds": 90,
    "userScore": 85,
    "userNickName": "User123",
    "pincode": "U2XT0H"
  }
]
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

5. Get Exam by ID

GET /:id

  • Description: Retrieves details of a specific exam by its ID, including participation information for the authenticated user.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Parameters:
    • id (string, required): ID of the exam.
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • validateRequest: Validates the request parameters against examSchemas.params.
  • Response:
    • 200 OK: Returns exam details and participation information. 
      {
  "exam": {
    "_id": "679b5278feb5dfd7e868e710",
    "creator": "66fa6bb1c58f93ea0cd0912c",
    "title": "Testing Exam",
    "description": "This is a description",
    "startDate": "2025-01-30T10:20:40.881Z",
    "duration": 10,
    "rootHash": "0x0",
    "secretKey": "SIOSDajksa",
    "questionCount": 3,
    "isRewarded": true,
    "rewardPerWinner": 1,
    "passingScore": 80,
    "contractAddress": "0x0",
    "deployJobId": "zkCWuZbPl0YFGXdtbf3Z2jgZOyYFpnzvZHQDJjP0rQTSfVqw",
    "isCompleted": true,
    "isDistributed": false,
    "isPrivate": false,
    "isWinnerlistRequested": true,
    "createdAt": "2025-01-30T10:20:40.899Z",
    "updatedAt": "2025-01-30T10:30:56.147Z",
    "__v": 0
  },
  "participatedUser": {
    "_id": "679b5385feb5dfd7e868e796",
    "user": "66fa6bb1c58f93ea0cd0912c",
    "exam": "679b5278feb5dfd7e868e710",
    "nickname": "bertrand-du-guesclin",
    "isFinished": true,
    "isWinner": false,
    "isRewardSent": false,
    "isMailSent": true,
    "jobAdded": true,
    "createdAt": "2025-01-30T10:25:09.870Z",
    "updatedAt": "2025-01-30T10:31:03.482Z",
    "__v": 0,
    "finishTime": "2025-01-30T10:29:01.651Z"
  }
}
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 404 Not Found: Exam not found. 
      {
  "message": "Exam not found"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

6. Get Exam Details

GET /:id/details

  • Description: Retrieves detailed information about a specific exam. Includes metadata, participants, winner list, and leaderboard if applicable.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Parameters:
    • id (string, required): The ID of the exam.
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • validateRequest: Validates the request parameters.
  • Response:
    • 200 OK: Returns detailed exam information. 
      {
  "_id": "679b5278feb5dfd7e868e710",
  "creator": "66fa6bb1c58f93ea0cd0912c",
  "title": "Testing Exam",
  "description": "This is a description",
  "startDate": "2025-01-30T10:20:40.881Z",
  "duration": 10,
  "rootHash": "0x0",
  "secretKey": "SIOSDajksa",
  "questionCount": 3,
  "isRewarded": true,
  "rewardPerWinner": 1,
  "passingScore": 80,
  "contractAddress": "0x0",
  "deployJobId": "zkCWuZbPl0YFGXdtbf3Z2jgZOyYFpnzvZHQDJjP0rQTSfVqw",
  "isCompleted": true,
  "isDistributed": false,
  "isPrivate": false,
  "isWinnerlistRequested": true,
  "createdAt": "2025-01-30T10:20:40.899Z",
  "updatedAt": "2025-01-30T10:30:56.147Z",
  "__v": 0,
  "winnerlist": [],
  "participants": [
    {
      "finishTime": "2025-01-30T10:29:01.651Z",
      "userId": "66fa6bb1c58f93ea0cd0912c",
      "nickname": "Z62aa9ssZH8zQaasVr53ApUBrtwt8odZ7hXVXguhq6udpUYQVbRnpVJ",
      "walletAddress": "Z62aa9ssZH8zQaasVr53ApUBrtwt8odZ7hXVXguhq6udpUYQVbRnpVJ",
      "score": 0
    }
  ],
  "leaderboard": [
    {
      "nickname": "The Night Fury",
      "score": 0,
      "finishTime": "2025-01-30T10:29:01.651Z"
    }
  ]
}
    • 403 Forbidden: User is not the creator of the exam. 
      {
  "message": "Only creator can access"
}
    • 404 Not Found: Exam not found. 
      {
  "message": "Exam not found"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

7. Start Exam

POST /startExam

  • Description: Starts an exam for the authenticated user. Private exams require a valid passcode for participation.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Body: 
    {
  "examId": "679ba93a31ae46ad07b67085",
  "passcode": "ffb3051d-dbf4-4bc7-9978-e6d353143982",
  "nickname": "The Night Fury"
}
    • examId (string, required): ID of the exam.
    • passcode (string, optional): Passcode for private exams.
    • nickname (string, optional): Nickname for the exam.
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • validateRequest: Validates the request body.
  • Response:
    • 200 OK: Exam started successfully. 
      {
  "message": "Exam participation created successfully"
}
    • 400 Bad Request: Invalid passcode or exam timing. 
      {
  "message": "Invalid passcode"
}
      {
  "message": "Exam has not started yet"
}
    • 404 Not Found: Exam not found. 
      {
  "message": "Exam not found"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

8. Finish Exam

POST /finishExam

  • Description: Submits the user's answers and marks the exam as completed. Calculates the user's score and updates their participation status.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Body: 
    {
  "examId": "679ba93a31ae46ad07b67085",
  "answers": [
    {
      "questionId": "questionId1",
      "answer": 1
    },
    {
      "questionId": "questionId2",
      "answer": 2
    }
  ]
}
    • examId (string, required): ID of the exam.
    • answers (array, required): User's answers to the exam questions.
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • validateRequest: Validates the request body.
  • Response:
    • 200 OK: Exam finished successfully. 
      {
  "message":"Exam completed successfully"
}
    • 400 Bad Request: Missing or invalid answers. 
      {
  "message": "Invalid answers"
}
    • 404 Not Found: Exam or participation not found. 
      {
"message": "User does not have participated in the exam"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Error finishing exam and submitting answers"
}

Draft Endpoints /drafts

1. Create Draft

POST /

  • Description: Creates a new draft for the authenticated user.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Body: 
    {
  "title": "Festing Exam",
  "description": "This is a description",
  "questions": [
    {
      "number": 1,
      "text": "Bqqnt",
      "options": [
        {
          "number": 1,
          "text": "Nsaaikep"
        },
        {
          "number": 2,
          "text": "Alexiod"
        },
        {
          "number": 3,
          "text": "John IIs"
        },
        {
          "number": 4,
          "text": "Manuel Is"
        },
        {
          "number": 5,
          "text": "Manuel IIss"
        }
      ],
      "difficulty": 2,
      "correctAnswer": 2
    },
    {
      "number": 2,
      "text": "Ottwqqoman",
      "options": [
        {
          "number": 1,
          "text": "Bayasaaad I"
        },
        {
          "number": 2,
          "text": "Mehdsdsmed I"
        },
        {
          "number": 3,
          "text": "Murad II"
        },
        {
          "number": 4,
          "text": "Mehmed II"
        },
        {
          "number": 5,
          "text": "Mehmed III"
        }
      ],
      "difficulty": 3,
      "correctAnswer": 2
    }
  ],
  "startDate": "2025-02-03T14:47:24.613Z",
  "duration": 20,
  "questionCount": 3,
  "isPrivate": false,
  "isWinnerlistRequested": false,
  "isRewarded": true,
  "rewardPerWinner": 1,
  "passingScore": 80
}
    • title (string, required): Title of the draft.
    • description (string, optional): Description of the draft.
    • startDate (string, optional): Starting date of the draft (ISO format).
    • duration (number, optional): Duration of the draft in minutes.
    • questionCount (number, optional): Number of questions in the draft.
    • isRewarded (boolean, optional): Indicates if the draft includes rewards.
    • rewardPerWinner (number, optional): Reward amount per winner (required if isRewarded is true).
    • passingScore (number, optional): Minimum score required to win (required if isRewarded is true).
    • questions (array, optional): List of questions with options and correct answers.
      • number (number, required): The question number.
      • text (string, required): The question text.
      • difficulty (number, optional): The question difficulty (between 1-5).
      • options (array of objects, required): List of answer options.
        • number (number, required): The option number.
        • text (string, required): The option text.
      • correctAnswer (number, required): The correct option number.
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • validateRequest: Validates the request body.
  • Response:
    • 201 Created: Draft successfully created. 
      {
  "creator": "67a207a94fda98d75cac8513",
  "title": "Festing Exam",
  "description": "This is a description",
  "startDate": "2025-02-03T14:47:24.613Z",
  "duration": 20,
  "questionCount": 3,
  "isRewarded": true,
  "rewardPerWinner": 1,
  "passingScore": 80,
  "isPrivate": false,
  "questions": [
    {
      "text": "Bqqnt",
      "difficulty": 2,
      "options": [
        {
          "number": 1,
          "text": "Nsaaikep",
          "_id": "67a208a94fda98d75cac859c"
        },
        {
          "number": 2,
          "text": "Alexiod",
          "_id": "67a208a94fda98d75cac859d"
        },
        {
          "number": 3,
          "text": "John IIs",
          "_id": "67a208a94fda98d75cac859e"
        },
        {
          "number": 4,
          "text": "Manuel Is",
          "_id": "67a208a94fda98d75cac859f"
        },
        {
          "number": 5,
          "text": "Manuel IIss",
          "_id": "67a208a94fda98d75cac85a0"
        }
      ],
      "correctAnswer": 2,
      "number": 1,
      "_id": "67a208a94fda98d75cac859b"
    },
    {
      "text": "Ottwqqoman",
      "difficulty": 2,
      "options": [
        {
          "number": 1,
          "text": "Bayasaaad I",
          "_id": "67a208a94fda98d75cac85a2"
        },
        {
          "number": 2,
          "text": "Mehdsdsmed I",
          "_id": "67a208a94fda98d75cac85a3"
        },
        {
          "number": 3,
          "text": "Murad II",
          "_id": "67a208a94fda98d75cac85a4"
        },
        {
          "number": 4,
          "text": "Mehmed II",
          "_id": "67a208a94fda98d75cac85a5"
        },
        {
          "number": 5,
          "text": "Mehmed III",
          "_id": "67a208a94fda98d75cac85a6"
        }
      ],
      "correctAnswer": 2,
      "number": 2,
      "_id": "67a208a94fda98d75cac85a1"
    }
  ],
  "_id": "67a208a94fda98d75cac859a",
  "createdAt": "2025-02-04T12:31:37.589Z",
  "updatedAt": "2025-02-04T12:31:37.589Z",
  "__v": 0
}
    • 400 Bad Request: Missing or invalid data. 
      {
  "error": "ValidationException",
  "message": "Validation failed",
  "errors": [
    {
      "field": "title",
      "message": "Title must be at least 3 characters"
    }
  ]
}
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

2. Get All Drafts

GET /

  • Description: Retrieves all drafts created by the authenticated user, with optional pagination and sorting.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • validateRequest: Validates the query parameters against draftSchemas.query.
  • Response:
    • 200 OK: Returns a list of drafts. 
      [
  {
    "_id": "67a208a94fda98d75cac859a",
    "creator": "67a207a94fda98d75cac8513",
    "title": "Festing Exam",
    "description": "This is a description",
    "startDate": "2025-02-03T14:47:24.613Z",
    "duration": 20,
    "questionCount": 3,
    "isRewarded": true,
    "rewardPerWinner": 1,
    "passingScore": 80,
    "isPrivate": false,
    "questions": [
      {
        "text": "Bqqnt",
        "difficulty": 2,
        "options": [
          {
            "number": 1,
            "text": "Nsaaikep",
            "_id": "67a208a94fda98d75cac859c"
          },
          {
            "number": 2,
            "text": "Alexiod",
            "_id": "67a208a94fda98d75cac859d"
          },
          {
            "number": 3,
            "text": "John IIs",
            "_id": "67a208a94fda98d75cac859e"
          },
          {
            "number": 4,
            "text": "Manuel Is",
            "_id": "67a208a94fda98d75cac859f"
          },
          {
            "number": 5,
            "text": "Manuel IIss",
            "_id": "67a208a94fda98d75cac85a0"
          }
        ],
        "correctAnswer": 2,
        "number": 1,
        "_id": "67a208a94fda98d75cac859b"
      },
      {
        "text": "Ottwqqoman",
        "difficulty": 3,
        "options": [
          {
            "number": 1,
            "text": "Bayasaaad I",
            "_id": "67a208a94fda98d75cac85a2"
          },
          {
            "number": 2,
            "text": "Mehdsdsmed I",
            "_id": "67a208a94fda98d75cac85a3"
          },
          {
            "number": 3,
            "text": "Murad II",
            "_id": "67a208a94fda98d75cac85a4"
          },
          {
            "number": 4,
            "text": "Mehmed II",
            "_id": "67a208a94fda98d75cac85a5"
          },
          {
            "number": 5,
            "text": "Mehmed III",
            "_id": "67a208a94fda98d75cac85a6"
          }
        ],
        "correctAnswer": 2,
        "number": 2,
        "_id": "67a208a94fda98d75cac85a1"
      }
    ],
    "createdAt": "2025-02-04T12:31:37.589Z",
    "updatedAt": "2025-02-04T12:31:37.589Z",
    "__v": 0
  }
]
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

3. Get Draft by ID

GET /:id

  • Description: Retrieves a specific draft by its ID.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Parameters:
    • id (string, required): ID of the draft.
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • validateRequest: Validates the request parameters.
  • Response:
    • 200 OK: Returns the draft details. 
      {
  "_id": "67a20af24fda98d75cac86bf",
  "creator": "67a207a94fda98d75cac8513",
  "title": "Festing Exam",
  "description": "This is a description",
  "startDate": "2025-02-03T14:47:24.613Z",
  "duration": 20,
  "questionCount": 3,
  "isRewarded": true,
  "rewardPerWinner": 1,
  "passingScore": 80,
  "isPrivate": false,
  "questions": [
    {
      "text": "Bqqnt",
      "difficulty": 2,
      "options": [
        {
          "number": 1,
          "text": "Nsaaikep",
          "_id": "67a20af24fda98d75cac86c1"
        },
        {
          "number": 2,
          "text": "Alexiod",
          "_id": "67a20af24fda98d75cac86c2"
        },
        {
          "number": 3,
          "text": "John IIs",
          "_id": "67a20af24fda98d75cac86c3"
        },
        {
          "number": 4,
          "text": "Manuel Is",
          "_id": "67a20af24fda98d75cac86c4"
        },
        {
          "number": 5,
          "text": "Manuel IIss",
          "_id": "67a20af24fda98d75cac86c5"
        }
      ],
      "correctAnswer": 2,
      "number": 1,
      "_id": "67a20af24fda98d75cac86c0"
    },
    {
      "text": "Ottwqqoman",
      "difficulty": 3,
      "options": [
        {
          "number": 1,
          "text": "Bayasaaad I",
          "_id": "67a20af24fda98d75cac86c7"
        },
        {
          "number": 2,
          "text": "Mehdsdsmed I",
          "_id": "67a20af24fda98d75cac86c8"
        },
        {
          "number": 3,
          "text": "Murad II",
          "_id": "67a20af24fda98d75cac86c9"
        },
        {
          "number": 4,
          "text": "Mehmed II",
          "_id": "67a20af24fda98d75cac86ca"
        },
        {
          "number": 5,
          "text": "Mehmed III",
          "_id": "67a20af24fda98d75cac86cb"
        }
      ],
      "correctAnswer": 2,
      "number": 2,
      "_id": "67a20af24fda98d75cac86c6"
    }
  ],
  "createdAt": "2025-02-04T12:41:22.617Z",
  "updatedAt": "2025-02-04T12:41:22.617Z",
  "__v": 0
}
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 403 Forbidden: User does not have access to the requested draft. 
      {
  "message": "Forbidden"
}
    • 404 Not Found: Draft not found. 
      {
  "message": "Draft not found"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

4. Update Draft

PUT /:id

  • Description: Updates an existing draft by its ID.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Parameters:
    • id (string, required): ID of the draft.
  • Body: 
    {
  "title": "Vesting Exam",
  "duration": 34
}
    • Partial update of draft fields (e.g., title, description, questions).
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • validateRequest: Validates the request parameters and body.
  • Response:
    • 200 OK: Draft updated successfully. 
      {
  "_id": "67a20af24fda98d75cac86bf",
  "creator": "67a207a94fda98d75cac8513",
  "title": "Vesting Exam",
  "description": "This is a description",
  "startDate": "2025-02-03T14:47:24.613Z",
  "duration": 34,
  "questionCount": 3,
  "isRewarded": true,
  "rewardPerWinner": 1,
  "passingScore": 80,
  "isPrivate": false,
  "questions": [
    {
      "text": "Bqqnt",
      "difficulty": 2,
      "options": [
        {
          "number": 1,
          "text": "Nsaaikep",
          "_id": "67a20af24fda98d75cac86c1"
        },
        {
          "number": 2,
          "text": "Alexiod",
          "_id": "67a20af24fda98d75cac86c2"
        },
        {
          "number": 3,
          "text": "John IIs",
          "_id": "67a20af24fda98d75cac86c3"
        },
        {
          "number": 4,
          "text": "Manuel Is",
          "_id": "67a20af24fda98d75cac86c4"
        },
        {
          "number": 5,
          "text": "Manuel IIss",
          "_id": "67a20af24fda98d75cac86c5"
        }
      ],
      "correctAnswer": 2,
      "number": 1,
      "_id": "67a20af24fda98d75cac86c0"
    },
    {
      "text": "Ottwqqoman",
      "difficulty": 3,
      "options": [
        {
          "number": 1,
          "text": "Bayasaaad I",
          "_id": "67a20af24fda98d75cac86c7"
        },
        {
          "number": 2,
          "text": "Mehdsdsmed I",
          "_id": "67a20af24fda98d75cac86c8"
        },
        {
          "number": 3,
          "text": "Murad II",
          "_id": "67a20af24fda98d75cac86c9"
        },
        {
          "number": 4,
          "text": "Mehmed II",
          "_id": "67a20af24fda98d75cac86ca"
        },
        {
          "number": 5,
          "text": "Mehmed III",
          "_id": "67a20af24fda98d75cac86cb"
        }
      ],
      "correctAnswer": 2,
      "number": 2,
      "_id": "67a20af24fda98d75cac86c6"
    }
  ],
  "createdAt": "2025-02-04T12:41:22.617Z",
  "updatedAt": "2025-02-04T12:44:05.596Z",
  "__v": 0
}
    • 400 Bad Request: Invalid update data. 
      {
  "error": "ValidationException",
  "message": "Validation failed",
  "errors": [
    {
      "field": "title",
      "message": "Title must be at least 3 characters"
    },
    {
      "field": "duration",
      "message": "Expected number, received string"
    }
  ]
}
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 403 Forbidden: User does not have permission to update the draft. 
      {
  "message": "Forbidden"
}
    • 404 Not Found: Draft not found. 
      {
  "message": "Draft not found"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

5. Delete Draft

DELETE /:id

  • Description: Deletes a specific draft by its ID.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Parameters:
    • id (string, required): ID of the draft.
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • validateRequest: Validates the request parameters.
  • Response:
    • 200 OK: Draft deleted successfully. 
      {
  "message": "Draft deleted successfully"
}
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 403 Forbidden: User does not have permission to delete the draft. 
      {
  "message": "Forbidden"
}
    • 404 Not Found: Draft not found. 
      {
  "message": "Draft not found"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

Question Endpoints /questions

1. Get Question by ID

GET /question/:questionId

  • Description: Retrieves details of a specific question by its ID. This endpoint is restricted to admin users.
  • Headers:
    • Session-Token (Bearer Token, required): Admin authentication token.
  • Parameters:
    • questionId (string, required): The ID of the question to retrieve.
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • ensureAdmin: Ensures the user has admin privileges.
    • validateRequest: Validates the questionId parameter.
  • Response:
    • 200 OK: Question successfully retrieved. 
      {
  "_id": "67a0c73bf658ea9eb6dc8e16",
  "exam": "67a0c73bf658ea9eb6dc8e14",
  "text": "Bqqntiwe",
  "difficulty": 2,
  "options": [
    {
      "number": 1,
      "text": "Nsaaikephoros sII",
      "_id": "67a0c73bf658ea9eb6dc8e17"
    },
    {
      "number": 2,
      "text": "Alexiodsaas Is",
      "_id": "67a0c73bf658ea9eb6dc8e18"
    },
    {
      "number": 3,
      "text": "John IIs",
      "_id": "67a0c73bf658ea9eb6dc8e19"
    },
    {
      "number": 4,
      "text": "Manuel Is",
      "_id": "67a0c73bf658ea9eb6dc8e1a"
    },
    {
      "number": 5,
      "text": "Manuel IIss",
      "_id": "67a0c73bf658ea9eb6dc8e1b"
    }
  ],
  "correctAnswer": 2,
  "number": 1,
  "createdAt": "2025-02-03T13:40:11.032Z",
  "updatedAt": "2025-02-03T13:40:11.032Z",
  "__v": 0
}
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 403 Forbidden: User is not an admin. 
      {
  "message": "Admin access required"
}
    • 404 Not Found: Question not found. 
      {
  "message": "Question not found"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

2. Get Questions by Exam

GET /:examId

  • Description: Retrieves all questions for a specific exam, ensuring the user has proper participation and the exam is active or upcoming.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Parameters:
    • examId (string, required): The ID of the exam for which questions are retrieved.
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • validateRequest: Validates the examId parameter.
  • Response:
    • 200 OK: Questions successfully retrieved. 
      [
  {
    "_id": "679b5278feb5dfd7e868e718",
    "exam": "679b5278feb5dfd7e868e710",
    "text": "Ottwqqoman",
    "difficulty": 2,
    "options": [
      {
        "number": 1,
        "text": "Bayasaaad I",
        "_id": "679b5278feb5dfd7e868e719"
      },
      {
        "number": 2,
        "text": "Mehdsdsmed I",
        "_id": "679b5278feb5dfd7e868e71a"
      },
      {
        "number": 3,
        "text": "Murad II",
        "_id": "679b5278feb5dfd7e868e71b"
      },
      {
        "number": 4,
        "text": "Mehmed II",
        "_id": "679b5278feb5dfd7e868e71c"
      },
      {
        "number": 5,
        "text": "Mehmed III",
        "_id": "679b5278feb5dfd7e868e71d"
      }
    ],
    "createdAt": "2025-01-30T10:20:40.909Z",
    "updatedAt": "2025-01-30T10:20:40.909Z",
    "__v": 0,
    "number": 1
  },
  {
    "_id": "679b5278feb5dfd7e868e71e",
    "exam": "679b5278feb5dfd7e868e710",
    "text": "Bqqntiwe",
    "difficulty": 3,
    "options": [
      {
        "number": 1,
        "text": "Nsaaikhoros sII",
        "_id": "679b5278feb5dfd7e868e71f"
      },
      {
        "number": 2,
        "text": "Alexiodsaas Is",
        "_id": "679b5278feb5dfd7e868e720"
      },
      {
        "number": 3,
        "text": "John IIs",
        "_id": "679b5278feb5dfd7e868e721"
      },
      {
        "number": 4,
        "text": "Manuel Is",
        "_id": "679b5278feb5dfd7e868e722"
      },
      {
        "number": 5,
        "text": "Manuel IIss",
        "_id": "679b5278feb5dfd7e868e723"
      }
    ],
    "createdAt": "2025-01-30T10:20:40.909Z",
    "updatedAt": "2025-01-30T10:20:40.909Z",
    "__v": 0,
    "number": 2
  },
  {
    "_id": "679b5278feb5dfd7e868e712",
    "exam": "679b5278feb5dfd7e868e710",
    "text": "Bqqniwe",
    "difficulty": 2,
    "options": [
      {
        "number": 1,
        "text": "Nsaaikephoros sII",
        "_id": "679b5278feb5dfd7e868e713"
      },
      {
        "number": 2,
        "text": "Alexiodsaas Is",
        "_id": "679b5278feb5dfd7e868e714"
      },
      {
        "number": 3,
        "text": "John IIs",
        "_id": "679b5278feb5dfd7e868e715"
      },
      {
        "number": 4,
        "text": "Manuel Is",
        "_id": "679b5278feb5dfd7e868e716"
      },
      {
        "number": 5,
        "text": "Manuel IIss",
        "_id": "679b5278feb5dfd7e868e717"
      }
    ],
    "createdAt": "2025-01-30T10:20:40.908Z",
    "updatedAt": "2025-01-30T10:20:40.908Z",
    "__v": 0,
    "number": 3
  }
]
    • 400 Bad Request: Exam is not active or timing is invalid. 
      {
  "message": "Exam has not started yet"
}
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 404 Not Found: Exam not found. 
      {
  "message": "Exam not found"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

Answer Endpoints /answers

1. Get My Answers

GET /myAnswers

  • Description: Retrieves the authenticated user's answers for a specific exam.
  • Headers:
    • Session-Token (Bearer Token, required): User authentication token.
  • Body:
    • examId (string, required): The ID of the exam.
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • validateRequest: Validates the request body.
  • Response:
    • 200 OK: Answers successfully retrieved. 
      {
  "_id": "67a0d89006bc9d15832828e8",
  "user": "6724c914bd890efb03a9166f",
  "exam": "67a0d6fc06bc9d15832825b9",
  "answers": [
    {
      "question": "67a0c73bf658ea9eb6dc8e16",
      "selectedOption": "2",
      "answerHash": "293d5daffb609c9f2c7eb4cb17405dfc7f7f2e8886f37a74134333ac5972ea32",
      "_id": "67a0d89006bc9d15832828e9"
    },
    {
      "question": "67a0c73bf658ea9eb6dc8e1c",
      "selectedOption": "2",
      "answerHash": "293d5daffb609c9f2c7eb4cb17405dfc7f7f2e8886f37a74134333ac5972ea32",
      "_id": "67a0d89006bc9d15832828ea"
    },
    {
      "question": "67a0c73bf658ea9eb6dc8e22",
      "selectedOption": "2",
      "answerHash": "293d5daffb609c9f2c7eb4cb17405dfc7f7f2e8886f37a74134333ac5972ea32",
      "_id": "67a0d89006bc9d15832828eb"
    }
  ],
  "createdAt": "2025-02-03T14:54:08.233Z",
  "updatedAt": "2025-02-03T14:54:08.233Z",
  "__v": 0
}
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 404 Not Found: Answers not found for the specified exam. 
      {
  "message": "Answers not found"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

2. Get Answer by ID

GET /answer/:answerId

  • Description: Retrieves a specific answer by its ID. This endpoint is restricted to admin users.
  • Headers:
    • Session-Token (Bearer Token, required): Admin authentication token.
  • Parameters:
    • answerId (string, required): The ID of the answer to retrieve.
  • Middleware:
    • ensureAuthenticated: Ensures the user is logged in.
    • ensureAdmin: Ensures the user has admin privileges.
    • validateRequest: Validates the answerId parameter.
  • Response:
    • 200 OK: Answer successfully retrieved. 
      {
  "_id": "67a0d89006bc9d15832828e8",
  "user": {
    "_id": "6724c914bd890efb03a9166f",
    "username": "B62qqVs4eJbEFKLHLt4VeneazmpBajJkHyC9nFTvj9PDnZkeePJpcVz",
    "walletAddress": "B62qqVs4eJbEFKLHLt4VeneazmpBajJkHyC9nFTvj9PDnZkeePJpcVz"
  },
  "exam": {
    "_id": "67a0d6fc06bc9d15832825b9",
    "title": "Festing Exam"
  },
  "answers": [
    {
      "question": "67a0c73bf658ea9eb6dc8e16",
      "selectedOption": "2",
      "answerHash": "293d5daffb609c9f2c7eb4cb17405dfc7f7f2e8886f37a74134333ac5972ea32",
      "_id": "67a0d89006bc9d15832828e9"
    },
    {
      "question": "67a0c73bf658ea9eb6dc8e1c",
      "selectedOption": "2",
      "answerHash": "293d5daffb609c9f2c7eb4cb17405dfc7f7f2e8886f37a74134333ac5972ea32",
      "_id": "67a0d89006bc9d15832828ea"
    },
    {
      "question": "67a0c73bf658ea9eb6dc8e22",
      "selectedOption": "2",
      "answerHash": "293d5daffb609c9f2c7eb4cb17405dfc7f7f2e8886f37a74134333ac5972ea32",
      "_id": "67a0d89006bc9d15832828eb"
    }
  ],
  "createdAt": "2025-02-03T14:54:08.233Z",
  "updatedAt": "2025-02-03T14:54:08.233Z",
  "__v": 0
}
    • 401 Unauthorized: User is not authenticated. 
      {
  "message": "Unauthorized"
}
    • 403 Forbidden: User is not an admin. 
      {
  "message": "Admin access required"
}
    • 404 Not Found: Answer not found for the specified ID. 
      {
  "message": "Answer not found"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}

Pincode Endpoints /pincode

1. Get Exam ID by Pincode

GET /:pincode

  • Description: Retrieves the exam ID associated with a given pincode. The pincode must be 6 characters long and will be automatically converted to uppercase.
  • Parameters:
    • pincode (string, required): A 6-character alphanumeric pincode.
  • Middleware:
    • validateRequest: Validates the pincode parameter format.
  • Response:
    • 200 OK: Returns the exam ID associated with the pincode. 
      {
  "examId": "679b4fe7feb5dfd7e868e5f9"
}
    • 400 Bad Request: Invalid pincode format. 
      {
  "error": "ValidationException",
  "message": "Validation failed",
  "errors": [
    {
      "field": "pincode",
      "message": "Pincode must be 6 characters long"
    }
  ]
  }
  }
]
}
]
    • 404 Not Found: Pincode not found. 
      {
  "message": "Pincode not found"
}
    • 500 Internal Server Error: Server encountered an unexpected error. 
      {
  "message": "Internal server error"
}