This page describes the web service exposed by tool_moodleload: the functions, their parameters and their responses. It is aimed at integrators and at the MoodleLoad engine.

General call:

POST /webservice/rest/server.php
  wstoken=<TOKEN>
  wsfunction=<function>
  moodlewsrestformat=json
  <function parameters>

The token is that of the moodleload account (see Installation and configuration). Never put it in a shared URL or in a document.

Returns a snapshot of the resources of the server running Moodle.

Parameter

Response

Example of an abridged response:

{
  "timestamp": 1727600000,
  "cpu_percent": 14.73,
  "memory": {"total": 16777216000, "available": 9663676416, "used": 7113539584, "used_percent": 42.40},
  "load_avg": {"avg1": 0.85, "avg5": 1.02, "avg15": 0.97},
  "processes": {"total": 312, "running": 2, "blocked": 0},
  "network": [],
  "error": "",
  "hostname": "web01"
}

The CPU measurement is a difference between two snapshots kept in Moodle's universal cache (adjustable lifetime). Call the function twice at least 5 seconds apart to get a meaningful value. The function is also called by the tool's dashboard with the administrator's Moodle session (no token is written in the page).

Handshake that MoodleLoad performs before launching a load test on the site. The engine refuses to fire on a site that does not answer it.

Parameters

Response

The signature covers the following string, the fields being separated by | in this order: protocol, nonce, wwwroot, timestamp, allowload, maxload, allowedhours, inallowedhours. The engine recomputes it with the token it knows and compares: an unsigned response, or one from another site, is rejected. The test is refused if allowload is 0 or if inallowedhours is 0.

These three functions require the tool/moodleload:setuptests capability in the system context. The normal sequence is:

1. Upload the file (course backup or users CSV) to /webservice/upload.php with the token: the upload returns a draft area identifier (itemid).
2. Call app_moodleload_commit to validate the file.
3. Call app_moodleload_restore_course or app_moodleload_bulk_create_install_users with the identifier of the validated file.

Validates the single file of a draft area as the test material for a given purpose. A new file replaces the previous one for the same purpose.

Restores a validated course backup. A course with the same short name is deleted before the restore, so that the test material is refreshed.

The caller must be able to create courses and restore into the targeted category. Response: courseid, shortname and categoryid of the restored course. An unreadable backup causes an error.

Creates or updates the users of a CSV file validated with the testusers purpose, then enrols them in the indicated courses. Accounts are identified by their login.

File format: the first line is the header. The separator is ; or , (whichever appears most in the header).

When the course has no enabled instance of the requested method, a default instance is added. A user or enrolment in error is reported with its line and does not stop the other lines.

• The service is reserved for authorised users. The moodleload account holds the Manager role: the token must be protected like an administration credential.
• Deleting a course with the same short name during a restore is intentional: do not use the short name of a real course for the test material.
• The write functions have no place on a production site.

Back to the component index - Back to plugins index - Back to catalogue