User Grades

Fields

FieldNameDescriptionTypeRequired
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 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.
  • timestamp: Specifying a timestamp limits results to recorded grades that have been updated since the given timestamp, according to the server time.
  • 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.
Path

GET https://api.schoology.com/v1/users/{user_id}/grades

Content

none

Return

A collection of grade objects, each one containing grade fields

JSON
{
    "section": [
        {
            "section_id": "4318461",
            "period": [
                {
                    "period_id": "p13011",
                    "period_title": "Never Ending Period",
                    "assignment": [
                        {
                            "enrollment_id": 44783151,
                            "assignment_id": 5699937,
                            "grade": 80,
                            "exception": 0,
                            "max_points": 100,
                            "is_final": 0,
                            "timestamp": 1389651403,
                            "comment": "",
                            "comment_status": null,
                            "override": null,
                            "calculated_grade": null,
                            "pending": null,
                            "type": "assignment",
                            "location": "http:\/\/...\/5699937",
                            "scale_id": 1,
                            "scale_type": 0,
                            "category_id": 4341
                        }
                    ]
                }
            ],
            "final_grade": [
                {
                    "period_id": "p13011",
                    "grade": 80,
                    "weight": 100,
                    "comment": "",
                    "scale_id": 0,
                    "grading_category": [
                        {
                            "category_id": 3081,
                            "grade": null
                        },
                        {
                            "category_id": 4341,
                            "grade": 80
                        }
                    ],
                    "comment_status": null
                },
                {
                    "period_id": "final",
                    "grade": 80,
                    "comment": "",
                    "comment_status": null,
                    "scale_id": 0
                }
            ],
            "grading_category": [
                {
                    "id": 3081,
                    "title": "e.g. Homework"
                },
                {
                    "id": 4341,
                    "title": "xtra points"
                }
            ]
        }
    ],
    "links": {
        "self": "http:\/\/...\/v1\/users\/48289\/grades"
    }
}
XML
<?xml version="1.0" encoding="utf-8" ?>
<result>
  <section>
    <section_id>4318461</section_id>
    <period>
      <period_id>p13011</period_id>
      <period_title>Never Ending Period</period_title>
      <assignment>
        <enrollment_id>44783151</enrollment_id>
        <assignment_id>5699937</assignment_id>
        <grade>80</grade>
        <exception>0</exception>
        <max_points>100</max_points>
        <is_final>0</is_final>
        <timestamp>1389651403</timestamp>
        <comment />
        <comment_status />
        <override />
        <calculated_grade />
        <pending />
        <type>assignment</type>
        <location>http://.../5699937</location>
        <scale_id>1</scale_id>
        <scale_type>0</scale_type>
        <category_id>4341</category_id>
      </assignment>
    </period>
    <final_grade>
      <period_id>p13011</period_id>
      <grade>80</grade>
      <weight>100</weight>
      <comment />
      <scale_id>0</scale_id>
      <grading_category>
        <category_id>3081</category_id>
        <grade />
      </grading_category>
      <grading_category>
        <category_id>4341</category_id>
        <grade>80</grade>
      </grading_category>
      <comment_status />
    </final_grade>
    <final_grade>
      <period_id>final</period_id>
      <grade>80</grade>
      <comment />
      <comment_status />
      <scale_id>0</scale_id>
    </final_grade>
    <grading_category>
      <id>3081</id>
      <title>e.g. Homework</title>
    </grading_category>
    <grading_category>
      <id>4341</id>
      <title>xtra points</title>
    </grading_category>
  </section>
  <links>
    <self>http://.../v1/users/48289/grades</self>
  </links>
</result>