RespondentDataField

  • fieldId
    Type: stringFormat: uuid
    required

    A unique id for a field.

  • type
    Type: string
    required

    Type of respondent data field. E.g. Fields of type 'GENERIC' can be used when adding respondent data for an invitation.
    Fields types:

    • GENERIC: Custom field that can be created by users.
      System fields
    • EMAIL: Email address used when creating invitations
    • PHONE_NUMBER: Phone number used when creating invitations
    • SCORE_CURRENTMAX: reserved for scoring used by the system
    • SCORE_OBTAINED: reserved for scoring used by the system
    • SCORE_MAX: reserved for scoring used by the system
  • discreteValues
    Type: boolean

    If the field will contain many unique values (e.g. customerId) it should always be stored as text. (use hasDiscreteValues: false)

    • false: stored as plain text.
    • true: the values are stored as discrete values.
  • fieldName
    Type: string

    A unique text representation of the field.

  • personalData
    Type: boolean

    If the respondent data field is intended to contain personal data.