Question
- additionalType: object · AdditionalInfo nullable
Information Additional information that might be visible for the question.
- messagesType: array object[] · ComplexText[]
- alternativesType: array object[] | null · Alternative[]
All alternatives for the question if applicable. Will not be visible if no alternatives on the question.
- alternativeType: stringFormat: uuid
Id A unique id for an alternative.
- orderType: integer | string
Number Pattern: ^-?(?:0|[1-9]\d*)$Format: int32Order the alternatives.
- scoreType: null | number | string
Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: doubleScore for the alternative if scoring is enabled.
- titlesType: array object[] · Title[]
All Titles for the alternative
- typeType: string
Alternative type. Valid values:
- DEFAULT: A regular alternative
- NA: Not applicable, N/A
- OTHER: Respondent specifies his own alternative as a short text
- weightType: null | number | string
Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: doubleWeight for the alternative. E.g. used in calculations.
- columnsType: array object[] | null · Column[]
All Columns for the question if applicable. Will not be visible if no columns on the question.
- orderType: integer | string
Number Pattern: ^-?(?:0|[1-9]\d*)$Format: int32Order of the question in the survey
- presentationType: string
Presentation of the question. Depending on the question type, different 'Presentation' might be valid. Data stored for question is the same regardless of 'Presentaion'. Default Value ''
- questionType: stringFormat: uuid
Id A unique id for a question.
- rowsType: array object[] | null · Row[]
All Rows for the question if applicable. Will not be visible if no rows on the question.
- titlesType: array object[] | null · Title[]
All question titles
- typeType: string
Column Types. Possible values:
- MATRIX: A matrix question, contains one or more rows(sub questions). Depending on the rows answers could be single select, mulitple choice or text.
- levelsType: array object[] | null · Level[]
Levels in the hierarchy. Only applicable for HIERARCHICAL question.
- alternativesType: array object[] · HierarchicalAlternative[]
All Alternatives. Alternatives have a hierarchical structure
- orderType: integer | string
Number Pattern: ^-?(?:0|[1-9]\d*)$Format: int32Order the questions.
- questionType: stringFormat: uuid
Id A unique id for a question.
- titlesType: array object[] · Title[]
All the titles for the current level
- orderType: integer | string
Number Pattern: ^-?(?:0|[1-9]\d*)$Format: int32Order of the question in the survey
- personalType: null | boolean
Data If the question is marked to posibly contains personal data.
- presentationType: string
Presentation of the question. Depending on the question type, different 'Presentation' might be valid. Data stored for question is the same regardless of 'Presentaion'. Default Value ''
- questionType: stringFormat: uuid
Id A unique id for a question.
- rowsType: array object[] | null · Row[]
All Rows for the question if applicable. Will not be visible if no rows on the question.
- alternativesType: array object[] | null · Alternative[]
All alternatives for the question if applicable. Will not be visible if no alternatives on the question.
- orderType: integer | string
Number Pattern: ^-?(?:0|[1-9]\d*)$Format: int32Order of the question in the survey
- presentationType: string
Presentation of the question. Depending on the question type, different 'Presentation' might be valid. Data stored for question is the same regardless of 'Presentaion'. Default Value ''
- questionType: stringFormat: uuid
Id A unique id for a question.
- titlesType: array object[] | null · Title[]
All question titles
- typeType: string
Row Types. Answers to the question are stored depending on the type. Below is a short overview of the types. Possible values:
- SINGLE_CHOICE: Single select question, takes a single alternative as answer. Possible for the respondent to specify his own alternative as a short text if the special alternative 'Other' is used.
- MULTIPLE_CHOICE: A Mulitpliple choice question, that takes one or more alternatives as answer. Possible for the respondent to specify his own alternative as a short text if the special alternative 'Other' is used.
- OPENANSWER: Open answer question. Answer is text.
- titlesType: array object[] | null · Title[]
All question titles
- languageType: string
Code requiredThe language code in BCP 47 format.
- titleType: stringrequired
Title as text
- typeType: string
Question Types. Answers to the question are stored depending on the type. Below is a short overview of the types. Possible values:
- SINGLE_CHOICE: Single select question, takes a single alternative as answer. Possible for the respondent to specify his own alternative as a short text if the special alternative 'Other' is used.
- MULTIPLE_CHOICE: A Mulitpliple choice question, that takes one or more alternatives as answer. Possible for the respondent to specify his own alternative as a short text if the special alternative 'Other' is used.
- OPENANSWER: Open answer question. Answer is text.
- MATRIX: A matrix question, contains one or more rows(sub questions). Depending on the rows answers could be single select, mulitple choice or text.
- MULTI_MATRIX: A question that contains 2 columns(matrix questions). Answers is depended on the type of matrix question.
- HIERARCHICAL: A questions that contain 1 or more levels. Each level gives a single alternative as answer.
- CALENDAR: A caldendar question. Answer is a date as text.
- FILE_UPLOAD: A file upload question. Respondent can upload a file as answer.
- INFORMATION: Only used for information when respondent is answering. No answers saved for this question type.