GET group/…/member-results/…
Retrieves drillable results for one particular member for all drills or courses of a group.
Resource URL
https://www.drillster.com/api/2.1.1/group/{group_id}/member-results/{user_id}
Parameters
Field | Type | Description |
---|---|---|
group_id required |
String | The ID of the group. Example value: Ak_X20ACmESsTY72HU5IbU37I50Y9UO5_enbyfJYowc |
user_id required |
String | The ID of the member. Example value: 7OuHq-RcQO_snGWR58TnBw |
query optional |
String | The text to search for in the drillable names. The search is case-insensitive. Example values: french |
resultFrom optional |
String | The id of the last element from the previous page. Use this parameter, in combination with resultSize , to apply pagination of the result; it will limit the number of drillables included in the result. If it is not specified, the first page will be displayed. |
resultSize optional |
Integer | The maximum number of drillables to include in the result. If not specified, a maximum of 10 drillables are returned. |
Response
A 2.1.1 GroupMemberResults object, with details about the drillable progress.
Example request
GET https://www.drillster.com/api/2.1.1/group/nf4g_47bwupIXenpal687sWxtiN1-wf4OnnAS_di9yI/member-results/U0RHPOoEQCWz1y_f5engPw?query=&resultFrom=_vRYCntWhr-HG66OBsVozQ&resultSize=3
Response
{
"group": {
"id": "nf4g_47bwupIXenpal687sWxtiN1-wf4OnnAS_di9yI",
"name": "Our test group",
"description": "Testing the API",
"icon": {
"type": "image/png",
"url": "https://www.drillster.com/bin/attachment/c0b0ae1c6b4c1d60fef4b897699c6887505957fb",
"width": 128,
"height": 128
}
},
"member": {
"type": "USER",
"id": "U0RHPOoEQCWz1y_f5engPw",
"name": "Test Account",
"emailAddress": "redacted@drillster.com",
"locale": "nl",
"realName": "Test Account"
},
"pagination": {
"total": 50,
"lastOnPage": "fRcOHk6pER0zpFZnBpuBig",
"moreAvailable": true
},
"groupDrillableMemberResults": [
{
"drillable": {
"id": "Uy_MGP3QTPbX1kL45vjs_A",
"type": "DRILL",
"name": "Dutch verbs",
"tags": [
{
"value": "core_material"
}
],
"subject": "Dutch",
"description": "Learn Dutch verbs"
},
"drillableResult": {
"id": "Uy_MGP3QTPbX1kL45vjs_A",
"proficiency": 0,
"timeSpent": 0
}
},
{
"drillable": {
"id": "2_3L6_Bd86Lw4T2rxTcxgA",
"type": "DRILL",
"name": "Dutch nouns",
"subject": "Dutch",
"description": "Learn Dutch nouns"
},
"drillableResult": {
"id": "2_3L6_Bd86Lw4T2rxTcxgA",
"proficiency": 50,
"timeSpent": 2139,
"lastPracticed": "2020-01-23T13:08:37Z"
}
},
{
"drillable": {
"id": "fRcOHk6pER0zpFZnBpuBig",
"type": "DRILL",
"name": "Dutch articles",
"subject": "Dutch",
"description": "Learn Dutch articles"
},
"drillableResult": {
"id": "fRcOHk6pER0zpFZnBpuBig",
"proficiency": 0,
"timeSpent": 0
}
}
]
}
Error responses
The following error situations are possible:
ID | Response code | Description |
---|---|---|
missing_user_id |
400 (Bad request) | No member ID provided |
missing_group_id |
400 (Bad request) | No group ID provided |
group_not_found |
404 (Not found) | Could not retrieve group details |
user_not_in_group |
404 (Not found) | User is not part of group |
no_group_access |
403 (Forbidden) | Caller has no permission to access the group |
Last updated on