GET group/…/objective/…/evaluations
Returns the list of evaluations for a group objective.
Resource URL
https://www.drillster.com/api/2.1.1/group/{group_id}/objective/{objective_id}/evaluations
Parameters
Field | Type | Description |
---|---|---|
group_id required |
String | The ID of the group for which the objective is defined. Example value: Ak_X20ACmESsTY72HU5IbU37I50Y9UO5_enbyfJYowc |
objective_id required |
String | The ID of the objective for which to retrieve the evaluations. Example value: rP8t4RKJikCzcaPyGqE4Zg |
query optional |
String | A filter for the group member. Only group members with a matching name or email address will be included in the response. Matching is case-insensitive. Example value: Bob |
resultFrom optional |
String | The ID of the element of the preceding page. The contents of this field depend on the context, and must always be copied from a 2.1.1 Pagination object, or otherwise omitted. The client must not determine the value themselves. |
resultSize optional |
Integer | The maximum number of evaluations to include in the result. If not specified, the evaluations for all (remaining) group members are returned. |
Response
An 2.1.1 ObjectiveEvaluations object containing evaluations of the group members of the objective.
Example request
GET https://www.drillster.com/api/2.1.1/group/Ak_X20ACmESsTY72HU5IbU37I50Y9UO5_enbyfJYowc/objective/rP8t4RKJikCzcaPyGqE4Zg/evaluations
Response
{
"objective": {
"id": "rP8t4RKJikCzcaPyGqE4Zg",
"name": "Retain 80% after 20-1-2019",
"icon": {
"type": "image/png",
"url": "https://www.drillster.com/bin/drillable-icon/3VMiHvtq_WUwb_4biiOtNw"
},
"type": "PERMANENT",
"reviewDate": "2019-01-20T00:00:00Z",
"minimumProficiency": 80,
"fallingMinimumProficiency": 65,
"estimatedStudyDuration": "PT96H"
},
"evaluations": [
{
"user": {
"type": "USER",
"id": "5fbAHX3yTguHrehpGbjlYA",
"name": "Bob"
},
"met": true,
"proficiency": 94,
"evaluationDate": "2019-01-21T15:30:42Z"
},
{
"user": {
"type": "USER",
"id": "rw0TTNXISiQsGfgP-yMywg",
"name": "Alice"
},
"met": false,
"proficiency": 12,
"evaluationDate": "2019-01-21T15:30:43Z"
}
],
"pagination": {
"total": 2,
"lastOnPage": "1543488169465",
"moreAvailable": false
}
}
Last updated on