Result

Welcome to Our New API Docs! This is the new home for all things API (previously at Canvas LMS REST API Documentation).

Result API

Result API for 1EdTech (IMS) Assignment and Grade Services.

A Result object looks like:

{
  // The fully qualified URL for showing the Result
  "id": "http://institution.canvas.com/api/lti/courses/5/line_items/2/results/1",
  // The lti_user_id or the Canvas user_id
  "userId": "50 | 'abcasdf'",
  // The score of the result as defined by Canvas, scaled to the resultMaximum
  "resultScore": 50,
  // Maximum possible score for this result; 1 is the default value and will be
  // assumed if not specified otherwise. Minimum value of 0 required.
  "resultMaximum": 50,
  // Comment visible to the student about the result.
  "comment": null,
  // URL of the line item this belongs to
  "scoreOf": "http://institution.canvas.com/api/lti/courses/5/line_items/2"
}

Show a collection of Results

Lti::Ims::ResultsController#index

GET /api/lti/courses/:course_id/line_items/:line_item_id/results

Scope: url:GET|/api/lti/courses/:course_id/line_items/:line_item_id/results

Show existing Results of a line item. Can be used to retrieve a specific student’s result by adding the user_id (defined as the lti_user_id or the Canvas user_id) as a query parameter (i.e. user_id=1000). If user_id is included, it will return only one Result in the collection if the result exists, otherwise it will be empty. May also limit number of results by adding the limit query param (i.e. limit=100)

Returns a Result object.

Show a Result

Lti::Ims::ResultsController#show

GET /api/lti/courses/:course_id/line_items/:line_item_id/results/:id

Scope: url:GET|/api/lti/courses/:course_id/line_items/:line_item_id/results/:id

Show existing Result of a line item.

Returns a Result object.

---

This documentation is generated directly from the Canvas LMS source code, available on Github.