Moodle
App · 20 actions
Read Moodle courses, users, enrolments, activities, assignments, grades, forums, calendars and completion.
Actions
| Action | What it does |
|---|---|
| Get activity completion | Get activity completion. |
| Get calendar events | Get calendar events. |
| Get course completion | Get course completion. |
| Get course contents | Get course contents. |
| Get courses by field | Get courses by field. |
| Get grade items | Get grade items. |
| Get site info | Get site info. |
| Get users | Get users. |
| List assignment grades | List assignment grades. |
| List assignment submissions | List assignment submissions. |
| List assignments | List assignments. |
| List categories | List categories. |
| List courses | List courses. |
| List discussion posts | List discussion posts. |
| List enrolled users | List enrolled users. |
| List forum discussions | List forum discussions. |
| List forums | List forums. |
| List quizzes | List quizzes. |
| List user courses | List user courses. |
| List user quiz attempts | List user quiz attempts. |
Get activity completion
Get activity completion.
Inputs
- Course
course_idnumberRequired - Course.At least 1.
- User ID
learner_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 ids
course_idslist - Course ids.
- Start
startdate and time - Start.
- End
enddate and time - End.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"events": []
}
}Get course completion
Get course completion.
Inputs
- Course
course_idnumberRequired - Course.At least 1.
- User ID
learner_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
- Course
course_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 field
search_fieldtextRequired - Search field.One of:
id,ids,shortname,idnumber,category. - Value
valuetextRequired - Value.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"courses": []
}
}Get grade items
Get grade items.
Inputs
- Course
course_idnumberRequired - Course.At least 1.
- Learner id
learner_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 field
search_fieldtextRequired - Search field.One of:
id,username,idnumber,email. - Values
valueslistRequired - Values.
Outputs
datalist- The service response, including pagination metadata when present.
Example output
{
"data": []
}List assignment grades
List assignment grades.
Inputs
- Assignment ids
assignment_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 ids
assignment_idslistRequired - Assignment ids.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"assignments": []
}
}List assignments
List assignments.
Inputs
- Courses
course_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 id
discussion_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
- Course
course_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 id
forum_idnumberRequired - Forum id.At least 1.
- Page
pagenumber - Page.At least 0.
- Perpage
perpagenumber - Perpage.From 1 to 100.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"discussions": []
}
}List forums
List forums.
Inputs
- Courses
course_idslist - Courses.
Outputs
datalist- The service response, including pagination metadata when present.
Example output
{
"data": []
}List quizzes
List quizzes.
Inputs
- Courses
course_idslist - Courses.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"quizzes": []
}
}List user courses
List user courses.
Inputs
- User ID
learner_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 id
quiz_idnumberRequired - Quiz id.At least 1.
- Learner id
learner_idnumber - Learner id.At least 1.
- Status
statustext - Status.One of:
all,finished,unfinished.
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"attempts": []
}
}