Skip to content

✨ Student

Endpoint : /student (GET method expected)

Example API Response

js
[
  {
    "year": "2024-2025",                       // Academic year for the record
    "gr_no": "001",                      // General Register Number - unique student identifier
    "student_name": "Demo Student",                // Name of the student
    "father_name": "Father Name",                // Father's name
    "surname": "Surname",                // Student's surname
    "gender": "Male or Female",                // Gender of the student
    "date_of_birth": "1990-12-12",                // Date of birth of the student (YYYY-MM-DD)
    "mobile_number": "983456789",                // Student's mobile number
    "standard": "JR.KG",                // Current academic standard of the student (e.g., JR.KG, 1, 10)
    "division": "A",                // Class division of the student (e.g., A, B, C)
    "birth_place": "ABC",                // Place where the student was born
    "mobile_number_2": "983456789",                // Alternate mobile number (optional)
    "whatsapp_number": "983456789",                // WhatsApp number (if different from mobile number)
    "sms_number": "983456789",                // SMS number (if different from mobile number)
    "e_mail": "[email protected]",                // Student's or parent's email address
    "blood_group": "A+",                // Student's blood group
    "nationality": "INDIAN",                // Student's nationality
    "religion": "Hindu",                // Student's religion
    "category": "Hindu",                // Social category (e.g., General, OBC, SC, ST)
    "caste": "Darji",                // Student's caste
    "sub_caste": "Darji",                // Student's sub-caste
    "social_caste": "Darji",                // Social caste (may be the same as category or more specific)
    "food_preferences": "Jain",                // Dietary preferences of the student
    "mother_tongue": "Jain",                // Student's mother tongue
    "language_known": "[Hindi,Gujarati]",                // Languages the student knows
    "language_spoken_at_home": "[Hindi,Gujarati]",                // Languages spoken at home
    "language_known_parents": "[Hindi,Gujarati]",                // Languages known by the parents
    "aadhar_number": "234567890",                // Student's Aadhar card number (unique identification number in India)
    "family_annual_income": "50000",                // Annual income of the student's family
    "fathers_aadhar_card_no": "234567890",                // Father's Aadhar card number
    "mother_aadhar_card_no": "234567890",                // Mother's Aadhar card number
    "deprived_group": "Yes or No",                // Whether the student belongs to a deprived group
    "outside_from_state": "Yes or No",                // Whether the student is from outside the state
    "is_defence_child": "Yes or No",                // Whether the student is a child of a defense personnel
    "bpl": "Yes or No",                // Whether the student's family is below the poverty line
    "student_lc": "Yes or No",                // Whether the student has a leaving certificate from a previous school
    "birth_certificate": "Yes or No",                // Whether the student has a birth certificate
    "last_school_medium": "School Name",                // Medium of instruction in the last attended school
    "previuos_standard": "5",                // Previous academic standard of the student
    "roll_no": "5",                // Student's roll number
    "rfid_code": "ABC001",                // Radio-Frequency Identification code for the student
    "pen_no": "ABC001",                // Permanent Education Number (unique student identifier in some regions)
    "admission_form_no": "ABC001",                // Admission form number
    "admission_date": "2023-01-01",                // Date of admission (YYYY-MM-DD)
    "admission_standard": "1",                // Standard at the time of admission
    "admission_division": "A",                // Division at the time of admission
    "last_attened_school": "ABC",                // Name of the last attended school
    "last_school_location": "ABC",                // Location of the last attended school
    "special_education_needs": "[Sports,Music]",                // Any special education needs or interests of the student
    "medium": "English",                // Current medium of instruction
    "aadhar_dise_number": "123456789",                // Aadhar linked District Information System for Education number
    "left_date": "2022-02-02",                // Date when the student left the school (if applicable, YYYY-MM-DD)
    "left_category": "",                // Category under which the student left (if applicable)
    "left_remark": "",                // Reason for leaving (if applicable)
    "shift": "",                // School shift (e.g., Morning, Afternoon)
    "interested_in_hostel_facility": "Yes or No",                // Whether the student is interested in hostel facility
    "food_facility": "Yes or No",                // Whether the student avails food facility at school
    "library_facility": "Yes or No",                // Whether the student avails library facility
    "new_old": "New or Old",                // Whether the student is a new or old admission
    "interested_in_transport_facility": "Yes or No",                // Whether the student is interested in transport facility
    "transport_area": "Area Name",                // Area for transport (if applicable)
    "address": "",                // Student's residential address
    "city": "",                // City of residence
    "taluka": "",                // Sub-district/Taluka of residence
    "town_village": "",                // Town or village of residence
    "district": "",                // District of residence
    "state": "",                // State of residence
    "country": "",                // Country of residence
    "pincode": ""               // Postal code/Pincode of residence
  }
]

