Skip to main content

Questionnaire

questions object[]

List of questions in the questionnaire

  • Array [
  • defaultSubQuestionsobject[]

    List of recursive questions from "questionnaire"

    descriptionstring

    Description of the question

    Example: Shipment readiness
    freeTextAnswerstring

    Free text answer for the question

    Example: Not good but acceptable
    idstringrequired

    Unique identifier of a question

    Example: abc-123
    options object[]

    List of answering options

  • Array [
  • idstring

    Unique identifier of the option

    otherOptionTextstring

    Other option text

    Example: Acceptable
    questionsobject[]

    List of recursive questions from "questionnaire"

    selectedboolean

    Indicate whether this option is selected or not

    Example: true
    textstring

    Preset answer in text

    Example: Yes
  • ]
  • questionTypestringrequired

    Question type e.g single select, multiple select

    Example: single select
    responseIdstring

    Unique identifier of a response

    Example: 1a2b3c
    validation objectrequired

    Question validation

    mandatorybooleanrequired

    Indicate if the question is mandatory or not

    Example: true
  • ]
  • Questionnaire
    {
    "questions": [
    {
    "defaultSubQuestions": [
    {}
    ],
    "description": "Shipment readiness",
    "freeTextAnswer": "Not good but acceptable",
    "id": "abc-123",
    "options": [
    {
    "id": "string",
    "otherOptionText": "Acceptable",
    "questions": [
    {}
    ],
    "selected": "true",
    "text": "Yes"
    }
    ],
    "questionType": "single select",
    "responseId": "1a2b3c",
    "validation": {
    "mandatory": "true"
    }
    }
    ]
    }