28/06/2024, 21:33 Web service API functions - MoodleDocs

Note:
If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Web service API functions

Moodle 3.11
Implemented
Must be implemented
Suggested
Color meaning

Contents
1 Web service protocols
2 Web service functions
2.1 Naming convention
2.2 Core web service functions
2.3 API Roadmap
3 See also
Web service protocols
Name Moodle Description CORS Issue
Ver.
REST Supported (3.0
(returning 2.0 XML data accessed through a REST API (not restful) and onwards)
XML)
REST Supported (3.0 MDL-29242
(returning 2.2 JSON data accessed through a REST API (not restful) and onwards)
JSON)
REST
(returning 2.X Would be very useful for client-side JavaScript Not supported MDL-29913
JSONP)
JSON 2.X JSON server receives a JSON encoded params and return JSON encoded values. Not supported MDL-21341
SOAP 2.0 Very important for interoperating with Java and .Net applications. There was a partial implementation JAVA/.Net in Moodle 2.0, but it does not work Not supported MDL-20804
MDL-28988
,
,
for anything but the most trivial functions. It is fully working with PHP clients. MDL-28989
XML remote-procedure call.
Note: The installation of the XMLRPC PHP extension is not needed for Moodle 4.1 core anymore. All MNet features continue working exactly
the same, but using a PHP library instead (see MDL-76055 for details).
If you were using the webservice_xmlrpc plugin for integrations with other systems, be warned that it has been removed from core for Moodle
4.1 (see MDL-76052 for details). It's now available @ https://github.com/moodlehq/moodle-webservice_xmlrpc and has been also
published in the Plugins directory . Note that, if you want to continue using this plugin, then you will need, before starting the upgrade
XMLRPC 2.0 process, to: Not supported
1. Install the XMLRPC PHP extension, the webservice requires it.
2. Install the webservice_xmlrpc plugin, from the links in the previous paragraph, into the webservice/xmlrpc directory.
3. Then, and only then, start the upgrade process.

Web service functions

Naming convention
All functions should be named as
{fullcomponent}_{methodname} - example: core_user_get_user_preferences
where
{fullcomponent} is the full frankenstyle name or the component such as core_user here
{methodname} is the name of the method in the form of {verb}_{noun} such as get_user_preferences here
{verb} - preferably one of get, create, delete, update or eventually other that well describes the action
{noun} - moodle objects, usually plural such as user_preferences here, or e.g. posts, discussions, users, courses etc.

https://docs.moodle.org/dev/Web_service_API_functions 1/17
28/06/2024, 21:33 Web service API functions - MoodleDocs
This naming convention has been in place since Moodle 2.2. See MDL-29106 for more details.
Core web service functions
Area Name Introduced Description Available Login Services
in AJAX required
Return list of users identities
\core_user\search_identity core_user_search_identity 3.11 matching the given criteria in Yes Yes
their name or other identity
fields.
auth_email auth_email_get_signup_settings 3.2 Get the signup required settings Yes No
and profile fields.
auth_email auth_email_signup_user 3.2 Adds a new user (pendingto be Yes No
confirmed) in the site.
block_recentlyaccesseditems block_recentlyaccesseditems_get_recent_items 3.6 List of items a user has Yes Yes moodle_mobile_app
accessed most recently.
block_starredcourses block_starredcourses_get_starred_courses 3.6 Get users starred courses. Yes Yes moodle_mobile_app
Record the action that the user
core\record_userfeedback_action core_create_userfeedback_action_record 3.9 takes in the user feedback Yes Yes
notification for future use.
core_auth core_auth_confirm_user 3.2 Confirm a user account. Yes No
core_auth core_auth_is_age_digital_consent_verification_enabled 3.5 Checks if age digital consent Yes No
verification is enabled.
core_auth core_auth_is_minor 3.5 Requests a check if a user is a Yes No
digital minor.
core_auth core_auth_request_password_reset 3.4 Requests a password reset. Yes No
core_auth core_auth_request_password_reset 3.4 Requests a password reset. Yes No
core_auth core_auth_resend_confirmation_email 3.6 Resend confirmation email. Yes No
core_auth core_auth_resend_confirmation_email 3.6 Resend confirmation email. Yes No
Gets the data to use when
core_backup core_backup_get_async_backup_links_backup 3.7 updating the status table row in Yes Yes
the UI for when an async
backup completes.
Gets the data to use when
core_backup core_backup_get_async_backup_links_restore 3.7 updating the status table row in Yes Yes
the UI for when an async
restore completes.
core_backup core_backup_get_async_backup_progress 3.7 Get the progress of an Yes Yes
Asyncronhous backup.
core_backup core_backup_get_copy_progress 3.9 Gets the progress of course Yes Yes
copy operations.
core_backup core_backup_submit_copy_form 3.9 Handles ajax submission of Yes Yes
course copy form.
core_badges core_badges_get_user_badges 3.1 Returns the list of badges No Yes moodle_mobile_app
awarded to a user.
core_block core_block_get_course_blocks 3.3 Returns blocks information for a No Yes moodle_mobile_app
course.
core_block core_block_get_dashboard_blocks 3.6 Returns blocks information for No Yes moodle_mobile_app
the given user dashboard.
core_block\fetch_addable_blocks core_block_fetch_addable_blocks 3.11 Returns all addable blocks in a Yes Yes moodle_mobile_app
given page.
core_blog core_blog_get_entries 3.6 Returns blog entries. Yes No moodle_mobile_app
core_blog core_blog_view_entries 3.6 Trigger the blog_entries_viewed Yes No moodle_mobile_app
event.
core_calendar core_calendar_create_calendar_events 2.5 Create calendar events No Yes moodle_mobile_app
core_calendar core_calendar_delete_calendar_events 2.5 Delete calendar events Yes Yes moodle_mobile_app
core_calendar core_calendar_get_action_events_by_course 3.3 Get calendar action events by Yes Yes moodle_mobile_app
course
core_calendar core_calendar_get_action_events_by_courses 3.3 Get calendar action events by Yes Yes moodle_mobile_app
courses
core_calendar core_calendar_get_action_events_by_timesort 3.3 Get calendar action events by Yes Yes moodle_mobile_app
tiemsort
core_calendar core_calendar_get_allowed_event_types 3.7 Get the type of events a user No Yes moodle_mobile_app
can create in the given course.
Convenience function to
core_calendar core_calendar_get_calendar_access_information 3.7 retrieve some No Yes moodle_mobile_app
permissions/access information
for the given course calendar.
core_calendar core_calendar_get_calendar_day_view 3.4 Fetch the day view data for a Yes Yes moodle_mobile_app
calendar
core_calendar core_calendar_get_calendar_event_by_id 3.4 Get calendar event by id Yes Yes moodle_mobile_app
core_calendar core_calendar_get_calendar_events 2.5 Get calendar events No Yes moodle_mobile_app
core_calendar core_calendar_get_calendar_monthly_view 3.4 Fetch the monthly view data for Yes Yes moodle_mobile_app
a calendar
core_calendar core_calendar_get_calendar_upcoming_view 3.4 Fetch the upcoming view data Yes Yes moodle_mobile_app
for a calendar
core_calendar core_calendar_get_timestamps 3.8 Fetch unix timestamps for given Yes Yes
date times.
core_calendar core_calendar_submit_create_update_form 3.4 Submit form data for event form Yes Yes moodle_mobile_app
core_calendar core_calendar_update_event_start_day 3.4 Update the start day (but not Yes Yes moodle_mobile_app
time) for an event.
core_calendar\export\token core_calendar_get_calendar_export_token 3.10 Return the auth token required No No moodle_mobile_app
for exporting a calendar.
core_cohort core_cohort_add_cohort_members 2.4 Add members to cohort No Yes
core_cohort core_cohort_create_cohorts 2.4 Create cohorts No Yes
https://docs.moodle.org/dev/Web_service_API_functions 2/17
28/06/2024, 21:33 Web service API functions - MoodleDocs

Area Name Introduced Description Available Login Services

