Failed Submissions endpoint
This endpoint can be used to submit failed learner submissions.
You would want to use this to re-submit a learner's session that could not be saved or submitted due to network issues, for example.
See Configuring Behavior in Case of Network Failure & Failed Submission for more information on how a learner can obtain their session data.
Endpoints:
Usage
The format of requests to the Data API use the following syntax:
https://data.learnosity.com/{LTS_VERSION}/{endpoint}
For example, to use the v2025.1.LTS
version and the itembank/items
endpoint, you would create a request like so:
https://data.learnosity.com/v2025.1.LTS/itembank/items
Important Data API is not a REST API. All requests must use the POST method with the action
request body parameter specifying the operation to use. The Learnosity SDK must be used to make requests to Data API.
Note Data API usage is subject to rate limits.
Related articles:
- Getting Started with the Data API
- See Release Cadence and Version Lifecycle for more information on available LTS versions.
Failed Submissions
Submit failed learner submissions.
The endpoint will create a job to be completed asynchronously which can be polled for, using the GET /jobs endpoint and the returned job_reference
to check the status of the job.
Endpoint | /{LTS_VERSION}/sessions |
---|---|
HTTP method | POST |
Action type | "set" |
Request body parameters
Body content type: application/json
-
data array[string]
An array of base64 strings that represent the learner's session data.
See Configuring Behavior in Case of Network Failure & Failed Submission for more information on how a learner can obtain their session data.
Maximum entries:
50
-
data_format string
The format of the request payload.
Must be set to
"failed_submission"
.Possible values
failed_submission
-
ignore_response_revisions boolean
Controls whether to ignore the revision value inside a recorded response.
See Understanding Submission and Scoring for more information.
Default:
false
Request body example
{ "data_format": "failed_submission", "data": [ "[BASE64 ENCODED SESSION 1]", "[BASE64 ENCODED SESSION 2]", "[BASE64 ENCODED SESSION 3]" ] }
Responses
Response example
{ "meta": { "status": true, "timestamp": 1433375442 }, "data": { "job_reference": "58023cd7-3158-4b47-9708-34f976466cd7" } }