Verona Inferfaces Specification "Schemer" 3.0.0 documentation

Verona Inferfaces Specification "Schemer" 3.0.0

This is one part of the Verona Online Assessment Standards. All messages are sent via the postMessage function of the html page. The schemer takes the page root of its parent as target (parent.window), and the application binds the function call to the iframe element of the schemer. Most important, the message body carries as first parameter the operationId of the message. The html page MUST contain a script-tag with metadata. The syntax and structure of this data are described here.

Operations

SEND vosReadyNotification
Ready Notification
The schemer announces that it's code is loaded and initialized so the communication can start.

Operation IDvosReadyNotification
Accepts the following message:
object
metadata
required
string
Via this property, the schemer sends the stringified metadata object definied as json-ld in the header of the html file. See here for more information.

Additional properties are allowed.
Examples
{ "metadata": "string" }

This example has been generated automatically.
RECEIVE vosStartCommand
Start Command
The application sends parameters for editing the coding scheme and commands the start of user interaction.

Operation IDvosStartCommand
Accepts the following message:
application/json
object
sessionId
required
string
The session id flags all communication. If a message has no or empty session id, it's not processed. The session id is unique and was generated by the application. Any simple algorithm would work. The session id helps to link the correct unit with the data of the message. Using the id of the editor hosting html element is less reliable, because the element could be reused with another unit.

codingScheme
string
format: byte
The coding scheme (if given) to be edited.

codingSchemeType
string
This lets the schemer the coding scheme format know. This might avoid UI mess after getting old schemes.

array<object [variable info for coding]>
Data of variables from unit definition. These variables represent the states of controls during assessment and form the basis of all coding. We call these variables 'base variables'.

object [variable info for coding]
uid: variable-list@iqb-standard@1.0
This data structure

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

type
required
string
Data type of the variable value

Allowed values:
"string"
"integer"
"number"
"boolean"
"attachment"
format
string
Data type format

Allowed values:
"text-selection"
"image"
"capture-image"
"audio"
"ggb-file"
"non-negative"
"latex"
"math-ml"
"math-table"
"ggb-variable"
""
multiple
boolean
Can the value be of type Array?

Default value:false
nullable
boolean
Can the value be null?

Default value:false
array<object>
List of possible values

object
value
required
string | number | boolean
label
string
Additional properties are allowed.
array<string>
Labels of the positions if the value is of type array

Items:
string
valuesComplete
boolean
Are the given values all possible values?

Default value:false
page
string
Pageof the unit, on which the variable is located.

Additional properties are allowed.
object
directDownloadUrl
string
After starting the schemer and loading the scheme, it might be necessary to load additional code or data from the server. This data is identified by an resource ID (usually a file name). The schemer can download this resource by itself without further interaction with the host frontend. The property directDownloadUrl provides the url for download. The schemer extends this url by an url separator "/" and the resource ID (uri-encoded if needed).

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "sessionId": "idk8ur5jf9ru5jk", "codingScheme": "<CodingScheme> <Variable id=\"text-field_2\" label=\"text-field_2\"> <RuleBased> <Transform>DATE_TO_ISO</Transform> </RuleBased> <Code code=\"1\" score=\"11\" label=\"111\"> <Rule method=\"MATCH\"> <Parameter>2021-12-04</Parameter> </Rule> </Code> <Code code=\"2\" score=\"22\" label=\"222\"> <Rule method=\"MATCH\"> <Parameter>2022-12-04</Parameter> </Rule> </Code> </Variable> </CodingScheme>", "codingSchemeType": "iqb@1.0", "variables": [ { "id": "^0$", "type": "string", "format": "text-selection", "multiple": false, "nullable": false, "values": [ { "value": "string", "label": "string" } ], "valuePositionLabels": [ "string" ], "valuesComplete": false, "page": "string" } ], "schemerConfig": { "directDownloadUrl": "https://www.iqb-supercoder.de/download/iskeid-34e845-didmmemdkek" } }

This example has been generated automatically.
SEND vosSchemeChangedNotification
Scheme Changed Notification
The coding scheme of the unit has changed.

Operation IDvosSchemeChangedNotification
Accepts the following message:
application/json
object
sessionId
required
string
The session id flags all communication. If a message has no or empty session id, it's not processed. The session id is unique and was generated by the application. Any simple algorithm would work. The session id helps to link the correct unit with the data of the message. Using the id of the editor hosting html element is less reliable, because the element could be reused with another unit.

timeStamp
required
string
format: date-time
Ensures, that later arriving states are ignored.

codingScheme
required
string
format: byte
To be stored.

codingSchemeType
required
string
In order to understand the coding scheme outside the schemer, the type of the scheme should be known. This helps to select a suitable coder to run coding.

array<object>
Files to provide or services to keep accessible during the coding of responses to the items of the unit.

object
id
required
string
type
required
string
Allowed values:
"file"
"service"
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "sessionId": "idk8ur5jf9ru5jk", "timeStamp": "2019-08-24T14:15:22Z", "codingScheme": "string", "codingSchemeType": "iqb@1.0", "dependenciesToCode": [ { "id": "https://short-answer-supercoder.iqb-berlin.de", "type": "file" } ] }

This example has been generated automatically.

Schemas

SessionIdString
string
The session id flags all communication. If a message has no or empty session id, it's not processed. The session id is unique and was generated by the application. Any simple algorithm would work. The session id helps to link the correct unit with the data of the message. Using the id of the editor hosting html element is less reliable, because the element could be reused with another unit.
object
id
required
string
type
required
string
Allowed values:
"file"
"service"
Additional properties are allowed.
object
directDownloadUrl
string
After starting the schemer and loading the scheme, it might be necessary to load additional code or data from the server. This data is identified by an resource ID (usually a file name). The schemer can download this resource by itself without further interaction with the host frontend. The property directDownloadUrl provides the url for download. The schemer extends this url by an url separator "/" and the resource ID (uri-encoded if needed).

Additional properties are allowed.

Verona Inferfaces Specification "Schemer" 3.0.0

Operations

SEND vosReadyNotification

Examples

This example has been generated automatically.

RECEIVE vosStartCommand

Examples

This example has been generated automatically.

SEND vosSchemeChangedNotification

Examples

This example has been generated automatically.

Schemas