GET
/
v1
/
trace-learn
/
onboarding
/
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.getTraceLearnOnboardingOptions()
{
  "roles": [
    {
      "label": "<string>",
      "description": "<string>",
      "firstDestination": "<string>"
    }
  ],
  "yearGroups": [],
  "examFamilies": [
    {
      "id": "<string>",
      "label": "<string>",
      "defaultForBuckinghamshire": true
    }
  ],
  "subjects": [
    {
      "name": "<string>"
    }
  ],
  "avatars": [
    {
      "id": "<string>",
      "label": "<string>",
      "icon": "<string>"
    }
  ],
  "tutorStudentCountBands": [],
  "tutorPainPoints": [
    {
      "label": "<string>"
    }
  ],
  "studentCredentialRules": {
    "usernameMinLength": 123,
    "pinLength": 123,
    "childrenUseEmailLogin": true
  }
}

Response

Success

roles
object[]
required
yearGroups
enum<string>[]
required
Available options:
Year 4,
Year 5,
Year 6
examFamilies
object[]
required
subjects
object[]
required
avatars
object[]
required
tutorStudentCountBands
enum<string>[]
required
Available options:
1-5,
6-15,
16-30,
30+
tutorPainPoints
object[]
required
studentCredentialRules
object
required