in AJAX required
core_cohort core_cohort_delete_cohort_members 2.4 Delete members from cohort No Yes
core_cohort core_cohort_delete_cohorts 2.4 Delete cohorts No Yes
core_cohort core_cohort_get_cohort_members 2.4 Get cohort members No Yes
core_cohort core_cohort_get_cohorts 2.4 Get cohorts No Yes
core_cohort core_cohort_search_cohorts 3.4 Search for cohorts. Yes Yes
core_cohort core_cohort_update_cohorts 2.4 Update cohorts No Yes
core_comment core_comment_add_comments 3.8 Adds a comment or comments. No Yes moodle_mobile_app
core_comment core_comment_delete_comments 3.8 Deletes a comment or No Yes moodle_mobile_app
comments.
core_comment core_comment_get_comments 2.9 Return all the comments for an No Yes moodle_mobile_app
specific component, context.
core_competency core_competency_add_competency_to_course 3.1 Add competency to a course Yes Yes
core_competency core_competency_add_competency_to_plan 3.1 Add a competency to a learning Yes Yes
plan
core_competency core_competency_add_competency_to_template 3.1 Add competency to a template Yes Yes
core_competency core_competency_add_related_competency 3.1 Create a relationship between Yes Yes
competencies
core_competency core_competency_approve_plan 3.1 Approve a learning plan Yes Yes
core_competency core_competency_competency_framework_viewed 3.1 Notify a competency framework Yes Yes
as being viewed
core_competency core_competency_competency_viewed 3.1 Report a competency as being Yes Yes moodle_mobile_app
viewed
core_competency core_competency_complete_plan 3.1 Complete a learning plan Yes Yes
core_competency core_competency_count_competencies 3.1 Count the competencies Yes Yes
core_competency core_competency_count_competencies_in_course 3.1 Count competencies in a course Yes Yes
core_competency core_competency_count_competencies_in_template 3.1 Count the competencies in a Yes Yes
template
core_competency core_competency_count_competency_frameworks 3.1 Count the competency Yes Yes
frameworks
core_competency core_competency_count_course_module_competencies 3.8 Count the competencies in a Yes Yes
course module
core_competency core_competency_count_courses_using_competency 3.1 Count courses using a Yes Yes
competency
core_competency core_competency_count_templates 3.1 Count templates Yes Yes
core_competency core_competency_count_templates_using_competency 3.1 Count templates using a Yes Yes
competency
core_competency core_competency_create_competency 3.1 Create a competency Yes Yes
core_competency core_competency_create_competency_framework 3.1 Create a competency Yes Yes
framework
core_competency core_competency_create_plan 3.1 Create a learning plan Yes Yes
core_competency core_competency_create_template 3.1 Create a template Yes Yes
Link an evidence of prior
core_competency core_competency_create_user_evidence_competency 3.1 learning with a user's Yes Yes
competency
core_competency core_competency_delete_competency 3.1 Delete a competency Yes Yes
core_competency core_competency_delete_competency_framework 3.1 Delete a competency Yes Yes
framework
core_competency core_competency_delete_evidence 3.1 Delete an evidence Yes Yes moodle_mobile_app
core_competency core_competency_delete_plan 3.1 Delete a learning plan Yes Yes
core_competency core_competency_delete_template 3.1 Delete a template Yes Yes
core_competency core_competency_delete_user_evidence 3.1 Delete an evidence of prior Yes Yes
learning
Remove a link between an
core_competency core_competency_delete_user_evidence_competency 3.1 evidence of prior learning and a Yes Yes
user's competency
core_competency core_competency_duplicate_competency_framework 3.1 Duplicate a competency Yes Yes
framework
core_competency core_competency_duplicate_template 3.1 Duplicate a template Yes Yes
core_competency core_competency_get_scale_values 3.1 Get the values for a scale Yes Yes moodle_mobile_app
core_competency core_competency_grade_competency 3.1 Rate a user's competency Yes Yes
core_competency core_competency_grade_competency_in_course 3.1 Rate a user's competency in a Yes Yes moodle_mobile_app
course
core_competency core_competency_grade_competency_in_plan 3.1 Rate a user's competency in a Yes Yes
learning plan
core_competency core_competency_list_competencies 3.1 List competencies Yes Yes
core_competency core_competency_list_competencies_in_template 3.1 List the competencies of a Yes Yes
template
core_competency core_competency_list_competency_frameworks 3.1 List the competency Yes Yes
frameworks
core_competency core_competency_list_course_competencies 3.1 List the competencies in a Yes Yes moodle_mobile_app
course
core_competency core_competency_list_course_module_competencies 3.8 List the competencies in a Yes Yes
course module
core_competency core_competency_list_plan_competencies 3.1 List a learning plan's Yes Yes
competencies
core_competency core_competency_list_templates 3.1 List templates Yes Yes
core_competency core_competency_list_templates_using_competency 3.1 List templates using a Yes Yes
competency
core_competency core_competency_list_user_plans 3.1 List a user's learning plans Yes Yes

https://docs.moodle.org/dev/Web_service_API_functions 3/17
28/06/2024, 21:33 Web service API functions - MoodleDocs

Area Name Introduced Description Available Login Services

in AJAX required
core_competency core_competency_move_down_competency 3.1 Move a competency down in its Yes Yes
branch
core_competency core_competency_move_up_competency 3.1 Move a competency up in its Yes Yes
branch
core_competency core_competency_plan_cancel_review_request 3.1 Cancel the review request of a Yes Yes
learning plan
core_competency core_competency_plan_request_review 3.1 Request the review of a learning Yes Yes
plan
core_competency core_competency_plan_start_review 3.1 Start the review of a learning Yes Yes
plan
core_competency core_competency_plan_stop_review 3.1 Stop the review of a learning Yes Yes
plan
core_competency core_competency_read_competency 3.1 Fetch a competency Yes Yes
core_competency core_competency_read_competency_framework 3.1 Fetch a competency framework Yes Yes
core_competency core_competency_read_plan 3.1 Fetch a learning plan Yes Yes
core_competency core_competency_read_template 3.1 Fetch a template Yes Yes
core_competency core_competency_read_user_evidence 3.1 Fetch an evidence of prior Yes Yes
learning
core_competency core_competency_remove_competency_from_course 3.1 Remove competency from a Yes Yes
course
core_competency core_competency_remove_competency_from_plan 3.1 Remove a competency from a Yes Yes
learning plan
core_competency core_competency_remove_competency_from_template 3.1 Remove competency from Yes Yes
template
core_competency core_competency_remove_related_competency 3.1 Remove a relationship between Yes Yes
competencies
core_competency core_competency_reopen_plan 3.1 Reopen a learning plan Yes Yes
core_competency core_competency_reorder_course_competency 3.1 Reorder competencies in a Yes Yes
course
core_competency core_competency_reorder_plan_competency 3.1 Reopen a competency in a Yes Yes
learning plan
core_competency core_competency_reorder_template_competency 3.1 Reorder competencies in a Yes Yes
template
Request the review of the user's
core_competency core_competency_request_review_of_user_evidence_linked_competencies 3.1 competencies linked to an Yes Yes
evidence of prior learning
core_competency core_competency_search_competencies 3.1 Search for competencies Yes Yes
core_competency core_competency_set_course_competency_ruleoutcome 3.1 Set the rule of course Yes Yes
competencies
core_competency core_competency_set_parent_competency 3.1 Relocate a competency to Yes Yes
another parent
core_competency core_competency_template_has_related_data 3.1 Check whether a template has Yes Yes
related data
core_competency core_competency_template_viewed 3.1 Report a template as being Yes Yes
viewed
core_competency core_competency_unapprove_plan 3.1 Unapprove a learning plan Yes Yes
core_competency core_competency_unlink_plan_from_template 3.1 Unlink a learning plan from a Yes Yes
template
core_competency core_competency_update_competency 3.1 Update a competency Yes Yes
core_competency core_competency_update_competency_framework 3.1 Update a competency Yes Yes
framework
core_competency core_competency_update_course_competency_settings 3.1 Update the course competency Yes Yes
settings
core_competency core_competency_update_plan 3.1 Update a learning plan Yes Yes
core_competency core_competency_update_template 3.1 Update a template Yes Yes
core_competency core_competency_user_competency_cancel_review_request 3.1 Cancel the review request of a Yes Yes
user's competency
core_competency core_competency_user_competency_plan_viewed 3.1 Report the archive of user's Yes Yes moodle_mobile_app
competency as being viewed
core_competency core_competency_user_competency_request_review 3.1 Request the review of a user's Yes Yes
competency
core_competency core_competency_user_competency_start_review 3.1 Start the review of a user's Yes Yes
competency
core_competency core_competency_user_competency_stop_review 3.1 Stop the review of a user's Yes Yes
competency
core_competency core_competency_user_competency_viewed 3.1 Report a user's competency as Yes Yes moodle_mobile_app
being viewed
core_competency core_competency_user_competency_viewed_in_course 3.1 Report a user's competency as Yes Yes moodle_mobile_app
being viewed from a course
Report a user's competency as
core_competency core_competency_user_competency_viewed_in_plan 3.1 being viewed from a learning Yes Yes moodle_mobile_app
plan
core_completion core_completion_get_activities_completion_status 2.9 Return the activities completion No Yes moodle_mobile_app
status for a user in a course.
core_completion core_completion_get_course_completion_status 2.9 Returns course completion No Yes moodle_mobile_app
status.
Update the course completion
core_completion core_completion_mark_course_self_completed 3.0 status for the current user (if No Yes moodle_mobile_app
course self-completion is
enabled).
Update completion status for a
core_completion core_completion_override_activity_completion_status 3.4 user in an activity by overriding Yes Yes
it.
https://docs.moodle.org/dev/Web_service_API_functions 4/17
28/06/2024, 21:33 Web service API functions - MoodleDocs

Area Name Introduced Description Available Login Services

