2.1 Test object extends Playable

A test object represents a test that has been defined for one or more users. Use the POST tests or POST group/…/tests calls to define a test.

Example

{
  "id": "gDCIpKnMSA-JIFiQxPh31g",
  "name": "European geography test",
  "drills" : [ "VPZVb_UPSVSLmV0qGgG8WA" ],
  "direction": "PRODUCTIVE",
  "style": "MULTIPLE_CHOICE",
  "group": "OcPiC-pcH2MaO8Kpow3TlKB-0wzeHAJzM6vlL1te6wI",
  "testType": "GROUP",
  "instructions" : {
    "text": "Get ready! You are about to start with the test. This test contains 20 questions. You can take this test only once.",
    "markup" : [ {
      "type": "bold",
      "offset" : 0,
      "length" : 10
    } ]
  },
  "disclosure" : [ "CORRECTIONS", "COMPONENT_SCORES", "OVERALL_SCORE", "METADATA" ],
  "columns" : [ "Capital" ],
  "questions" : [ 20 ],
  "created": "2013-07-22T10:46:35Z",
  "reviewDate": "2013-07-30T22:00:00Z",
  "startable" : true,
  "icon" : {
      "type": "image/png",
      "url": "https://www.drillster.com/bin/feature/a17ab8d1cb2bd2fee8c6012db95a30b42d837553"
  },
  "cover" : {
    "type": "image/png",
    "url": "https://www.drillster.com/bin/cover/8e9851b360f9dd13aac3d4d3576958982873da6f"
  }
}

Fields

Field	Type	Description
`id` required	String	The unique ID of this test. Example value: `gDCIpKnMSA-JIFiQxPh31g`
`name` required	String	The name of the test. Example value: `European geography test`
`drills` required	List of Strings	The drills that are tested. Example value: `[ "VPZVb_UPSVSLmV0qGgG8WA", "fb5u4Z7gQgIjDwOQJtrMLA" ]`
`direction` optional	String	The enforced direction for the questions of this test. If the drill of this test has an enforced direction, this will be used instead of the defined direction. `PRODUCTIVE` — Reproduce what you've learned: questions are picked from the known column `RECEPTIVE` — Recognize what you've learned: questions are picked from the unknown column(s) `BIDIRECTIONAL` — Questions are picked from both the known and unknown columns (default)
`style` optional	String	The answer style for the questions of this test. If the drill(s) of this test have a enforced style, this style will be used instead of the defined style. `MULTIPLE_CHOICE` — The user has to select the correct answer from two or more presented answers (default) `OPEN_ENDED` — The user has to enter the correct answer
`group` optional	String	If present, the group for which this test is defined. Example value: `OcPiC-pcH2MaO8Kpow3TlKB-0wzeHAJzM6vlL1te6wI`
`testType` required	String	The type of the test. `INDIVIDUAL` — This test can be taken only be the user who has defined it. `ANONYMOUS` — This test is defined by an organization, and can be taken by any number of users (anonymously). For each user, a ticket must be issued before starting the test. `GROUP` — This test is defined for a group, and can only be taken by the members of the group.
`instructions` required	2.1 MarkupText object	Instructions to be shown to the end user before starting the test.
`disclosure` optional	List of Strings	The disclosure defines what test results the user will see after finishing the test. Example value: `[ "CORRECTIONS", "COMPONENT_SCORES", "OVERALL_SCORE" ]`
`columns` required	List of Strings	The names of the unknown columns included in the test questions. Example value: `[ "Capital" ]`
`questions` required	List of Integers	The number of questions that will be asked in this test. If the list contains more than one number, this means that the test includes more than one drill, and each number is the number of questions from each drill. The position of the number in the list corresponds with the position of the drill in the `drills` list. If, for example `questions` is `[ 5, 8 ]`, and `drills` is `[ "VPZVb_UPSVSLmV0qGgG8WA", "fb5u4Z7gQgIjDwOQJtrMLA" ]`, 5 questions will be taken from drill `VPZVb_UPSVSLmV0qGgG8WA`, and 8 from drill `fb5u4Z7gQgIjDwOQJtrMLA`. Example value: `[ 5, 8 ]`
`created` required	Date	The date and time that this test was defined. Example value: `2013-07-22T10:46:35Z`
`reviewDate` optional	Date	When set, the user(s) taking this test is/are expected to complete it before this review date/time. Tests can't be started or completed after this date/time. Example value: `2013-07-30T22:00:00Z`
`reminderDate` optional	Date	If a user has not completed this test before the reminderDate, he will receive an email reminding him of the test. The email includes a hyperlink that will take the user directly to the test. Example value: `2013-07-29T12:00:00Z`
`startable` required	Boolean	If `TRUE`, this test may be started. This means that either the test was never started, or the test was completed one or multiple times and the possibility exists to start this test again. `TRUE` `FALSE`
`sendAnnouncement` optional	Boolean	If `TRUE`, an email is sent to all group members, announcing the test and its review date. The email contains a hyperlink that will take the user directly to the test. The emails are sent within 24 hours after defining the test, or within 24 hours after a new user joins the group after this test was defined. `TRUE` `FALSE` (default)
`weights` optional	List of Integers	The weight of each drill on the result of the test. If the test contains more than one drill, a weight can be specified for each drill. The weight of the drill is used to adjust the contribution of the answers for the drill to the overall score. The value of the weight can anything between 0 and 100 (inclusive). By default, the weight of each drill is 100. If the test contains two drills, and the first drill's weight is 50, and the second is 100, the answers on questions from the second drill will have twice the impact of answers on the first drill. If specified, the number of weights values matches the number of drills values. The order of the weights values matches that of the drills values, so the first weights value applies to the first drill, etc. Example value: `[ 75, 100 ]`
`compatibility` optional	2.1 Compatibility object	The compatibility indicates whether the client application calling this API endpoint is capable of serving this test to the end user. If it is not capable, the client application should decide what to do with this test, e.g. hide it from the end user. A client application is compatible with the test if it has implemented all optional Drillster features that the test is using. These features can be specific media types used in the test (such as audio), or question types like sequence questions. If your client application supports tests, you can (and should) configure the Drillster features it supports to see correct the compatibility for each test. This object is only included if the test is not compatible. A list of features that are not supported by the client application, but are required by this test is included.
`icon` required	2.1 Media object	The MIME type and location of the icon that represents this test.
`cover` required	2.1 Media object	The MIME type and location of the cover that is displayed at the start of the test.