2.1.1 Question object

A Question contains all information that is required to present a question to the user.

Fields

Field	Type	Description
`reference` required	String	Unique reference (ID) for this question. When submitting the answer for this question, this reference must be included. The ID is globally unique. Should the same question be asked again, it would have a different reference. Example value: `gUaA56tcQfyXpMJc9EE4sQ`
`sequenceNr` optional	Integer	The sequence number of the question being asked for the drill from which this question is taken. Absent for introductions. For tests the sequence number denotes the one-based sequence number of the current test. Example value: `1`
`ask` required	2.1.1 Ask object	The question itself.
`tell` required	2.1.1 Tell object	All data related to answering the question: how the question must be answered (multiple choice or open-ended), if a single answer or multiple answers are expected, and which answers must be presented.
`context` optional	2.1.1 Context object	A message that provides contextual information for this question. This information must be presented to the user along with the question.
`timeLimit` optional	ISO 8601 duration	If specified, the user must submit the answer within this period of time. Otherwise the question will be considered incorrectly answered, regardless of the answer that was submitted. Example value: `PT30S`
`remainingTestTime` optional	ISO 8601 duration	If specified, the user must complete the test within this period of time. Answers submitted after this time, or questions that are not submitted are considered incorrectly answered. A test can have a time limits per answer (`timeLimit`), or a time limit for the entire test (`remainingTestTime`), but not both. Example value: `PT15M30S`
`questionsInTest` optional, deprecated	Integer	Indicates the total number of questions in a test. Only applies to tests, and only for tests for which the total number of questions is known beforehand. This field has been deprecated. In future versions, it will no longer exist. Instead, use `availableQuestions`.
`givenAnswers` optional	List of 2.1.1 Term objects	The previously given answers, where this is applicable. This only applies to tests that allow question navigation.
`availableQuestions` optional	Integer	Indicates the total number of questions that are available in the current context: drill(s), selected column(s), practice direction, or the current test. For adaptive tests, no value will be provided.
`disclosedQuestions` optional	Integer	Indicates the number of (unique) questions that have been presented one or more times. This includes the current question. For practice questions, no distinction is made between introductions and regular questions.

Last updated on 2025-04-18