in AJAX required
Update completion status for
core_completion core_completion_update_activity_completion_status_manually 2.9 the current user in an activity, No Yes moodle_mobile_app
only for activities with manual
tracking.
core_contentbank\delete_content core_contentbank_delete_content 3.9 Delete a content from the Yes Yes
content bank.
core_contentbank\rename_content core_contentbank_rename_content 3.9 Rename a content in the Yes Yes
content bank.
core_contentbank\set_content_visibility core_contentbank_set_content_visibility 3.11 Set the visibility of a content in Yes Yes
the content bank.
Adds a content item (activity,
core_course core_course_add_content_item_to_user_favourites 3.9 resource or their subtypes) to Yes Yes
the favourites for the user.
Check if there is updates
core_course core_course_check_updates 3.2 affecting the user for the given Yes Yes moodle_mobile_app
course and contexts.
core_course core_course_create_categories 2.3 create categories No Yes
core_course core_course_create_courses 2.0 Create new courses No Yes
core_course core_course_delete_categories 2.3 delete categories No Yes
core_course core_course_delete_courses 2.3 delete courses No Yes
core_course core_course_delete_modules 2.5 Deletes all specified module No Yes
instances
core_course core_course_duplicate_course 2.3 duplicate a course No Yes
Performs an action on course
core_course core_course_edit_module 3.3 module (change visibility, Yes Yes
duplicate, delete, etc.)
Performs an action on course
core_course core_course_edit_section 3.3 section (change visibility, set Yes Yes
marker, delete)
core_course core_course_get_activities_overview 3.2 Return activities overview for No Yes
the given courses.
core_course core_course_get_activity_chooser_footer 3.9 Fetch the data for the activity Yes Yes
chooser footer.
core_course core_course_get_categories 2.3 get categories No Yes moodle_mobile_app
core_course core_course_get_contents 2.2 get course content (modules + No Yes moodle_mobile_app
web service file urls)
Fetch all the content items
core_course core_course_get_course_content_items 3.9 (activities, resources and their Yes Yes
subtypes) for the activity picker
core_course core_course_get_course_module 3.0 Return information about a No Yes moodle_mobile_app
course module.
Return information about a
core_course core_course_get_course_module_by_instance 3.0 given module name and No Yes moodle_mobile_app
instance id.
core_course core_course_get_courses 2.0 Return course details Yes Yes moodle_mobile_app
Get courses matching a specific
core_course core_course_get_courses_by_field 3.2 field (id/s, shortname, No Yes moodle_mobile_app
idnumber, category)
List of enrolled courses for the
core_course core_course_get_enrolled_courses_by_timeline_classification 3.6 given timeline classification Yes Yes moodle_mobile_app
(past, inprogress, or future).
core_course core_course_get_enrolled_users_by_cmid 3.8 List users by course module id Yes Yes
& filter by group id.
core_course core_course_get_module 3.3 Returns html with one activity Yes Yes
module on course page
core_course core_course_get_recent_courses 3.6 List of courses a user has Yes Yes moodle_mobile_app
accessed most recently.
Check if there are updates
core_course core_course_get_updates_since 3.3 affecting the user for the given Yes Yes moodle_mobile_app
course since the given time
stamp.
Return a list of administration
core_course core_course_get_user_administration_options 3.2 options in a set of courses that No Yes moodle_mobile_app
are avaialable or not for the
current user.
Return a list of navigation
core_course core_course_get_user_navigation_options 3.2 options in a set of courses that No Yes moodle_mobile_app
are avaialable or not for the
current user.
Import course data from a
core_course core_course_import_course 2.4 course into another course. No Yes
Does not include any user data.
Removes a content item
core_course core_course_remove_content_item_from_user_favourites 3.9 (activity, resource or their Yes Yes
subtypes) from the favourites
for the user.
core_course core_course_search_courses 3.0 Search courses by (name, Yes Yes moodle_mobile_app
module, block, tag).
core_course core_course_set_favourite_courses 3.6 Add a list of courses to the list Yes Yes moodle_mobile_app
of favourite courses.
Adds or removes an activity as
core_course core_course_toggle_activity_recommendation 3.9 a recommendation in the Yes Yes
activity chooser.
core_course core_course_update_categories 2.3 update categories No Yes
core_course core_course_update_courses 2.5 Update courses. No Yes
https://docs.moodle.org/dev/Web_service_API_functions 5/17
28/06/2024, 21:33 Web service API functions - MoodleDocs

Area Name Introduced Description Available Login Services

in AJAX required
core_course core_course_view_course 2.9 Log that the course was viewed No Yes moodle_mobile_app
core_customfield core_customfield_create_category 3.7 Creates a new category Yes Yes
core_customfield core_customfield_delete_category 3.7 Deletes a category Yes Yes
core_customfield core_customfield_delete_field 3.7 Deletes an entry Yes Yes
core_customfield core_customfield_move_category 3.7 Drag and drop categories Yes Yes
core_customfield core_customfield_move_field 3.7 Drag and drop Yes Yes
core_customfield core_customfield_reload_template 3.7 Reloads template Yes Yes
core_enrol core_enrol_edit_user_enrolment 3.4 External function that updates a Yes Yes
given user enrolment
core_enrol core_enrol_get_course_enrolment_methods 3.0 Get the list of course enrolment No Yes moodle_mobile_app
methods
core_enrol core_enrol_get_enrolled_users 2.1 Get enrolled users by course id No Yes moodle_mobile_app
For each course and capability
core_enrol core_enrol_get_enrolled_users_with_capability 2.4 specified, return a list of the No Yes
users that are enrolled in the
course and have that capability
core_enrol core_enrol_get_potential_users 3.4 Get the list of potential users to Yes Yes
enrol
get list of course ids that a user
core_enrol core_enrol_get_users_courses 2.0 is enrolled in (if you are allowed No Yes moodle_mobile_app
to see that)
core_enrol core_enrol_search_users 3.8 Search within the list of course Yes Yes moodle_mobile_app
participants
core_enrol core_enrol_submit_user_enrolment_form 3.7 Submit form data for enrolment Yes Yes
form
core_enrol core_enrol_unenrol_user_enrolment 3.4 External function that unenrols Yes Yes
a given user enrolment
core_fetch core_fetch_notifications 3.1 Return a list of notifications for Yes No
the current session
core_files core_files_get_files 2.0 browse moodle files No Yes moodle_mobile_app
core_files core_files_upload 2.2 upload a file to moodle No Yes
Delete the indicated files (or
core_files\delete\draft core_files_delete_draft_files 3.10 directories) from a user draft No No moodle_mobile_app
file area.
core_files\get\unused_draft core_files_get_unused_draft_itemid 3.11 Generate a new draft itemid for No No moodle_mobile_app
the current user.
core_filters core_filters_get_available_in_context 3.4 Returns the filters available in No Yes moodle_mobile_app
the given contexts.
core_form core_form_get_filetypes_browser_data 3.4 Provides data for the filetypes Yes No
element browser.
core_form\dynamic_form core_form_dynamic_form 3.11 Process submission of a Yes Yes
dynamic (modal) form
Return all raw strings (with {$a-
core_get core_get_component_strings 2.4 >xxx}) for a specific component Yes No moodle_mobile_app
- similar to core
get_component_strings() call
core_get core_get_fragment 3.1 Return a fragment for inclusion, Yes Yes
such as a JavaScript page.
core_get core_get_string 2.4 Return a translated string - Yes No
similar to core get_string() call
Return some translated strings
core_get core_get_strings 2.4 - like several core get_string() Yes No
calls
core_get core_get_user_dates 3.3 Return formatted timestamps Yes Yes
core_grade core_grade_update_grades 2.7 Update a grade item and No Yes
associated student grades.
core_grades core_grades_create_gradecategory 3.10 Create a grade category inside No No
a course gradebook.
Returns student course total
grade and grades for activities.
This function does not return
core_grades core_grades_get_grades 2.7 category or manual items. This No Yes
function is suitable for
managers or teachers not
students.
Fetch the data required to
display the grader grading
core_grades core_grades_grader_gradingpanel_point_fetch 3.8 panel for simple grading, Yes Yes moodle_mobile_app
creating the grade item if
required
Store the data required to
core_grades core_grades_grader_gradingpanel_point_store 3.8 display the grader grading Yes Yes moodle_mobile_app
panel for simple grading
Fetch the data required to
display the grader grading
core_grades core_grades_grader_gradingpanel_scale_fetch 3.8 panel for scale-based grading, Yes Yes moodle_mobile_app
creating the grade item if
required
Store the data required to
core_grades core_grades_grader_gradingpanel_scale_store 3.8 display the grader grading Yes Yes moodle_mobile_app
panel for scale-based grading
core_grades\create_gradecategories core_grades_create_gradecategories 3.11 Create grade categories inside No No
a course gradebook.

https://docs.moodle.org/dev/Web_service_API_functions 6/17
28/06/2024, 21:33 Web service API functions - MoodleDocs

Area Name Introduced Description Available Login Services

