Skip to content

Admin GetStudents

Vaishakh GK edited this page Apr 29, 2023 · 8 revisions

Get Students

Route Used to get students details.

URL : /api/admin/get-students

Method : GET

Auth Required : YES

Query

search : To specify find student based on what

mandatory

value : Value that can be used to identify the student

mandatory

status : To specify the status of student

if status is not passed it will search students with all status


Example query

http://localhost:9000/api/admin/get-students?search=admissionNo&&value=1

Success Response

Code : 200 OK

Content example

[
  {
    "_id": "6448bebb5161a7d2c2d8b79e",
    "aadhaarNo": "1234 5678 9012",
    "admissionDate": "21-04-2023",
    "admissionNo": 1,
    "applicationNo": 1,
    "caste": "Nair",
    "category": "General",
    "class": 11,
    "course": "PCMB",
    "dob": "15-05-2005",
    "gender": "Male",
    "name": "Amit Kumar",
    "nameOfParent": "Rajesh Kumar",
    "occupationOfParent": "Businessman",
    "phone": 9876543210,
    "qualifyingExamDetails": {
      "nameOfBoard": "CBSE",
      "passingTime": "March-2023",
      "registerNo": 3456
    },
    "relationshipWithGuardian": "Father",
    "religion": "Hindu",
    "secondLanguage": "Hindi",
    "status": "permanent",
    "tcDetailsOnAdmission": {
      "date": "20-04-2023",
      "number": "TC-2023-XYZ",
      "school": "ABC High School"
    }
  }
]

Error Response

Condition : Not Logged In as admin.

Code : 401 Unauthorized

Content :

"Not Logged In"

Condition : Server Error

Code : 500 Internal Server Error

Content :

"Request failed"

Clone this wiki locally