scp-index - click on schema id to expand documentation

scp-index - click on schema id to expand

Specification for survey content package index.

Operations

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

Schemas

object [Survey Content Package Index]
uid: scp-index@0.2
Specification for survey content package index.

packageId
required
string
Identifier for the survey content package

version
required
string
Package Version in SemVer format.

required
array<object>
non-empty
Language tagged text

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
array<object>
non-empty
Language tagged text

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
maintainerName
string
Name of the person or institution responsable for creating and maintaining

Examples values:
"IQB - Institut zur Qualitätsentwicklung im Bildungswesen"
maintainerUrl
string
Url of maintainer to get more information or to get in contact

Examples values:
"https://www.iqb.hu-berlin.de/tba"
status
string
Describes the progress of development and visibility issues. During development, version suffixes may be used like 'beta', 'rc' etc.

Default value:"IN_DEVELOPMENT"
Allowed values:
"IN_DEVELOPMENT"
"DISCONTINUED"
"RELEASED_PUBLIC"
"RELEASED_CONFIDENTIAL"
object [Metadata Values]
uid: metadata-values@iqb-standard@3.0
Data structure to store metadata

profileId
required
string
non-empty
Identifier for the metadata profile

order
integer
Specifies the position of this profile if more than one are used. Set to -1 if you want to hide/disable the profile.

required
array<object>
non-empty
object
id
required
string
non-empty
Id of the profile entry related to these data

array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
required
anyOf
array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
array<object>
non-empty
Used for storing selected vocabulary entries and (optional) additional texts.

object
id
required
string
non-empty
Full id of the vocabulary entry as url - including the vocabulary url

array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
object
Used for uncoded text, numbers and boolean.

raw
required
string
Pure value. Numbers and boolean in JavaScript toString() notation ('true', 'false', '23.566').

array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are allowed.
Additional properties are NOT allowed.
object
Some parameters for coding and analysis in general

array<object>
Mapping logical item values to numeric values. Standards are 1-FULL_CREDIT, 0-NO_CREDIT, -99-MISSING.

object
type
string
Allowed values:
"FULL_CREDIT"
"NO_CREDIT"
"MISSING"
value
integer
Additional properties are allowed.
array<object>
Rules how to translate response status into item value

object
itemValueType
required
string
Allowed values:
"FULL_CREDIT"
"NO_CREDIT"
"MISSING"
required
array<string>
non-empty
Items:
string
Allowed values:
"UNSET"
"NOT_REACHED"
"DISPLAYED"
"VALUE_CHANGED"
"DERIVE_ERROR"
"NO_CODING"
"INVALID"
"CODING_INCOMPLETE"
"CODING_ERROR"
"PARTLY_DISPLAYED"
"DERIVE_PENDING"
"INTENDED_INCOMPLETE"
"CODE_SELECTION_PENDING"
Additional properties are NOT allowed.
minItemsPercent
number
Minimum number of items in responses for a scale to be reported (percent)

Default value:0
Additional properties are NOT allowed.
array<object>
non-empty
Groups of instruments, administrated the same way or at the same time.

object
id
required
string
Identifier for the survey part

required
array<object>
non-empty
Language tagged text

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
array<object>
non-empty
Language tagged text

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
object [Metadata Values]
uid: metadata-values@iqb-standard@3.0
Data structure to store metadata

profileId
required
string
non-empty
Identifier for the metadata profile

order
integer
Specifies the position of this profile if more than one are used. Set to -1 if you want to hide/disable the profile.

required
array<object>
non-empty
object
id
required
string
non-empty
Id of the profile entry related to these data

array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
required
anyOf
array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
array<object>
non-empty
Used for storing selected vocabulary entries and (optional) additional texts.

object
id
required
string
non-empty
Full id of the vocabulary entry as url - including the vocabulary url

array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
object
Used for uncoded text, numbers and boolean.

raw
required
string
Pure value. Numbers and boolean in JavaScript toString() notation ('true', 'false', '23.566').

array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are allowed.
Additional properties are NOT allowed.
array<object>
non-empty
All modules used in this surveyPart by instruments

object
id
required
string
Id to be referred in instruments

name
string
description
string
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

required
array<object>
non-empty
All units being part of the module

object
id
required
string
Identifier for the instrument

alias
string
Identifier for responses

name
string
description
string
order
integer
>= 0
Default sorting is alpha-numeric.

Default value:0
required
array<object>
non-empty
All digital objects being part of the unit

object
id
required
string
Id/path to find the digital object

type
required
string
Describes the function of the dependency.

Allowed values:
"UNIT_XML"
"CODING_SCHEME"
"METADATA"
"UI_DEFINITION"
"PLAYER"
"PLAYER_DEPENDENCY"
"WIDGET"
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
required
array<object>
non-empty
All instruments for the survey part, online or to hand out

object
id
required
string
Identifier for the instrument

required
array<object>
non-empty
Language tagged text

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
object [Metadata Values]
uid: metadata-values@iqb-standard@3.0
Data structure to store metadata

profileId
required
string
non-empty
Identifier for the metadata profile

order
integer
Specifies the position of this profile if more than one are used. Set to -1 if you want to hide/disable the profile.

