Reminders

The API supports the viewing of realm specific reminders that mirror the functionality of the reminder widget on the web

Supported Reminder Types

Type	Description	Realm support
ungraded	A reminder for course section admins that lists out assignments and corresponding revisions that have not yet been graded	sections
resubmitted	A reminder for course section admins that lists out assignments and corresponding revisions that have not yet been viewed	sections

Fields

Fields will differ depending on the type of reminder

Universal Fields

Field	Name	Description	Type
type	Type	type of reminder	string of one of the supported reminder types
count	Count	The number of reminders	integer

Specific Fields

Type	Objects
ungraded	Assignment objects that have ungraded revisions Student revision objects that are ungraded
resubmitted	Assignment objects that have unviewed revisions Student revision objects that have not yet been viewed

Operations

list

View a list of reminders across all realms for a specific type.

with_attachments: retrieve attachments for this piece of content.

Path

GET https://api.schoology.com/v1/reminders/{type}

Content

none

Return

A collection of reminder objects

JSON

{
  "reminders": [
    {
      "type": "ungraded",
      "count": 3,
      "assignments": [
        {
          "id": 5818701,
          "title": "Assignment 1",
          "description": "Please use the attached document to complete the assignment",
          "due": "",
          "grading_scale": "0",
          "grading_period": "25097",
          "grading_category": "4445",
          "max_points": "100",
          "factor": "1",
          "is_final": "0",
          "show_comments": "0",
          "grade_stats": "0",
          "allow_dropbox": "1",
          "allow_discussion": "1",
          "published": 1,
          "type": "assignment",
          "grade_item_id": 5818701,
          "available": 1,
          "completed": 0,
          "dropbox_locked": 0,
          "grading_scale_type": 0,
          "show_rubric": false,
          "num_assignees": 0,
          "assignees": [
            
          ],
          "section_id": "5818697",
          "revisions": [
            {
              "revision_id": 8,
              "uid": 248071,
              "created": 1409094487,
              "num_items": 1,
              "late": 1,
              "draft": 0
            }
          ]
        },
        {
          "id": 9274619,
          "title": "Health Choices",
          "description": "",
          "due": "",
          "grading_scale": "0",
          "grading_period": "31217",
          "grading_category": "7813",
          "max_points": "100",
          "factor": "1",
          "is_final": "0",
          "show_comments": "0",
          "grade_stats": "0",
          "allow_dropbox": "1",
          "allow_discussion": "1",
          "published": 1,
          "type": "assignment",
          "grade_item_id": 9274619,
          "available": 1,
          "completed": 0,
          "dropbox_locked": 0,
          "grading_scale_type": 0,
          "show_rubric": false,
          "num_assignees": 0,
          "assignees": [
            
          ],
          "section_id": "8495243",
          "revisions": [
            {
              "revision_id": 15,
              "uid": 81562,
              "created": 1411075065,
              "num_items": 1,
              "late": 0,
              "draft": 0
            },
            {
              "revision_id": 6,
              "uid": 2441585,
              "created": 1410805384,
              "num_items": 1,
              "late": 0,
              "draft": 0
            }
          ]
        }
      ]
    }
  ]
}

XML

<?xml version="1.0" encoding="utf-8" ?>
<result>
	<reminders>
		<type>ungraded</type>
		<count>3</count>
		<assignments>
			<id>5818701</id>
			<title>Assignment 1</title>
			<description>Please use the attached document to complete the assignment</description>
			<due />
			<grading_scale>0</grading_scale>
			<grading_period>25097</grading_period>
			<grading_category>4445</grading_category>
			<max_points>100</max_points>
			<factor>1</factor>
			<is_final>0</is_final>
			<show_comments>0</show_comments>
			<grade_stats>0</grade_stats>
			<allow_dropbox>1</allow_dropbox>
			<allow_discussion>1</allow_discussion>
			<published>1</published>
			<type>assignment</type>
			<grade_item_id>5818701</grade_item_id>
			<available>1</available>
			<completed>0</completed>
			<dropbox_locked>0</dropbox_locked>
			<grading_scale_type>0</grading_scale_type>
			<show_rubric></show_rubric>
			<num_assignees>0</num_assignees>
			<assignees />
			<section_id>5818697</section_id>
			<revisions>
				<revision_id>8</revision_id>
				<uid>248071</uid>
				<created>1409094487</created>
				<num_items>1</num_items>
				<late>1</late>
				<draft>0</draft>
			</revisions>
		</assignments>
		<assignments>
			<id>9274619</id>
			<title>Health Choices</title>
			<description />
			<due />
			<grading_scale>0</grading_scale>
			<grading_period>31217</grading_period>
			<grading_category>7813</grading_category>
			<max_points>100</max_points>
			<factor>1</factor>
			<is_final>0</is_final>
			<show_comments>0</show_comments>
			<grade_stats>0</grade_stats>
			<allow_dropbox>1</allow_dropbox>
			<allow_discussion>1</allow_discussion>
			<published>1</published>
			<type>assignment</type>
			<grade_item_id>9274619</grade_item_id>
			<available>1</available>
			<completed>0</completed>
			<dropbox_locked>0</dropbox_locked>
			<grading_scale_type>0</grading_scale_type>
			<show_rubric></show_rubric>
			<num_assignees>0</num_assignees>
			<assignees />
			<section_id>8495243</section_id>
			<revisions>
				<revision_id>15</revision_id>
				<uid>81562</uid>
				<created>1411075065</created>
				<num_items>1</num_items>
				<late>0</late>
				<draft>0</draft>
			</revisions>
			<revisions>
				<revision_id>6</revision_id>
				<uid>2441585</uid>
				<created>1410805384</created>
				<num_items>1</num_items>
				<late>0</late>
				<draft>0</draft>
			</revisions>
		</assignments>
	</reminders>
</result>