POST groups
Creates a new group. The group is created empty – it will have no drills or members.
Resource URL
https://www.drillster.com/api/2/groups
Parameters
Field | Type | Description |
---|---|---|
name required |
String | The name of the newly created group. Example value: Class of 2013 |
description required |
String | A description of the group. Example value: Contains all of the students of the class of 2013. |
Response
A group object, representing the newly created group.
Example request
POST https://www.drillster.com/api/2/groups
name=Class+4a
description=English+course+2013
Response
{
"id": "dy2iiJrat0j-9P9EHLWhT6B-0wzeHAJzM6vlL1te6wI",
"name": "Class 4a",
"description": "English course 2013",
"drills": 0,
"members": 0
}
The type is used to differentiate drills from courses, and will be set to DRILL in all cases for this API call.
Error responses
The following error situations are possible:
ID | Description |
---|---|
no_permission |
You are not allowed to create groups |
name_missing |
No group name specified |
description_missing |
No group description specified |