ResponseWithAnswers

  • questId
    Type: stringFormat: uuid
    required

    A unique id for a quest.

  • responseId
    Type: stringFormat: uuid
    required

    A unique id for a response.

  • answers
    Type: array object[] · Answer[]

    Answers for the current response. alternativeId and/or value will be set.

    • questionId
      Type: stringFormat: uuid
      required

      A unique id for a question.

    • alternativeId
      Type: null | stringFormat: uuid

      A unique id for an alternative. Alternative not visible if not applicable.

    • value
      Type: null | string

      The answer value. Can be a string or a number.

  • completedAt

    When the response was completed.

  • distributionChannel
    Type: string

    Distribution channel used when sending the invitation. Valid values:

    • EMAIL: Invitation link distriubted by email
    • SMS: Invitation link distributed by sms
    • EXTERNALLY_MANAGED: Invitation link distributed by quest owner. E.g. Send emails with private provider
    • LINK: Static link exposed by quest owner; one link for all respondents. E.g. a web page.
    • LINK_WITH_EMAIL: Static link exposed by quest owner; one link for all respondents, possible for respondent to apply email address.
    • DYNAMIC_LINK: Invitation link distributed by dynamic link
  • hiddenIdentity
    Type: boolean

    If the response is hidden identity or not.

  • invitationId
    Type: null | stringFormat: uuid

    A unique id for a invitation.

  • languageCode
    Type: string

    The language code in BCP 47 format.

  • respondentData
    Type: array object[] · RespondentDataValue[]

    Respondent data for the current response

    • fieldId
      Type: stringFormat: uuid
      required

      A unique id for a field.

    • fieldValue
      Type: null | string

      The value of the data value.

    • fieldValueId
      Type: null | stringFormat: uuid

      A unique id for a respondent data field data value.

  • respondentIdent
    Type: string

    Respondent identifier. Unique for the respondent.

  • startedAt

    When the response was started.