in AJAX required
Returns grading definitions for
the course module ids and
areaname provided as
core_grading core_grading_get_definitions 2.6 parameters. An optionall No Yes
activeonly parameter can be
provided so that only the active
grading method is returned.
Returns the instances and
fillings for the requested
definition id. An optional since
core_grading core_grading_get_gradingform_instances 2.6 parameter allows the number of No Yes
records returned to be reduced
so that only those with a
timemodified value >= since are
returned
Accepts an array of areas as a
core_grading core_grading_save_definitions 2.8 parameter. The areas contain No Yes
grading definitions with criteria
for inserting and updating
core_group core_group_add_group_members 2.0 Adds group members No Yes
core_group core_group_assign_grouping 2.3 assign groups from groupings No Yes
core_group core_group_create_groupings 2.3 create groupings No Yes
core_group core_group_create_groups 2.0 Creates new groups No Yes
core_group core_group_delete_group_members 2.0 Deletes group members No Yes
core_group core_group_delete_groupings 2.3 delete groupings No Yes
core_group core_group_delete_groups 2.0 Deletes all specified groups No Yes
Gets a list of groups that the
core_group core_group_get_activity_allowed_groups 3.0 user is allowed to access within No Yes moodle_mobile_app
the specified activity.
core_group core_group_get_activity_groupmode 3.0 Returns effective groupmode No Yes moodle_mobile_app
used in a given activity.
core_group core_group_get_course_groupings 2.3 get all groupings in specified No Yes moodle_mobile_app
course
core_group core_group_get_course_groups 2.0 Returns all groups in specified Yes Yes moodle_mobile_app
course
core_group core_group_get_course_user_groups 2.9 Returns all groups in specified No Yes moodle_mobile_app
course for the specified user.
core_group core_group_get_group_members 2.0 Returns group members No Yes
core_group core_group_get_groupings 2.3 get groupings No Yes
core_group core_group_get_groups 2.0 Returns group details. No Yes
core_group core_group_unassign_grouping 2.3 unassign groups from No Yes
groupings
core_group core_group_update_groupings 2.3 update groupings No Yes
core_group core_group_update_groups 3.6 Updates existing groups. No Yes
core_h5p core_h5p_get_trusted_h5p_file 3.8 Get the H5P file cleaned for Yes Yes moodle_mobile_app
Mobile App.
core_message core_message_block_contacts 2.5 Block contacts Yes Yes moodle_mobile_app
core_message core_message_block_user 3.6 Blocks a user Yes Yes moodle_mobile_app
core_message core_message_confirm_contact_request 3.6 Confirms a contact request Yes Yes moodle_mobile_app
core_message core_message_create_contact_request 3.6 Creates a contact request Yes Yes moodle_mobile_app
core_message core_message_create_contacts 2.5 Add contacts to the contact list Yes Yes moodle_mobile_app
core_message core_message_data_for_messagearea_contacts 3.2 Retrieve the template data for Yes Yes moodle_mobile_app
the contact list
core_message core_message_data_for_messagearea_conversations 3.2 Retrieve the template data for Yes Yes moodle_mobile_app
the conversation list
core_message core_message_data_for_messagearea_get_most_recent_message 3.2 Retrieve the template data for Yes Yes
the most recent message
core_message core_message_data_for_messagearea_get_profile 3.2 Retrieve the template data for Yes Yes
the users\'s profile
core_message core_message_data_for_messagearea_messages 3.2 Retrieve the template data for Yes Yes moodle_mobile_app
the messages
core_message core_message_data_for_messagearea_search_messages 3.2 Retrieve the template data for Yes Yes moodle_mobile_app
searching for messages
core_message core_message_data_for_messagearea_search_users 3.2 Retrieve the template data for Yes Yes
searching for people
core_message core_message_data_for_messagearea_search_users_in_course 3.2 Retrieve the template data for Yes Yes
searching for people in a course
core_message core_message_decline_contact_request 3.6 Declines a contact request Yes Yes moodle_mobile_app
core_message core_message_delete_contacts 2.5 Remove contacts from the Yes Yes moodle_mobile_app
contact list
core_message core_message_delete_conversation 3.2 Deletes a conversation. Yes Yes moodle_mobile_app
core_message core_message_delete_conversations_by_id 3.6 Deletes a list of conversations. Yes Yes moodle_mobile_app
core_message core_message_delete_message 3.1 Deletes a message. Yes Yes moodle_mobile_app
core_message core_message_delete_message_for_all_users 3.7 Deletes a message for all users. Yes Yes moodle_mobile_app
core_message core_message_get_blocked_users 2.9 Retrieve a list of users blocked No Yes moodle_mobile_app
core_message core_message_get_contact_requests 3.6 Returns contact requests for a Yes Yes moodle_mobile_app
user
core_message core_message_get_contacts 2.5 Retrieve the contact list No Yes moodle_mobile_app
core_message core_message_get_conversation 3.6 Retrieve a conversation for a Yes Yes moodle_mobile_app
user
core_message core_message_get_conversation_between_users 3.6 Retrieve a conversation for a Yes Yes moodle_mobile_app
user between another user
https://docs.moodle.org/dev/Web_service_API_functions 7/17
28/06/2024, 21:33 Web service API functions - MoodleDocs

Area Name Introduced Description Available Login Services

in AJAX required
core_message core_message_get_conversation_counts 3.6 Retrieve a list of conversation Yes Yes moodle_mobile_app
counts, indexed by type.
core_message core_message_get_conversation_members 3.6 Retrieve a list of members in a Yes Yes moodle_mobile_app
conversation
Retrieve the conversation
core_message core_message_get_conversation_messages 3.6 messages and relevant member Yes Yes moodle_mobile_app
information
core_message core_message_get_conversations 3.6 Retrieve a list of conversations Yes Yes moodle_mobile_app
for a user
core_message core_message_get_member_info 3.6 Retrieve a user message Yes Yes moodle_mobile_app
profiles
core_message core_message_get_message_processor 3.2 Get a message processor Yes Yes
Retrieve a list of messages sent
core_message core_message_get_messages 2.8 and received by a user Yes Yes moodle_mobile_app
(conversations, notifications or
both)
core_message core_message_get_received_contact_requests_count 3.6 Gets the number of received Yes Yes moodle_mobile_app
contact requests
core_message core_message_get_self_conversation 3.7 Retrieve a self-conversation for Yes Yes moodle_mobile_app
a user
core_message core_message_get_unread_conversations_count 3.2 Retrieve the count of unread Yes Yes moodle_mobile_app
conversations for a given user
core_message core_message_get_user_contacts 3.6 Retrieve the contact list Yes Yes moodle_mobile_app
core_message core_message_get_user_message_preferences 3.2 Get the message preferences Yes Yes moodle_mobile_app
for a given user.
core_message core_message_get_user_notification_preferences 3.2 Get the notification preferences No Yes moodle_mobile_app
for a given user.
core_message core_message_mark_all_conversation_messages_as_read 3.6 Mark all conversation messages Yes Yes moodle_mobile_app
as read for a given user
core_message core_message_mark_all_messages_as_read 3.2 Mark all messages as read for a Yes Yes moodle_mobile_app
given user
core_message core_message_mark_all_notifications_as_read 3.2 Mark all notifications as read for Yes Yes moodle_mobile_app
a given user
core_message core_message_mark_message_read 2.9 Mark a single message as read, Yes Yes moodle_mobile_app
trigger message_viewed event.
Mark a single notification as
core_message core_message_mark_notification_read 3.5 read, trigger Yes Yes moodle_mobile_app
notification_viewed event.
core_message core_message_message_processor_config_form 3.2 Process the message processor Yes Yes moodle_mobile_app
config form
core_message core_message_message_search_users 3.6 Retrieve the data for searching Yes Yes moodle_mobile_app
for people
core_message core_message_mute_conversations 3.7 Mutes a list of conversations Yes Yes moodle_mobile_app
core_message core_message_search_contacts 2.5 Search for contacts No Yes moodle_mobile_app
core_message core_message_send_instant_messages 2.1 Send instant messages Yes Yes moodle_mobile_app
core_message core_message_send_messages_to_conversation 3.6 Send messages to an existing Yes Yes moodle_mobile_app
conversation between users
Mark a conversation or group of
core_message core_message_set_favourite_conversations 3.6 conversations as Yes Yes moodle_mobile_app
favourites/starred
conversations.
core_message core_message_unblock_contacts 2.5 Unblock contacts Yes Yes moodle_mobile_app
core_message core_message_unblock_user 3.6 Unblocks a user Yes Yes moodle_mobile_app
core_message core_message_unmute_conversations 3.7 Unmutes a list of conversations Yes Yes moodle_mobile_app
Unset a conversation or group
core_message core_message_unset_favourite_conversations 3.6 of conversations as Yes Yes moodle_mobile_app
favourites/starred
conversations.
core_notes core_notes_create_notes 2.1 Create notes Yes Yes moodle_mobile_app
core_notes core_notes_delete_notes 2.5 Delete Notes No Yes moodle_mobile_app
Returns all notes in specified
core_notes core_notes_get_course_notes 2.9 course (or site) for the specified No Yes moodle_mobile_app
user.
core_notes core_notes_get_notes 2.5 Retrieve Notes No Yes
core_notes core_notes_update_notes 2.5 Update Notes No Yes
Simulates the web interface
core_notes core_notes_view_notes 2.9 view of notes/index.php: trigger No Yes moodle_mobile_app
events.
core_output core_output_load_fontawesome_icon_map 3.3 Load the mapping of names to Yes No
icons
core_output core_output_load_template 3.0 Load a template for a Yes No
renderable
Get the list of payment
core_payment\get_available_gateways core_payment_get_available_gateways 3.10 gateways that support the given Yes Yes
component/area
core_question core_question_get_random_question_summaries 3.5 Get the random question set for Yes Yes
a criteria
core_question core_question_submit_tags_form 3.5 Update the question tags. Yes Yes
core_question core_question_update_flag 3.1 Update the flag state of a No Yes moodle_mobile_app
question attempt.
core_rating core_rating_add_rating 3.2 Rates an item. No Yes moodle_mobile_app
core_rating core_rating_get_item_ratings 2.9 Retrieve all the ratings for an No Yes moodle_mobile_app
item.
https://docs.moodle.org/dev/Web_service_API_functions 8/17
28/06/2024, 21:33 Web service API functions - MoodleDocs

Area Name Introduced Description Available Login Services

