> For the complete documentation index, see [llms.txt](https://developerdocs.instructure.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developerdocs.instructure.com/services/canvas/resources/result.md).

# Result

Result API for 1EdTech (IMS) [Assignment and Grade Services](/services/canvas/external-tools/lti/file.assignment_tools.md).

#### A Result object looks like: <a href="#result" id="result"></a>

```js
{
  // 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](#method.lti/ims/results.index) <a href="#method.lti-ims-results.index" id="method.lti-ims-results.index"></a>

[Lti::Ims::ResultsController#index](https://github.com/instructure/canvas-lms/blob/master/app/controllers/lti/ims/results_controller.rb)

#### `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](#result) object.

## [Show a Result](#method.lti/ims/results.show) <a href="#method.lti-ims-results.show" id="method.lti-ims-results.show"></a>

[Lti::Ims::ResultsController#show](https://github.com/instructure/canvas-lms/blob/master/app/controllers/lti/ims/results_controller.rb)

#### `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](#result) object.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developerdocs.instructure.com/services/canvas/resources/result.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
