2.1.1 Drill object extends Drillable

Represents a drill that can be practiced. Drill is a subclass of 2.1.1 Drillable.

Example

{
  "id": "AHYrVtULyqnN1S7gRWq45Q",
  "type": "DRILL",
  "name": "Recognize the cars",
  "icon": {
    "type" :"image/jpeg",
    "url": "https://res.cloudinary.com/drillster/image/upload/w_512,h_512,c_fill,g_auto,f_auto,q_auto/f_auto,q_auto/v1/image/1f8432ecb50130512182c10d7b4648ec19ae98bc.jpg"
  },
  "cover": {
    "type": "image/jpeg",
    "url": "https://www.drillster.com/bin/cover/43fe764ccf521fcdb444210486db969f44fc3312"
  },
  "created": "2019-02-26T13:33:07Z",
  "locale": "en"
}

Fields

Field Type Description
type
required
String constant The type of this drillable, which is always DRILL for drills.
id
required
String The unique ID of this drill.

Example value: gDCIpKnSSA-JIFiQxPq31g
name
required
String The name (title) of the playable object.

Example value: 17th Century Painters
icon
required
2.1.1 Media object An icon representing the object.
cover
optional
2.1.1 Media object An optional cover that is used for this object.
compatibility
optional
2.1.1 Compatibility object The compatibility indicates whether the client application calling this API endpoint is capable of serving this drill or course to the end user. If it is not capable, the client application should decide what to do with this drill, e.g. hide it from the end user.

A client application is compatible with the drill or course if it has implemented all optional Drillster features that the drill or course is using. These features can be specific media types used in the drill (such as audio), or question types like sequence questions. If your client application supports practicing drills, you can (and should) configure the Drillster features it supports to see correct the compatibility for each drill or course.

This object is only included if the drill or course is not compatible. A list of features that are not supported by the client application, but are required by this drill or course is included.
creator
required
2.1.1 Actor object The creator of the playable. This can either be the organization of the creating user, or the creating user.
created
required
Date The date and time this playable was created.
locale
optional
String An optional locale of the playable. This is the language of the targeted audience.
reception
optional
2.1.1 Reception object Information on how this playable is received and perceived by the general public.
affordances
optional
List of strings A list of actions that the calling user may perform on this playable.
tags
optional
List of 2.1.1 Tag objects An optional list of tags to help identify this playable.
subject
required
String The subject matter of this drillable.

Example value: Geography
size
required
Integer The number of lines contained in this drillable.
description
required
String A short description of this drillable.
practice
optional
2.1.1 Practice object Practice status information.
lastEdited
optional
Timestamp The last time this drillable was edited.
columns
optional
2.1.1 Columns object Details about the drillable's column composition.
restrictions
optional
2.1.1 Restrictions object Details about any practice restrictions configured for this drillable.
version
optional
2.1.1 Version object Optional details about this version of the drill.
versions
optional
List of 2.1.1 Version objects Optional versioning details (not just about the current version).
entries
optional
List of 2.1.1 Entry objects The drill content. This is only used in the context of the drill editor.