Schemas

• acp-index@0.5

  Expand all

  object [Assessment Content Package Index]

  uid: acp-index@0.5

  Specification for assessment content package index.

  packageId

  required

  string

  Identifier for the assessment content package

  version

  required

  string

  Package Version in SemVer format.

  name

  Expand all

  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.

  description

  Expand all

  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.

  Default value:"IN_DEVELOPMENT"

  Allowed values:
  • "IN_DEVELOPMENT"
  • "DISCONTINUED"
  • "RELEASED_PUBLIC"
  • "RELEASED_CONFIDENTIAL"

  metadata

  Expand all

  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.

  entries

  Expand all

  required

  array<object>

  non-empty

  object

  id

  required

  string

  non-empty

  Id of the profile entry related to these data

  label

  Expand all

  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.

  value

  Expand all

  required

  anyOf

  Can adhere to:

  Expand all

  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.

  Or to:

  Expand all

  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

  label

  Expand all

  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.

  annotation

  Expand all

  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.

  Or to:

  Expand all

  object

  Used for uncoded text, numbers and boolean.

  raw

  required

  string

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

  asText

  Expand all

  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.

  codingParameters

  Expand all

  object

  Some parameters for coding and analysis in general

  itemValues

  Expand all

  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.

  statusMapping

  Expand all

  array<object>

  Rules how to translate response status into item value

  object

  itemValueType

  required

  string

  Allowed values:
  • "FULL_CREDIT"
  • "NO_CREDIT"
  • "MISSING"

  status

  Expand all

  required

  array<string>

  non-empty

  Items:

  string

  Allowed values:
  • "UNSET"
  • "NOT_REACHED"
  • "DISPLAYED"
  • "INVALID"
  • "CODING_ERROR"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  assessmentParts

  Expand all

  array<object>

  non-empty

  Groups of instruments, administrated the same way or at the same time.

  object

  id

  required

  string

  Identifier for the assessment part

  name

  Expand all

  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.

  description

  Expand all

  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.

  metadata

  Expand all

  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.

  entries

  Expand all

  required

  array<object>

  non-empty

  object

  id

  required

  string

  non-empty

  Id of the profile entry related to these data

  label

  Expand all

  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.

  value

  Expand all

  required

  anyOf

  Can adhere to:

  Expand all

  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.

  Or to:

  Expand all

  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

  label

  Expand all

  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.

  annotation

  Expand all

  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.

  Or to:

  Expand all

  object

  Used for uncoded text, numbers and boolean.

  raw

  required

  string

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

  asText

  Expand all

  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.

  units

  Expand all

  required

  array<object [Assessment Content Package Unit]>

  non-empty

  Definition of all units and items used by modules.

  object [Assessment Content Package Unit]

  uid: acp-unit@0.5

  Specification for assessment content package unit.

  id

  required

  string

  name

  string

  description

  string

  lang

  string

  must match: ^[a-z]{2}$non-empty

  ISO-language code

  Default value:"de"

  items

  Expand all

  array<object>

  non-empty

  Default sorting is alpha-numeric.

  object

  id

  required

  string

  useUnitAliasAsPrefix

  boolean

  If true, the unique item identifier will be composed of the unit alias and the item id. If false, the item id has no prefix.

  Default value:true

  name

  string

  sourceVariable

  required

  string

  Refers to the variable providing its score as item value

  Additional properties are NOT allowed.

  dependencies

  Expand all

  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_INDEX"
  • "UNIT_CODING_SCHEME"
  • "UNIT_METADATA"
  • "UNIT_UI_DEFINITION"
  • "PLAYER"
  • "PLAYER_DEPENDENCY"
  • "WIDGET"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  bookletModules

  Expand all

  required

  array<object>

  non-empty

  All modules used in this assessmentPart by instruments

  object

  id

  required

  string

  Id to be referred in instruments

  name

  string

  description

  string

  lang

  string

  must match: ^[a-z]{2}$non-empty

  ISO-language code

  Default value:"de"

  units

  Expand all

  required

  array<object>

  non-empty

  All units being part of the module

  object

  id

  required

  string

  Identifier referring to unit list

  alias

  string

  Prefix for full item identifier. If not given, the id will be used instead.

  order

  integer

  >= 0

  Default sorting is alpha-numeric.

  Default value:0

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  instruments

  Expand all

  required

  array<object>

  non-empty

  All instruments for the assessment part, online or to hand out

  object

  id

  required

  string

  Identifier for the instrument

  name

  Expand all

  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.

  metadata

  Expand all

  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.

  entries

  Expand all

  required

  array<object>

  non-empty

  object

  id

  required

  string

  non-empty

  Id of the profile entry related to these data

  label

  Expand all

  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.

  value

  Expand all

  required

  anyOf

  Can adhere to:

  Expand all

  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.

  Or to:

  Expand all

  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

  label

  Expand all

  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.

  annotation

  Expand all

  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.

  Or to:

  Expand all

  object

  Used for uncoded text, numbers and boolean.

  raw

  required

  string

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

  asText

  Expand all

  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.

  testcenterBooklet

  Expand all

  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

  string

  must match: ^[a-z]{2}$non-empty

  ISO-language code

  Default value:"de"

  definitionId

  required

  string

  Id/path to the booklet XML to run this instrument

  modules

  Expand all

  required

  array<object>

  non-empty

  object

  moduleId

  required

  string

  Reference to the module id at assessmentPart 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"

  handOutsForTestTaker

  Expand all

  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"

  file

  Expand all

  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.

  scales

  Expand all

  array<object [Assessment Content Package: Scale]>

  non-empty

  Scales to calculate performance indicators

  object [Assessment Content Package: Scale]

  uid: acp-scale@0.2

  Specification for assessment content package scale.

  id

  required

  string

  Identifier referred by other scales and assessment output.

  name

  Expand all

  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.

  description

  Expand all

  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.

  scaleType

  required

  string

  Allowed values:
  • "BASE"
  • "DERIVED"
  • "AGGREGATED"

  typeParameters

  Expand all

  required

  oneOf

  Every type needs a different set of parameters.

  Adheres to:

  Expand all

  object

  These parameters will be used for scaleType BASE

  method

  required

  string

  Way how to process the item values.

  Allowed values:
  • "SCORE_SUM"
  • "SCORE_RATIO"
  • "SCORE_MEAN"
  • "SCORE_MEDIAN"
  • "WLE"
  • "CODE_COUNT"

  methodParameters

  Expand all

  oneOf

  Depending on the method, different parameters may specify the processing.

  Adheres to:

  Expand all

  object

  Parameters for the processing method SCORE_RATIO.

  maxValue

  required

  number

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

  Additional properties are NOT allowed.

  Or to:

  Expand all

  object

  Parameters for the processing method CODE_COUNT.

  codeValue

  required

  number

  Value of code to be counted

  Additional properties are NOT allowed.

  items

  Expand all

  required

  array<object>

  non-empty

  List of all items providing it's value to this scale

  object

  id

  required

  string

  Identifier referring to unique identifier of item in unit list.

  parameters

  Expand all

  array<object>

  List of item values relevant for processing

  object

  key

  required

  string

  Allowed values:
  • "LOGIT_FULL_CREDIT"
  • "LOGIT_PARTIAL_CREDIT_1"
  • "LOGIT_PARTIAL_CREDIT_2"
  • "LOGIT_PARTIAL_CREDIT_3"

  value

  string

  Additional properties are NOT allowed.

  weight

  number

  Default value:1

  Additional properties are NOT allowed.

  minItemNumber

  number

  Minimum number of items in responses for this scale to be reported; set '0' for unlimited

  Default value:0

  Additional properties are NOT allowed.

  Or to:

  Expand all

  object

  These parameters will be used for scaleType DERIVED

  source

  required

  string

  Id of the scale providing the value for this derived scale.

  mappings

  Expand all

  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"

  parameters

  Expand all

  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

  valueLabel

  Expand all

  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.

  valueDescription

  Expand all

  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

  elseValueLabel

  Expand all

  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.

  elseValueDescription

  Expand all

  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.

  relatedVocabularies

  Expand all

  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

  values

  Expand all

  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.

  Or to:

  Expand all

  object

  These parameters will be used for scaleType AGGREGATED

  method

  string

  Way how to process the item values.

  Default value:"SUM"

  Allowed values:
  • "SUM"
  • "MEAN"

  sources

  Expand all

  required

  array<object>

  >= 2 items

  List of all scales providing it's value to this scale

  object

  id

  required

  string

  Id of the scale providing the value for this aggregation.

  weight

  number

  Factor to adapt the scale value

  Default value:1

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  additionalDocuments

  Expand all

  array<object>

  non-empty

  Additional documents supporting the assessment

  object

  contentType

  required

  string

  Allowed values:
  • "CODING_INSTRUCTIONS"
  • "STUDY_BACKGROUND"

  targeting

  Expand all

  required

  array<string>

  non-empty

  Items:

  string

  Allowed values:
  • "PROCTOR"
  • "TEST_TAKER"
  • "TEACHER"
  • "TEST_ADMINISTRATION"
  • "GOVERNANCE"
  • "CODER"

  file

  Expand all

  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.