Namespace Reference — Modules

Learning

Curated JQL namespaces and examples for learning.

Learning namespaces cover categories, instructors, tags, courses, enrollments, progress, sections, items, reviews, certificates, learning paths, quizzes, SCORM/xAPI runtime data, and learner projections.

Key namespaces and models

  • learning.Category
  • learning.Instructor
  • learning.Tag
  • learning.Course
  • learning.CourseEnrollment
  • learning.CourseProgress
  • learning.CourseSection
  • learning.CourseItem
  • learning.CourseReview
  • learning.CourseCertificate
  • learning.LearningPath
  • learning.LearningPathEnrollment
  • learning.Quiz
  • learning.QuizAttempt
  • learning.LearningContentRegistration
  • learning.ScormRuntimeData
  • learning.XapiStatement
  • learning.LearnerStateProjection

Common controller intents

  • learning.Learning.getQuickStats
  • learning.Category.getQuickStats
  • learning.Course.getQuickStats
  • learning.LearningContentRegistration.registerContent
  • learning.LearningContentRegistration.uploadPackage
  • learning.LearningLaunch.requestLaunch
  • learning.ScormRuntime.initialise
  • learning.XapiIngestion.ingestStatement

Common model intents

Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.

Retrieve example

json
1{ 2 "__meta__": { 3 "schema": "model", 4 "namespace": "learning.Course", 5 "intent": "retrieve", 6 "authenticationClass": "jwt", 7 "ordering": "-created", 8 "limit": 20 9 }, 10 "id": null, 11 "created": null 12}

Create example

json
1{ 2 "__meta__": { 3 "schema": "model", 4 "namespace": "learning.Category", 5 "intent": "create", 6 "authenticationClass": "jwt", 7 "return": { 8 "id": null, 9 "name": null, 10 "alias": null 11 } 12 }, 13 "name": "Compliance", 14 "alias": "compliance" 15}

For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.