[POST] A New Timetable

[arafaysaleem]

Summary

As a student, I should be able to create timetables, so that I can save them for sharing.

Acceptance Criteria

GIVEN a student is creating a timetable in the app
WHEN the app hits the /timetables endpoint with a valid POST request, containing:

• term_id int(10) unsigned NOT NULL,
• student_erp varchar(5),
• is_active tinyint(1) NOT NULL DEFAULT 0,
• classes array, where each item is a:
  • class_erp varchar(5)

THEN the app should receive a status 201
AND in the response, the following information should be returned:

• headers
• timetable_id

Sample Request/Sample Response

headers: {
    error: 0,
    message: "..."
}
body: {
    "timetable_id": "1",
    "affected_rows": 1
}

Resources

• Development URL: {Here goes a URL to the feature on development API}
• Production URL: {Here goes a URL to the feature on production API}

Dev Notes

{Some complementary notes if necessary}

Testing Notes

Scenario 1: POST request is successful

1. Create a new timetable entry with a POST request to /timetables endpoint with student_erp == erp in student account token and ensure a 201 status code is returned.
2. Use the id returned by the response in a subsequent GET request to /timetables/:id endpoint and ensure a 200 status code is returned.
3. Ensure the response contains a timetable with the correct information i.e. matching the initially sent body.
4. Clean up the database by sending a DELETE request to /timetables/:id endpoint and ensure a 200 status code is returned.

Scenario 2: POST request is incorrect

1. Send a POST request to /timetables endpoint with an incorrect key name in the body
2. Ensure a 422 status code is returned
3. And the response headers' code parameter should contain "InvalidPropertiesException"
4. And the response headers' data parameter should contain the name of the invalid parameter

Scenario 3: POST request is forbidden

1. Send a POST request to /timetables endpoint with student_erp != erp in student account token.
2. Ensure the response returns a 403 forbidden status code.
3. And the response headers' code parameter should contain "ForbiddenException"

Scenario 4: POST request is unauthorized

1. Send a POST request to /timetables endpoint without an authorization token
2. Ensure a 401 unauthorized status code is returned.
3. And the response headers' code parameter should contain "TokenMissingException"