in AJAX required
core_role core_role_assign_roles 2.0 Manual role assignments No Yes
core_role core_role_unassign_roles 2.0 Manual role unassignments No Yes
core_search core_search_get_relevant_users 3.5 Gets relevant users for a search Yes Yes
request.
core_session core_session_time_remaining 3.8 Count the seconds remaining in Yes Yes
this session
core_session core_session_touch 3.8 Keep the users session alive Yes Yes
core_table\dynamic\get core_table_get_dynamic_table_content 3.9 Get the dynamic table content Yes Yes moodle_mobile_app
raw html
core_tag core_tag_get_tag_areas 3.7 Retrieves existing tag areas. No Yes moodle_mobile_app
Retrieves a tag cloud for the
core_tag core_tag_get_tag_cloud 3.7 given collection and/or query No Yes moodle_mobile_app
search.
core_tag core_tag_get_tag_collections 3.7 Retrieves existing tag No Yes moodle_mobile_app
collections.
core_tag core_tag_get_tagindex 3.1 Gets tag index page for one tag Yes Yes moodle_mobile_app
and one tag area
core_tag core_tag_get_tagindex_per_area 3.7 Gets tag index page per No Yes moodle_mobile_app
different areas.
core_tag core_tag_get_tags 3.0 Gets tags by their ids Yes Yes
core_tag core_tag_update_tags 3.0 Updates tags Yes Yes
core_update core_update_inplace_editable 3.1 Generic service to update title Yes Yes
Store mobile user devices
core_user core_user_add_user_device 2.6 information for PUSH No Yes moodle_mobile_app
Notifications.
core_user core_user_add_user_private_files 2.6 Copy files from a draft area to No Yes moodle_mobile_app
users private files area.
core_user core_user_agree_site_policy 3.2 Agree the site policy for the No Yes moodle_mobile_app
current user.
core_user core_user_create_users 2.0 Create users - admin function No Yes
core_user core_user_delete_users 2.0 Delete users - admin function No Yes
core_user core_user_get_course_user_profiles 2.1 Get course user profiles by id No Yes moodle_mobile_app
Returns general information
core_user core_user_get_private_files_info 3.4 about files in the user private No Yes moodle_mobile_app
files area.
core_user core_user_get_user_preferences 3.2 Return user preferences. Yes Yes moodle_mobile_app
Search users. - If you want to
get multiple users for one
core_user core_user_get_users 2.5 specific field, use No Yes
core_user_get_users_by_field(),
it's designed for this purpose
and it should be faster.
Retrieve users information for a
core_user core_user_get_users_by_field 2.5 specified unique field - If you Yes Yes moodle_mobile_app
want to do a user search, use
core_user_get_users()
core_user core_user_get_users_by_id 2.0 Get users by id No Yes
core_user core_user_remove_user_device 2.9 Remove a user device from the No Yes moodle_mobile_app
Moodle database.
core_user core_user_set_user_preferences 3.2 Set user preferences. Yes Yes moodle_mobile_app
core_user core_user_update_picture 3.2 Update or delete the user No Yes moodle_mobile_app
picture in the site
core_user core_user_update_user_preferences 3.2 Update a user\'s preferences Yes Yes moodle_mobile_app
core_user core_user_update_users 2.0 Update users Yes Yes
Simulates the web-interface
core_user core_user_view_user_list 2.9 view of user/index.php No Yes moodle_mobile_app
(triggering events).
Simulates the web-interface
core_user core_user_view_user_profile 2.9 view of user/view.php and No Yes moodle_mobile_app
user/profile.php (triggering
events).
core_webservice core_webservice_get_site_info 2.1 Return some site info / user info No Yes moodle_mobile_app
/ list web service functions
core_xapi\post_statement core_xapi_statement_post 3.9 Post an xAPI statement. Yes Yes moodle_mobile_app
enrol_guest enrol_guest_get_instance_info 3.1 Return guest enrolment No Yes moodle_mobile_app
instance information.
enrol_manual enrol_manual_enrol_users 2.0 Manual enrol users No Yes
enrol_manual enrol_manual_unenrol_users 3.0 Manual unenrol users No Yes
enrol_self enrol_self_enrol_user 3.0 Self enrol the current user in the No Yes moodle_mobile_app
given course.
enrol_self enrol_self_get_instance_info 3.0 self enrolment instance No Yes moodle_mobile_app
information.
gradereport_overview gradereport_overview_get_course_grades 3.2 Get the given user courses final No Yes moodle_mobile_app
grades
gradereport_overview gradereport_overview_view_grade_report 3.2 Trigger the report view event No Yes moodle_mobile_app
Returns the complete list of
gradereport_user gradereport_user_get_grade_items 3.2 grade items for users in a No Yes moodle_mobile_app
course
gradereport_user gradereport_user_get_grades_table 2.9 Get the user/s report grades No Yes moodle_mobile_app
table for a course

https://docs.moodle.org/dev/Web_service_API_functions 9/17
28/06/2024, 21:33 Web service API functions - MoodleDocs

Area Name Introduced Description Available Login Services

in AJAX required
Trigger the
grade_report_viewed event
when a user view his grade
gradereport_user gradereport_user_view_grade_report 2.9 report (this web service will be No Yes moodle_mobile_app
initially used by the mobile app
so information can be logged in
the Moodle side when a user
see the same page in the app).
Fetch the data required to
gradingform_guide gradingform_guide_grader_gradingpanel_fetch 3.8 display the grader grading Yes Yes
panel, creating the grade item if
required
Store the grading data for a
gradingform_guide gradingform_guide_grader_gradingpanel_store 3.8 user from the grader grading Yes Yes
panel.
Fetch the data required to
gradingform_rubric gradingform_rubric_grader_gradingpanel_fetch 3.8 display the grader grading Yes Yes
panel, creating the grade item if
required
Store the grading data for a
gradingform_rubric gradingform_rubric_grader_gradingpanel_store 3.8 user from the grader grading Yes Yes
panel.
local_mobile local_mobile_get_plugin_settings 3.4 Retrieve the plugin settings. No Yes
Check if the users have
message_airnotifier message_airnotifier_are_notification_preferences_configured 2.7 notification preferences No Yes moodle_mobile_app
configured yet
Enables or disables a registered
message_airnotifier message_airnotifier_enable_device 3.2 user device so it can receive No Yes moodle_mobile_app
Push notifications
Return the list of mobile devices
message_airnotifier message_airnotifier_get_user_devices 3.2 that are registered in Moodle for No Yes moodle_mobile_app
the given user
message_airnotifier message_airnotifier_is_system_configured 2.7 Check whether the airnotifier No Yes moodle_mobile_app
settings have been configured
message_popup message_popup_get_popup_notifications 3.2 Retrieve a list of popup Yes Yes moodle_mobile_app
notifications for a user
Retrieve the count of unread
message_popup message_popup_get_unread_popup_notification_count 3.2 popup notifications for a given Yes Yes moodle_mobile_app
user
mod_assign mod_assign_copy_previous_attempt 2.6 Copy a students previous No Yes
attempt to a new attempt.
Returns the courses and
mod_assign mod_assign_get_assignments 2.4 assignments for the users No Yes moodle_mobile_app
capability
mod_assign mod_assign_get_grades 2.4 Returns grades from the No Yes moodle_mobile_app
assignment
Get a participant for an
mod_assign mod_assign_get_participant 3.1 assignment, with some Yes Yes moodle_mobile_app
summary info about their
submissions.
Returns information about an
mod_assign mod_assign_get_submission_status 3.1 assignment submission status No Yes moodle_mobile_app
for a given user.
mod_assign mod_assign_get_submissions 2.5 Returns the submissions for No Yes moodle_mobile_app
assignments
mod_assign mod_assign_get_user_flags 2.6 Returns the user_flags for No Yes moodle_mobile_app
assignments
mod_assign mod_assign_get_user_mappings 2.6 Returns the user_mappings for No Yes moodle_mobile_app
assignments
List the participants for a single
mod_assign mod_assign_list_participants 3.1 assignment, with some Yes Yes moodle_mobile_app
summary info about their
submissions.
mod_assign mod_assign_lock_submissions 2.6 Prevent students from making No Yes moodle_mobile_app
changes to a list of submissions
mod_assign mod_assign_reveal_identities 2.6 Reveal the identities for a blind No Yes moodle_mobile_app
marking assignment
mod_assign mod_assign_revert_submissions_to_draft 2.6 Reverts the list of submissions No Yes moodle_mobile_app
to draft status
mod_assign mod_assign_save_grade 2.6 Save a grade update for a single No Yes moodle_mobile_app
student.
mod_assign mod_assign_save_grades 2.7 Save grade updates for one or No Yes moodle_mobile_app
more students.
mod_assign mod_assign_save_submission 2.6 Update the current students No Yes moodle_mobile_app
submission
mod_assign mod_assign_save_user_extensions 2.6 Save a list of assignment No Yes moodle_mobile_app
extensions
mod_assign mod_assign_set_user_flags 2.6 Sets the specified user_flags No Yes moodle_mobile_app
for an assignment
mod_assign mod_assign_submit_for_grading 2.6 Submit the current students No Yes moodle_mobile_app
assignment for grading
mod_assign mod_assign_submit_grading_form 3.1 Submit the grading form data Yes Yes moodle_mobile_app
via ajax
mod_assign mod_assign_unlock_submissions 2.6 Allow students to make changes No Yes moodle_mobile_app
to a list of submissions

https://docs.moodle.org/dev/Web_service_API_functions 10/17
28/06/2024, 21:33 Web service API functions - MoodleDocs

Area Name Introduced Description Available Login Services

