Skip to main content
GET
/
assessment-tests
Search and filter assessment tests
curl --request GET \
  --url https://qti.alpha-1edtech.ai/api/assessment-tests \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "identifier": "<string>",
      "title": "<string>",
      "qtiVersion": "3.0",
      "qti-test-part": [
        {
          "identifier": "<string>",
          "navigationMode": "linear",
          "submissionMode": "individual",
          "qti-assessment-section": [
            {
              "identifier": "<string>",
              "title": "<string>",
              "visible": true,
              "required": true,
              "fixed": false,
              "sequence": 123,
              "qti-assessment-item-ref": [
                {
                  "identifier": "<string>",
                  "href": "<string>"
                }
              ]
            }
          ]
        }
      ],
      "qti-outcome-declaration": [
        {
          "identifier": "<string>",
          "cardinality": "single",
          "baseType": "identifier",
          "normalMaximum": 123,
          "normalMinimum": 123,
          "defaultValue": {
            "value": "<unknown>"
          }
        }
      ],
      "rawXml": "<string>",
      "content": {
        "qti-assessment-test": {
          "_attributes": {
            "xmlns": "<string>",
            "xmlns:xsi": "<string>",
            "xsi:schemaLocation": "<string>",
            "identifier": "<string>",
            "title": "<string>",
            "tool-name": "<string>",
            "tool-version": "<string>"
          },
          "qti-outcome-declaration": [
            {
              "_attributes": {
                "identifier": "<string>",
                "cardinality": "<string>",
                "base-type": "<string>"
              },
              "qti-default-value": {
                "qti-value": "<unknown>"
              },
              "normal-maximum": 123,
              "normal-minimum": 123
            }
          ],
          "qti-test-part": [
            {
              "_attributes": {
                "identifier": "<string>",
                "navigation-mode": "<string>",
                "submission-mode": "<string>"
              },
              "qti-assessment-section": [
                {
                  "_attributes": {
                    "identifier": "<string>",
                    "title": "<string>",
                    "visible": "<string>"
                  },
                  "qti-assessment-item-ref": [
                    {
                      "_attributes": {
                        "identifier": "<string>",
                        "href": "<string>"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "timeLimit": 123,
      "maxAttempts": 123,
      "toolsEnabled": {},
      "metadata": {},
      "__v": 123
    }
  ],
  "total": 123,
  "page": 1,
  "pages": 123,
  "limit": 10,
  "sort": "<string>",
  "order": "asc"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
query
string

Search title and identifier fields using a search term. This is a fuzzy search.

​
page
string
default:1

Page number for pagination

Example:

1

​
limit
string
default:10

Number of items per page

Example:

10

​
sort
enum<string>

Field to sort by

Available options:
title,
identifier,
createdAt,
updatedAt
Example:

"createdAt"

​
order
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

​
navigationMode
enum<string>

Filter by navigation mode (linear: sequential navigation, nonlinear: free navigation)

Available options:
linear,
nonlinear
Example:

"linear"

​
submissionMode
enum<string>

Filter by submission mode (individual: submit per item, simultaneous: submit all at once)

Available options:
individual,
simultaneous
Example:

"individual"

​
subject
string

Filter by subject (e.g. Math, Reading) using the optimized consolidated field

Example:

"Math"

​
grade
string

Filter by grade level using the optimized consolidated field

Example:

"5"

​
hasQuestions
enum<string>

Filter tests based on whether they have questions (true) or not (false)

Available options:
true,
false
Example:

"true"

​
filter
string

Advanced filter expression using =, !=, >, >=, <, <=, ~ and logical AND/OR. Example: type='practice' AND createdAt>'2024-01-01'

Response

Assessment tests retrieved successfully

Paginated response containing all assessment tests available on the service provider with navigation metadata

​
items
object[]
required

Array of assessment tests that match the search criteria on the service provider

​
total
number
required

The total number of entities that match the search criteria.

​
page
number
default:1
required

The page number of the entities that match the search criteria.

​
pages
number
required

The total number of pages of entities that match the search criteria.

​
limit
number
default:10
required

The number of entities per page.

​
sort
string
required

The field to sort the entities by.

​
order
enum<string>
required

The order to sort the entities by. Either 'asc' or 'desc'.

Available options:
asc,
desc