Voxco · Schema

Study

A Study.

Survey SoftwareMarket ResearchCATIOmnichannelText AnalyticsData CollectionPanel Management

Properties

Name	Type	Description
key	integer	The key of the Study, which will not change for the lifetime of the Study.
quota	integer	The quota for the Study If no quota is set for the Study this field will not be present in the response.
id	string	The id of the Study.
name	string	The name of the Study. If no study name is set for the Study this field will not be present in the response.
description	string	The description of the Study. If no description is set for the Study this field will not be present in the response.
status	string	A one-character string which specifies the status of the Study: a: Archived p: Coding in progress c: Completed d: Deleted h: On hold r: Review in p
supervisorKey	integer	The key of the Person who will do revision of coding work If no supervisor is set for the Study this field will not be present in the response.
clientCompanyKey	integer	The key of the Company for which this coding work is assigned If no client company is set for the Study this field will not be present in the response.
endCompanyKey	integer	The key of the Company for which this coding work is being performed If no end customer company is set for the Study this field will not be present in the response.
help	string	The information about the Study If no help information is set for the Study this field will not be present in the response.
createDateUtc	string	The UTC date/time the Study was created.
startDateUtc	string	UTC date/time the Study was started. If the date is not set yet for the Study this field will not be present in the response.
dueDateUtc	string	UTC date/time the Study was completed. If the date is not set yet for the Study this field will not be present in the response.
externalStudyId	string	External study id from StudyMaps

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Study",
  "required": [
    "createDateUtc",
    "id",
    "key",
    "status"
  ],
  "type": "object",
  "properties": {
    "key": {
      "type": "integer",
      "description": "The key of the Study, which will not change for the lifetime of the Study.",
      "format": "int32"
    },
    "quota": {
      "type": "integer",
      "description": "The quota for the Study\r\nIf no quota is set for the Study this field will not be present in the response.",
      "format": "int32",
      "nullable": true
    },
    "id": {
      "minLength": 1,
      "type": "string",
      "description": "The id of the Study."
    },
    "name": {
      "type": "string",
      "description": "The name of the Study.\r\n\r\nIf no study name is set for the Study this field will not be present in the response.",
      "nullable": true
    },
    "description": {
      "type": "string",
      "description": "The description of the Study.\r\n\r\nIf no description is set for the Study this field will not be present in the response.",
      "nullable": true
    },
    "status": {
      "minLength": 1,
      "type": "string",
      "description": "A one-character string which specifies the status of the Study:\r\n<ul><li>a: Archived\r\n</li><li>p: Coding in progress\r\n</li><li>c: Completed\r\n</li><li>d: Deleted\r\n</li><li>h: On hold\r\n</li><li>r: Review in progress\r\n</li><li>s: Shipping\r\n</li><li>u: Under construction</li></ul>"
    },
    "supervisorKey": {
      "type": "integer",
      "description": "The key of the Person who will do revision of coding work\r\n\r\nIf no supervisor is set for the Study this field will not be present in the response.",
      "format": "int32",
      "nullable": true
    },
    "clientCompanyKey": {
      "type": "integer",
      "description": "The key of the Company for which this coding work is assigned\r\n\r\nIf no client company is set for the Study this field will not be present in the response.",
      "format": "int32",
      "nullable": true
    },
    "endCompanyKey": {
      "type": "integer",
      "description": "The key of the Company for which this coding work is being performed\r\n\r\nIf no end customer company is set for the Study this field will not be present in the response.",
      "format": "int32",
      "nullable": true
    },
    "help": {
      "type": "string",
      "description": "The information about the Study\r\n\r\nIf no help information is set for the Study this field will not be present in the response.",
      "nullable": true
    },
    "createDateUtc": {
      "type": "string",
      "description": "The UTC date/time the Study was created.",
      "format": "date-time"
    },
    "startDateUtc": {
      "type": "string",
      "description": "UTC date/time the Study was started.\r\n\r\nIf the date is not set yet for the Study this field will not be present in the response.",
      "format": "date-time",
      "nullable": true
    },
    "dueDateUtc": {
      "type": "string",
      "description": "UTC date/time the Study was completed.\r\n\r\nIf the date is not set yet for the Study this field will not be present in the response.",
      "format": "date-time",
      "nullable": true
    },
    "externalStudyId": {
      "type": "string",
      "description": "External study id from StudyMaps",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "A Study."
}