Table of Contents
Fields
Field | Name | Description | Type | Required |
---|---|---|---|---|
enrollment_id | Enrollment ID | The ID of the enrollment to which the grade belongs | integer | |
assignment_id | Assignment ID | The ID of the assignment to which the grade belongs | integer | |
section_id | Assignment ID | The ID of the course section to which the enrollment belongs | integer | |
grade | Grade | The grade received for the assignment. Assignments with an assigned grading scale can accept letter-grades as defined by the scale. | integer or string | |
comment | Comment | A comment associated with the grade | string | |
comment_status | Comment status | Whether or not the grade comment is visible to the student. Only administrators will see this value. | {1,0} | |
timestamp | Timestamp | The Unix timestamp the last time the grade was modified in any way, according to the server time. | string |
Operations
list
View a list of grades in the active enrollments for the given user. The following query strings can (optionally) be appended to the path to filter results:
- section_id: Specifying a section id limits results to that section.
- grading_period_ids: Specifying a comma-delimited list of grading period ids limits results to those grading periods. Use ‘other’ for the ‘Other’ grading period, and ‘final’ for final grades.
Note The output of the following query parameters is paginated by enrollment and will include a links
object with next
key to navigate to the next page of enrollment grades.
- timestamp: Specifying a timestamp limits results to recorded grades that have been updated since the given timestamp, according to the server time.
- include_all_enrollments: If set to 1, grades for all enrollments including inactive will be included in the response.
Path | |
Content | none |
Return | A collection of grade objects, each one containing grade fields JSON XML
|