Create Session Response

Response after successfully creating a session

questions object[]

Array of questions for the current page

Possible values: <= 1000

Array [

oneOf

• Descriptive Block
• Form Question
• Matrix Question
• Multiple Choice Question
• Net Promoter Score Question
• Rank Order Question
• Slider Question
• Text Entry Question

idstringrequired

Unique question identifier

Example: QID1

displaystringrequired

Question text/HTML content to display

requiredstring

Question requirement level - 'off', 'force' (required), 'request' (optional)

Possible values: [off, force, request]

Example: force

typestringrequired

Descriptive Block question type (display-only text/media)

Possible values: [db]

file object

File/image configuration for display

urlstringrequired

URL of the file/image to display

typestringrequired

Type of file

Possible values: [image, file]

descriptionstringrequired

Alt text or description of the file

]

endMessagestring

Message displayed when survey is complete

donebooleanrequired

Whether the survey is complete

embeddedData object

Embedded data variables

property name* object

anyOf

• string
• number<double>
• boolean

string

sessionIdstringrequired

Unique session identifier

Example: FS_123456789

Create Session Response

{
  "questions": [
    {
      "id": "QID1",
      "display": "string",
      "required": "force",
      "type": "db",
      "file": {
        "url": "string",
        "type": "image",
        "description": "string"
      }
    },
    {
      "id": "QID1",
      "display": "string",
      "required": "force",
      "type": "form",
      "choices": [
        {
          "id": "1",
          "display": "string",
          "image": {
            "name": "string",
            "url": "string",
            "textPosition": "top",
            "expandedUrl": "string"
          },
          "textEntry": {
            "contentType": "number",
            "required": true,
            "symbol": {
              "value": "$",
              "position": "before"
            }
          },
          "exclusiveSelect": true
        }
      ]
    },
    {
      "id": "QID1",
      "display": "string",
      "required": "force",
      "type": "matrix",
      "labels": [
        "Strongly Disagree",
        "Disagree",
        "Neutral",
        "Agree",
        "Strongly Agree"
      ],
      "multiSelect": true,
      "statements": [
        {
          "id": "1",
          "display": "string",
          "image": {
            "name": "string",
            "url": "string",
            "textPosition": "top",
            "expandedUrl": "string"
          },
          "textEntry": {
            "contentType": "number",
            "required": true,
            "symbol": {
              "value": "$",
              "position": "before"
            }
          },
          "exclusiveSelect": true
        },
        {
          "id": "string",
          "groupLabel": "string",
          "statements": [
            {
              "id": "1",
              "display": "string",
              "image": {
                "name": "string",
                "url": "string",
                "textPosition": "top",
                "expandedUrl": "string"
              },
              "textEntry": {
                "contentType": "number",
                "required": true,
                "symbol": {
                  "value": "$",
                  "position": "before"
                }
              },
              "exclusiveSelect": true
            }
          ]
        }
      ],
      "scalePoints": [
        {
          "id": "1",
          "display": "string",
          "image": {
            "name": "string",
            "url": "string",
            "textPosition": "top",
            "expandedUrl": "string"
          },
          "textEntry": {
            "contentType": "number",
            "required": true,
            "symbol": {
              "value": "$",
              "position": "before"
            }
          },
          "exclusiveSelect": true
        }
      ],
      "headers": {}
    },
    {
      "id": "QID1",
      "display": "string",
      "required": "force",
      "type": "mc",
      "multiSelect": true,
      "choices": [
        {
          "id": "1",
          "display": "string",
          "image": {
            "name": "string",
            "url": "string",
            "textPosition": "top",
            "expandedUrl": "string"
          },
          "textEntry": {
            "contentType": "number",
            "required": true,
            "symbol": {
              "value": "$",
              "position": "before"
            }
          },
          "exclusiveSelect": true
        },
        {
          "id": "string",
          "groupLabel": "string",
          "choices": [
            {
              "id": "1",
              "display": "string",
              "image": {
                "name": "string",
                "url": "string",
                "textPosition": "top",
                "expandedUrl": "string"
              },
              "textEntry": {
                "contentType": "number",
                "required": true,
                "symbol": {
                  "value": "$",
                  "position": "before"
                }
              },
              "exclusiveSelect": true
            }
          ]
        }
      ]
    },
    {
      "id": "QID1",
      "display": "string",
      "required": "force",
      "type": "nps",
      "columnLabels": [
        "Not at all likely",
        "Extremely likely"
      ]
    },
    {
      "id": "QID1",
      "display": "string",
      "required": "force",
      "type": "ro",
      "choices": [
        {
          "id": "1",
          "display": "string",
          "image": {
            "name": "string",
            "url": "string",
            "textPosition": "top",
            "expandedUrl": "string"
          },
          "textEntry": {
            "contentType": "number",
            "required": true,
            "symbol": {
              "value": "$",
              "position": "before"
            }
          },
          "exclusiveSelect": true
        }
      ]
    },
    {
      "id": "QID1",
      "display": "string",
      "required": "force",
      "type": "slider",
      "statements": [
        {
          "id": "1",
          "display": "string",
          "image": {
            "name": "string",
            "url": "string",
            "textPosition": "top",
            "expandedUrl": "string"
          },
          "textEntry": {
            "contentType": "number",
            "required": true,
            "symbol": {
              "value": "$",
              "position": "before"
            }
          },
          "exclusiveSelect": true
        }
      ],
      "min": 0,
      "max": 100,
      "step": 1,
      "labels": [
        "Not satisfied",
        "Very satisfied"
      ],
      "notApplicable": {
        "display": "string"
      }
    },
    {
      "id": "QID1",
      "display": "string",
      "required": "force",
      "type": "te",
      "characterLimit": {
        "min": 0,
        "max": 0
      }
    }
  ],
  "endMessage": "string",
  "done": true,
  "embeddedData": {
    "customVar": "value",
    "userId": "12345"
  },
  "sessionId": "FS_123456789"
}