|
3 | 3 | "type": "object",
|
4 | 4 | "properties": {
|
5 | 5 | "page_id": {
|
| 6 | + "description": "Identifier of the page the question belongs to", |
6 | 7 | "type": ["string", "null"]
|
7 | 8 | },
|
8 | 9 | "id": {
|
| 10 | + "description": "Unique identifier for the question", |
9 | 11 | "type": ["string", "null"]
|
10 | 12 | },
|
11 | 13 | "position": {
|
| 14 | + "description": "Position of the question within the survey", |
12 | 15 | "type": ["integer", "null"]
|
13 | 16 | },
|
14 | 17 | "visible": {
|
| 18 | + "description": "Indicates if the question is visible", |
15 | 19 | "type": ["boolean", "null"]
|
16 | 20 | },
|
17 | 21 | "family": {
|
| 22 | + "description": "Family to which the question belongs", |
18 | 23 | "type": ["string", "null"]
|
19 | 24 | },
|
20 | 25 | "subtype": {
|
| 26 | + "description": "Specific type of question", |
21 | 27 | "type": ["string", "null"]
|
22 | 28 | },
|
23 | 29 | "layout": {
|
| 30 | + "description": "Layout style of the question", |
24 | 31 | "type": ["object", "null"]
|
25 | 32 | },
|
26 | 33 | "sorting": {
|
| 34 | + "description": "Sorting options for the question", |
27 | 35 | "type": ["object", "null"],
|
28 | 36 | "properties": {
|
29 | 37 | "ignore_last": {
|
| 38 | + "description": "Boolean to ignore the last option for sorting", |
30 | 39 | "type": ["boolean", "null"]
|
31 | 40 | },
|
32 | 41 | "type": {
|
| 42 | + "description": "Type of sorting", |
33 | 43 | "type": ["string", "null"]
|
34 | 44 | }
|
35 | 45 | }
|
36 | 46 | },
|
37 | 47 | "required": {
|
| 48 | + "description": "Indicates if the question is required", |
38 | 49 | "type": ["object", "null"],
|
39 | 50 | "properties": {
|
40 | 51 | "amount": {
|
| 52 | + "description": "Number of required choices", |
41 | 53 | "type": ["string", "null"]
|
42 | 54 | },
|
43 | 55 | "text": {
|
| 56 | + "description": "Text specifying requirement", |
44 | 57 | "type": ["string", "null"]
|
45 | 58 | },
|
46 | 59 | "type": {
|
| 60 | + "description": "Type of requirement", |
47 | 61 | "type": ["string", "null"]
|
48 | 62 | }
|
49 | 63 | }
|
50 | 64 | },
|
51 | 65 | "validation": {
|
| 66 | + "description": "Validation rules for the question", |
52 | 67 | "type": ["object", "null"],
|
53 | 68 | "properties": {
|
54 | 69 | "max": {
|
| 70 | + "description": "Maximum value for validation", |
55 | 71 | "type": ["integer", "null"]
|
56 | 72 | },
|
57 | 73 | "min": {
|
| 74 | + "description": "Minimum value for validation", |
58 | 75 | "type": ["integer", "null"]
|
59 | 76 | },
|
60 | 77 | "sum": {
|
| 78 | + "description": "Sum value for validation", |
61 | 79 | "type": ["integer", "null"]
|
62 | 80 | },
|
63 | 81 | "sum_text": {
|
| 82 | + "description": "Sum text for validation", |
64 | 83 | "type": ["string", "null"]
|
65 | 84 | },
|
66 | 85 | "text": {
|
| 86 | + "description": "Text validation message", |
67 | 87 | "type": ["string", "null"]
|
68 | 88 | },
|
69 | 89 | "type": {
|
| 90 | + "description": "Type of validation", |
70 | 91 | "type": ["string", "null"]
|
71 | 92 | }
|
72 | 93 | }
|
73 | 94 | },
|
74 | 95 | "forced_ranking": {
|
| 96 | + "description": "Indicates if the question uses forced ranking", |
75 | 97 | "type": ["boolean", "null"]
|
76 | 98 | },
|
77 | 99 | "headings": {
|
| 100 | + "description": "Array of headings for the question", |
78 | 101 | "type": ["array", "null"],
|
79 | 102 | "items": {
|
| 103 | + "description": "Represents an individual heading", |
80 | 104 | "type": ["object", "null"],
|
81 | 105 | "properties": {
|
82 | 106 | "heading": {
|
| 107 | + "description": "Text of the heading", |
83 | 108 | "type": ["string", "null"]
|
84 | 109 | }
|
85 | 110 | }
|
86 | 111 | }
|
87 | 112 | },
|
88 | 113 | "href": {
|
| 114 | + "description": "Hyperlink reference for the question", |
89 | 115 | "type": ["string", "null"]
|
90 | 116 | },
|
91 | 117 | "answers": {
|
| 118 | + "description": "Contains information about answer choices for the question", |
92 | 119 | "type": ["object", "null"],
|
93 | 120 | "properties": {
|
94 | 121 | "choices": {
|
| 122 | + "description": "An array of answer choices for the question", |
95 | 123 | "type": ["array", "null"],
|
96 | 124 | "items": {
|
| 125 | + "description": "Represents an individual answer choice", |
97 | 126 | "type": ["object", "null"],
|
98 | 127 | "properties": {
|
99 | 128 | "position": {
|
| 129 | + "description": "Position of the answer choice in the list", |
100 | 130 | "type": ["integer", "null"]
|
101 | 131 | },
|
102 | 132 | "visible": {
|
| 133 | + "description": "Boolean indicating if the answer choice is visible", |
103 | 134 | "type": ["boolean", "null"]
|
104 | 135 | },
|
105 | 136 | "text": {
|
| 137 | + "description": "Text of the answer choice", |
106 | 138 | "type": ["string", "null"]
|
107 | 139 | },
|
108 | 140 | "quiz_options": {
|
| 141 | + "description": "Optional properties specific to quiz questions", |
109 | 142 | "type": ["object", "null"],
|
110 | 143 | "properties": {
|
111 | 144 | "score": {
|
| 145 | + "description": "Score associated with the answer choice", |
112 | 146 | "type": ["integer", "null"]
|
113 | 147 | }
|
114 | 148 | }
|
115 | 149 | },
|
116 | 150 | "id": {
|
| 151 | + "description": "Unique identifier for the answer choice", |
117 | 152 | "type": ["string", "null"]
|
118 | 153 | }
|
119 | 154 | }
|
|
0 commit comments