Skip to main content
GET
/
ims
/
oneroster
/
gradebook
/
v1p2
/
classes
/
{classSourcedId}
/
lineItems
/
{lineItemSourcedId}
/
results
Get Results for a Line Item for a Class
curl --request GET \
  --url https://api.alpha-1edtech.ai/ims/oneroster/gradebook/v1p2/classes/{classSourcedId}/lineItems/{lineItemSourcedId}/results \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "status": "active",
      "lineItem": {
        "sourcedId": "<string>"
      },
      "student": {
        "sourcedId": "<string>"
      },
      "scoreStatus": "exempt",
      "scoreDate": "2023-11-07T05:31:56Z",
      "sourcedId": "<string>",
      "dateLastModified": "2023-11-07T05:31:56Z",
      "metadata": {},
      "class": {
        "sourcedId": "<string>"
      },
      "scoreScale": {
        "sourcedId": "<string>"
      },
      "score": 123,
      "textScore": "<string>",
      "comment": "<string>",
      "learningObjectiveSet": [
        {
          "source": "<string>",
          "learningObjectiveResults": [
            {
              "learningObjectiveId": "<string>",
              "score": 123,
              "textScore": "<string>"
            }
          ]
        }
      ],
      "inProgress": "<string>",
      "incomplete": "<string>",
      "late": "<string>",
      "missing": "<string>"
    }
  ],
  "totalCount": 123,
  "pageCount": 123,
  "pageNumber": 123,
  "offset": 123,
  "limit": 123
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

classSourcedId
string
required

The sourcedId of the class

lineItemSourcedId
string
required

The sourcedId of the line item

Query Parameters

fields
string

Comma-separated list of fields to include in the response

Example:

"sourcedId,name"

limit
integer
default:100

The maximum number of items to return in the paginated response. While the OneRoster specification does not define a maximum limit, this implementation enforces a maximum of 3000 to prevent abuse and ensure optimal performance.

Required range: 1 <= x <= 3000
Example:

100

offset
integer
default:0

The number of items to skip in the paginated response

Required range: x >= 0
Example:

0

sort
string

The field to sort the response by

orderBy
enum<string>

The order to sort the response by

Available options:
asc,
desc
filter
string

The filter to apply to the response

Example:

"status='active'"

PROPRIETARY EXTENSION: Free-text search across multiple fields. Provides convenient text-based querying beyond the standard OneRoster filter parameter.

Example:

"john"

Response

Successful response containing a collection of results for the specified line item in the class

results
object[]
required
totalCount
number
required
pageCount
number
required
pageNumber
number
required
offset
number
required
limit
number
required