GET group/…/drillables
Returns the list of drillables (drills and courses) in the group.
Resource URL
https://www.drillster.com/api/2.1.1/group/{group_id}/drillables
Parameters
Field | Type | Description |
---|---|---|
group_id required |
String | The ID of the group to be retrieved. Example value: Ak_X20ACmESsTY72HU5IbU37I50Y9UO5_enbyfJYowc |
query optional |
String | The text to search for in the drill names and descriptions. The search is case-insensitive. If a query is present, the list of drillable records in the response is not sorted by relevance. Example values: Geography |
resultStart optional |
Integer | The index number (zero-based) of the first drillable to include in the result. Use this parameter, in combination with resultSize , to apply pagination of the result; it will limit the number of drillables included in the result. Defaults to 0 . |
resultSize optional |
Integer | The maximum number of drillables to include in the result. If not specified, a fixed number of 10 drillables (or the remaining items in the list) are returned. |
Response
A 2.1.1 Group object containing the group details and a list of drillables.
Example request
GET https://www.drillster.com/api/2.1.1/group/Ak_X20ACmESsTY72HU5IbU37I50Y9UO5_enbyfJYowc/drillables
Response
{
"id": "Ak_X20ACmESsTY72HU5IbU37I50Y9UO5_enbyfJYowc",
"name": "Acme Corp managers",
"description": "The managers in Acme Corp.",
"drillables": [ {
"id": "1wsGXTIPcY4jMNL0sJ7n5A",
"type": "DRILL",
"name": "Anger Management",
"icon": {
"type": "image/png",
"url": "https://www.drillster.com/bin/attachment/b439eef7a629f8f645a8c1409d9257f25bef057b"
}
}, {
"id": "bDE_YA9lEX4jMNL76KJnc-",
"type": "DRILL",
"name": "Dealing with customers",
"icon": {
"type": "image/png",
"url": "https://www.drillster.com/bin/attachment/a17ab8d1cb2bd2fee8c60037995a30b42d837853"
}
}, {
"id": "gH_Jhy-CTvSmbDE_YA9l6w",
"type": "DRILL",
"name": "Safety",
"icon": {
"type": "image/png",
"url": "https://www.drillster.com/bin/attachment/7e58bac3a87addd8d89de71d0e5609ba359ab0b1"
}
} ],
"counts": {
"drillables": 3
}
}
Error responses
The following error situations are possible:
ID | Response code | Description |
---|---|---|
not_found |
404 (Not found) | Requested group not found |
invalid_group_id |
400 (Bad request) | Given group ID is not valid |
no_group_access |
403 (Forbidden) | No access to group |
Last updated on