GET
/
v1
/
trace-learn
/
tutor
/
assignments
/
authoring-options
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'

const client = new TxAgentKitClient({
  token: process.env.TX_AGENT_KIT_TOKEN
})

const response = await client.traceLearn.getTraceLearnAssignmentAuthoringOptions()
{
  "subjects": [
    {
      "name": "<string>"
    }
  ],
  "students": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "avatarId": "<string>",
      "yearGroup": "<string>",
      "targetSchool": "<string>",
      "overallScore": 50
    }
  ],
  "modeRules": {
    "miniTest": {
      "defaultQuestionCount": 123,
      "allowedQuestionCounts": [
        123
      ],
      "defaultTimeLimitMinutes": 123,
      "allowedTimeLimitMinutes": [
        123
      ],
      "immediateFeedback": true
    },
    "test": {
      "defaultQuestionCount": 123,
      "allowedQuestionCounts": [
        123
      ],
      "defaultTimeLimitMinutes": 123,
      "allowedTimeLimitMinutes": [
        123
      ],
      "immediateFeedback": true
    },
    "practice": {
      "fixedQuestionCount": 123,
      "fixedTimeLimitMinutes": 123,
      "immediateFeedback": true
    }
  }
}

Response

Success

subjects
object[]
required
students
object[]
required
modeRules
object
required