2.0 Group object
Represents a group. A group ties together a set of drills, a set of members (participants) and a set of test definitions.
Example
{
"id": "nYrK9udUc-UGvRS2kxaPtaB-0wzeHAJzM6vlL1te6wI",
"name": "European geography",
"description": "Learn the countries and capitals of Europe",
"counts": {
"members": 10,
"drillables": 20,
"tests": 5
}
}
Fields
Field | Type | Description |
---|---|---|
id required |
String | The unique ID of this group. Example value: nYrK9udUc-UGvRS2kxaPtaB-0wzeHAJzM6vlL1te6wI |
name optional |
String | The name of this group. Example value: European geography |
description optional |
String | A description for this group. Example value: Learn the countries and capitals of Europe |
members optional |
List of 2.0 GroupMember objects | Details of members of the group. |
drills optional |
List of 2.0 GroupDrillable objects | Details of drillables (drills or courses) contained in the group. |
tests optional |
List of 2.0 Test objects | Details of tests contained in the group. |
counts optional |
2.0 GroupCounts object | Aggregate details including counts of members, drills and tests. |
icon optional |
2.0 Media object | An icon to represent the group. |
created optional |
Date | The creation date and time of the group. |
lastEdited optional |
Date | The date and time the group was last changed. |