Skip to content

Commit

Permalink
Revert term/semester
Browse files Browse the repository at this point in the history
  • Loading branch information
IDzyre committed Apr 30, 2024
1 parent 4453e9a commit e8b91ff
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions source/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,18 +170,18 @@ curl --request GET \
"data": {
"unarchived_courses": [
{
"term": "f19",
"semester": "f19",
"title": "blank",
"display_name": "",
"display_term": "Fall 2019"
"display_semester": "Fall 2019"
}
],
"archived_courses": [
{
"term": "f19",
"semester": "f19",
"title": "sample",
"display_name": "",
"display_term": "Fall 2019"
"display_semester": "Fall 2019"
}
]
}
Expand All @@ -199,10 +199,10 @@ Get all the courses the user is taking or have taken.
```shell
curl --request POST \
--url <base_url>/api/courses \
--form course_term=f19 \
--form course_semester=f19 \
--form course_title=api \
--form head_instructor=instructor \
--form base_course_term=f19 \
--form base_course_semester=f19 \
--form base_course_title=sample \
--header 'Authorization: my_token'
```
Expand All @@ -219,10 +219,10 @@ Note that the endpoint builds a course based on a prior course offering (called

Parameter | Description
--------- | -----------
course_term | term of the new course
course_semester | semester of the new course
course_title | Title (or code) of the new course
head_instructor | Head instructor of the new course
base_course_term | term of the base course
base_course_semester | semester of the base course
base_course_title | Title (or code) of the base course

# Courses.Users
Expand All @@ -231,7 +231,7 @@ base_course_title | Title (or code) of the base course

```shell
curl --request GET \
--url <base_url>/api/<term>/<course>/users \
--url <base_url>/api/<semester>/<course>/users \
--header 'Authorization: my_token'
```

Expand Down Expand Up @@ -267,13 +267,13 @@ This end point gets all users in a course.

### HTTP Request

`GET /api/<term>/<course>/users`
`GET /api/<semester>/<course>/users`

## Get Graders

```shell
curl --request GET \
--url <base_url>/api/<term>/<course>/graders \
--url <base_url>/api/<semester>/<course>/graders \
--header 'Authorization: my_token'
```

Expand Down Expand Up @@ -307,31 +307,31 @@ curl --request GET \

### HTTP Request

`GET /api/<term>/<course>/graders`
`GET /api/<semester>/<course>/graders`

# Courses.Reports

## Generate Grade Summaries

```shell
curl --request POST \
--url <base_url>/api/<term>/<course>/reports/summaries \
--url <base_url>/api/<semester>/<course>/reports/summaries \
--header 'Authorization: my_token'
```

This endpoint helps system administrators set up cron jobs for automatic grade summary generation.

### HTTP Request

`POST /api/<term>/<course>/reports/summaries`
`POST /api/<semester>/<course>/reports/summaries`


# Gradeables
## Get gradeable values

```shell
curl -X GET \
<base_url>/api/<term>/<course>/gradeable/<gradeable_id>/values?user_id=<user_id>
<base_url>/api/<semester>/<course>/gradeable/<gradeable_id>/values?user_id=<user_id>

```
> Possible response examples:
Expand Down Expand Up @@ -359,11 +359,11 @@ curl -X GET \
}
```

The endpoint returns values associated with an autograded gradeable with the given gradeable_id, which allows for determining a score on an assignment, if it has been graded, etc.
The endpoint returns values associated with an autograded gradeable with the given gradeable_id, which allows for desemesterining a score on an assignment, if it has been graded, etc.

### HTTP Request

`GET /api/<term>/<course>/gradeable/<gradeable_id>/values?user_id=<user_id>`
`GET /api/<semester>/<course>/gradeable/<gradeable_id>/values?user_id=<user_id>`

### Parameters

Expand All @@ -375,7 +375,7 @@ user_id | User's unique ID

```shell
curl -X POST \
<base_url>/api/<term>/<course>/gradeable/<gradeable_id>/upload\
<base_url>/api/<semester>/<course>/gradeable/<gradeable_id>/upload\
-F user_id=student \
-F vcs_checkout=true \
-F git_repo_id=true
Expand Down Expand Up @@ -406,7 +406,7 @@ The endpoint requests for a VCS gradeable with the given gradeable_id to be subm

### HTTP Request

`POST /api/<term>/<course>/gradeable/<gradeable_id>/upload`
`POST /api/<semester>/<course>/gradeable/<gradeable_id>/grade`

### Parameters

Expand Down

0 comments on commit e8b91ff

Please sign in to comment.