Skip to content

Latest commit

 

History

History
247 lines (214 loc) · 5.41 KB

class.md

File metadata and controls

247 lines (214 loc) · 5.41 KB

Back to main

Class

Add Class
Remove Class
Add User To Class
Remove User From Class
Get All Users From Class
Get All Chairs From Class
Get All Classes
Assign Teacher To Class


Endpoint

/Class

Add Class

Back to the top

POST

Expected Request

{
    "body": {
        "teacher_username": "RS600499",
        "class_name": "Test Class",
        "hour": 4,
        "room_id": 4
    },
    "action": "add_class"
}


Variable Data Type Required Additional Validation
teacher_username string True Must be a username ascribed to a teacher
class_name string True No
hour integer True Teacher must not have other class at this hour
room_id integer True Room must not have a class taught in it at this hour


Expected Response:

Healthy Call

{
    "message": "Class added"
}

Unhealthy Call

{
    "error": "error message"
}

Remove Class

Back to the top

DELETE

Expected Request

?class_id=7&action=remove_class


Variable Data Type Required Additional Validation
class_id integer True No


Expected Response:

Healthy Call

{
    "message": "Class Removed"
}

Unhealthy Call

{
    "error": "error message"
}

Get All Users From Class

Back to the top

GET

Expected Request

?class_id=1&action=get_all_users_from_class


Variable Data Type Required Additional Validation
class_id integer True No


Expected Response:

Healthy Call

{
    "message": "array of user information for that class"
}

Unhealthy Call

{
    "error": "error message"
}

Add User To Class

Back to the top

POST

Expected Request

{
    "body": {
        "class_id": 21,
        "user_id": 71
    },
    "action": "add_user_to_class"
}


Variable Data Type Required Additional Validation
class_id integer True No
user_id integer True No


Expected Response:

Healthy Call

{
    "message": "User has been added to that class"
}

Unhealthy Call

{
    "error": "error message"
}

Remove User From Class

Back to the top

DELETE

Expected Request

?class_id=2&user_id=244&action=remove_user_from_class

Variable Data Type Required Additional Validation
class_id integer True No
user_id integer True No


Expected Response:

Healthy Call

{
    "message": "User has been added to that class"
}

Unhealthy Call

{
    "error": "error message"
}

Get All Chairs From Class

Back to the top

GET

Expected Request

?class_id=1&action=get_all_chairs_from_class

Variable Data Type Required Additional Validation
class_id integer True No


Expected Response:

Healthy Call

{
    "message": "array with all chairs in the provided class"
}

Unhealthy Call

{
    "error": "error message"
}

Get All Classes

Back to the top

GET

Expected Request

/api/class/?action=get_all_classes

Variable Data Type Required Additional Validation


Expected Response:

Healthy Call

{
    "message": "array of all classes"
}

Unhealthy Call

{
    "error": "error message"
}

Assign Teacher to Class

Back to the top

PUT

Expected Request

{
    "body": {
        "class_id": 3,
        "teacher_id": 2
    },
    "action": "assign_teacher_to_class" 
}


Variable Data Type Required Additional Validation
class_id integer True No
teacher_id integer True No


Expected Response:

Healthy Call

{
    "message": "teacher has been assigned to that class"
}

Unhealthy Call

{
    "error": "error message"
}