Learning Analytics Documentation

In the examples below, depends on the UDD version being queried.

See UDD-Direct-Integration for more detail on the API

Basic Queres

Example 1: Get students on a module instance, retrieving their student details

Here we query the student entity, matching on as the module instance we wish to find, using populate to add in the student details.

<root>/student?query='{"MOD_INSTANCE_ID":"<modid>"}&populate={"path":"student"}'

Example 2: Get a staff by DASHSHIBID, making the search case insenstive.

For this we use a regular expression.

<root>/staff?query={"DASH_SHIB_ID":{"$regex":"(?i)^mwebb@jisc.ac.uk"}}

Example 3: Get students on particular course instance, returning only their student_id's

Here we use selct to return only the field we want

<root>/courseinstance?query={"COURSE_INSTANCE_ID":"LWI02A-20152"}&select=STUDENT_ID

Example 4: Get students on particular course instance, returning the VLE_IDs from the student entity

This example combines a select and populate.

<root>/courseinstance?{"COURSE_INSTANCE_ID":"LWI02A-20152"}&populate=student&select={"STUDENT_ID":1,"student.VLE_ID":1}