Deadline Scheduling Suggestion

This API is a part of a bigger project that aims to create:

1. An API that answers the following kinds of queries:
   1.1. Get Suggestions: when given the college name, course name, duration of assignment, minimum and maximum due dates, suggests the best due date for the assignment of that course, considering what other assignments the students of this course have.
   1.2. Student Schedule: when given the college name, course name returns the score (avg number of assignments per student in the next 7 days) and assignments that the students have in the current week.
   1.3. Inform about Events: inform the API about other events that should be considered while scheduling the assignments besides assignments of other courses. For example, quizzes, college fests, etc.
2. A chrome extension for classroom that adds to these platforms the functionality of getting suggestions of release date and due date of an assignment/deadline. (Repository)
3. A mailer to send regular (weekly) mails to profs about how free/busy the students are in the coming week. (Repository)

hosted on: https://easyscheduler.kracr.iiitd.edu.in:8200/

This API Supports the following features: 1.

1 Get Suggestions

HTTP Request Format

GET https://easyscheduler.kracr.iiitd.edu.in:8200/[college_name]/get_suggestions/[course_name]/[duration]/[min due date]/[max due date]

Parameters

college_name
iiitd is the only supported college name.

course_name

Name of the course for which suggestion for assignment deadline is required.

duration

The amount of time that the professor wants to give to the assignment.
Format: days-hours-minutes
Example: if the assignment is to be given 1 day 5 hrs for completion, duration = 1-5-0

min_due_date

A range of allowed dates for the due date of the assignment is required. min_due_date is the earliest date that can be the due date of the assignment.
Format: YYYY-MM-DDTHH:mm:ss.sssZ
Example: if the assignment's due date to be between 2020-08-17, 5 PM and 2020-08-20, 5 PM then min_due_date = 2020-08-17T17:00:00.000Z.

max_due_date

A range of allowed dates for the due date of the assignment is required. max_due_date is the farthest date that can be the due date of the assignment.
Format: YYYY-MM-DDTHH:mm:ss.sssZ
Example: if the professor wants the assignment's due date to be between 2020-08-17, 5 PM and 2020-08-20, 5 PM then max_due_date = 2020-08-20T17:00:00.000Z.

Response

{
  suggestions: [
    {
      start_date: type- Date, 
      end_date: type- Date, 
      clash: {
        score: type - float, // avg number of assignments each student of this course has in this duration
        reason: [
          {
            courseWork: {
              course_name: type- string, 
              coursework_name: type- string,
              start_date: type- date,
              end_date: type- date,
            }, // assignment
            fraction_of_students: type - float,
            fraction_of_overlap: type - float
          }
          ... 
        ]// list of assignments
      }
    } // suggestion
    ...
  ] // list of suggestions
}

2 Student Schedule

HTTP Request Format

GET https://https://easyscheduler.kracr.iiitd.edu.in:8200/[college_name]/student_schedule/[course_name]/week

Response

{
  score: type - float, // avg number of assignments each student of this course has in this duration (week)
  reason: [
    {
      courseWork: {
        course_name: type- string, 
        coursework_name: type- string,
        start_date: type- date,
        end_date: type- date,
      }, // assignment
      fraction_of_students: type - float,
      fraction_of_overlap: type - float
    }
    ... 
  ]// list of assignments
}

3 Inform about Event

Inform the API to consider some event while scheduling deadlines. The start datetime and end datetime needs to be provided. Some examples of such events can be quizzes, fests, sports events, etc.

HTTP Request Format

GET https://easyscheduler.kracr.iiitd.edu.in:8200/[college_name]/inform_about_event/[event_type]/[course_name]/[event_start_datetime]/[event_end_datetime]

event_type

Currently the three supported event_types are quiz, backpack_deadline, backpack_deadline_reminder.

4 Is Course Present

Know whether a course is in our database

HTTP Request Format

GET https://easyscheduler.kracr.iiitd.edu.in:8200/[college_name]/courses/[course_name]/is_present

Response

If the course is present it returns 'true' else returns 'false'.

5 Add new course

HTTP Request Format

GET https://easyscheduler.kracr.iiitd.edu.in:8200/[college_name]/courses/[course_name]/add_course/[professor_name]/[professor_email]/[students]

students should be a comma seperated list of the unique identifiers of students (roll no., email, etc). Eg. 2018001,2018002,2018003

Response

HTTP response with empty body or error.