Raw schema
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"contest",
"survey",
"quiz",
"hunt",
"qa",
"ideas",
"nominate",
"wall"
],
"description": "contest: people vote for entries; survey: questions; quiz: questions with right answers and a leaderboard; hunt: find QR checkpoints; qa: the audience asks and upvotes questions; ideas: people share and upvote ideas; nominate: people suggest the entries, then vote on the finalists; wall: people leave messages (no voting)"
},
"title": {
"type": "string",
"maxLength": 120
},
"description": {
"type": "string",
"maxLength": 1000
},
"entries": {
"type": "array",
"maxItems": 200,
"description": "Contests and nominations: the entries (a nomination's suggestions join them); hunts: the checkpoints. A name, or { name, description }.",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 80
},
"description": {
"type": "string",
"maxLength": 300
}
},
"required": [
"name"
]
}
]
}
},
"questions": {
"type": "array",
"maxItems": 50,
"description": "Surveys and quizzes, as in setQuestions: { type: single|multi|yesno|likert|rating|short|long, prompt, options? (single/multi), max? (rating 5 or 10), required?, answer? (quiz: option index, list of indexes, yesno 1/0, or accepted texts for short) }",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"single",
"multi",
"yesno",
"likert",
"rating",
"short",
"long"
]
},
"prompt": {
"type": "string",
"maxLength": 300
},
"options": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100
},
"maxItems": 20
},
"max": {
"type": "integer",
"enum": [
5,
10
]
},
"required": {
"type": "boolean"
},
"answer": {}
},
"required": [
"type",
"prompt"
]
}
},
"categories": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60
},
"maxItems": 20,
"description": "Contests: separate awards, one vote in each (e.g. Scariest, Funniest)"
},
"mode": {
"type": "string",
"enum": [
"single",
"each"
],
"description": "Contests: one vote in total, or one vote per entry (like/heart each)"
},
"results": {
"type": "string",
"enum": [
"live",
"after",
"private"
],
"description": "When people see results"
},
"closesAt": {
"type": "string",
"description": "When voting ends, ISO 8601 with a time zone offset"
},
"theme": {
"type": "string",
"enum": [
"classic",
"halloween",
"harvest",
"winter",
"garden",
"carnival",
"beach",
"sports",
"hearts",
"stars",
"lunar",
"diwali",
"muertos",
"hanami",
"cats",
"dogs",
"campfire",
"art",
"trivia",
"classroom",
"cookoff",
"science",
"wedding",
"carshow",
"workplace",
"thanksgiving"
]
},
"lang": {
"type": "string",
"enum": [
"en",
"es",
"de",
"zh",
"fr",
"pt",
"ja",
"ko",
"it",
"hi",
"id",
"tr",
"ar"
],
"description": "The voters' language: its QR codes, big screen and printed signs use it (anyone can still switch). Default: the language the person is using, else en."
},
"leaderboard": {
"type": "boolean",
"description": "Quizzes: show a leaderboard"
},
"host": {
"type": "boolean",
"description": "Quizzes: run it live on a big screen, one question at a time"
},
"posts": {
"type": "array",
"maxItems": 10,
"description": "qa, ideas, wall: starter posts, up from the start",
"items": {
"type": "string",
"maxLength": 280
}
},
"labels": {
"type": "array",
"maxItems": 10,
"description": "ideas: categories people pick from (e.g. Went well, To improve, Try next)",
"items": {
"type": "string",
"maxLength": 40
}
},
"approve": {
"type": "boolean",
"description": "qa, ideas, nominate, wall: new posts wait for the organizer's approval (default on, except ideas)"
},
"names": {
"type": "boolean",
"description": "qa, ideas, nominate, wall: people may add their name (default on, except ideas)"
}
},
"required": [
"kind",
"title"
],
"description": "What to fill the create form with. Same shapes as the API (https://qrvote.org/openapi.json)."
}