Common Models

The following is an example of a Survey Question:

{
  "surveyQuestionId": 54949,
  "type": "Candidate",
  "cycle": 2010,
  "name": "Maddow for Senate",
  "mediumName": "Maddow",
  "shortName": "MS",
  "scriptQuestion": "In the upcoming race for US Senate, do you plan to vote for Republican Scott Brown or Democrat Rachel Maddow?",
  "status": "Active",
  "responses": [
    {
      "surveyResponseId": 246016,
      "name": "1 - Strong Maddow",
      "mediumName": "1",
      "shortName": "1"
    },
    {
      "surveyResponseId": 246017,
      "name": "2 - Leaning Maddow",
      "mediumName": "2",
      "shortName": "2"
    },
    {
      "surveyResponseId": 246018,
      "name": "3 - Undecided",
      "mediumName": "3",
      "shortName": "3"
    },
    {
      "surveyResponseId": 246020,
      "name": "4 - Leaning Brown",
      "mediumName": "4",
      "shortName": "4"
    },
    {
      "surveyResponseId": 246019,
      "name": "5 - Strong Brown",
      "mediumName": "5",
      "shortName": "5"
    }
  ]
}

Survey Question

Each Survey Question has the following properties:

Property

Type

Description

surveyQuestionId

int

Unique identifier for a Survey Question in this context (this is an ID that is often unique across many VAN database tabs)

type

string

A general category for a Survey Question (e.g., Candidate, Issue, etc.)

cycle

int

The election cycle or year this question is assigned

name

string

A name for the Survey Question, no longer than 20 characters

mediumName

string

A shorter name for the Survey Question, no longer than 9 characters

shortName

string

An even shorter name for the Survey Question, no longer than 4 characters

scriptQuestion

string

The text of the actual question that would appear on a script

status

string

For organizational purposes, VAN users often use various statuses to hide older Survey Questions. This property will be one of: Active, Archived, or Inactive.

responses

array

An array of zero or more Survey Response objects, sorted as they should appear on a script

Survey Response

Each Survey Response has the following properties:

Property

Type

Description

surveyResponseId

int

An identifier (unique to this Survey Question) for a Survey Response

name

string

A name for the Survey Question, no longer than 20 characters

mediumName

string

A shorter name for the Survey Question, no longer than 3 characters

shortName

string

An even shorter name for the Survey Question, no longer than 1 character