Voxco · Schema

CreateQuestionResponse

Response of Create Question web method, it contains data of the newly created question

Survey SoftwareMarket ResearchCATIOmnichannelText AnalyticsData CollectionPanel Management

Properties

Name	Type	Description
errorMessage	string
key	integer	The key of the newly created question
codebookKey	integer	The key of the Codebook for the Question. If you did not specify a codebook key in the request, this is the key of a newly created empty Codebook.
id	string	The ID of the new question
tasks	object
type	object
label	string	The label of the new question
text	string	The text of the new Question. This is the question posed to the respondent.
help	string	The help information for the Question, which may be empty.
sortOrder	integer	Ordinal number of the Question. It uses for sorting questions in list, tables, so on.
codingSource	object
alternativeCodingSource	object
externalQuestionId	string	External Question ID from QuestionMaps

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateQuestionResponse",
  "type": "object",
  "properties": {
    "errorMessage": {
      "type": "string",
      "nullable": true
    },
    "key": {
      "type": "integer",
      "description": "The key of the newly created question",
      "format": "int32"
    },
    "codebookKey": {
      "type": "integer",
      "description": "The key of the Codebook for the Question. If you did not specify a codebook key in the request, this is the key of a newly created empty Codebook.",
      "format": "int32",
      "nullable": true
    },
    "id": {
      "type": "string",
      "description": "The ID of the new question",
      "nullable": true
    },
    "tasks": {
      "$ref": "#/components/schemas/TaskTypes"
    },
    "type": {
      "$ref": "#/components/schemas/DBQuestionTypes"
    },
    "label": {
      "type": "string",
      "description": "The label of the new question",
      "nullable": true
    },
    "text": {
      "type": "string",
      "description": "The text of the new Question. This is the question posed to the respondent.",
      "nullable": true
    },
    "help": {
      "type": "string",
      "description": "The help information for the Question, which may be empty.\r\n",
      "nullable": true
    },
    "sortOrder": {
      "type": "integer",
      "description": "Ordinal number of the Question. It uses for sorting questions in list, tables, so on.",
      "format": "int32",
      "nullable": true
    },
    "codingSource": {
      "$ref": "#/components/schemas/DBQuestionCodingSource"
    },
    "alternativeCodingSource": {
      "$ref": "#/components/schemas/DBQuestionCodingSource"
    },
    "externalQuestionId": {
      "type": "string",
      "description": "External Question ID from QuestionMaps",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Response of Create Question web method, it contains data of the newly created question"
}