Submit Score

The Assignment & Grades endpoint tools call to post a grade. You never call this — LTIAAS relays it to your Service URL as a SCORE_POST service request, and passes your status code straight back to the tool.

Requires an access token with the GRADES_WRITE scope.

Path Parameters

contextId string required
The URL-encoded context identifier — the same context value you supplied when starting the launch.
Example: 2022CSEa5e6c431b91
lineItemId string required
The line item identifier your Service URL assigned.
Example: 412

application/json

Request Body required

userId string required
activityProgress string required

Possible values: [Initialized, Started, InProgress, Submitted, Completed]

How far the user has got with the activity.

gradingProgress string required

Possible values: [FullyGraded, Pending, PendingManual, Failed, NotReady]

How far the tool has got with grading it.

comment string
scoreGiven number

Optional — a score may report progress without a grade.

scoreMaximum number

Required whenever scoreGiven is present.

Responses

• 200
• 400
• 401
• 403

---

Score accepted. The exact status is whatever your Service URL returned.

One or more request parameters were missing or malformed.

application/json

Schema

Example (from schema)

---

Schema

status integer
error string
details object
errors object[]
One entry per field that failed validation.
Array [
field string
message string
]

{
  "status": 400,
  "error": "Bad Request",
  "details": {
    "errors": [
      {
        "field": "clientId",
        "message": "Missing 'clientId' parameter."
      }
    ]
  }
}

The Authorization header was missing, malformed, or carried the wrong key.

application/json

Schema

Example (from schema)

Example

---

Schema

status integer
error string
details object

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

message string

description string

property name* any

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "description": "string"
  }
}

{
  "status": 401,
  "error": "Unauthorized",
  "details": {
    "message": "INVALID_BEARER_AUTHORIZATION_HEADER",
    "description": "Invalid API Key for account."
  }
}

The LTI® service this endpoint depends on is not enabled on your account.

application/json

Schema

Example (from schema)

Example

---

Schema

status integer
error string
details object

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

message string

description string

property name* any

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "description": "string"
  }
}

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "service": "Deep Linking"
  }
}

Loading...