Grading Period

Grading periods (marking periods) determine when a course section is active.

Table of Contents

Course sections and assignments are linked to grading periods (or marking periods). This endpoint lists all grading periods for the school. To view a list of grading periods for a specific section, see course sections. This endpoint is only available to school administrators.

Fields

Field Name Description Type Required
title Title

The grading period title. This title must be unique across all grading periods in the school.

 string yes
start Start Date

The grading period start date

 date string (YYYY-MM-DD) yes
end End Date

The grading period end date

 date string (YYYY-MM-DD) yes

Operations

create

Create a grading period

Path

POST https://api.schoology.com/v1/gradingperiods

Content

An object containing grading period fields

JSON 
{
    "title": "The grading period title",
    "start": "2013-09-09",
    "end": "2013-12-22"
}
XML 
<body>
  <title>The grading period title</title>
  <start>2013-09-09</start>
  <end>2013-12-22</end>
</body>
Return

An object containing grading period fields

JSON 
{
    "id": "25739",
    "title": "Summer Period",
    "start": "2014-05-01",
    "end": "2014-09-01",
    "active": "0",
    "links": {
        "self": "http:\/\/..."
    }
}
XML 
<?xml version="1.0" encoding="utf-8" ?>
<result>
	<id>25739</id>
	<title>Summer Period</title>
	<start>2014-05-01</start>
	<end>2014-09-01</end>
	<active>0</active>
	<links>
		<self>http:\/\/...</self>
	</links>
</result>

list

View a list of grading periods. You can also use the following parameters to filter results:

  • title: specifies an exact title to search for.
  • startswith: set this value to 1 to match all grading periods whose titles begin with the title provided.
Path

GET https://api.schoology.com/v1/gradingperiods

Content

none
Return

A collection of grading period objects, each one containing grading period fields

JSON 
{
    "total": 1,
    "gradingperiods": [
        {
            "id": 13011,
            "title": "Never Ending Period",
            "start": "2012-09-17",
            "end": "2016-09-17",
            "active": "1",
            "links": {
                "self": "http:\/\/..."
            }
        }
    ]
}
XML 
<?xml version="1.0" encoding="utf-8" ?>
<result>
	<total>1</total>
	<gradingperiods>
		<id>13011</id>
		<title>Never Ending Period</title>
		<start>2012-09-17</start>
		<end>2016-09-17</end>
		<active>1</active>
		<links>
			<self>http:\/\/...</self>
		</links>
	</gradingperiods>
</result>

view

View a specific grading period:

Path

GET https://api.schoology.com/v1/gradingperiods/{id}

Content

none
Return

An object containing grading period fields

JSON 
{
    "id": "25739",
    "title": "Summer Period",
    "start": "2014-05-01",
    "end": "2014-09-01",
    "active": "0"
}
XML 
<?xml version="1.0" encoding="utf-8" ?>
<result>
	<id>25739</id>
	<title>Summer Period</title>
	<start>2014-05-01</start>
	<end>2014-09-01</end>
	<active>0</active>
</result>

update

Modify a grading period

Path

PUT https://api.schoology.com/v1/gradingperiods/{id}

Content

An object containing grading period fields

JSON 
{
    "title": "Extended grading period title",
    "start": "2013-09-09",
    "end": "2014-06-15"
}
XML 
<body>
  <title>Extended grading period title</title>
  <start>2013-09-09</start>
  <end>2014-06-15</end>
</body>
Return

none

delete

Delete a grading period (cannot be undone). All course sections belonging to this grading period must first be deleted or associated with a different period.

Path

DELETE https://api.schoology.com/v1/gradingperiods/{id}

Content

none
Return

none