required
array<object>
non-empty
object
id
required
string
non-empty
Id of the profile entry related to these data

array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
required
anyOf
array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
array<object>
non-empty
Used for storing selected vocabulary entries and (optional) additional texts.

object
id
required
string
non-empty
Full id of the vocabulary entry as url - including the vocabulary url

array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
object
Used for uncoded text, numbers and boolean.

raw
required
string
Pure value. Numbers and boolean in JavaScript toString() notation ('true', 'false', '23.566').

array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are allowed.
Additional properties are NOT allowed.
required
array<object>
If part of TBA, this ids refer to the language specific XML definition used to run the instrument in IQB-Testcenter.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

definitionId
required
string
Id/path to the booklet XML to run this instrument

required
array<object>
non-empty
object
moduleId
required
string
Reference to the module id at surveyPart level

order
integer
>= 0
Default sorting is alpha-numeric.

Default value:0
Additional properties are NOT allowed.
Additional properties are NOT allowed.
administrationMode
string
Default value:"TEST_BY_TEST_TAKER"
Allowed values:
"TEST_BY_TEST_TAKER"
"TEST_BY_PROCTOR"
"STIMULUS_FOR_TEST_TAKER"
array<object>
non-empty
All documents must be presented to the test taker (online or print-out).

object
order
integer
>= 0
Default sorting is alpha-numeric.

Default value:0
mode
string
Default value:"PRINT"
Allowed values:
"PRINT_SHOW"
"PRINT_WRITE_DRAW"
"ON_SCREEN"
required
array<array<object>>
non-empty
All language variants of the same hand-out

Items:
array<object>
non-empty
Variants of the same object in different languages

object
id
required
string
id/path to the object, used as reference

lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

label
required
string
description
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
required
array<object>
non-empty
Definition of all items from all modules.

object
id
required
string
Identifier used in all other definitions of this document

required
array<object>
non-empty
Language tagged text

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
required
array<object>
non-empty
This item will get its value from various sources throughout the survey

object
moduleId
string
Refers to the module used by an instrument of the surveyPart. If no moduleId is given, all modules will searched for the unit.

unitId
required
string
Refers to the unit data (UI definition, coding scheme, metadata etc.)

unitAlias
string
Refers to the unit id used in response data

sourceVariable
required
string
Refers to the variable providing its score as item value

Additional properties are NOT allowed.
fullCreditValue
integer
Score of source variable representing full credit

Default value:1
noCreditValue
integer
Score of source variable representing no credit

Default value:0
Additional properties are NOT allowed.
array<object>
Scales based directly on item values, providing one value per test taker

object
id
required
string
Identifier referred by other scales and survey output.

required
array<object>
non-empty
Language tagged text

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
array<object>
non-empty
Language tagged text

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
method
required
string
Way how to process the item values.

Allowed values:
"SUM"
"RATIO"
"MEAN"
"MEDIAN"
oneOf
Depending on the method, different parameters specify the processing.

object
Parameters for the processing method RATIO.

maxValue
required
number
If methodParameters is not given, the number of items will be taken as maxValue

Additional properties are NOT allowed.
required
array<string>
non-empty
List of all items providing it's value to this specific scale

Items:
string
Additional properties are NOT allowed.
array<object>
Scales based on other scale's value, providing one value per test taker

object
id
required
string
Identifier referred by other scales and survey output.

required
array<object>
non-empty
Language tagged text

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
array<object>
non-empty
Language tagged text

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
source
required
string
Id of the scale providing the value for this derived scale.

required
array<object>
non-empty
Applies the method to the value. The first match will go.

object
method
required
string
Condition for evaluation

Allowed values:
"EQUALS"
"LESS_THAN"
"MORE_THAN"
"MAX"
"MIN"
required
array<string>
non-empty
Depending on the method, additional parameter(s) is needed.

Items:
string
newValue
required
number
Value as outcome of this scale

array<object>
non-empty
Language tagged text

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
array<object>
non-empty
Language tagged text

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
elseValue
number
Value if no mapping matches

Default value:0
array<object>
non-empty
Language tagged text

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
array<object>
non-empty
Language tagged text

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
array<object>
Refers to public vocabularies to map the proficiency level to well known concepts

object
url
required
string
URL to access the related vocabulary

name
string
Shorthand title or name to understand the relation quickly

required
array<object>
non-empty
object
value
required
number
url
required
string
relationShip
string
Default value:"SAME_AS"
Allowed values:
"SAME_AS"
"ALIKE"
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
array<object>
non-empty
Additional documents supporting the assessment

object
contentType
required
string
Allowed values:
"CODING_INSTRUCTIONS"
"STUDY_BACKGROUND"
required
array<string>
non-empty
Items:
string
Allowed values:
"PROCTOR"
"TEST_TAKER"
"TEACHER"
"TEST_ADMINISTRATION"
"GOVERNANCE"
"CODER"
required
array<object>
non-empty
Variants of the same object in different languages

object
id
required
string
id/path to the object, used as reference

lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

label
required
string
description
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.

Operations

SEND iqb_data_structures

Examples

Schemas