🧑‍🎓Students

This endpoints allow you to read and write students to our database. To register students, make sure you use the corresponding class codes to put them in the correct class in your institution

Get school class list

Returns list of classes created by the school

GET https://dev.api.fees.ng/api/v2/class/list

When registering a student, use the class code from the data to identify the student's class.

200: OK Successfully fetched class list

{
    "data": {
        "classCount": 12,
        "classes": [
            {
                "_id": "63ada4fea611cda692ba233e",
                "name": "entry class A",
                "code": 1,
                "type": "primary",
                "organization": "63ada4fda611cda692ba2336"
            },
            {
                "_id": "63ada4fea611cda692ba2347",
                "name": "Primary 4",
                "code": 10,
                "type": "primary",
                "organization": "63ada4fda611cda692ba2336"
            },
            {
                "_id": "63ada4fea611cda692ba2349",
                "name": "Primary 6",
                "code": 12,
                "type": "primary",
                "organization": "63ada4fda611cda692ba2336"
            },
            {
                "_id": "63ada4fea611cda692ba233f",
                "name": "Preparatory 2",
                "code": 2,
                "type": "primary",
                "organization": "63ada4fda611cda692ba2336"
            },
            {
                "_id": "63ada4fea611cda692ba2344",
                "name": "grade 1",
                "code": 7,
                "type": "primary",
                "organization": "63ada4fda611cda692ba2336"
            },
            {
                "_id": "63ada4fea611cda692ba2346",
                "name": "Primary 3",
                "code": 9,
                "type": "primary",
                "organization": "63ada4fda611cda692ba2336"
            },
            {
                "_id": "63ada4fea611cda692ba2341",
                "name": "Nursery 1",
                "code": 4,
                "type": "primary",
                "organization": "63ada4fda611cda692ba2336"
            },
            {
                "_id": "63ada4fea611cda692ba2340",
                "name": "Pre Nursery",
                "code": 3,
                "type": "primary",
                "organization": "63ada4fda611cda692ba2336"
            },
            {
                "_id": "63ada4fea611cda692ba2342",
                "name": "Nursery 2",
                "code": 5,
                "type": "primary",
                "organization": "63ada4fda611cda692ba2336"
            },
            {
                "_id": "63ada4fea611cda692ba2343",
                "name": "Nursery 3",
                "code": 6,
                "type": "primary",
                "organization": "63ada4fda611cda692ba2336"
            },
            {
                "_id": "63ada4fea611cda692ba2348",
                "name": "Primary 5",
                "code": 11,
                "type": "primary",
                "organization": "63ada4fda611cda692ba2336"
            },
            {
                "_id": "63ada4fea611cda692ba2345",
                "name": "Grade 2",
                "code": 8,
                "type": "primary",
                "organization": "63ada4fda611cda692ba2336"
            }
        ]
    },
    "status": "success"
}

Registering a new student

Register a new student

POST https://dev.api.fees.ng/api/v2/student/register

This Endpoint is used to register students. It allows you to send multiple records at a time. If you are registering only one student, send only item in the students array

Request Body

Name	Type	Description
students*	Array	An array of student records to be created. Each student record should have these compulsory fields regNumber (String), fullName (String), gender(String), classCode(Number)
regNumber	String	Student's unique Identifier. Should not container special characters and spaces
fullName	String	Students full name
gender	String	Value can either be male or female
classCode	String	Class code gotten from the class list Endpoint

200 If supplied students already exists. Validation is done with reg number

{
    "message": "All students Records Are Up To Date",
    "status": "success"
}

404: Not Found If school does not have any session

201: Created Student successfully registered

Updating an existing student

Update student profile

PATCH https://dev.api.fees.ng/api/v2/student/update-record/:regNumber

Only gender and full names can be edited via the API. Admin should be contacted if any other field requires change. It is important to make sure the reg numbers are correct

Path Parameters

Name	Type	Description
regNumber*	String	Student reg number

Request Body

Name	Type	Description
fullName	String	Student's full name
gender	String	Value can either be male or female

Get students list

Fetch student records

GET https://dev.api.fees.ng/api/v2/student/list

This endpoint returns students record. Maximum records per page is 100

Query Parameters

Name	Type	Description
filteredByClass		Value to filter by class
search	String	Search value. this searches the full name and reg number fields
pageNumber	String	Page number. Default is 1 if nothing is passed
filteredByGraduated	String	Value is false by default

200: OK Successfully fetched students records

{
    "data": {
        "page": 1,
        "pages": 1,
        "studentCount": 18,
        "students": [
            {
                "_id": "65699d803ded06d9ecfef473",
                "fullName": "Test chinedu one",
                "regNumber": "FN2200030",
                "gender": "male",
                "class": {
                    "_id": "63ada4fea611cda692ba233e",
                    "name": "entry class A",
                    "code": 1,
                    "type": "primary"
                },
                "department": null,
                "program": null,
                "removed": false,
                "graduated": false,
            },
            {
                "_id": "65699d803ded06d9ecfef474",
                "fullName": "eze chinedu",
                "regNumber": "EN2200030",
                "gender": "male",
                "class": {
                    "_id": "63ada4fea611cda692ba233e",
                    "name": "entry class A",
                    "code": 1,
                    "type": "primary"
                },
                "department": null,
                "program": null,
                "removed": false,
                "graduated": false,
            },
        ]
    },
    "status": "success"
}