-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_doc_api_grade_change_log.html.txt
141 lines (98 loc) · 5.31 KB
/
_doc_api_grade_change_log.html.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
Grade Change Log API
Query audit log of grade change events.
For each endpoint, a compound document is returned. The primary collection of
event objects is paginated, ordered by date descending. Secondary collections
of assignments, courses, students and graders related to the returned events
are also included. Refer to the Assignment, Courses, and Users APIs for
descriptions of the objects in those collections.
A GradeChangeEventLinks object looks like:
{
// ID of the assignment associated with the event
"assignment": 2319,
// ID of the course associated with the event. will match the context_id in the
// associated assignment if the context type for the assignment is a course
"course": 2319,
// ID of the student associated with the event. will match the user_id in the
// associated submission.
"student": 2319,
// ID of the grader associated with the event. will match the grader_id in the
// associated submission.
"grader": 2319,
// ID of the page view during the event if it exists.
"page_view": "e2b76430-27a5-0131-3ca1-48e0eb13f29b"
}
A GradeChangeEvent object looks like:
{
// ID of the event.
"id": "e2b76430-27a5-0131-3ca1-48e0eb13f29b",
// timestamp of the event
"created_at": "2012-07-19T15:00:00-06:00",
// GradeChange event type
"event_type": "grade_change",
// Boolean indicating whether the submission was excused after the change.
"excused_after": true,
// Boolean indicating whether the submission was excused before the change.
"excused_before": false,
// The grade after the change.
"grade_after": "8",
// The grade before the change.
"grade_before": "8",
// Boolean indicating whether the student name was visible when the grade was
// given. Could be null if the grade change record was created before this
// feature existed.
"graded_anonymously": true,
// Version Number of the grade change submission.
"version_number": "1",
// The unique request id of the request during the grade change.
"request_id": "e2b76430-27a5-0131-3ca1-48e0eb13f29b",
"links": null
}
Query by assignmentGradeChangeAuditApiController#for_assignment
GET /api/v1/audit/grade_change/assignments/:assignment_id
List grade change events for a given assignment.
Parameter | | Type | Description
start_time | | DateTime | The beginning of the time range from which you want events.
end_time | | DateTime | The end of the time range from which you want events.
The beginning of the time range from which you want events.
The end of the time range from which you want events.
Query by courseGradeChangeAuditApiController#for_course
GET /api/v1/audit/grade_change/courses/:course_id
List grade change events for a given course.
Parameter | | Type | Description
start_time | | DateTime | The beginning of the time range from which you want events.
end_time | | DateTime | The end of the time range from which you want events.
The beginning of the time range from which you want events.
The end of the time range from which you want events.
Query by studentGradeChangeAuditApiController#for_student
GET /api/v1/audit/grade_change/students/:student_id
List grade change events for a given student.
Parameter | | Type | Description
start_time | | DateTime | The beginning of the time range from which you want events.
end_time | | DateTime | The end of the time range from which you want events.
The beginning of the time range from which you want events.
The end of the time range from which you want events.
Query by graderGradeChangeAuditApiController#for_grader
GET /api/v1/audit/grade_change/graders/:grader_id
List grade change events for a given grader.
Parameter | | Type | Description
start_time | | DateTime | The beginning of the time range from which you want events.
end_time | | DateTime | The end of the time range from which you want events.
The beginning of the time range from which you want events.
The end of the time range from which you want events.
Advanced queryGradeChangeAuditApiController#query
GET /api/v1/audit/grade_change
List grade change events satisfying all given parameters. Teachers may query for events in courses they teach. Queries withoutcourse_idrequire account administrator rights.
At least one ofcourse_id,assignment_id,student_id, orgrader_idmust be specified.
Parameter | | Type | Description
course_id | | integer | Restrict query to events in the specified course.
assignment_id | | integer | Restrict query to the given assignment. If âoverrideâ is given, query the course final grade override instead.
student_id | | integer | User id of a student to search grading events for.
grader_id | | integer | User id of a grader to search grading events for.
start_time | | DateTime | The beginning of the time range from which you want events.
end_time | | DateTime | The end of the time range from which you want events.
Restrict query to events in the specified course.
Restrict query to the given assignment. If âoverrideâ is given, query the course final grade override instead.
User id of a student to search grading events for.
User id of a grader to search grading events for.
The beginning of the time range from which you want events.
The end of the time range from which you want events.