Object specifications for storing and processing response in assessments (see schema id for version) documentation

Object specifications for storing and processing response in assessments (see schema id for version)

After the assessment is finished, the response data are to be processed in various ways. The data structures describe here are part of interface specifications of IQB.

Go to the Schema section of this document and select one schema. Expand all nodes and explore.

Operations

SEND iqb_data_structures
Operation IDPlease select one schema
Accepts the following message:
select_schema
Message IDselect_schema
Examples

Schemas

object [Response]
uid: response@iqb-standard@1.3
Data structure produced by verona players

id
required
string
must match: ^[0-9a-zA-Z_]+$
Identifier for the data source (variable)

status
required
string
Status as stage in the workflow of creating and coding a variable's value

Allowed values:
"UNSET"
"NOT_REACHED"
"DISPLAYED"
"VALUE_CHANGED"
"DERIVE_ERROR"
"NO_CODING"
"INVALID"
"CODING_INCOMPLETE"
"CODING_ERROR"
"CODING_COMPLETE"
required
anyOf
array<string | null>
Items:
string | null
array<number | null>
Items:
number | null
array<boolean | null>
Items:
boolean | null
Or to:
number
Or to:
string
Or to:
null
Or to:
boolean
subform
string
If variables i. e. data source ids are not unique in the unit, 'subform' can specify the sub object related to the specific variable.

code
integer
Code representing the category of the value after coding process.

score
integer
This value represents the result evaluation of the code after coding process.

Additional properties are allowed.
object [Coding Scheme]
uid: coding-scheme@iqb-standard@3.1
Data structure to specify all processing steps of response data in order to get coded and scored data for analyses.

version
required
string
must match: ^\d+\.\d+$
Major and minor of the version of the data structure.

Examples values:
"3.5"
"4.10"
array<object>
object
id
required
string
must match: ^[0-9a-zA-Z_]+$
Identifier for the variable. In case of a scheme for a base variable, this id is identical with the source variable's id. All ids of a response scheme should be unique.

alias
string
must match: ^[0-9a-zA-Z_]+$
Alternative identifier for the variable. In case of a scheme for a base variable, this id is identical with the source variable's alternative id. All alternative ids of a response scheme should be unique.

label
string
Some additional info for UI

sourceType
required
string
Specifies how to derive (concatenate, check uniqueness, sum code etc.).

Allowed values:
"BASE"
"COPY_VALUE"
"CONCAT_CODE"
"SUM_CODE"
"SUM_SCORE"
"UNIQUE_VALUES"
"SOLVER"
object
Parameters to specify the derive method

solverExpression
string
If sourceType 'solver', this expression is evaluated when deriving. Placeholder for variables are in curly brakes.

Examples values:
"${01}*${03}-100"
array<string>
Some options to change value or status

Items:
string
Allowed values:
"TO_LOWER_CASE"
"TO_NUMBER"
"REMOVE_ALL_SPACES"
"REMOVE_DISPENSABLE_SPACES"
"TAKE_DISPLAYED_AS_VALUE_CHANGED"
"TAKE_EMPTY_AS_VALID"
"SORT"
Additional properties are allowed.
array<string>
Items:
string
must match: ^[0-9a-zA-Z_]+$
array<string>
This parameter defines what (pre)processing should be done.

Items:
string
Allowed values:
"IGNORE_CASE"
"IGNORE_ALL_SPACES"
"IGNORE_DISPENSABLE_SPACES"
"SORT_ARRAY"
"REPLAY_REQUIRED"
"ATTACHMENT"
fragmenting
string
Regular expression to get fragments out of the value if of type string

manualInstruction
string
Instructions for manual coding.

codeModel
string
Info for applications to simplify UI

Allowed values:
"MANUAL_AND_RULES"
"RULES_ONLY"
"MANUAL_ONLY"
page
string
If the unit supports paging, this property defines the page to be presented to the coder if manually coded.

array<object>
object
required
oneOf
If this code's rules/instructions match, the code and score is taken for the response. If the code id is of value 'null', no code or score is taken. Instead, the status 'INVALID' will be set.

Adheres to:
integer
Or to:
null
type
string
To ease some processing and documentation

Allowed values:
"UNSET"
"FULL_CREDIT"
"PARTIAL_CREDIT"
"TO_CHECK"
"NO_CREDIT"
"RESIDUAL"
"RESIDUAL_AUTO"
label
string
score
integer
manualInstruction
string
Instructions for manual coding.

ruleSetOperatorAnd
boolean
If true, all rule sets must match to take that code. Otherwise (default: false), one matching rule set will satisfy.

array<object>
object
anyOf
Can adhere to:
integer
Refers to a specific position in the value array [0..n-1].

Or to:
string
Refers to any position in the value array, to the sum of all array values or the length of the value array.

Allowed values:
"ANY"
"ANY_OPEN"
"SUM"
"LENGTH"
ruleOperatorAnd
boolean
If true, all rules must match to take that code. Otherwise (default: false), one matching rule will satisfy.

required
array<object>
object
fragment
integer
Refers to a specific fragment of the value [0..n-1] or to any -1.

method
required
string
Condition for evaluation

Allowed values:
"MATCH"
"MATCH_REGEX"
"NUMERIC_MATCH"
"NUMERIC_RANGE"
"NUMERIC_LESS_THAN"
"NUMERIC_MORE_THAN"
"NUMERIC_MAX"
"NUMERIC_MIN"
"IS_EMPTY"
"IS_NULL"
"IS_TRUE"
"IS_FALSE"
array<string>
Depending on the method, additional parameter(s) is needed. See separate documentation

Items:
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object [Missing]
uid: missing@iqb-standard@1.0
Data structure to describe a missing status in the final data set.

id
required
string
must match: ^[A-Za-z_]+$
Identifier for missing

Examples values:
"mnr"
"mir"
"mbo"
label
required
string
Short description. This text might be used as code label in data sets.

description
required
string
Long description to explain meaning of that missing.

code
required
integer
Code used in data sets to represent this missing.

Examples values:
-98
-97
Additional properties are allowed.
object [Status Map]
uid: state-map@iqb-standard@1.0
Data structure to specify recoding based on response state.

status
required
string
Status of a response to be recoded.

Allowed values:
"UNSET"
"NOT_REACHED"
"DISPLAYED"
"INVALID"
"DERIVE_ERROR"
"NO_CODING"
"CODING_INCOMPLETE"
"CODING_ERROR"
recodeToMissing
string
must match: ^[A-Za-z_]+$
Identifier for missing. A missing list is required to lookup the code value.

Examples values:
"mbi"
"mbd"
"mir"
recodeToFalse
boolean
If true, the value is recoded to the first score 0 code found in the code list of coding scheme.

Additional properties are allowed.

Object specifications for storing and processing response in assessments (see schema id for version)

Operations

SEND iqb_data_structures

Examples

Schemas