Skip to main content

Get Scores from Line Item

The LTI protocol allows you to retrieves scores from the LMS grade book through the Assignment and Grades - Results service. LTIAAS gives you access to this service through the /api/lineitems/:lineItemID/scores API endpoint.

Please check our Manipulating grades guide and its Retrieving grades section to learn more about using this endpoint.

API Authentication MethodSupported
Path Parameters
    lineItemID uri required

    The URL encoded line item ID.

Query Parameters
    userId string

    Used to to filter the results to a single user. The results MUST contain at most 1 result. An empty array MAY be returned if the user does not have any result recorded.

    limit integer

    Possible values: >= 1

    Used to to restrict the number of results returned; the platform MAY further reduce the number of results returned at its own discretion.

    url string

    Retrieves scores from a specific URL


    scores object[] required

    The platform must return a result record for each user that has a non empty 'resultScore' for the queried upon line item. The platform MAY skip empty results.

  • Array [
  • id uri required

    URL uniquely identifying the result record.

    userId string required

    The userId contains the LTI user ID identifying the recipient of the Result (usually a learner). The userId MUST be present.

    scoreOf uri required

    URL identifying the Line Item to which this result belongs. Must be the same as the line item id and the value of the lineitem claim when included in the LTI message.

    timestamp date-time required

    The timestamp MUST be present and indicate when the score was changed; it is intended to be used by the platform as a way to guard against out of order score updates. Score timestamp represents the server time when the Score state was modified.

    resultScore number

    The current score for this user. The value must be a numeric value. If no value exists, this attribute may be omitted, or have an explicit null value.

    resultMaximum number

    Possible values: > 0

    The 'resultMaximum' value MUST be a positive number (with 0 considered a negative number); if no value is specified, then a default maximum value of 1 must be used.

    comment string

    The current value for the comment. The value must be a string. If no value exists, this attribute may be omitted, blank or have an explicit null value.

  • ]
  • next uri

    A URL pointing to the next page of line items.

    prev uri

    A URL pointing to the previous page of line items.

    first uri

    A URL pointing to the first page of line items.

    last uri

    A URL pointing to the last page of line items.


All trademarks, logos, and service marks displayed on this website are the property of their respective owners. LTIAAS is a trademark of GatherAct, LLC, doing business as LTIAAS. Learning Tools Interoperability (LTI)® is a trademark of 1EdTech Consortium, Inc. LTIAAS is not affiliated with, endorsed or sponsored by 1EdTech Consortium, Inc. or by any other owners of third-party trademarks used on this website. LTIAAS is not responsible for the content, quality, or accuracy of any websites linked to or from this website that are not owned by LTIAAS. If you have any questions or concerns about the use of any trademarks or content on this website, please contact us.