Voxco · Schema

GetCodebookResponse

Contains a presentation of codebook

Survey SoftwareMarket ResearchCATIOmnichannelText AnalyticsData CollectionPanel Management

Properties

Name Type Description
errorMessage string
codebookKey integer The key of the Codebook.
codebook array The Codes in the Codebook, in the order they appear in the Codebook. Codebooks are tree structured and may be of any depth, although a depth of more than 6 is rare. Only the leaf nodes may be applied
View JSON Schema on GitHub

JSON Schema

GetCodebookResponse.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "GetCodebookResponse",
  "type": "object",
  "properties": {
    "errorMessage": {
      "type": "string",
      "nullable": true
    },
    "codebookKey": {
      "type": "integer",
      "description": "The key of the Codebook.",
      "format": "int32"
    },
    "codebook": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CodeOrNet"
      },
      "description": "The Codes in the Codebook, in the order they appear in the Codebook.\r\n  \r\nCodebooks are tree structured and may be of any depth, although a depth of more than 6 is rare.\r\n  \r\nOnly the leaf nodes may be applied to a response.  These leaf nodes are Codes.\r\n\r\nNets have child codes or nets.  Nets may not be used to code a response.  They serve to provide structure to the Codebook.\r\n\r\nNets typically represent groups of related codes.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Contains a presentation of codebook"
}