get_exelearnings_by_courses – List Course Activities

mod_exelearning_get_exelearnings_by_courses returns all accessible mod_exelearning instances visible to the calling user in the given set of courses. When no course IDs are supplied the function automatically queries the user’s enrolled courses. Courses the user cannot access produce a warning entry rather than an error, so a single inaccessible course never aborts the entire request.

Function details

Field	Value
Function name	`mod_exelearning_get_exelearnings_by_courses`
Class::method	`mod_exelearning\external\get_exelearnings_by_courses::execute`
Type	`read`
Service	`MOODLE_OFFICIAL_MOBILE_SERVICE`
Capability	`mod/exelearning:view`

Parameters

courseids

array of int

List of course IDs to search for mod_exelearning instances. Pass an empty array (or omit the parameter) to search all courses the authenticated user is enrolled in.

Returns

exelearnings

array

Array of activity instance objects. Visibility is enforced by get_all_instances_in_courses() — hidden or restricted instances are excluded for users without the appropriate permission.

Show Instance object fields

int

The exelearning table row ID (the activity instance ID).

coursemodule

int

The course-module ID (cm.id). This is not the parameter for other API functions — those take exelearningid (the instance id field), not this coursemodule value.

course

int

ID of the course containing the activity.

name

string

Display name of the activity, formatted for output.

intro

string

Intro text, formatted for output.

introformat

int

Moodle text format constant for intro.

introfiles

array

Files embedded in the intro field (standard Moodle file structure).

packageurl

string

Download URL for the source ELPX package. Only returned to users who hold moodle/course:manageactivities (teachers and admins). Absent for students.

timemodified

int

Unix timestamp of the last modification.

section

int

Course section number.

visible

int

1 if the activity is visible to students; 0 if hidden.

groupmode

int

Group mode setting (0 = no groups, 1 = separate, 2 = visible).

groupingid

int

ID of the grouping used for access restriction (0 = none).

gradeenabled

int

Whether grading is enabled for this activity (1 = yes, 0 = no).

grademodel

int

Grade model: 0 = single overall column, 1 = per-iDevice columns.

grademax

float

Maximum grade value for the activity.

gradepass

float

Passing grade threshold (0 = no pass/fail threshold set).

maxattempt

int

Maximum number of attempts allowed (0 = unlimited).

grademethod

int

Attempt aggregation method (e.g. highest, average, first, last).

reviewmode

int

Bitmask controlling when students may review their attempts.

revision

int

Package revision counter used as a cache-buster.

warnings

array

One warning object per course that could not be accessed. The request succeeds even when warnings are present — the function never fails on an inaccessible course.

Show Warning object fields

item

string

The item type that caused the warning (e.g. "course").

itemid

int

The ID of the inaccessible course.

warningcode

string

Machine-readable warning code.

message

string

Human-readable warning message.

Security note

The packageurl field is only present in the response for users who hold the moodle/course:manageactivities capability (typically teachers and administrators). This mirrors the access control enforced by the pluginfile handler — students cannot download the raw ELPX source package.

Example request

POST {wwwroot}/webservice/rest/server.php
Content-Type: application/x-www-form-urlencoded

wstoken=<token>
&wsfunction=mod_exelearning_get_exelearnings_by_courses
&moodlewsrestformat=json
&courseids[0]=42
&courseids[1]=57

Example response

{
  "exelearnings": [
    {
      "id": 12,
      "coursemodule": 88,
      "course": 42,
      "name": "Introduction to HTML",
      "intro": "<p>Complete this activity before the exam.</p>",
      "introformat": 1,
      "introfiles": [],
      "timemodified": 1712000000,
      "section": 2,
      "visible": 1,
      "groupmode": 0,
      "groupingid": 0,
      "gradeenabled": 1,
      "grademodel": 0,
      "grademax": 100.0,
      "gradepass": 50.0,
      "maxattempt": 3,
      "grademethod": 1,
      "reviewmode": 6,
      "revision": 4
    }
  ],
  "warnings": []
}

Web Services

Admin AJAX

get_exelearnings_by_courses – List Course Activities

Function details

Parameters

Returns

Security note

Example request

Example response

Build docs developers (and LLMs) love

Web Services

Admin AJAX

Documentation Index

​Function details

​Parameters

​Returns

​Security note

​Example request

​Example response

Build docs developers (and LLMs) love

Function details

Parameters

Returns

Security note

Example request

Example response