Skip to main content
POST
/
assessment-tests
Create a new assessment test
curl --request POST \
  --url https://qti.alpha-1edtech.ai/api/assessment-tests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "<string>",
  "title": "<string>",
  "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>"
            }
          ]
        }
      ]
    }
  ],
  "qtiVersion": "3.0",
  "toolName": "<string>",
  "toolVersion": "<string>",
  "timeLimit": 123,
  "maxAttempts": 123,
  "toolsEnabled": {},
  "metadata": {},
  "qti-outcome-declaration": [
    {
      "identifier": "<string>",
      "baseType": "identifier",
      "cardinality": "single",
      "normalMaximum": 123,
      "normalMinimum": 123,
      "defaultValue": {
        "value": "<unknown>"
      }
    }
  ]
}
'
{
  "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",
  "isValidXml": true,
  "timeLimit": 123,
  "maxAttempts": 123,
  "toolsEnabled": {},
  "metadata": {},
  "__v": 123
}

Authorizations

​
Authorization
string
header
required

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

Body

The assessment test to create

Create a new assessment test on the service provider. The test must include at least one test part and can optionally include outcome declarations for result tracking

​
identifier
string
required

Unique identifier for the entity on the service provider.

​
title
string
required

Human-readable title of the entity on the service provider.

​
qti-test-part
object[]
required

Array of test parts to include in this assessment test. At least one test part is required

​
qtiVersion
string
default:3.0

Version of the specification used for this assessment test

​
toolName
string

Name of the authoring tool that created this entity. The tool name characteristic allows the tool creating the test to identify itself. Other processing systems may use this information to interpret the content of application specific data, such as labels on the elements of the test rubric.

​
toolVersion
string

Version of the authoring tool that created this entity. The tool version characteristic allows the tool creating the test to identify its version. This value must only be interpreted in the context of the tool name.

​
timeLimit
number

Time limit for the entire assessment test in seconds. When not specified, there is no time limit

​
maxAttempts
number

Maximum number of attempts allowed for the assessment test. When not specified, unlimited attempts are allowed

​
toolsEnabled
object

Configuration of assessment tools available to candidates. Each tool is represented as a key-value pair where the key is the tool name and the value indicates if it's enabled

​
metadata
object

Additional custom metadata for extending entity properties beyond standard specification for QTI entities.

​
qti-outcome-declaration
object[]

Array of outcome variable declarations for storing assessment results and computed values

Response

Assessment test created successfully

Complete assessment test data including all test parts, sections, items, and configuration settings

​
identifier
string
required

Unique identifier for the entity on the service provider.

​
title
string
required

Human-readable title of the entity on the service provider.

​
qtiVersion
string
default:3.0
required

Version of the specification used for this assessment test

​
qti-test-part
object[]
required
​
qti-outcome-declaration
object[]
required

Array of outcome variable declarations for storing assessment results and computed values

​
rawXml
string
required

Raw XML representation of the entity, automatically generated from the JSON or XML sent when creating entities on the service provider. The rawxml field will contain all content sent when creating the entity on the service provider. This field is stable and should be used when working within this QTI API.

​
content
object
required

Parsed XML content structure for the assessment test. For production use, rawXml is recommended over this parsed structure.

​
createdAt
string<date-time>
required

ISO 8601 timestamp when the entity was created

​
updatedAt
string<date-time>
required

ISO 8601 timestamp when the entity was last updated

​
isValidXml
boolean
required

Indicates whether the generated XML is valid according to schema validation

​
timeLimit
number

Time limit for the entire assessment test in seconds. When not specified, there is no time limit

​
maxAttempts
number

Maximum number of attempts allowed for the assessment test. When not specified, unlimited attempts are allowed

​
toolsEnabled
object

Configuration of assessment tools available to candidates. Each tool is represented as a key-value pair where the key is the tool name and the value indicates if it's enabled

​
metadata
object

Additional custom metadata for extending entity properties beyond standard specification for QTI entities.

​
__v
number

MongoDB version key for optimistic concurrency control