Skip to main content
GET
/
stimuli
Search and filter stimuli
curl --request GET \
  --url https://qti.alpha-1edtech.ai/api/stimuli \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "identifier": "<string>",
      "title": "<string>",
      "catalogInfo": [
        {
          "id": "<string>",
          "support": "<string>",
          "content": "<string>"
        }
      ],
      "rawXml": "<string>",
      "content": {
        "qti-assessment-stimulus": {
          "_attributes": {
            "xmlns": "<string>",
            "xmlns:xsi": "<string>",
            "xsi:schemaLocation": "<string>",
            "identifier": "<string>",
            "xml:lang": "<string>",
            "title": "<string>"
          },
          "qti-stimulus-body": {},
          "qti-stylesheet": {
            "_attributes": {
              "href": "<string>",
              "type": "<string>"
            }
          },
          "qti-catalog-info": {
            "qti-catalog": {
              "_attributes": {
                "id": "<string>"
              },
              "qti-card": {
                "_attributes": {
                  "support": "<string>"
                },
                "qti-html-content": {}
              }
            }
          }
        }
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "label": "<string>",
      "language": "en",
      "stylesheet": {
        "href": "<string>",
        "type": "<string>"
      },
      "toolName": "<string>",
      "toolVersion": "<string>",
      "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"

Response

Successfully retrieved stimuli

Paginated response containing all stimuli that match the search criteria with navigation metadata

​
items
object[]
required

The items array will contain all stimuli 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