GET
/
v1
/
trace-learn
/
session
/
context
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.getTraceLearnSessionContext({
  query: {},
})
{
  "actorId": "<string>",
  "displayName": "<string>",
  "organizationId": "<string>",
  "teamId": "<string>",
  "studentId": "<string>",
  "learnerKey": "<string>",
  "adminGrants": []
}

Query Parameters

​
role
enum<string>
Available options:
student,
tutor,
parent,
admin_internal

Response

Success

​
actorId
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
​
role
enum<string>
required
Available options:
student,
tutor,
parent,
admin_internal
​
displayName
string
required

a string at least 1 character(s) long

Minimum string length: 1
​
organizationId
string | null
required

a string at most 128 character(s) long

Required string length: 1 - 128
​
teamId
string | null
required

a string at most 128 character(s) long

Required string length: 1 - 128
​
studentId
string | null
required

a string at most 128 character(s) long

Required string length: 1 - 128
​
learnerKey
string | null
required

a string at most 128 character(s) long

Required string length: 1 - 128
​
entitlementState
enum<string>
required
Available options:
diagnostic_only,
trial,
active,
past_due,
none
​
adminGrants
enum<string>[]
required
Available options:
content_admin,
platform_admin,
support