Skip to content

nanoyan/response

Repository files navigation

Response

Title: Response

Type object
Required No
Additional properties Any type allowed

Description: Data structure produced by verona players

Property Pattern Type Deprecated Definition Title/Description
+ id No string No - Identifier for the data source (variable)
+ status No enum (of string) No - Status as stage in the workflow of creating and coding a variable's value
+ value No Combination No - -
- subform No string No - 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 No integer No - Code representing the category of the value after coding process.
- score No integer No - This value represents the result evaluation of the code after coding process.

1. Property Response > id

Type string
Required Yes

Description: Identifier for the data source (variable)

Examples:

"IE7873"
"UHZ654"
Restrictions
Must match regular expression ^[0-9a-zA-Z_]+$ Test

2. Property Response > status

Type enum (of string)
Required Yes

Description: Status as stage in the workflow of creating and coding a variable's value

Must be one of:

  • "UNSET"
  • "NOT_REACHED"
  • "DISPLAYED"
  • "VALUE_CHANGED"
  • "DERIVE_ERROR"
  • "CODING_COMPLETE"
  • "NO_CODING"
  • "INVALID"
  • "CODING_INCOMPLETE"
  • "CODING_ERROR"
  • "PARTLY_DISPLAYED"
  • "DERIVE_PENDING"
  • "INTENDED_INCOMPLETE"

3. Property Response > value

Type combining
Required Yes
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6

3.1. Property Response > value > anyOf > item 0

Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
item 0 items -

3.1.1. Response > value > anyOf > item 0 > item 0 items

Type string or null
Required No

3.2. Property Response > value > anyOf > item 1

Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
item 1 items -

3.2.1. Response > value > anyOf > item 1 > item 1 items

Type number or null
Required No

3.3. Property Response > value > anyOf > item 2

Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
item 2 items -

3.3.1. Response > value > anyOf > item 2 > item 2 items

Type boolean or null
Required No

3.4. Property Response > value > anyOf > item 3

Type number
Required No

3.5. Property Response > value > anyOf > item 4

Type string
Required No

3.6. Property Response > value > anyOf > item 5

Type null
Required No

3.7. Property Response > value > anyOf > item 6

Type boolean
Required No

4. Property Response > subform

Type string
Required No

Description: If variables i. e. data source ids are not unique in the unit, 'subform' can specify the sub object related to the specific variable.

5. Property Response > code

Type integer
Required No

Description: Code representing the category of the value after coding process.

6. Property Response > score

Type integer
Required No

Description: This value represents the result evaluation of the code after coding process.


Generated using json-schema-for-humans on 2025-02-26 at 10:28:17 +0000