Local Device Assessment endpoint

The content from this endpoint is used in the Learnosity local device assessment app.

See Using Local Device Assessment for more information.

Endpoints:

• Get Local Device Assessment Package

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.

Download all content in assessment from your Item bank for offline use in a local device.

This 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.

Request body parameters

Body content type: application/json

• organisation_id integer

  Specifies the Item bank to retrieve content from.

  The API consumer making the request will need to have access to the Item bank. This access can be checked via the API consumers configuration in the Learnosity Console.

  Default: the primary Item bank associated with the API consumer.

• activity_references array[string]

  A list of Activity references to include in the local device package.

  Maximum entries: 1000

• items array[object]

  A list of ItemObjects to be packaged.

• item_references array[string] Deprecated

  This parameter is deprecated, see items instead.

  A list of Item references to be packaged.

  Maximum entries: 1000

• base_directory string

  (optional) Specify the base directory for all content and assets.

  Default: /vendor/itembank

Request body example

{
    "items": [
        {
            "id": "item_reference_1",
            "reference": "item_reference_1"
        },
        {
            "id": "item_reference_2",
            "reference": "item_reference_2",
            "organisation_id": 1
        }
    ],
    "activity_references": [
        "activity_reference_1"
    ]
}

Responses

A JSON object containing a job_reference that can be submitted to the jobs endpoint to track the completion of the asynchronous request.

Response example

{
    "meta": {
        "status": true,
        "timestamp": 1389193100,
        "records": 1
    },
    "data": [
        {
            "job_reference": "69fe1753-dec5-43d3-9b83-e2b87e1d8ffa"
        }
    ]
}