2.1.1 Playable object abstract

A playable represents material that can be played in the Drillster player. It generally has two appearances:

2.1.1 Drillable — Material that can be practiced, such as a drill or a course
2.1.1 Test — A test

Example

{
  "id": "5x7kjFr2vfbptyUTsTximg",
  "type": "DRILL",
  "name": "17th Century Painters",
  "icon": {
    "type": "image/png",
    "url": "https://www.drillster.com/bin/feature/a17ab8d1cb2bd2fee8c60037995a30b42d837353"
  }
}

Fields

Field	Type	Description
`type` required	String	The type of this playable. `DRILL` — A single drill `COURSE` — A collection of drills `TEST` — A test
`id` required	String	The unique ID of this drill, course or test. 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.
`owner` optional	2.1.1 Actor object	The owner of the playable. The owner by default is the creator of the playable. Optionally can either be the organization of the creating user, the co-author of the playable or a customized owner name.
`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.
`license` optional	2.1.1 License objects	An optional license for use.

Last updated on 2025-04-18