A Submission represents the relationship between a Person and an Assignment.
The submissions API enables developers to:
- manage a submission's state.
- grade a submission.
- submit student work, if supported by the source provider.
- download attached files, if supported by the source provider.
Note that the attempts array is a User API feature, whereas attachments is for Graph API.
Submission States
For details on the different submission states and the lifecycle of a submission take a look at the following guide.
Note that due to the existence of Phantom Submissions, we do not support a DELETE endpoint for this resource. If you are trying to "undo" a submission on a student's behalf, you probably should be reclaiming the submission.
Grading a submission
For details assigning grades to submissions take a look at the following guide.
Note that grading via Rubric is more complex because it requires you to first get the rubric (so you know what all the criteria are) and then fill out the rubric_grade object with a property containing the correct criteria names..
Submitting Student Work
For details on submitting student work take a look at the following guide.
Properties
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the object. |
created_date | Date | When the object was created in the source. |
updated_date | Date | When the object was last updated in the source. |
state | SubmissionState | The state of the submission. |
flags | SubmissionFlag[] | The flags for the submission. All, some, or none of the possible flags may be included. |
attachments | SubmissionAttachment[] | The attachments tied to the latest attempt the assignee has made for this submission (Graph API only). |
attempts | Attempt[] | All of the attempts the assignee has made for this submission (User API only). |
grade_comment | string | An optional comment left by the grader. |
grade_points | number | The numerical representation of the grade, if applicable. (i.e. 96) |
grade | string | The string representation of the grade, if applicable. (i.e. A+) |
extra_attempts | number | The number of extra attempts the assignee is allowed beyond the Assignment's max_attempts. |
override_due_date | Date | The due_date for this particular assignee, overriding that of the Assignment. |
assignment_id | string | The UUID of the Assignment. |
grader_id | string | The UUID of the Person who grades the submission. |
rubric_grade | {"criterion_name" as string: "performance_level_name" as string} | A mapping between the rubric's underlying criterion name and performance level that you are selecting for this grade. Be sure to fill out all of the criteria. |
person_id | string | The UUID of the Person who is the assignee of the submission. |
Supported Providers
| Provider | Support |
|---|---|
| aeries | list, get, update |
| aspen | list, get, create, update |
| blackbaud | list, get, create, update |
| blackboard | list, get, update, reclaim, return, submit |
| brightspace | list, get, update, download, reclaim, return, submit |
| canvas | list, get, update, download, reclaim, return, submit |
| classgather | list, get, create, update |
| clever | list, get, update, submit |
| list, get, update, reclaim, return, submit | |
| illuminate | list, get, update |
| microsoft | list, get, update, reclaim, return, submit |
| moodle | list, get, update, reclaim, return, submit |
| oneroster | list, get, create, update |
| powerschool | list, get, create, update |
| schoology | list, get, update, download, reclaim, return, submit |
| lti | list, get, update, reclaim, return, submit |
| skyward | list, get, create, update |
| veracross | list, get, update, return, submit |
| qmlativ | list, get, create, update |
| infinitecampus | list, get, create, update |
| rapididentity | list, get, create, update |
| sapphire | list, get, create, update |
| genesis | list, get, create, update |
| rediker | list, get, create, update |
| renweb | list, get, create, update |
| synergy | list, get, create, update |
| managebac | list, get, update |
| tyler | list, get, create, update |
| banner | list, get, create, update |
| frontline | list, get, create, update |
| ascender | list, get, create, update |