in AJAX required
mod_assign mod_assign_view_assign 3.2 Update the module completion No Yes moodle_mobile_app
status.
mod_assign mod_assign_view_grading_table 3.0 Trigger the No Yes moodle_mobile_app
grading_table_viewed event.
mod_assign mod_assign_view_submission_status 3.1 Trigger the submission status No Yes moodle_mobile_app
viewed event.
mod_book mod_book_get_books_by_courses 3.0 Returns a list of book instances No Yes moodle_mobile_app
in a provided set of courses.
Trigger the course module
mod_book mod_book_view_book 3.0 viewed event and update the No Yes moodle_mobile_app
module completion status.
mod_chat mod_chat_get_chat_latest_messages 3.0 Get the latest messages from No Yes moodle_mobile_app
the given chat sessio.
mod_chat mod_chat_get_chat_users 3.0 Get the list of users in the given No Yes moodle_mobile_app
chat session.
mod_chat mod_chat_get_chats_by_courses 3.0 Returns a list of chat instances No Yes moodle_mobile_app
in a provided set of courses.
mod_chat mod_chat_get_session_messages 3.5 Retrieves messages of the No Yes moodle_mobile_app
given chat session.
mod_chat mod_chat_get_sessions 3.5 Retrieves chat sessions for a No Yes moodle_mobile_app
given chat.
mod_chat mod_chat_login_user 3.0 Log a user into a chat room in No Yes moodle_mobile_app
the given chat.
mod_chat mod_chat_send_chat_message 3.0 Send a message on the given No Yes moodle_mobile_app
chat session.
Trigger the course module
mod_chat mod_chat_view_chat 3.0 viewed event and update the No Yes moodle_mobile_app
module completion status.
mod_choice mod_choice_delete_choice_responses 3.0 Delete the given submitted No Yes moodle_mobile_app
responses in a choice.
mod_choice mod_choice_get_choice_options 3.0 Retrieve options for a specific No Yes moodle_mobile_app
choice.
mod_choice mod_choice_get_choice_results 3.0 Retrieve users results for a No Yes moodle_mobile_app
given choice.
Returns a list of choice
mod_choice mod_choice_get_choices_by_courses 3.0 instances in a provided set of No Yes moodle_mobile_app
courses.
mod_choice mod_choice_submit_choice_response 3.0 Submit responses to a specific No Yes moodle_mobile_app
choice item.
Trigger the course module
mod_choice mod_choice_view_choice 3.0 viewed event and update the No Yes moodle_mobile_app
module completion status..
mod_data mod_data_add_entry 3.3 Adds a new entry. No Yes moodle_mobile_app
mod_data mod_data_approve_entry 3.3 Approves or unapproves an No Yes moodle_mobile_app
entry.
mod_data mod_data_delete_entry 3.3 Deletes an entry. No Yes moodle_mobile_app
mod_data mod_data_get_data_access_information 3.3 Return access information for a No Yes moodle_mobile_app
given database.
Returns a list of database
instances in a provided set of
mod_data mod_data_get_databases_by_courses 2.9 courses, if no courses are No Yes moodle_mobile_app
provided then all the database
instances the user has access
to will be returned.
mod_data mod_data_get_entries 3.3 Return the complete list of No Yes moodle_mobile_app
entries of the given database.
Return one entry record from
mod_data mod_data_get_entry 3.3 the database, including No Yes moodle_mobile_app
contents optionally.
mod_data mod_data_get_fields 3.3 Return the list of configured No Yes moodle_mobile_app
fields for the given database.
mod_data mod_data_search_entries 3.3 Search for entries in the given No Yes moodle_mobile_app
database.
mod_data mod_data_update_entry 3.3 Updates an existing entry. No Yes moodle_mobile_app
Simulate the view.php web
mod_data mod_data_view_database 3.3 interface data: trigger events, No Yes moodle_mobile_app
completion, etc...
mod_feedback mod_feedback_get_analysis 3.3 Retrieves the feedback analysis. No Yes moodle_mobile_app
Returns the temporary
mod_feedback mod_feedback_get_current_completed_tmp 3.3 completion record for the No Yes moodle_mobile_app
current user.
mod_feedback mod_feedback_get_feedback_access_information 3.3 Return access information for a No Yes moodle_mobile_app
given feedback.
Returns a list of feedbacks in a
provided list of courses, if no
mod_feedback mod_feedback_get_feedbacks_by_courses 3.3 list is provided all feedbacks No Yes moodle_mobile_app
that the user can view will be
returned.
mod_feedback mod_feedback_get_finished_responses 3.3 Retrieves responses from the No Yes moodle_mobile_app
last finished attempt.
mod_feedback mod_feedback_get_items 3.3 Returns the items (questions) in No Yes moodle_mobile_app
the given feedback.
mod_feedback mod_feedback_get_last_completed 3.3 Retrieves the last completion No Yes moodle_mobile_app
record for the current user.

https://docs.moodle.org/dev/Web_service_API_functions 11/17
28/06/2024, 21:33 Web service API functions - MoodleDocs

Area Name Introduced Description Available Login Services

in AJAX required
mod_feedback mod_feedback_get_non_respondents 3.3 Retrieves a list of students who No Yes moodle_mobile_app
didn\'t submit the feedback.
mod_feedback mod_feedback_get_page_items 3.3 Get a single feedback page No Yes moodle_mobile_app
items.
mod_feedback mod_feedback_get_responses_analysis 3.3 Return the feedback user No Yes moodle_mobile_app
responses analysis.
mod_feedback mod_feedback_get_unfinished_responses 3.3 Retrieves responses from the No Yes moodle_mobile_app
current unfinished attempt.
mod_feedback mod_feedback_launch_feedback 3.3 Starts or continues a feedback No Yes moodle_mobile_app
submission.
mod_feedback mod_feedback_process_page 3.3 Process a jump between pages. No Yes moodle_mobile_app
Trigger the course module
mod_feedback mod_feedback_view_feedback 3.3 viewed event and update the No Yes moodle_mobile_app
module completion status.
Returns a list of folders in a
provided list of courses, if no
list is provided all folders that
mod_folder mod_folder_get_folders_by_courses 3.3 the user can view will be No Yes moodle_mobile_app
returned. Please note that this
WS is not returning the folder
contents.
Trigger the course module
mod_folder mod_folder_view_folder 3.0 viewed event and update the No Yes moodle_mobile_app
module completion status.
mod_forum mod_forum_add_discussion 3.0 Add a new discussion into an No Yes moodle_mobile_app
existing forum.
mod_forum mod_forum_add_discussion_post 3.0 Create new posts into an Yes Yes moodle_mobile_app
existing discussion.
Check if the current user can
mod_forum mod_forum_can_add_discussion 3.1 add discussions in the given No Yes moodle_mobile_app
forum (and optionally for the
given group).
Deletes a post or a discussion
mod_forum mod_forum_delete_post 3.8 completely when the post is the No Yes moodle_mobile_app
discussion topic.
mod_forum mod_forum_get_discussion_post 3.8 Get a particular discussion post. No Yes moodle_mobile_app
mod_forum mod_forum_get_discussion_posts 3.7 Returns a list of forum posts for Yes Yes moodle_mobile_app
a discussion.
mod_forum mod_forum_get_discussion_posts_by_userid 3.8 Returns a list of forum posts for Yes Yes
a discussion for a user.
mod_forum mod_forum_get_forum_access_information 3.7 Return capabilities information No Yes moodle_mobile_app
for a given forum.
mod_forum mod_forum_get_forum_discussion_posts 2.7 Returns a list of forum posts for No Yes moodle_mobile_app
a discussion.
Returns a list of forum
mod_forum mod_forum_get_forum_discussions 3.7 discussions optionally sorted No Yes moodle_mobile_app
and paginated.
Returns a list of forum
mod_forum mod_forum_get_forum_discussions_paginated 2.8 discussions optionally sorted No Yes moodle_mobile_app
and paginated.
Returns a list of forum instances
in a provided set of courses, if
mod_forum mod_forum_get_forums_by_courses 2.5 no courses are provided then all No Yes moodle_mobile_app
the forum instances the user
has access to will be returned.
mod_forum mod_forum_prepare_draft_area_for_post 3.8 Prepares a draft area for editing No Yes moodle_mobile_app
a post.
mod_forum mod_forum_set_lock_state 3.7 Set the lock state for the Yes Yes moodle_mobile_app
discussion
mod_forum mod_forum_set_pin_state 3.7 Set the pin state Yes Yes moodle_mobile_app
mod_forum mod_forum_set_subscription_state 3.7 Set the subscription state Yes Yes moodle_mobile_app
mod_forum mod_forum_toggle_favourite_state 3.7 Toggle the favourite state Yes Yes moodle_mobile_app
mod_forum mod_forum_update_discussion_post 3.8 Updates a post or a discussion No Yes moodle_mobile_app
topic post.
Trigger the
course_module_viewed event
when a user view a forum (this
mod_forum mod_forum_view_forum 2.9 web service will be initially used No Yes moodle_mobile_app
by the mobile app so
information can be logged in
the Moodle side when a user
see the same page in the app).
Trigger the discussion_viewed
event when a user view a forum
discussion (this web service will
mod_forum mod_forum_view_forum_discussion 2.9 be initially used by the mobile No Yes moodle_mobile_app
app so information can be
logged in the Moodle side when
a user see the same page in the
app).
mod_glossary mod_glossary_add_entry 3.2 Add a new entry to a given No Yes moodle_mobile_app
glossary
mod_glossary mod_glossary_get_authors 3.1 Get the authors in a glossary No Yes moodle_mobile_app
mod_glossary mod_glossary_get_categories 3.1 Get a glossary's categories No Yes moodle_mobile_app
mod_glossary mod_glossary_get_entries_by_author 3.1 Get entries using author No Yes moodle_mobile_app
filtering
https://docs.moodle.org/dev/Web_service_API_functions 12/17
28/06/2024, 21:33 Web service API functions - MoodleDocs

Area Name Introduced Description Available Login Services

