GET group/…/test-results/…
Retrieves test results for one particular test definition for all members of a group.
Resource URL
https://www.drillster.com/api/2.1.1/group/{group_id}/test-results/{test_id}
Parameters
Field | Type | Description |
---|---|---|
group_id required |
String | The ID of the group. Example value: Ak_X20ACmESsTY72HU5IbU37I50Y9UO5_enbyfJYowc |
test_id required |
String | The ID of the test definition. This defines the test itself, not the individual instances done by users. Example value: 7OuHq7RcQOCsnGWR58TnBw |
query optional |
String | The text to search for in the user names. The search is case-insensitive. If a query is present, the list of user records in the response is sorted by relevance. In the absence of a query, the response is sorted by signup date. Example values: Jane |
resultStart optional |
Integer | The index number (zero-based) of the first user to include in the result. Use this parameter, in combination with resultSize , to apply pagination of the result; it will limit the number of users included in the result. Defaults to 0 . |
resultSize optional |
Integer | The maximum number of users to include in the result. If not specified, a maximum of 10 users with their test results are returned. |
Response
A 2.1.1 GroupTestResults object, with details about the test itself, and the individual test results.
Example request
GET https://www.drillster.com/api/2.1.1/group/Ak_X20ACmESsTY72HU5IbU37I50Y9UO5_enbyfJYowc/test-results/7OuHq7RcQOCsnGWR58TnBw
Response
{
"group": {
"id": "Ak_X20ACmESsTY72HU5IbU37I50Y9UO5_enbyfJYowc",
"name": "Group XYZ",
"description": "Represents the people in group XYZ.",
"icon": {
"type": "image/png",
"url": "https://www.drillster.com/img/icon-groups.png",
"width": 128,
"height": 128
}
},
"total": 2,
"test": {
"id": "9Rr7Ry6sR8xz4DE7ZheKDw",
"type": "TEST",
"name": "日本語 Japanese",
"icon": {
"type": "image/jpeg",
"url": "https://www.drillster.com/bin/feature/4db91792c5bb1388010e6e235c81ab037bec1e8d"
},
"created": "2014-03-04T14:15:31Z",
"subject": "日本語 Japanese"
},
"groupMemberTestResults": [{
"member": {
"type": "USER",
"id": "GVJyukIzQba9VfyGQVbGUQ",
"name": "Michael Lopez",
"emailAddress": "michael@example.com"
},
"testResults": [ ]
}, {
"member": {
"type": "USER",
"id": "CBj4BLaWQieWyIBWzUQOhw",
"name": "Jane Doe",
"emailAddress": "jane@example.com"
},
"testResults": [ ]
}]
}
Error responses
The following error situations are possible:
ID | Response code | Description |
---|---|---|
missing_test_definition |
400 (Bad request) | No test definition provided |
group_not_found |
404 (Not found) | Could not retrieve group details |
test_not_in_group |
404 (Not found) | Test definition is not part of group |
no_group_access |
403 (Forbidden) | Caller has no permission to access the group |
Last updated on