Alternative

  • 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

    • languageCode
      Type: string
      required

      The language code in BCP 47 format.

    • title
      Type: string
      required

      Title as text

  • 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.