in AJAX required
mod_glossary mod_glossary_get_entries_by_author_id 3.1 Get entries using author ID No Yes moodle_mobile_app
filtering
mod_glossary mod_glossary_get_entries_by_category 3.1 Get entries using category No Yes moodle_mobile_app
filtering
mod_glossary mod_glossary_get_entries_by_date 3.1 Get entries using date filtering No Yes moodle_mobile_app
mod_glossary mod_glossary_get_entries_by_letter 3.1 Get entries using letter filtering No Yes moodle_mobile_app
mod_glossary mod_glossary_get_entries_by_search 3.1 Get entries matching a search No Yes moodle_mobile_app
query
mod_glossary mod_glossary_get_entries_by_term 3.1 Get entries using term filtering No Yes moodle_mobile_app
mod_glossary mod_glossary_get_entries_to_approve 3.1 Get entries to be approved No Yes moodle_mobile_app
mod_glossary mod_glossary_get_entry_by_id 3.1 Get an entry by ID No Yes moodle_mobile_app
mod_glossary mod_glossary_get_glossaries_by_courses 3.1 Get the glossaries in courses No Yes moodle_mobile_app
mod_glossary mod_glossary_view_entry 3.1 Notify that a glossary entry was No Yes moodle_mobile_app
viewed
mod_glossary mod_glossary_view_glossary 3.1 Notify that a glossary was No Yes moodle_mobile_app
viewed
Returns a list of imscp
mod_imscp mod_imscp_get_imscps_by_courses 3.0 instances in a provided set of No Yes moodle_mobile_app
courses.
Trigger the course module
mod_imscp mod_imscp_view_imscp 3.0 viewed event and update the No Yes moodle_mobile_app
module completion status.
Returns a list of labels in a
mod_label mod_label_get_labels_by_courses 3.3 provided list of courses, if no No Yes moodle_mobile_app
list is provided all labels that the
user can view will be returned.
mod_lesson mod_lesson_finish_attempt 3.3 Finishes the current attempt. No Yes moodle_mobile_app
mod_lesson mod_lesson_get_attempts_overview 3.3 Get a list of all the attempts No Yes moodle_mobile_app
made by users in a lesson.
Return the list of content pages
mod_lesson mod_lesson_get_content_pages_viewed 3.3 viewed by a user during a No Yes moodle_mobile_app
lesson attempt.
mod_lesson mod_lesson_get_lesson 3.3 Return information of a given No Yes moodle_mobile_app
lesson.
mod_lesson mod_lesson_get_lesson_access_information 3.3 Return access information for a No Yes moodle_mobile_app
given lesson.
Returns a list of lessons in a
provided list of courses, if no
mod_lesson mod_lesson_get_lessons_by_courses 3.3 list is provided all lessons that No Yes moodle_mobile_app
the user can view will be
returned.
mod_lesson mod_lesson_get_page_data 3.3 Return information of a given No Yes moodle_mobile_app
page, including its contents.
Return the list of pages in a
mod_lesson mod_lesson_get_pages 3.3 lesson (based on the user No Yes moodle_mobile_app
permissions).
mod_lesson mod_lesson_get_pages_possible_jumps 3.3 Return all the possible jumps for No Yes moodle_mobile_app
the pages in a given lesson.
mod_lesson mod_lesson_get_questions_attempts 3.3 Return the list of questions No Yes moodle_mobile_app
attempts in a given lesson.
Return information about the
mod_lesson mod_lesson_get_user_attempt 3.3 given user attempt (including No Yes moodle_mobile_app
answers).
mod_lesson mod_lesson_get_user_attempt_grade 3.3 Return grade information in the No Yes moodle_mobile_app
attempt for a given user.
mod_lesson mod_lesson_get_user_grade 3.3 Return the final grade in the No Yes moodle_mobile_app
lesson for the given user.
mod_lesson mod_lesson_get_user_timers 3.3 Return the timers in the current No Yes moodle_mobile_app
lesson for the given user.
mod_lesson mod_lesson_launch_attempt 3.3 Starts a new attempt or No Yes moodle_mobile_app
continues an existing one.
mod_lesson mod_lesson_process_page 3.3 Processes page responses. No Yes moodle_mobile_app
Trigger the course module
mod_lesson mod_lesson_view_lesson 3.3 viewed event and update the No Yes moodle_mobile_app
module completion status.
mod_lti mod_lti_create_tool_proxy 3.1 Create a tool proxy Yes Yes
mod_lti mod_lti_create_tool_type 3.1 Create a tool type Yes Yes
mod_lti mod_lti_delete_tool_proxy 3.1 Delete a tool proxy Yes Yes
mod_lti mod_lti_delete_tool_type 3.1 Delete a tool type Yes Yes
mod_lti mod_lti_get_ltis_by_courses 3.0 Returns a list of lti instances in No Yes moodle_mobile_app
a provided set of courses.
mod_lti mod_lti_get_tool_launch_data 3.0 Return the launch data for a No Yes moodle_mobile_app
given external tool.
mod_lti mod_lti_get_tool_proxies 3.1 Get a list of the tool proxies Yes Yes
mod_lti mod_lti_get_tool_proxy_registration_request 3.1 Get a registration request for a Yes Yes
tool proxy
mod_lti mod_lti_get_tool_types 3.1 Get a list of the tool types Yes Yes
mod_lti mod_lti_is_cartridge 3.1 Determine if the given url is for Yes Yes
a cartridge
mod_lti mod_lti_update_tool_type 3.1 Update a tool type Yes Yes
Trigger the course module
mod_lti mod_lti_view_lti 3.0 viewed event and update the No Yes moodle_mobile_app
module completion status.
https://docs.moodle.org/dev/Web_service_API_functions 13/17
28/06/2024, 21:33 Web service API functions - MoodleDocs

Area Name Introduced Description Available Login Services

in AJAX required
Returns a list of pages in a
provided list of courses, if no
mod_page mod_page_get_pages_by_courses 3.3 list is provided all pages that No Yes moodle_mobile_app
the user can view will be
returned.
Trigger the course module
mod_page mod_page_view_page 3.0 viewed event and update the No Yes moodle_mobile_app
module completion status.
mod_quiz mod_quiz_get_attempt_access_information 3.1 Return access information for a No Yes moodle_mobile_app
given attempt in a quiz.
Returns information for the
mod_quiz mod_quiz_get_attempt_data 3.1 given attempt page for a quiz No Yes moodle_mobile_app
attempt in progress.
Returns review information for
mod_quiz mod_quiz_get_attempt_review 3.1 the given finished attempt, can No Yes moodle_mobile_app
be used by users or teachers.
mod_quiz mod_quiz_get_attempt_summary 3.1 Returns a summary of a quiz No Yes moodle_mobile_app
attempt before it is submitted.
Combines the review options
mod_quiz mod_quiz_get_combined_review_options 3.1 from a number of different quiz No Yes moodle_mobile_app
attempts.
mod_quiz mod_quiz_get_quiz_access_information 3.1 Return access information for a No Yes moodle_mobile_app
given quiz.
Get the feedback text that
mod_quiz mod_quiz_get_quiz_feedback_for_grade 3.1 should be show to a student No Yes moodle_mobile_app
who got the given grade in the
given quiz.
Return the potential question
mod_quiz mod_quiz_get_quiz_required_qtypes 3.1 types that would be required for No Yes moodle_mobile_app
a given quiz.
Returns a list of quizzes in a
provided list of courses, if no
mod_quiz mod_quiz_get_quizzes_by_courses 3.1 list is provided all quizzes that No Yes moodle_mobile_app
the user can view will be
returned.
mod_quiz mod_quiz_get_user_attempts 3.1 Return a list of attempts for the No Yes moodle_mobile_app
given quiz and user.
mod_quiz mod_quiz_get_user_best_grade 3.1 Get the best current grade for No Yes moodle_mobile_app
the given user on a quiz.
Process responses during an
mod_quiz mod_quiz_process_attempt 3.1 attempt at a quiz and also deals No Yes moodle_mobile_app
with attempts finishing.
Processes save requests during
mod_quiz mod_quiz_save_attempt 3.1 the quiz.This function is No Yes moodle_mobile_app
intended for the quiz auto-save
feature.
mod_quiz mod_quiz_start_attempt 3.1 Starts a new attempt at a quiz. No Yes moodle_mobile_app
mod_quiz mod_quiz_view_attempt 3.1 Trigger the attempt viewed No Yes moodle_mobile_app
event.
mod_quiz mod_quiz_view_attempt_review 3.1 Trigger the attempt reviewed No Yes moodle_mobile_app
event.
mod_quiz mod_quiz_view_attempt_summary 3.1 Trigger the attempt summary No Yes moodle_mobile_app
viewed event.
Trigger the course module
mod_quiz mod_quiz_view_quiz 3.1 viewed event and update the No Yes moodle_mobile_app
module completion status.
Returns a list of files in a
mod_resource mod_resource_get_resources_by_courses 3.3 provided list of courses, if no No Yes moodle_mobile_app
list is provided all files that the
user can view will be returned.
Trigger the course module
mod_resource mod_resource_view_resource 3.0 viewed event and update the No Yes moodle_mobile_app
module completion status.
mod_scorm mod_scorm_get_scorm_access_information 3.7 Return capabilities information No Yes moodle_mobile_app
for a given scorm.
Return the number of attempts
mod_scorm mod_scorm_get_scorm_attempt_count 3.0 done by a user in the given No Yes moodle_mobile_app
SCORM.
Retrieves SCO tracking data for
mod_scorm mod_scorm_get_scorm_sco_tracks 3.0 the given user id and attempt No Yes moodle_mobile_app
number.
Returns a list containing all the
mod_scorm mod_scorm_get_scorm_scoes 3.0 scoes data related to the given No Yes moodle_mobile_app
scorm id.
Retrieves user tracking and
mod_scorm mod_scorm_get_scorm_user_data 3.0 SCO data and default SCORM No Yes moodle_mobile_app
values.
Returns a list of scorm
mod_scorm mod_scorm_get_scorms_by_courses 3.0 instances in a provided set of No Yes moodle_mobile_app
courses.
mod_scorm mod_scorm_insert_scorm_tracks 3.0 Saves a scorm tracking record. No Yes moodle_mobile_app
mod_scorm mod_scorm_launch_sco 3.1 Trigger the SCO launched No Yes moodle_mobile_app
event.
Trigger the course module
mod_scorm mod_scorm_view_scorm 3.0 viewed event and update the No Yes moodle_mobile_app
module completion status..

https://docs.moodle.org/dev/Web_service_API_functions 14/17
28/06/2024, 21:33 Web service API functions - MoodleDocs

Area Name Introduced Description Available Login Services

