Skip to content
The API may change between versions while TTX-Zone is 0.x.

Get evaluation

GET
/api/v1/ttx/{ttx_id}/run/evaluation

The Evaluator’s EEG for the session, with their ratings.

room
Any of:
string
<= 16 characters

Successful Response

Media typeapplication/json
RunEvaluationRead

The evaluator’s EEG for the session: the objectives they rate (all of them for the Lead Evaluator) and how far along they are.

object
objectives
required
Objectives
Array<object>
RunEvalObjectiveRead
object
capability
required
Capability
string
code
required
Code
string
id
required
Id
string format: uuid
points
required
Points
Array<object>
RunPointRead

An observation point to rate: what it means at each level (blank: the common scale), where it comes from, what the Controller saw of its expected action, and the evaluator’s rating.

object
action_code
required
Action Code
string
action_mark
required
Any of:
ActionMark
string
Allowed values: observed partial not_observed
action_note
required
Action Note
string
criteria
required
Criteria
object
key
additional properties
string
expected_within_minutes
required
Any of:
integer
id
required
Id
string format: uuid
inject_code
required
Inject Code
string
kind
required
Kind
string
rating
required
Any of:
RunRatingRead
object
inject_code
required
Inject Code
string
level
required
RatingLevel

The common rating scale: performed without challenges (P), with some (S), with major ones (M), or unable to be performed (U).

string
Allowed values: P S M U
rationale
required
Rationale
string
updated_at
required
Updated At
string format: date-time
responsible_role
required
Responsible Role
string
text
required
Text
string
statement
required
Statement
string
title
required
Title
string
rated
required
Rated
integer
total
required
Total
integer

Example

{
"objectives": [
{
"points": [
{
"action_mark": "observed",
"rating": {
"level": "P"
}
}
]
}
]
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}