Question

  • additionalInformation
    Type: object · AdditionalInfo nullable

    Additional information that might be visible for the question.

    • messages
      Type: array object[] · ComplexText[]
  • alternatives
    Type: array object[] | null · Alternative[]

    All alternatives for the question if applicable. Will not be visible if no alternatives on the question.

    • alternativeId
      Type: stringFormat: uuid

      A unique id for an alternative.

    • orderNumber
      Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

      Order the alternatives.

    • score
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

      Score for the alternative if scoring is enabled.

    • titles
      Type: array object[] · Title[]

      All Titles for the alternative

    • type
      Type: string

      Alternative type. Valid values:

      • DEFAULT: A regular alternative
      • NA: Not applicable, N/A
      • OTHER: Respondent specifies his own alternative as a short text
    • weight
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

      Weight for the alternative. E.g. used in calculations.

  • columns
    Type: array object[] | null · Column[]

    All Columns for the question if applicable. Will not be visible if no columns on the question.

    • orderNumber
      Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

      Order of the question in the survey

    • presentation
      Type: 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 ''

    • questionId
      Type: stringFormat: uuid

      A unique id for a question.

    • rows
      Type: array object[] | null · Row[]

      All Rows for the question if applicable. Will not be visible if no rows on the question.

    • titles
      Type: array object[] | null · Title[]

      All question titles

    • type
      Type: 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.
  • levels
    Type: array object[] | null · Level[]

    Levels in the hierarchy. Only applicable for HIERARCHICAL question.

    • alternatives
      Type: array object[] · HierarchicalAlternative[]

      All Alternatives. Alternatives have a hierarchical structure

    • orderNumber
      Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

      Order the questions.

    • questionId
      Type: stringFormat: uuid

      A unique id for a question.

    • titles
      Type: array object[] · Title[]

      All the titles for the current level

  • orderNumber
    Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

    Order of the question in the survey

  • personalData
    Type: null | boolean

    If the question is marked to posibly contains personal data.

  • presentation
    Type: 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 ''

  • questionId
    Type: stringFormat: uuid

    A unique id for a question.

  • rows
    Type: array object[] | null · Row[]

    All Rows for the question if applicable. Will not be visible if no rows on the question.

    • alternatives
      Type: array object[] | null · Alternative[]

      All alternatives for the question if applicable. Will not be visible if no alternatives on the question.

    • orderNumber
      Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

      Order of the question in the survey

    • presentation
      Type: 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 ''

    • questionId
      Type: stringFormat: uuid

      A unique id for a question.

    • titles
      Type: array object[] | null · Title[]

      All question titles

    • type
      Type: 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.
  • titles
    Type: array object[] | null · Title[]

    All question titles

    • languageCode
      Type: string
      required

      The language code in BCP 47 format.

    • title
      Type: string
      required

      Title as text

  • type
    Type: 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.