in AJAX required
Get the complete list of
mod_survey mod_survey_get_questions 3.0 questions for the survey, No Yes moodle_mobile_app
including subquestions.
Returns a list of survey
instances in a provided set of
mod_survey mod_survey_get_surveys_by_courses 3.0 courses, if no courses are No Yes moodle_mobile_app
provided then all the survey
instances the user has access
to will be returned.
mod_survey mod_survey_submit_answers 3.0 Submit the answers for a given No Yes moodle_mobile_app
survey.
Trigger the course module
mod_survey mod_survey_view_survey 3.0 viewed event and update the No Yes moodle_mobile_app
module completion status.
Returns a list of urls in a
mod_url mod_url_get_urls_by_courses 3.3 provided list of courses, if no No Yes moodle_mobile_app
list is provided all urls that the
user can view will be returned.
Trigger the course module
mod_url mod_url_view_url 3.0 viewed event and update the No Yes moodle_mobile_app
module completion status.
mod_wiki mod_wiki_edit_page 3.1 Save the contents of a page. No Yes moodle_mobile_app
mod_wiki mod_wiki_get_page_contents 3.1 Returns the contents of a page. No Yes moodle_mobile_app
mod_wiki mod_wiki_get_page_for_editing 3.1 Locks and retrieves info of No Yes moodle_mobile_app
page-section to be edited.
mod_wiki mod_wiki_get_subwiki_files 3.1 Returns the list of files for a No Yes moodle_mobile_app
specific subwiki.
mod_wiki mod_wiki_get_subwiki_pages 3.1 Returns the list of pages for a No Yes moodle_mobile_app
specific subwiki.
mod_wiki mod_wiki_get_subwikis 3.1 Returns the list of subwikis the No Yes moodle_mobile_app
user can see in a specific wiki.
Returns a list of wiki instances
in a provided set of courses, if
mod_wiki mod_wiki_get_wikis_by_courses 3.1 no courses are provided then all No Yes moodle_mobile_app
the wiki instances the user has
access to will be returned.
mod_wiki mod_wiki_new_page 3.1 Create a new page in a subwiki. No Yes moodle_mobile_app
Trigger the page viewed event
mod_wiki mod_wiki_view_page 3.1 and update the module No Yes moodle_mobile_app
completion status.
Trigger the course module
mod_wiki mod_wiki_view_wiki 3.1 viewed event and update the No Yes moodle_mobile_app
module completion status.
mod_workshop mod_workshop_add_submission 3.4 Add a new submission to a No Yes moodle_mobile_app
given workshop.
mod_workshop mod_workshop_delete_submission 3.4 Deletes the given submission. No Yes moodle_mobile_app
Evaluates an assessment (used
mod_workshop mod_workshop_evaluate_assessment 3.4 by teachers for provide No Yes moodle_mobile_app
feedback to the reviewer).
Evaluates a submission (used
mod_workshop mod_workshop_evaluate_submission 3.4 by teachers for provide No Yes moodle_mobile_app
feedback or override the
submission grade).
mod_workshop mod_workshop_get_assessment 3.4 Retrieves the given assessment. No Yes moodle_mobile_app
mod_workshop mod_workshop_get_assessment_form_definition 3.4 Retrieves the assessment form No Yes moodle_mobile_app
definition.
Returns the assessment and
mod_workshop mod_workshop_get_grades 3.4 submission grade for the given No Yes moodle_mobile_app
user.
mod_workshop mod_workshop_get_grades_report 3.4 Retrieves the assessment No Yes moodle_mobile_app
grades report.
mod_workshop mod_workshop_get_reviewer_assessments 3.4 Retrieves all the assessments No Yes moodle_mobile_app
reviewed by the given user.
mod_workshop mod_workshop_get_submission 3.4 Retrieves the given submission. No Yes moodle_mobile_app
mod_workshop mod_workshop_get_submission_assessments 3.4 Retrieves all the assessments of No Yes moodle_mobile_app
the given submission.
Retrieves all the workshop
mod_workshop mod_workshop_get_submissions 3.4 submissions or the one done by No Yes moodle_mobile_app
the given user (except example
submissions).
mod_workshop mod_workshop_get_user_plan 3.4 Return the planner information No Yes moodle_mobile_app
for the given user.
mod_workshop mod_workshop_get_workshop_access_information 3.4 Return access information for a No Yes moodle_mobile_app
given workshop.
Returns a list of workshops in a
provided list of courses, if no
mod_workshop mod_workshop_get_workshops_by_courses 3.4 list is provided all workshops No Yes moodle_mobile_app
that the user can view will be
returned.
mod_workshop mod_workshop_update_assessment 3.4 Add information to an allocated No Yes moodle_mobile_app
assessment.
mod_workshop mod_workshop_update_submission 3.4 Update the given submission. No Yes moodle_mobile_app
mod_workshop mod_workshop_view_submission 3.4 Trigger the submission viewed No Yes moodle_mobile_app
event.

https://docs.moodle.org/dev/Web_service_API_functions 15/17
28/06/2024, 21:33 Web service API functions - MoodleDocs

Area Name Introduced Description Available Login Services

in AJAX required
Trigger the course module
mod_workshop mod_workshop_view_workshop 3.4 viewed event and update the No Yes moodle_mobile_app
module completion status.
report_competency report_competency_data_for_report 3.1 Load the data for the Yes Yes
competency report in a course.
report_insights report_insights_action_executed 3.8 Stores an action executed over Yes Yes moodle_mobile_app
a group of predictions.
report_insights report_insights_set_fixed_prediction 3.4 Flags a prediction as fixed. Yes Yes moodle_mobile_app
report_insights report_insights_set_notuseful_prediction 3.4 Flags the prediction as not Yes Yes moodle_mobile_app
useful.
tool_analytics tool_analytics_potential_contexts 3.8 Retrieve the list of potential Yes Yes moodle_mobile_app
contexts for a model.
Load the data for the
tool_lp tool_lp_data_for_competencies_manage_page 3.1 competencies manage page Yes Yes
template
Load the data for the
tool_lp tool_lp_data_for_competency_frameworks_manage_page 3.1 competency frameworks Yes Yes
manage page template
tool_lp tool_lp_data_for_competency_summary 3.1 Load competency data for Yes Yes
summary template.
tool_lp tool_lp_data_for_course_competencies_page 3.1 Load the data for the course Yes Yes moodle_mobile_app
competencies page template.
tool_lp tool_lp_data_for_plan_page 3.1 Load the data for the plan page Yes Yes moodle_mobile_app
template.
tool_lp tool_lp_data_for_plans_page 3.1 Load the data for the plans Yes Yes moodle_mobile_app
page template
tool_lp tool_lp_data_for_related_competencies_section 3.1 Load the data for the related Yes Yes
competencies template.
tool_lp tool_lp_data_for_template_competencies_page 3.1 Load the data for the template Yes Yes
competencies page template.
Load the data for the learning
tool_lp tool_lp_data_for_templates_manage_page 3.1 plan templates manage page Yes Yes
template
tool_lp tool_lp_data_for_user_competency_summary 3.1 Load a summary of a user Yes Yes moodle_mobile_app
competency.
tool_lp tool_lp_data_for_user_competency_summary_in_course 3.1 Load a summary of a user Yes Yes moodle_mobile_app
competency.
tool_lp tool_lp_data_for_user_competency_summary_in_plan 3.1 Load a summary of a user Yes Yes moodle_mobile_app
competency.
tool_lp tool_lp_data_for_user_evidence_list_page 3.1 Load the data for the user Yes Yes moodle_mobile_app
evidence list page template
tool_lp tool_lp_data_for_user_evidence_page 3.1 Load the data for the user Yes Yes moodle_mobile_app
evidence page template
tool_lp tool_lp_list_courses_using_competency 3.1 List the courses using a Yes Yes
competency
tool_lp tool_lp_search_cohorts 3.1 Search for cohorts. Yes Yes
tool_lp tool_lp_search_users 3.1 Search for users. Yes Yes
tool_mobile tool_mobile_call_external_functions 3.7 Call multiple external functions No Yes moodle_mobile_app
and return all responses.
Creates an auto-login key for
tool_mobile tool_mobile_get_autologin_key 3.2 the current user. Is created only No Yes moodle_mobile_app
in https sites and is restricted
by time and ip address.
Returns a list of the site
tool_mobile tool_mobile_get_config 3.2 configurations, filtering by No Yes moodle_mobile_app
section.
tool_mobile tool_mobile_get_content 3.5 Returns a piece of content to be No Yes moodle_mobile_app
displayed in the Mobile app.
tool_mobile tool_mobile_get_plugins_supporting_mobile 3.1 Returns a list of Moodle plugins Yes No moodle_mobile_app
supporting the mobile app.
Returns a list of the site public
tool_mobile tool_mobile_get_public_config 3.2 settings, those not requiring Yes No moodle_mobile_app
authentication.
tool_templatelibrary tool_templatelibrary_list_templates 3.0 List/search templates by Yes No
component.
Load a canonical template by
tool_templatelibrary tool_templatelibrary_load_canonical_template 3.0 name (not the theme overidden Yes No
one).
tool_usertours tool_usertours_complete_tour 3.2 Mark the specified tour as Yes Yes
completed for the current user
tool_usertours tool_usertours_fetch_and_start_tour 3.2 Fetch the specified tour Yes Yes
tool_usertours tool_usertours_reset_tour 3.2 Remove the specified tour Yes Yes
tool_usertours tool_usertours_step_shown 3.2 Mark the specified step as Yes Yes
completed for the current user
tool_xmldb tool_xmldb_invoke_move_action 3.6 moves element up/down Yes Yes

This is the list of the integrated core functions. To see the roadmap, see to the tracker issue in the section bellow.

https://docs.moodle.org/dev/Web_service_API_functions 16/17
28/06/2024, 21:33 Web service API functions - MoodleDocs
New Web Services entries are automatically generated for each new major version via this script: https://github.com/moodlehq/moodlemobile-scripts/blob/master/ws-documenter.php
<F2>
API Roadmap
Tracker issue: MDL-29934
SeeWeb services
alsoAPI Changes
How to contribute a web service function to core
Web services developer documentation
Web services user documentation
Retrieved from "https://docs.moodle.org/dev/index.php?title=Web_service_API_functions&oldid=63769"

This page was last edited on 2 January 2023, at 10:34.

Content is available under GNU General Public License unless otherwise noted.

https://docs.moodle.org/dev/Web_service_API_functions 17/17