Object Schemas

The QB Reader API represents tossups and bonuses as JSON objects. These schemas describe the structure of these objects.

Note: the type field of tossups and bonuses is deprecated and will be removed in a future update.

Tossup

Get another example

• _id: string
  The internal ID of the tossup.
• question: string
  The question text.
• formatted_answer: string
  The answerline, formatted with HTML.
• answer: string
  The answerline, unformatted.
• category: string
  The category of the question.
• subcategory: string
  The subcategory of the question.
• packet: string
  The internal ID of the packet the question is from.
• set: string
  The internal ID of the set the question is from.
• setName: string
  The name of the set the question is from.
• type: string
  The type of the question. Always "tossup" for tossups. Note: this field will be deprecated in a future update.
• packetNumber: number
  The packet number of the packet the question is from. Always a positive integer.
• questionNumber: number
  The question number of the question in the packet. Always a positive integer.
• createdAt: string
  The date the question was created in the database. ISO 8601 format.
• updatedAt: string
  The date the question was last modified in the database. ISO 8601 format.
• difficulty: number
  The difficulty of the question. Always an integer in [0-10].

Bonus

Get another example

• _id: string
  The internal ID of the bonus.
• leadin: string
  The leadin of the bonus.
• parts: [string, string, string]
  The parts of the bonus.
• formatted_answers: [string, string, string]
  The answerlines, formatted with HTML.
• answers: [string, string, string]
  The answerlines, unformatted.
• category: string
  The category of the question.
• subcategory: string
  The subcategory of the question.
• packet: string
  The internal ID of the packet the question is from.
• set: string
  The internal ID of the set the question is from.
• setName: string
  The name of the set the question is from.
• type: string
  The type of the question. Always "bonus" for bonuses. Note: this field will be deprecated in a future update.
• packetNumber: number
  The packet number of the packet the question is from. Always a positive integer.
• questionNumber: number
  The question number of the question in the packet. Always a positive integer.
• createdAt: string
  The date the question was created in the database. ISO 8601 format.
• updatedAt: string
  The date the question was last modified in the database. ISO 8601 format.
• difficulty: number
  The difficulty of the question. Always an integer in [0-10].