Moodle

App · 20 actions

Read Moodle courses, users, enrolments, activities, assignments, grades, forums, calendars and completion.

Actions

ActionWhat it does
Get activity completionGet activity completion.
Get calendar eventsGet calendar events.
Get course completionGet course completion.
Get course contentsGet course contents.
Get courses by fieldGet courses by field.
Get grade itemsGet grade items.
Get site infoGet site info.
Get usersGet users.
List assignment gradesList assignment grades.
List assignment submissionsList assignment submissions.
List assignmentsList assignments.
List categoriesList categories.
List coursesList courses.
List discussion postsList discussion posts.
List enrolled usersList enrolled users.
List forum discussionsList forum discussions.
List forumsList forums.
List quizzesList quizzes.
List user coursesList user courses.
List user quiz attemptsList user quiz attempts.

Get activity completion

Get activity completion.

Inputs

Coursecourse_idnumberRequired
Course.At least 1.
User IDlearner_idnumberRequired
User ID.At least 1.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "statuses": []
  }
}

Get calendar events

Get calendar events.

Inputs

Course idscourse_idslist
Course ids.
Startstartdate and time
Start.
Endenddate and time
End.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "events": []
  }
}

Get course completion

Get course completion.

Inputs

Coursecourse_idnumberRequired
Course.At least 1.
User IDlearner_idnumberRequired
User ID.At least 1.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "completionstatus": {
      "completed": false
    }
  }
}

Get course contents

Get course contents.

Inputs

Coursecourse_idnumberRequired
Course.At least 1.

Outputs

datalist
The service response, including pagination metadata when present.
Example output
{
  "data": []
}

Get courses by field

Get courses by field.

Inputs

Search fieldsearch_fieldtextRequired
Search field.One of: id, ids, shortname, idnumber, category.
ValuevaluetextRequired
Value.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "courses": []
  }
}

Get grade items

Get grade items.

Inputs

Coursecourse_idnumberRequired
Course.At least 1.
Learner idlearner_idnumber
Learner id.At least 1.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "usergrades": []
  }
}

Get site info

Get site info.

Inputs

None.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "functions": [],
    "sitename": "example",
    "userid": 1,
    "username": "example"
  }
}

Get users

Get users.

Inputs

Search fieldsearch_fieldtextRequired
Search field.One of: id, username, idnumber, email.
ValuesvalueslistRequired
Values.

Outputs

datalist
The service response, including pagination metadata when present.
Example output
{
  "data": []
}

List assignment grades

List assignment grades.

Inputs

Assignment idsassignment_idslistRequired
Assignment ids.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "assignments": []
  }
}

List assignment submissions

List assignment submissions.

Inputs

Assignment idsassignment_idslistRequired
Assignment ids.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "assignments": []
  }
}

List assignments

List assignments.

Inputs

Coursescourse_idslist
Courses.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "courses": []
  }
}

List categories

List categories.

Inputs

None.

Outputs

datalist
The service response, including pagination metadata when present.
Example output
{
  "data": []
}

List courses

List courses.

Inputs

None.

Outputs

datalist
The service response, including pagination metadata when present.
Example output
{
  "data": []
}

List discussion posts

List discussion posts.

Inputs

Discussion iddiscussion_idnumberRequired
Discussion id.At least 1.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "posts": []
  }
}

List enrolled users

List enrolled users.

Inputs

Coursecourse_idnumberRequired
Course.At least 1.

Outputs

datalist
The service response, including pagination metadata when present.
Example output
{
  "data": []
}

List forum discussions

List forum discussions.

Inputs

Forum idforum_idnumberRequired
Forum id.At least 1.
Pagepagenumber
Page.At least 0.
Perpageperpagenumber
Perpage.From 1 to 100.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "discussions": []
  }
}

List forums

List forums.

Inputs

Coursescourse_idslist
Courses.

Outputs

datalist
The service response, including pagination metadata when present.
Example output
{
  "data": []
}

List quizzes

List quizzes.

Inputs

Coursescourse_idslist
Courses.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "quizzes": []
  }
}

List user courses

List user courses.

Inputs

User IDlearner_idnumberRequired
User ID.At least 1.

Outputs

datalist
The service response, including pagination metadata when present.
Example output
{
  "data": []
}

List user quiz attempts

List user quiz attempts.

Inputs

Quiz idquiz_idnumberRequired
Quiz id.At least 1.
Learner idlearner_idnumber
Learner id.At least 1.
Statusstatustext
Status.One of: all, finished, unfinished.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "attempts": []
  }
}

On this page