Skip to content

[Feature:Developer] Add more to student API #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
IDzyre wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[Feature:Developer] Add more to student API #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3e51dd
Add more student API, and list gradeables
IDzyre Mar 18, 2026
d05f4b8
Add more to values endpoint
IDzyre Mar 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
198 changes: 195 additions & 3 deletions source/index.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,100 @@ curl -X GET \
}
}
```

```json
{
"status": "success",
"data": {
"is_queued": false,
"queue_position": -1,
"is_grading": false,
"has_submission": true,
"autograding_complete": true,
"has_active_version": true,
"highest_version": 7,
"total_points": 5,
"total_percent": 1,
"test_cases": [
{
"name": "Test 0 -- Compilation",
"details": "",
"is_extra_credit": false,
"points_available": 1,
"has_extra_results": false,
"points_received": 1,
"testcase_message": "",
"autochecks": []
},
{
"name": "Test 1 -- Provided Example",
"details": "",
"is_extra_credit": false,
"points_available": 1,
"has_extra_results": true,
"points_received": 1,
"testcase_message": "",
"autochecks": [
{
"description": "Z <enter>",
"messages": [],
"diff_viewer": {},
"expected": "...",
"actual": "..."
}
]
},
{
"name": "Test 2 -- Provided Example",
"details": "",
"is_extra_credit": false,
"points_available": 1,
"has_extra_results": true,
"points_received": 1,
"testcase_message": "",
"autochecks": [
{
"description": "A <enter>",
"messages": [],
"diff_viewer": {},
"expected": "...",
"actual": "..."
}
]
},
{
"name": "Test 3 -- Provided Example",
"details": "",
"is_extra_credit": false,
"points_available": 1,
"has_extra_results": true,
"points_received": 1,
"testcase_message": "",
"autochecks": [
{
"description": "J <enter>",
"messages": [],
"diff_viewer": {},
"expected": "...",
"actual": "..."
}
]
},
{
"name": "Test 4 -- Correct Formatting Of lowercase.cpp",
"details": "",
"is_extra_credit": false,
"points_available": 1,
"has_extra_results": false,
"points_received": 1,
"testcase_message": "",
"autochecks": []
}
]
}
}
```

```json
{
"status": "fail",
Expand All @@ -398,8 +492,10 @@ The endpoint returns values associated with an autograded gradeable with the giv

Parameter | Description
--------- | -----------
user_id | User's unique ID

user_id | User's unique ID (Optional if instructor wants to get values for student)
semester | Semester of the gradeable
course | Course of the gradeable
gradeable_id | ID of the gradeable
## Submit VCS Gradeable

```shell
Expand Down Expand Up @@ -441,6 +537,102 @@ The endpoint requests for a VCS gradeable with the given gradeable_id to be subm

Parameter | Description
--------- | -----------
user_id | User's unique ID
user_id | User's unique ID (Optional if instructor wants to submit for student)
vcs_checkout | Required to be `true`
git_repo_id | Required value, however no specific value is checked.
semester | Semester of the gradeable
course | Course of the gradeable
gradeable_id | ID of the gradeable

## Retrieve a list of gradeables from a course

```shell
curl -X GET \
<base_url>/api/<semester>/<course>/gradeables?user_id=<user_id>
```
> Possible responses:

```json
{
"status": "success",
"data": {
"obj1-1pt-l": {
"id": "obj1-1pt-l",
"title": "Objective 1 - Lowercase (1 pt)",
"instructions_url": "",
"syllabus_bucket": "homework",
"section": 2,
"section_name": "OPEN",
"due_date": {
"date": "2026-02-27 23:59:59.000000",
"timezone_type": 3,
"timezone": "America\/Los_Angeles"
},
"gradeable_type": "Electronic File",
"vcs_repository":
"https://my_vcs_url.org/vcs",
"vcs_subdirectory": "homework\/01_cpp_types\/1pt_lowercase"
},
"obj1-1pt-p": {
"id": "obj1-1pt-p",
"title": "Objective 1 - Pets (1 pt)",
"instructions_url": "",
"syllabus_bucket": "homework",
"section": 5,
"section_name": "GRADED",
"due_date": {
"date": "2026-01-15 23:59:59.000000",
"timezone_type": 3,
"timezone": "America\/Los_Angeles"
},
},
},
}
```


The endpoint requests all homeworks assigned to a user in a given term and course.

### HTTP Request

`POST /api/<semester>/<course>/gradeables`

### Parameters

Parameter | Description
--------- | -----------
user_id | User's unique ID (Optional if instructor wants to submit for student)
semester | Semester of the gradeable
course | Course of the gradeable

## ME endpoint

```shell
curl -X GET \
<base_url>/api/me
```
> Possible responses:

```json
{
"status": "fail",
"message": "Unauthenticated access. Please log in."
}
```
```json
{
"status": "success",
"data": {
"user_id": "student",
"user_given_name": "Joe",
"user_family_name": "Student"
}
}
```


The endpoint is used to verify logged in user

### HTTP Request

`POST /api/me`
Loading