Skip to content

✨ 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

NameParameterDescriptionExpected Values
yearformatAcademic year for the album2024-2025
standardTextStandard for the homeworkSR.KG
subjectTextSubject of the homeworkEnglish
divisionsArrayArray of division identifiers this homework is assigned to.[A,B]
submission_datedateDate for homework submission (YYYY-MM-DD format preferred)2025-12-12
submission_timetimeTime for homework submission (HH:MM in 24-hour format)12:00

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

NameParameterDescriptionExpected Values
chapterTextOptional chapter information
homework_typeTextType of homework: "Daily", "Vacation", "Project", "Assignment", "Practical", "Exam Homework"Daily or Vacation or Project or Assignment or Practical or Exam Homework
return_homeworkTextIndicates if the homework needs to be returned by students ("YES" or "NO")YES/NO
save_as_draftTextIndicates if the homework was saved as a draft ("YES" or "NO") - Might not be relevant for migration.YES/NO
remarkTextOptional remarks or instructions for the homework
upload_image_nameArrayArray of file url for any attached images.[file_url/test.jpg,file_url/hello.jpg]
release_datedateDate when the homework was released (YYYY-MM-DD format preferred)2025-04-12
release_timetimeTime when the homework was released (HH:MM in 24-hour format)00:12
student_check_statusArrayArray of student identifiers who have checked/viewed the homework.[001,002,003]

Notes:

  • Consistent use of YYYY-MM-DD format for dates (submission_date, release_date) and HH:MM (24-hour) for times (submission_time, release_time) is recommended.
  • The save_as_draft field 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"

Thank You!