Mandatory Parameters

NameParameterDescriptionExpected Values
yearformatAcademic year for the record2024-2025
gr_notextGeneral Register Number - unique student identifier001
student_nametextName of the studentDemo Student
father_nametextFather's nameFather Name
surnametextStudent's surnameSurname
gendertextGender of the studentMale or Female
date_of_birthtextDate of birth of the student (YYYY-MM-DD)1990-12-12
mobile_numbertextStudent's mobile number983456789
standardtextCurrent academic standard of the student (e.g., JR.KG, 1, 10)JR.KG
divisiontextClass division of the student (e.g., A, B, C)A

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

NameParameterDescriptionExpected Values
birth_placetextPlace where the student was bornABC
mobile_number_2textAlternate mobile number (optional)983456789
whatsapp_numbertextWhatsApp number (if different from mobile number)983456789
sms_numbertextSMS number (if different from mobile number)983456789
e_mailtextStudent's or parent's email address[email protected]
blood_grouptextStudent's blood groupA+
nationalitytextStudent's nationalityINDIAN
religiontextStudent's religionHindu
categorytextSocial category (e.g., General, OBC, SC, ST)OBC
castetextStudent's casteDarji
sub_castetextStudent's sub-casteDarji
social_castetextSocial caste (may be the same as category or more specific) Dietary preferences of the studentDarji
food_preferencestextJain
mother_tonguetextStudent's mother tongueJain
language_knownArrayLanguages the student knows[Hindi,Gujarati]
language_spoken_at_homeArrayLanguages spoken at home[Hindi,Gujarati]
language_known_parentsArrayLanguages known by the parents[Hindi,Gujarati]
aadhar_numbernumberStudent's Aadhar card number (unique identification number in India)234567890
family_annual_incomenumberAnnual income of the student's family50000
fathers_aadhar_card_nonumberFather's Aadhar card number234567890
mother_aadhar_card_nonumberMother's Aadhar card number234567890
deprived_grouptextWhether the student belongs to a deprived groupYes or No
outside_from_statetextWhether the student is from outside the stateYes or No
is_defence_childtextWhether the student is a child of a defense personnelYes or No
bpltextWhether the student's family is below the poverty lineYes or No
student_lctextWhether the student has a leaving certificate from a previous schoolYes or No
birth_certificatetextWhether the student has a birth certificateYes or No
last_school_mediumtextMedium of instruction in the last attended schoolSchool Name
previuos_standardtextPrevious academic standard of the student5
roll_notextStudent's roll number5
rfid_codetextRadio-Frequency Identification code for the studentABC001
pen_notextPermanent Education Number (unique student identifier in some regions)ABC001
admission_form_notextAdmission form numberABC001
admission_datedateDate of admission (YYYY-MM-DD)2023-01-01
admission_standardtextStandard at the time of admission1
admission_divisiontextDivision at the time of admissionA
last_attened_schooltextName of the last attended schoolABC
last_school_locationtextLocation of the last attended schoolABC
special_education_needsArrayAny special education needs or interests of the student[Sports,Music]
special_qualities_in_childtextABC
mediumtextCurrent medium of instructionEnglish
aadhar_dise_numbertextAadhar linked District Information System for Education number123456789
left_datedateDate when the student left the school (if applicable, YYYY-MM-DD)2022-02-02
left_categorytextCategory under which the student left (if applicable)
left_remarktextReason for leaving (if applicable)
shifttextSchool shift (e.g., Morning, Afternoon)
interested_in_hostel_facilitytextWhether the student is interested in hostel facilityYes or No
food_facilitytextWhether the student avails food facility at schoolYes or No
library_facilitytextWhether the student avails library facilityYes or No
new_oldtextWhether the student is a new or old admissionNew or Old
interested_in_transport_facilitytextWhether the student is interested in transport facilityYes or No
transport_areatextArea for transport (if applicable)Area Name
addresstextStudent's residential address
citytextCity of residence
talukatextSub-district/Taluka of residence
town_villagetextTown or village of residence
districttextDistrict of residence
statetextState of residence
countrytextCountry of residence
pincodetextPostal code/Pincode of residence

Notes:

Thank You!