====== Differences ====== This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
api2:adaptive:recommendations [2017/10/16 11:51] maries |
api2:adaptive:recommendations [2018/07/23 10:34] (current) maries |
||
---|---|---|---|
Line 19: | Line 19: | ||
If you want to specify which recommendation you want to get, you can add the following parameters in a JSON request:\\ | If you want to specify which recommendation you want to get, you can add the following parameters in a JSON request:\\ | ||
- | ^ Property ^ Type ^ Description ^ | + | ^ Property ^ Type ^ Description ^ |
| student_id | Integer | The ID of the student you want to fetch the recommendations for | | | student_id | Integer | The ID of the student you want to fetch the recommendations for | | ||
| objective_id | Integer | The ID of the particular Objective you want to fetch recommendations for | | | objective_id | Integer | The ID of the particular Objective you want to fetch recommendations for | | ||
Line 53: | Line 53: | ||
}] | }] | ||
</code> | </code> | ||
+ | |||
+ | |||
+ | ===Fetch the next best concept (GET)=== | ||
+ | |||
+ | ^ Method | GET | | ||
+ | ^ URL | /recommendation_utils/fetch_best_knowledge_recommendations | | ||
+ | |||
+ | |||
+ | ==Parameters (*Required parameters)== | ||
+ | |||
+ | ^ Property ^ Type ^ Description ^ | ||
+ | | student_id or student_uid * | Integer or String | Identifier of the student | | ||
+ | | objective_id or uid | Integer | Identifier of the objective | | ||
+ | | objectives | String | If "all" it will select all your objectives | | ||
+ | | limit | Integer | The maximum number of recommendations you want (1 by default) | | ||
+ | |||
+ | If no objective_id nor objectives parameters are given, the API will select all your active objectives. | ||
+ | |||
+ | ===Fetch the next best content (GET)=== | ||
+ | |||
+ | ^ Method | GET | | ||
+ | ^ URL | /recommendation_utils/fetch_best_content_recommendations | | ||
+ | |||
+ | ==Parameters (*Required parameters)== | ||
+ | |||
+ | ^ Property ^ Type ^ Description ^ | ||
+ | | student_id or student_uid * | Integer or String | Identifier of the student | | ||
+ | | objective_id | Integer | Identifier of the objective | | ||
+ | | objectives | String | If "all" it will select all your objectives | | ||
+ | | limit | Integer | The maximum number of recommendations you want (1 by default) | | ||
+ | | knowledge_node_id | Integer | If you want recommendations on a specific Knowledge Node | | ||
+ | |||
+ | |||
+ | If no objective_id nor objectives parameters are given, the API will select all your active objectives. | ||