List assignment submissions SubmissionsApiController#index

GET /api/v1/courses/:course_id/assignments/:assignment_id/submissions

GET /api/v1/sections/:section_id/assignments/:assignment_id/submissions

Request Parameters:

API response field:

• assignment_id
  The unique identifier for the assignment.
• user_id
  The id of the user who submitted the assignment.
• grader_id
  The id of the user who graded the submission. This will be null for submissions that haven't been graded yet. It will be a positive number if a real user has graded the submission and a negative number if the submission was graded by a process (e.g. Quiz autograder and autograding LTI tools). Specifically autograded quizzes set grader_id to the negative of the quiz id. Submissions autograded by LTI tools set grader_id to the negative of the tool id.
• canvadoc_document_id
  The id for the canvadoc document associated with this submission, if it was a file upload.
• submitted_at
  The timestamp when the assignment was submitted, if an actual submission has been made.
• score
  The raw score for the assignment submission.
• attempt
  If multiple submissions have been made, this is the attempt number.
• body
  The content of the submission, if it was submitted directly in a text field.
• grade
  The grade for the submission, translated into the assignment grading scheme (so a letter grade, for example).
• grade_matches_current_submission
  A boolean flag which is false if the student has re-submitted since the submission was last graded.
• preview_url
  Link to the URL in canvas where the submission can be previewed. This will require the user to log in.
• redo_request
  If the submission was reassigned
• url
  If the submission was made as a URL.
• late
  Whether the submission was made after the applicable due date.
• assignment_visible
  Whether this assignment is visible to the user who submitted the assignment.
• workflow_state
  The current status of the submission. Possible values: “submitted”, “unsubmitted”, “graded”, “pending_review”

List submissions for multiple assignments SubmissionsApiController#for_students

GET /api/v1/courses/:course_id/students/submissions

GET /api/v1/sections/:section_id/students/submissions

Request Parameters:

# Without grouped:

