Moodle: list of all web-service functions

Trabla: Moodle: list of all web-service functions

Moodle list of all web-service functions - codingtrabla tutorial

Solving:




Official page - Web services Roadmap
https://docs.moodle.org/dev/Web_services_Roadmap

Web service protocols

NameMoodle Ver.DescriptionIssue
AMF2.0Adobe protocol to communicate with Flash/Flex apps
REST (returning XML)2.0XML data accessed through a REST API (not restful)
REST (returning JSON)2.2JSON data accessed through a REST API (not restful)MDL-29242
REST (returning JSONP)2.XWould be very useful for client-side JavaScriptMDL-29913
JSON2.XJSON server receives a JSON encoded params and return JSON encoded values.MDL-21341
SOAP2.0Very important for interoperating with Java and .Net applications. There was a partial implementation JAVA/.Net in Moodle 2.0, but it does not work for anything but the most trivial functions. It is fully working with PHP clients.MDL-20804, MDL-28988, MDL-28989
XMLRPC2.0XML remote-procedure call.

Core web service functions

AreaMoodle 2.2 nameMoodle 2.0/2.1 nameIntroduced inDescriptionIssue
usercore_user_create_users()moodle_user_create_users()2.0Create users - admin function
usercore_user_delete_users()moodle_user_delete_users()2.0Delete users - admin function
usercore_user_update_users()moodle_user_update_users()2.0Update users
usercore_user_get_users_by_id()moodle_user_get_users_by_id()2.0Get users by id
usercore_user_get_course_user_profiles()moodle_user_get_course_participants_by_id()2.1Get course user profiles by id
cohortcore_cohort_create_cohorts()
2.4Create cohortsMDL-29472
cohortcore_cohort_update_cohorts()
2.4Update cohortsMDL-29472
cohortcore_cohort_delete_cohorts()
2.4Delete cohortsMDL-29472
cohortcore_cohort_get_cohorts()
2.4Get cohortsMDL-29472
cohortcore_cohort_add_cohort_members()
2.4Add members to cohortMDL-29472
cohortcore_cohort_delete_cohort_members()
2.4Delete members from cohortMDL-29472
cohortcore_cohort_get_cohort_members()
2.4Get cohort membersMDL-29472
coursecore_course_get_courses()moodle_course_get_courses()2.0Return course details
coursecore_course_create_courses()moodle_course_create_courses()2.0Create new courses
groupcore_group_create_groups()moodle_group_create_groups()2.0Creates new groups
groupcore_group_get_groups()moodle_group_get_groups()2.0Returns group details.
groupcore_group_get_course_groups()moodle_group_get_course_groups()2.0Returns all groups in specified course
groupcore_group_delete_groups()moodle_group_delete_groups()2.0Deletes all specified groups
groupcore_group_get_group_members()moodle_group_get_groupmembers()2.0Returns group members
groupcore_group_add_group_members()moodle_group_add_groupmembers()2.0Adds group members
groupcore_group_delete_group_members()moodle_group_delete_groupmembers()2.0Deletes group members
rolecore_role_assign_roles()moodle_role_assign()2.0Manual role assignments
rolecore_role_unassign_roles()moodle_role_unassign()2.0Manual role unassignments
enrolNONEmoodle_enrol_get_enrolled_users()2.0get some minimal information about the users enrolled in a course (DEPRECATED)
enrolcore_enrol_get_enrolled_users()moodle_user_get_users_by_courseid()2.1Get enrolled users by course id
enrolcore_enrol_get_users_courses()moodle_enrol_get_users_courses()2.0get list of course ids that a user is enrolled in (if you are allowed to see that)
enrol/manualenrol_manual_enrol_users()moodle_enrol_manual_enrol_users()2.0Manual enrol users
webservicecore_webservice_get_site_info()moodle_webservice_get_siteinfo()2.1Return some site info / user info / list web service functions
messagecore_message_send_instant_messages()moodle_message_send_instantmessages()2.1Send instant messages
notescore_notes_create_notes()moodle_notes_create_notes()2.1Create notes
notescore_notes_delete_notes()
2.5Delete NotesMDL-30072
notescore_notes_get_notes()
2.5Retrieve NotesMDL-30072
notescore_notes_update_notes()
2.5Update NotesMDL-30072
filescore_files_get_files()moodle_file_get_files()2.0browse moodle files
filescore_files_upload()moodle_file_upload()2.0upload a file to moodle (DEPRECATED)
coursecore_course_get_contents()
2.2get course content (modules + web service file urls)MDL-28646
coursecore_course_delete_courses()
2.3delete coursesMDL-13130
coursecore_course_duplicate_course()
2.3duplicate a courseMDL-32233
coursecore_course_get_categories()
2.3get categoriesMDL-32941
coursecore_course_update_categories()
2.3update categoriesMDL-32941
coursecore_course_create_categories()
2.3create categoriesMDL-32941
coursecore_course_delete_categories()
2.3delete categoriesMDL-32941
groupcore_group_create_groupings()
2.3create groupingsMDL-32662
groupcore_group_update_groupings()
2.3update groupingsMDL-32662
groupcore_group_get_groupings()
2.3get groupingsMDL-32662
groupcore_group_delete_groupings()
2.3delete groupingsMDL-32662
groupcore_group_assign_grouping()
2.3assign groups from groupingsMDL-32662
groupcore_group_unassign_grouping()
2.3unassign groups from groupingsMDL-32662
groupcore_group_get_course_groupings()
2.3get all groupings in specified courseMDL-32662
usercore_user_get_users_by_field()
2.5Retrieve users information for a specified unique field - If you want to do a user search, use core_user_get_users()MDL-35543
enrolcore_enrol_get_enrolled_users_with_capability()
2.4For each course and capability specified, return a list of the users that are enrolled in the course and have that capabilityMDL-31859
coursecore_course_import_course()
2.4Import course data from a course into another course. Does not include any user data.MDL-32919
messagecore_message_create_contacts()
2.5Add contacts to the contact listMDL-30070
messagecore_message_delete_contacts()
2.5Remove contacts from the contact listMDL-30070
messagecore_message_block_contacts()
2.5Block contactsMDL-30070
messagecore_message_unblock_contacts()
2.5Unblock contactsMDL-30070
messagecore_message_get_contacts()
2.5Retrieve the contact listMDL-30070
messagecore_message_search_contacts()
2.5Search for contactsMDL-30070
externalcore_get_string()
2.4Return a translated string - similar to core get_string() callMDL-35997
externalcore_get_component_strings()
2.4Return all raw strings (with {$a->xxx}) for a specific component - similar to core get_component_strings() callMDL-35997
externalcore_get_strings()
2.4Return some translated strings - like several core get_string() callsMDL-35997
calendarcore_calendar_delete_calendar_events()
2.5Delete calendar eventsMDL-37077
calendarcore_calendar_get_calendar_events()
2.5Get calendar eventsMDL-37100
calendarcore_calendar_create_calendar_events()
2.5Create calendar eventsMDL-37101
mod_assignmod_assign_get_grades()
2.4Returns grades from the assignmentMDL-31873
mod_assignmod_assign_get_assignments()
2.4Returns the courses and assignments for the users capabilityMDL-31873
mod_assignmod_assign_get_submissions
2.5Returns the submissions for assignmentsMDL-31682
mod_assignmod_assign_get_user_flags
2.6Returns the user_flags for assignmentsMDL-40548
mod_assignmod_assign_set_user_flags
2.6Sets the specified user_flags for an assignmentMDL-41738
mod_assignmod_assign_get_user_mappings
2.6Returns the user_mappings for assignmentsMDL-40548
mod_assignmod_assign_revert_submissions_to_draft
2.6Reverts the list of submissions to draft statusMDL-37148
mod_assignmod_assign_lock_submissions
2.6Prevent students from making changes to a list of submissionsMDL-37148
mod_assignmod_assign_unlock_submissions
2.6Allow students to make changes to a list of submissionsMDL-37148
mod_assignmod_assign_save_submission
2.6Update the current students submissionMDL-37148
mod_assignmod_assign_submit_for_grading
2.6Submit the current students assignment for gradingMDL-37148
mod_assignmod_assign_save_grade
2.6Save a grade update for a single student.MDL-37148
mod_assignmod_assign_save_grades
2.7Save grade updates for one or more students.MDL-42425
mod_assignmod_assign_save_user_extensions
2.6Save a list of assignment extensionsMDL-37148
mod_assignmod_assign_reveal_identities
2.6Reveal the identities for a blind marking assignmentMDL-37148
mod_forummod_forum_get_forums_by_courses
2.5Returns a list of forum instances in a provided set of courses, if no courses are provided then all the forum instances the user has access to will be returned.MDL-37247
mod_forummod_forum_get_forum_discussions
2.5Returns a list of forum discussions in a provided set of forums.MDL-30102
coursecore_course_update_courses()
2.5Update courses.MDL-30062
usercore_user_get_users()
2.5Search users. - If you want to get multiple users for one specific field, use core_user_get_users_by_field(), it's designed for this purpose and it should be faster.MDL-29938
gradecore_grade_get_definitions()
2.5Returns grading definitions for the course module ids and areaname provided as parameters. An optionall activeonly parameter can be provided so that only the active grading method is returned. Will be deprecated and replaced by core_grading_get_definitions in 2.6MDL-31681
gradingcore_grading_get_definitions()
2.6Returns grading definitions for the course module ids and areaname provided as parameters. An optionall activeonly parameter can be provided so that only the active grading method is returned.MDL-31890
gradingcore_grading_get_gradingform_instances()
2.6Returns the instances and fillings for the requested definition id. An optional since parameter allows the number of records returned to be reduced so that only those with a timemodified value >= since are returnedMDL-31890
gradingcore_grading_save_definitions()
2.8Accepts an array of areas as a parameter. The areas contain grading definitions with criteria for inserting and updatingMDL-31861

No comments:

Post a Comment