✨ Homework
Endpoint : /homework (GET method expected)
Example API Response
js
[
{
"year": "2024-2025", // Academic year for the homework
"standard": "SR.KG", // Standard or grade for the homework
"subject": "ENGLISH", // Subject of the homework
"chapter": "", // Optional chapter information
"divisions": [ // Array of division identifiers this homework is assigned to.
"A",
"B"
],
"submission_date": "2025-04-12", // Date for homework submission (YYYY-MM-DD format preferred)
"submission_time": "00:00", // Time for homework submission (HH:MM in 24-hour format)
"homework_type": "Daily", // Type of homework: "Daily", "Vacation", "Project", "Assignment", "Practical", "Exam Homework"
"return_homework": "YES", // Indicates if the homework needs to be returned by students ("YES" or "NO")
"save_as_draft": "NO", // Indicates if the homework was saved as a draft ("YES" or "NO") - Might not be relevant for migration.
"remark": "", // Optional remarks or instructions for the homework
"upload_image_name": [ // Array of file url for any attached images.
"file_url/demo.png",
"file_url/test.jpg"
],
"release_date": "2025-04-12", // Date when the homework was released (YYYY-MM-DD format preferred)
"release_time": "00:12", // Time when the homework was released (HH:MM in 24-hour format)
"student_check_status": [ // Array of student identifiers who have checked/viewed the homework.
"Demo1",
"Demo2",
"Demo3"
]
}
// ... more homework objects can be included in the array
]Mandatory Parameters
| Name | Parameter | Description | Expected Values |
|---|---|---|---|
| year | format | Academic year for the album | 2024-2025 |
| standard | Text | Standard for the homework | SR.KG |
| subject | Text | Subject of the homework | English |
| divisions | Array | Array of division identifiers this homework is assigned to. | [A,B] |
| submission_date | date | Date for homework submission (YYYY-MM-DD format preferred) | 2025-12-12 |
| submission_time | time | Time for homework submission (HH:MM in 24-hour format) | 12:00 |
Optional Parameters
The optional parameters in the HTTP API are tabulated below:
| Name | Parameter | Description | Expected Values |
|---|---|---|---|
| chapter | Text | Optional chapter information | |
| homework_type | Text | Type of homework: "Daily", "Vacation", "Project", "Assignment", "Practical", "Exam Homework" | Daily or Vacation or Project or Assignment or Practical or Exam Homework |
| return_homework | Text | Indicates if the homework needs to be returned by students ("YES" or "NO") | YES/NO |
| save_as_draft | Text | Indicates if the homework was saved as a draft ("YES" or "NO") - Might not be relevant for migration. | YES/NO |
| remark | Text | Optional remarks or instructions for the homework | |
| upload_image_name | Array | Array of file url for any attached images. | [file_url/test.jpg,file_url/hello.jpg] |
| release_date | date | Date when the homework was released (YYYY-MM-DD format preferred) | 2025-04-12 |
| release_time | time | Time when the homework was released (HH:MM in 24-hour format) | 00:12 |
| student_check_status | Array | Array of student identifiers who have checked/viewed the homework. | [001,002,003] |
Notes:
- Consistent use of
YYYY-MM-DDformat for dates (submission_date,release_date) andHH:MM(24-hour) for times (submission_time,release_time) is recommended. - The
save_as_draftfield might not be directly applicable during data migration. Consider if this state needs to be migrated. - Type of homework: "Daily", "Vacation", "Project", "Assignment", "Practical", "Exam Homework"