[
  { "assignment_id": 100, grade: 5, "user_id": 1, ... },
  { "assignment_id": 101, grade: 6, "user_id": 2, ... }

# With grouped:

[
  {
    "user_id": 1,
    "submissions": [
      { "assignment_id": 100, grade: 5, ... },
      { "assignment_id": 101, grade: 6, ... }
    ]
  }
]

Get a single submission SubmissionsApiController#show

GET /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id

GET /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id

Request Parameters:

Get a single submission by anonymous id SubmissionsApiController#show_anonymous

GET /api/v1/courses/:course_id/assignments/:assignment_id/anonymous_submissions/:anonymous_id

GET /api/v1/sections/:section_id/assignments/:assignment_id/anonymous_submissions/:anonymous_id

Request Parameters:

Upload a file SubmissionsApiController#create_file

POST /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/files

POST /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/files

Grade or comment on a submission SubmissionsApiController#update

PUT /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id

PUT /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id

Request Parameters:

Grade or comment on a submission by anonymous id SubmissionsApiController#update_anonymous

PUT /api/v1/courses/:course_id/assignments/:assignment_id/anonymous_submissions/:anonymous_id

PUT /api/v1/sections/:section_id/assignments/:assignment_id/anonymous_submissions/:anonymous_id

Request Parameters:

List gradeable students SubmissionsApiController#gradeable_students

GET /api/v1/courses/:course_id/assignments/:assignment_id/gradeable_students

Request Parameters:

List multiple assignments gradeable students SubmissionsApiController#multiple_gradeable_students

GET /api/v1/courses/:course_id/assignments/gradeable_students

Request Parameters:

A [UserDisplay] with an extra assignment_ids field to indicate what assignments
that user can submit

[
  {
    "id": 2,
    "display_name": "Display Name",
    "avatar_image_url": "http://avatar-image-url.jpeg",
    "html_url": "http://canvas.com",
    "assignment_ids": [1, 2, 3]
  }
]

Grade or comment on multiple submissions SubmissionsApiController#bulk_update

POST /api/v1/courses/:course_id/submissions/update_grades

POST /api/v1/courses/:course_id/assignments/:assignment_id/submissions/update_grades

POST /api/v1/sections/:section_id/submissions/update_grades

POST /api/v1/sections/:section_id/assignments/:assignment_id/submissions/update_grades

Request Parameters:

curl 'https://<canvas>/api/v1/courses/1/assignments/2/submissions/update_grades' \
     -X POST \
     -F 'grade_data[3][posted_grade]=88' \
     -F 'grade_data[4][posted_grade]=95' \
     -H "Authorization: Bearer <token>"

Mark submission as read SubmissionsApiController#mark_submission_read

PUT /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/read

PUT /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/read

curl 'https://<canvas>/api/v1/courses/<course_id>/assignments/<assignment_id>/submissions/<user_id>/read.json' \
     -X PUT \
     -H "Authorization: Bearer <token>" \
     -H "Content-Length: 0"

Mark submission as unread SubmissionsApiController#mark_submission_unread

DELETE /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/read

DELETE /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/read

curl 'https://<canvas>/api/v1/courses/<course_id>/assignments/<assignment_id>/submissions/<user_id>/read.json' \
     -X DELETE \
     -H "Authorization: Bearer <token>"

Mark bulk submissions as read SubmissionsApiController#mark_bulk_submissions_as_read

PUT /api/v1/courses/:course_id/submissions/bulk_mark_read

PUT /api/v1/sections/:section_id/submissions/bulk_mark_read

Request Parameters:

curl 'https://<canvas>/api/v1/courses/<course_id>/submissions/bulk_mark_read.json' \
     -X PUT \
     -H "Authorization: Bearer <token>" \
     -H "Content-Length: 0" \
     -F 'submissionIds=['88']'

Mark submission item as read SubmissionsApiController#mark_submission_item_read

PUT /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/read/:item

PUT /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/read/:item

curl 'https://<canvas>/api/v1/courses/<course_id>/assignments/<assignment_id>/submissions/<user_id>/read/<item>.json' \
     -X PUT \
     -H "Authorization: Bearer <token>" \
     -H "Content-Length: 0"

Clear unread status for all submissions. SubmissionsApiController#submissions_clear_unread

PUT /api/v1/courses/:course_id/submissions/:user_id/clear_unread

PUT /api/v1/sections/:section_id/submissions/:user_id/clear_unread

curl 'https://<canvas>/api/v1/courses/<course_id>/submissions/<user_id>/clear_unread.json' \
     -X PUT \
     -H "Authorization: Bearer <token>" \
     -H "Content-Length: 0"

Get rubric assessments read state SubmissionsApiController#rubric_assessments_read_state

GET /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/rubric_comments/read

GET /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/rubric_assessments/read

GET /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/rubric_comments/read

GET /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/rubric_assessments/read

curl 'https://<canvas>/api/v1/courses/<course_id>/assignments/<assignment_id>/submissions/<user_id>/rubric_comments/read' \
     -H "Authorization: Bearer <token>"

# or

curl 'https://<canvas>/api/v1/courses/<course_id>/assignments/<assignment_id>/submissions/<user_id>/rubric_assessments/read' \
     -H "Authorization: Bearer <token>"

{
  "read": false
}

Mark rubric assessments as read SubmissionsApiController#mark_rubric_assessments_read

PUT /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/rubric_comments/read

PUT /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/rubric_assessments/read

PUT /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/rubric_comments/read

PUT /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/rubric_assessments/read

curl 'https://<canvas>/api/v1/courses/<course_id>/assignments/<assignment_id>/submissions/<user_id>/rubric_comments/read' \
     -X PUT \
     -H "Authorization: Bearer <token>" \
     -H "Content-Length: 0"

# or

curl 'https://<canvas>/api/v1/courses/<course_id>/assignments/<assignment_id>/submissions/<user_id>/rubric_assessments/read' \
     -X PUT \
     -H "Authorization: Bearer <token>" \
     -H "Content-Length: 0"

{
  "read": true
}

Get document annotations read state SubmissionsApiController#document_annotations_read_state

GET /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/document_annotations/read

GET /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/document_annotations/read

curl 'https://<canvas>/api/v1/courses/<course_id>/assignments/<assignment_id>/submissions/<user_id>/document_annotations/read' \
     -H "Authorization: Bearer <token>"

{
  "read": false
}

Mark document annotations as read SubmissionsApiController#mark_document_annotations_read

PUT /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/document_annotations/read

PUT /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/document_annotations/read

curl 'https://<canvas>/api/v1/courses/<course_id>/assignments/<assignment_id>/submissions/<user_id>/document_annotations/read' \
     -X PUT \
     -H "Authorization: Bearer <token>" \
     -H "Content-Length: 0"

{
  "read": true
}

Submission Summary SubmissionsApiController#submission_summary

GET /api/v1/courses/:course_id/assignments/:assignment_id/submission_summary

GET /api/v1/sections/:section_id/assignments/:assignment_id/submission_summary

Request Parameters:

{
  "graded": 5,
  "ungraded": 10,
  "not_submitted": 42
}