CreateExternalLmsServerRequest

A request or response body; the type column links to the schemas it refers to.

CreateExternalLmsServerRequest

FieldTypeRequiredDescription
organization_idstring (uuid)yes

Organization whose catalogue the server belongs to.

slugstringyes

Unique within the organization. Slugs are lowercase letters and digits in words separated by single hyphens, like moodle-eu.

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

namestringyes

1–200 characters

descriptionstringno

Omit or send empty for no description.

at most 2000 characters

base_urlstring (uri)no

at most 2000 characters

lms_kindstringno

Free-text kind of the server, e.g. "moodle" or "scorm-cloud"; informational.

1–100 characters

jsonExample
{
  "organization_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "slug": "moodle-eu",
  "name": "Moodle (EU campus)",
  "description": "string",
  "base_url": "https://moodle.example.com",
  "lms_kind": "moodle"
}