For Developers

Submissions

List Submissions

submissions.list(class_id, assignment_id, options);

Retrieve a list of Submissions for an Assignment in a Class.

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
class_idstringThe UUID of the class.
assignment_idstringThe UUID of the assignment.

Fetch Submission

submissions.fetch(class_id, assignment_id, submission_id);

Retrieve a Submission for an Assignment in a Class.

Function Arguments

ParameterTypeDescription
class_idstringThe UUID of the class.
assignment_idstringThe UUID of the assignment.
submission_idstringThe UUID of the submission.

Update Submission Metadata

submissions.update(class_id, assignment_id, submission_id, submission);

Update metadata for a specific Submission. This includes submitting grades, comments, or altering due date overrides (setting the due date for an individual student to be different than that of the other assignees.)

Function Arguments

ParameterTypeDescription
class_idstringThe UUID of the class.
assignment_idstringThe UUID of the assignment.
submission_idstringThe UUID of the submission.
submissionSubmissionA partial submission object.

Submit Submission

submissions.submit(class_id, assignment_id, attempt);

As a student, submit an attempt for your Submission. This will add it to the attempts array seen when retrieving a submission. It will also update the state of the submission to submitted.

Function Arguments

ParameterTypeDescription
class_idstringThe UUID of the class.
assignment_idstringThe UUID of the assignment.
attemptAttemptThe attempt to submit.

Reclaim Submission

submissions.reclaim(class_id, assignment_id);

As a student, reclaim your Submission. This will update the state of the submission to reclaimed. In order to reclaim the submission, it must be in the submitted state.

Function Arguments

ParameterTypeDescription
class_idstringThe UUID of the class.
assignment_idstringThe UUID of the assignment.

Return Submission

submissions.return(class_id, assignment_id, submission_id);

As a teacher, finalize the grade for a Submission and send it back to the assignee.

The user must be enrolled as a teacher, ta, designer, administrator, or district-administrator in the class to use this endpoint.

Function Arguments

ParameterTypeDescription
class_idstringThe UUID of the class.
assignment_idstringThe UUID of the assignment.
submission_idstringThe UUID of the submission.