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