Voxco · Schema

PostResponse

A respondent's answer to the question.

Survey SoftwareMarket ResearchCATIOmnichannelText AnalyticsData CollectionPanel Management

Properties

Name	Type	Description
rid	string	The respondent id, which is unique among Responses in this Question. This id identifies the respondent in the Study, and that respondent's Response in this Question.
verbatim	string	The verbatim text of the response, in other words the answer the respondent gave to the question posed. Required if this is a new respondent, optional if updating an existing response for this respond
translation	string	Optional translation of the verbatim text.
transcription	string	Optional transcription of the response.
notes	string	Optional notes associated with the response.
appliedcodes	array	Array of codes to apply to the response. Note this will ignore any listed codes already applied and will not remove any.
segmentcodes	array	Array of segments of applied codes

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PostResponse",
  "required": [
    "rid"
  ],
  "type": "object",
  "properties": {
    "rid": {
      "minLength": 1,
      "type": "string",
      "description": "The respondent id, which is unique among Responses in this Question.\r\n\r\nThis id identifies the respondent in the Study, and that respondent's Response in this Question."
    },
    "verbatim": {
      "type": "string",
      "description": "The verbatim text of the response, in other words the answer the respondent gave to the question posed.\r\n\r\nRequired if this is a new respondent, optional if updating an existing response for this respondent.",
      "nullable": true
    },
    "translation": {
      "type": "string",
      "description": "Optional translation of the verbatim text.",
      "nullable": true
    },
    "transcription": {
      "type": "string",
      "description": "Optional transcription of the response.",
      "nullable": true
    },
    "notes": {
      "type": "string",
      "description": "Optional notes associated with the response.",
      "nullable": true
    },
    "appliedcodes": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "Array of codes to apply to the response. Note this will ignore any listed codes already applied and will not remove any.",
      "nullable": true
    },
    "segmentcodes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SegmentCode"
      },
      "description": "Array of segments of applied codes",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "A respondent's answer to the question."
}