Preparing search index...
The search index is not available
moodle-api
moodle-api
api
mod
glossary
view_entry
Returns
Interface Returns
Hierarchy
Returns
Index
Properties
status
warnings
Properties
status
status
:
null
|
boolean
True on success
warnings
warnings
:
api
.
mod
.
glossary
.
view_entry
.
ReturnsWarnings
list of warnings
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
status
warnings
moodle-api
FunctionDefinition
auth
block
core
enrol
gradereport
gradingform
media
message
mod
paygw
qbank
quizaccess
report
tiny
tool
api
auth
email
get_signup_settings
Params
Returns
ReturnsProfilefieldsItem
ReturnsWarningsItem
ReturnsNamefields
ReturnsProfilefields
ReturnsWarnings
signup_user
Params
ParamsCustomprofilefieldsItem
Returns
ReturnsWarningsItem
ParamsCustomprofilefields
ReturnsWarnings
block
accessreview
get_module_data
Params
ReturnsItem
Returns
get_section_data
Params
ReturnsItem
Returns
recentlyaccesseditems
get_recent_items
Params
ReturnsItem
Returns
starredcourses
get_starred_courses
Params
ReturnsItem
Returns
core
admin
set_block_protection
Params
Returns
set_plugin_order
Params
Returns
set_plugin_state
Params
Returns
auth
confirm_user
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
is_age_digital_consent_verification_enabled
Params
Returns
is_minor
Params
Returns
request_password_reset
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
resend_confirmation_email
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
backup
get_async_backup_links_backup
Params
Returns
get_async_backup_links_restore
Params
Returns
get_async_backup_progress
Params
ReturnsItem
ParamsBackupids
Returns
get_copy_progress
Params
ParamsCopiesItem
ReturnsItem
ParamsCopies
Returns
submit_copy_form
Params
badges
get_user_badges
Params
Returns
ReturnsBadgesItem
ReturnsBadgesItemAlignmentItem
ReturnsBadgesItemEndorsement
ReturnsBadgesItemRelatedbadgesItem
ReturnsWarningsItem
ReturnsBadges
ReturnsBadgesItemAlignment
ReturnsBadgesItemRelatedbadges
ReturnsWarnings
block
fetch_addable_blocks
Params
ReturnsItem
Returns
get_course_blocks
Params
Returns
ReturnsBlocksItem
ReturnsBlocksItemConfigsItem
ReturnsBlocksItemContents
ReturnsBlocksItemContentsFilesItem
ReturnsWarningsItem
ReturnsBlocks
ReturnsBlocksItemConfigs
ReturnsBlocksItemContentsFiles
ReturnsWarnings
get_dashboard_blocks
Params
Returns
ReturnsBlocksItem
ReturnsBlocksItemConfigsItem
ReturnsBlocksItemContents
ReturnsBlocksItemContentsFilesItem
ReturnsWarningsItem
ReturnsBlocks
ReturnsBlocksItemConfigs
ReturnsBlocksItemContentsFiles
ReturnsWarnings
blog
get_entries
Params
ParamsFiltersItem
Returns
ReturnsEntriesItem
ReturnsEntriesItemAttachmentfilesItem
ReturnsEntriesItemSummaryfilesItem
ReturnsEntriesItemTagsItem
ReturnsWarningsItem
ParamsFilters
ReturnsEntries
ReturnsEntriesItemAttachmentfiles
ReturnsEntriesItemSummaryfiles
ReturnsEntriesItemTags
ReturnsWarnings
view_entries
Params
ParamsFiltersItem
Returns
ReturnsWarningsItem
ParamsFilters
ReturnsWarnings
calendar
create_calendar_events
Params
ParamsEventsItem
Returns
ReturnsEventsItem
ReturnsWarningsItem
ParamsEvents
ReturnsEvents
ReturnsWarnings
delete_calendar_events
Params
ParamsEventsItem
ParamsEvents
delete_subscription
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_action_events_by_course
Params
Returns
ReturnsEventsItem
ReturnsEventsItemAction
ReturnsEventsItemCategory
ReturnsEventsItemCourse
ReturnsEventsItemIcon
ReturnsEventsItemSubscription
ReturnsEvents
get_action_events_by_courses
Params
Returns
ReturnsGroupedbycourseItem
ReturnsGroupedbycourseItemEventsItem
ReturnsGroupedbycourseItemEventsItemAction
ReturnsGroupedbycourseItemEventsItemCategory
ReturnsGroupedbycourseItemEventsItemCourse
ReturnsGroupedbycourseItemEventsItemIcon
ReturnsGroupedbycourseItemEventsItemSubscription
ParamsCourseids
ReturnsGroupedbycourse
ReturnsGroupedbycourseItemEvents
get_action_events_by_timesort
Params
Returns
ReturnsEventsItem
ReturnsEventsItemAction
ReturnsEventsItemCategory
ReturnsEventsItemCourse
ReturnsEventsItemIcon
ReturnsEventsItemSubscription
ReturnsEvents
get_allowed_event_types
Params
Returns
ReturnsWarningsItem
ReturnsAllowedeventtypes
ReturnsWarnings
get_calendar_access_information
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_calendar_day_view
Params
Returns
ReturnsDate
ReturnsEventsItem
ReturnsEventsItemAction
ReturnsEventsItemCategory
ReturnsEventsItemCourse
ReturnsEventsItemIcon
ReturnsEventsItemSubscription
ReturnsNextperiod
ReturnsPreviousperiod
ReturnsEvents
get_calendar_event_by_id
Params
Returns
ReturnsEvent
ReturnsEventAction
ReturnsEventCategory
ReturnsEventCourse
ReturnsEventIcon
ReturnsEventSubscription
ReturnsWarningsItem
ReturnsWarnings
get_calendar_events
Params
ParamsEvents
ParamsOptions
Returns
ReturnsEventsItem
ReturnsWarningsItem
ParamsEventsCategoryids
ParamsEventsCourseids
ParamsEventsEventids
ParamsEventsGroupids
ReturnsEvents
ReturnsWarnings
get_calendar_export_token
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_calendar_monthly_view
Params
Returns
ReturnsDate
ReturnsDaynamesItem
ReturnsNextperiod
ReturnsPreviousperiod
ReturnsWeeksItem
ReturnsWeeksItemDaysItem
ReturnsWeeksItemDaysItemEventsItem
ReturnsWeeksItemDaysItemEventsItemAction
ReturnsWeeksItemDaysItemEventsItemCategory
ReturnsWeeksItemDaysItemEventsItemCourse
ReturnsWeeksItemDaysItemEventsItemIcon
ReturnsWeeksItemDaysItemEventsItemSubscription
ReturnsDaynames
ReturnsWeeks
ReturnsWeeksItemDays
ReturnsWeeksItemDaysItemCalendareventtypes
ReturnsWeeksItemDaysItemEvents
ReturnsWeeksItemPostpadding
ReturnsWeeksItemPrepadding
get_calendar_upcoming_view
Params
Returns
ReturnsDate
ReturnsEventsItem
ReturnsEventsItemAction
ReturnsEventsItemCategory
ReturnsEventsItemCourse
ReturnsEventsItemIcon
ReturnsEventsItemSubscription
ReturnsEvents
get_timestamps
Params
ParamsDataItem
Returns
ReturnsTimestampsItem
ParamsData
ReturnsTimestamps
submit_create_update_form
Params
Returns
ReturnsEvent
ReturnsEventAction
ReturnsEventCategory
ReturnsEventCourse
ReturnsEventIcon
ReturnsEventSubscription
update_event_start_day
Params
Returns
ReturnsEvent
ReturnsEventAction
ReturnsEventCategory
ReturnsEventCourse
ReturnsEventIcon
ReturnsEventSubscription
change
editmode
Params
Returns
cohort
add_cohort_members
Params
ParamsMembersItem
ParamsMembersItemCohorttype
ParamsMembersItemUsertype
Returns
ReturnsWarningsItem
ParamsMembers
ReturnsWarnings
create_cohorts
Params
ParamsCohortsItem
ParamsCohortsItemCategorytype
ParamsCohortsItemCustomfieldsItem
ReturnsItem
ParamsCohorts
ParamsCohortsItemCustomfields
Returns
delete_cohort_members
Params
ParamsMembersItem
ParamsMembers
delete_cohorts
Params
ParamsCohortids
get_cohort_members
Params
ReturnsItem
ParamsCohortids
Returns
ReturnsItemUserids
get_cohorts
Params
ReturnsItem
ReturnsItemCustomfieldsItem
ParamsCohortids
Returns
ReturnsItemCustomfields
search_cohorts
Params
ParamsContext
Returns
ReturnsCohortsItem
ReturnsCohortsItemCustomfieldsItem
ReturnsCohorts
ReturnsCohortsItemCustomfields
update_cohorts
Params
ParamsCohortsItem
ParamsCohortsItemCategorytype
ParamsCohortsItemCustomfieldsItem
ParamsCohorts
ParamsCohortsItemCustomfields
comment
add_comments
Params
ParamsCommentsItem
ReturnsItem
ParamsComments
Returns
delete_comments
Params
ReturnsItem
ParamsComments
Returns
get_comments
Params
Returns
ReturnsCommentsItem
ReturnsWarningsItem
ReturnsComments
ReturnsWarnings
competency
add_competency_to_course
Params
add_competency_to_plan
Params
add_competency_to_template
Params
add_related_competency
Params
approve_plan
Params
competency_framework_viewed
Params
competency_viewed
Params
complete_plan
Params
count_competencies
Params
ParamsFiltersItem
ParamsFilters
count_competencies_in_course
Params
count_competencies_in_template
Params
count_competency_frameworks
Params
ParamsContext
count_course_module_competencies
Params
count_courses_using_competency
Params
count_templates
Params
ParamsContext
count_templates_using_competency
Params
create_competency
Params
ParamsCompetency
Returns
create_competency_framework
Params
ParamsCompetencyframework
Returns
create_plan
Params
ParamsPlan
Returns
ReturnsCommentarea
ReturnsReviewer
ReturnsTemplate
create_template
Params
ParamsTemplate
Returns
create_user_evidence_competency
Params
Returns
delete_competency
Params
delete_competency_framework
Params
delete_evidence
Params
delete_plan
Params
delete_template
Params
delete_user_evidence
Params
delete_user_evidence_competency
Params
duplicate_competency_framework
Params
Returns
duplicate_template
Params
Returns
get_scale_values
Params
ReturnsItem
Returns
grade_competency
Params
Returns
ReturnsActionuser
grade_competency_in_course
Params
Returns
ReturnsActionuser
grade_competency_in_plan
Params
Returns
ReturnsActionuser
list_competencies
Params
ParamsFiltersItem
ReturnsItem
ParamsFilters
Returns
list_competencies_in_template
Params
ReturnsItem
Returns
list_competency_frameworks
Params
ParamsContext
ReturnsItem
Returns
list_course_competencies
Params
ReturnsItem
ReturnsItemCompetency
ReturnsItemCoursecompetency
Returns
list_course_module_competencies
Params
ReturnsItem
ReturnsItemCompetency
ReturnsItemCoursemodulecompetency
Returns
list_plan_competencies
Params
ReturnsItem
ReturnsItemCompetency
ReturnsItemUsercompetency
ReturnsItemUsercompetencyReviewer
ReturnsItemUsercompetencyplan
Returns
list_templates
Params
ParamsContext
ReturnsItem
Returns
list_templates_using_competency
Params
ReturnsItem
Returns
list_user_plans
Params
ReturnsItem
ReturnsItemCommentarea
ReturnsItemReviewer
ReturnsItemTemplate
Returns
move_down_competency
Params
move_up_competency
Params
plan_cancel_review_request
Params
plan_request_review
Params
plan_start_review
Params
plan_stop_review
Params
read_competency
Params
Returns
read_competency_framework
Params
Returns
read_plan
Params
Returns
ReturnsCommentarea
ReturnsReviewer
ReturnsTemplate
read_template
Params
Returns
read_user_evidence
Params
Returns
ReturnsCompetenciesItem
ReturnsFilesItem
ReturnsCompetencies
ReturnsFiles
remove_competency_from_course
Params
remove_competency_from_plan
Params
remove_competency_from_template
Params
remove_related_competency
Params
reopen_plan
Params
reorder_course_competency
Params
reorder_plan_competency
Params
reorder_template_competency
Params
request_review_of_user_evidence_linked_competencies
Params
search_competencies
Params
ReturnsItem
Returns
set_course_competency_ruleoutcome
Params
set_parent_competency
Params
template_has_related_data
Params
template_viewed
Params
unapprove_plan
Params
unlink_plan_from_template
Params
update_competency
Params
ParamsCompetency
update_competency_framework
Params
ParamsCompetencyframework
update_course_competency_settings
Params
ParamsSettings
update_plan
Params
ParamsPlan
Returns
ReturnsCommentarea
ReturnsReviewer
ReturnsTemplate
update_template
Params
ParamsTemplate
user_competency_cancel_review_request
Params
user_competency_plan_viewed
Params
user_competency_request_review
Params
user_competency_start_review
Params
user_competency_stop_review
Params
user_competency_viewed
Params
user_competency_viewed_in_course
Params
user_competency_viewed_in_plan
Params
completion
get_activities_completion_status
Params
Returns
ReturnsStatusesItem
ReturnsStatusesItemDetailsItem
ReturnsStatusesItemDetailsItemRulevalue
ReturnsWarningsItem
ReturnsStatuses
ReturnsStatusesItemDetails
ReturnsWarnings
get_course_completion_status
Params
Returns
ReturnsCompletionstatus
ReturnsCompletionstatusCompletionsItem
ReturnsCompletionstatusCompletionsItemDetails
ReturnsWarningsItem
ReturnsCompletionstatusCompletions
ReturnsWarnings
mark_course_self_completed
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
override_activity_completion_status
Params
Returns
update_activity_completion_status_manually
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
contentbank
delete_content
Params
Returns
ReturnsWarningsItem
ParamsContentids
ReturnsWarnings
rename_content
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
set_content_visibility
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
course
add_content_item_to_user_favourites
Params
Returns
check_updates
Params
ParamsTocheckItem
Returns
ReturnsInstancesItem
ReturnsInstancesItemUpdatesItem
ReturnsWarningsItem
ParamsFilter
ParamsTocheck
ReturnsInstances
ReturnsInstancesItemUpdates
ReturnsInstancesItemUpdatesItemItemids
ReturnsWarnings
create_categories
Params
ParamsCategoriesItem
ReturnsItem
ParamsCategories
Returns
create_courses
Params
ParamsCoursesItem
ParamsCoursesItemCourseformatoptionsItem
ParamsCoursesItemCustomfieldsItem
ReturnsItem
ParamsCourses
ParamsCoursesItemCourseformatoptions
ParamsCoursesItemCustomfields
Returns
delete_categories
Params
ParamsCategoriesItem
ParamsCategories
delete_courses
Params
Returns
ReturnsWarningsItem
ParamsCourseids
ReturnsWarnings
delete_modules
Params
ParamsCmids
duplicate_course
Params
ParamsOptionsItem
Returns
ParamsOptions
edit_module
Params
edit_section
Params
get_activity_chooser_footer
Params
Returns
get_categories
Params
ParamsCriteriaItem
ReturnsItem
ParamsCriteria
Returns
get_contents
Params
ParamsOptionsItem
ReturnsItem
ReturnsItemModulesItem
ReturnsItemModulesItemCompletiondata
ReturnsItemModulesItemCompletiondataDetailsItem
ReturnsItemModulesItemCompletiondataDetailsItemRulevalue
ReturnsItemModulesItemContentsItem
ReturnsItemModulesItemContentsItemTagsItem
ReturnsItemModulesItemContentsinfo
ReturnsItemModulesItemDatesItem
ParamsOptions
Returns
ReturnsItemModules
ReturnsItemModulesItemCompletiondataDetails
ReturnsItemModulesItemContents
ReturnsItemModulesItemContentsItemTags
ReturnsItemModulesItemContentsinfoMimetypes
ReturnsItemModulesItemDates
get_course_content_items
Params
Returns
ReturnsContentItemsItem
ReturnsContentItems
get_course_module
Params
Returns
ReturnsCm
ReturnsCmAdvancedgradingItem
ReturnsCmOutcomesItem
ReturnsWarningsItem
ReturnsCmAdvancedgrading
ReturnsCmOutcomes
ReturnsWarnings
get_course_module_by_instance
Params
Returns
ReturnsCm
ReturnsCmAdvancedgradingItem
ReturnsCmOutcomesItem
ReturnsWarningsItem
ReturnsCmAdvancedgrading
ReturnsCmOutcomes
ReturnsWarnings
get_courses
Params
ParamsOptions
ReturnsItem
ReturnsItemCourseformatoptionsItem
ReturnsItemCustomfieldsItem
ParamsOptionsIds
Returns
ReturnsItemCourseformatoptions
ReturnsItemCustomfields
get_courses_by_field
Params
Returns
ReturnsCoursesItem
ReturnsCoursesItemContactsItem
ReturnsCoursesItemCourseformatoptionsItem
ReturnsCoursesItemCustomfieldsItem
ReturnsCoursesItemFiltersItem
ReturnsCoursesItemOverviewfilesItem
ReturnsCoursesItemSummaryfilesItem
ReturnsWarningsItem
ReturnsCourses
ReturnsCoursesItemContacts
ReturnsCoursesItemCourseformatoptions
ReturnsCoursesItemCustomfields
ReturnsCoursesItemEnrollmentmethods
ReturnsCoursesItemFilters
ReturnsCoursesItemOverviewfiles
ReturnsCoursesItemSummaryfiles
ReturnsWarnings
get_enrolled_courses_by_timeline_classification
Params
Returns
ReturnsCoursesItem
ReturnsCourses
get_enrolled_courses_with_action_events_by_timeline_classification
Params
Returns
ReturnsCoursesItem
ReturnsCourses
get_enrolled_users_by_cmid
Params
Returns
ReturnsUsersItem
ReturnsWarningsItem
ReturnsUsers
ReturnsWarnings
get_module
Params
get_recent_courses
Params
ReturnsItem
Returns
get_updates_since
Params
Returns
ReturnsInstancesItem
ReturnsInstancesItemUpdatesItem
ReturnsWarningsItem
ParamsFilter
ReturnsInstances
ReturnsInstancesItemUpdates
ReturnsInstancesItemUpdatesItemItemids
ReturnsWarnings
get_user_administration_options
Params
Returns
ReturnsCoursesItem
ReturnsCoursesItemOptionsItem
ReturnsWarningsItem
ParamsCourseids
ReturnsCourses
ReturnsCoursesItemOptions
ReturnsWarnings
get_user_navigation_options
Params
Returns
ReturnsCoursesItem
ReturnsCoursesItemOptionsItem
ReturnsWarningsItem
ParamsCourseids
ReturnsCourses
ReturnsCoursesItemOptions
ReturnsWarnings
import_course
Params
ParamsOptionsItem
ParamsOptions
remove_content_item_from_user_favourites
Params
Returns
search_courses
Params
Returns
ReturnsCoursesItem
ReturnsCoursesItemContactsItem
ReturnsCoursesItemCustomfieldsItem
ReturnsCoursesItemOverviewfilesItem
ReturnsCoursesItemSummaryfilesItem
ReturnsWarningsItem
ParamsRequiredcapabilities
ReturnsCourses
ReturnsCoursesItemContacts
ReturnsCoursesItemCustomfields
ReturnsCoursesItemEnrollmentmethods
ReturnsCoursesItemOverviewfiles
ReturnsCoursesItemSummaryfiles
ReturnsWarnings
set_favourite_courses
Params
ParamsCoursesItem
Returns
ReturnsWarningsItem
ParamsCourses
ReturnsWarnings
toggle_activity_recommendation
Params
Returns
update_categories
Params
ParamsCategoriesItem
ParamsCategories
update_courses
Params
ParamsCoursesItem
ParamsCoursesItemCourseformatoptionsItem
ParamsCoursesItemCustomfieldsItem
Returns
ReturnsWarningsItem
ParamsCourses
ParamsCoursesItemCourseformatoptions
ParamsCoursesItemCustomfields
ReturnsWarnings
view_course
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
courseformat
file_handlers
Params
ReturnsItem
Returns
get_state
Params
update_course
Params
ParamsIds
create
userfeedback_action_record
Params
customfield
create_category
Params
delete_category
Params
delete_field
Params
move_category
Params
move_field
Params
reload_template
Params
Returns
ReturnsCategoriesItem
ReturnsCategoriesItemFieldsItem
ReturnsCategories
ReturnsCategoriesItemFields
dynamic
tabs_get_content
Params
Returns
enrol
get_course_enrolment_methods
Params
ReturnsItem
Returns
get_enrolled_users
Params
ParamsOptionsItem
ReturnsItem
ReturnsItemCustomfieldsItem
ReturnsItemEnrolledcoursesItem
ReturnsItemGroupsItem
ReturnsItemPreferencesItem
ReturnsItemRolesItem
ParamsOptions
Returns
ReturnsItemCustomfields
ReturnsItemEnrolledcourses
ReturnsItemGroups
ReturnsItemPreferences
ReturnsItemRoles
get_enrolled_users_with_capability
Params
ParamsCoursecapabilitiesItem
ParamsOptionsItem
ReturnsItem
ReturnsItemUsersItem
ReturnsItemUsersItemCustomfieldsItem
ReturnsItemUsersItemEnrolledcoursesItem
ReturnsItemUsersItemGroupsItem
ReturnsItemUsersItemPreferencesItem
ReturnsItemUsersItemRolesItem
ParamsCoursecapabilities
ParamsCoursecapabilitiesItemCapabilities
ParamsOptions
Returns
ReturnsItemUsers
ReturnsItemUsersItemCustomfields
ReturnsItemUsersItemEnrolledcourses
ReturnsItemUsersItemGroups
ReturnsItemUsersItemPreferences
ReturnsItemUsersItemRoles
get_potential_users
Params
ReturnsItem
ReturnsItemCustomfieldsItem
ReturnsItemPreferencesItem
Returns
ReturnsItemCustomfields
ReturnsItemPreferences
get_users_courses
Params
ReturnsItem
ReturnsItemOverviewfilesItem
Returns
ReturnsItemOverviewfiles
search_users
Params
ReturnsItem
ReturnsItemCustomfieldsItem
ReturnsItemPreferencesItem
Returns
ReturnsItemCustomfields
ReturnsItemPreferences
submit_user_enrolment_form
Params
Returns
unenrol_user_enrolment
Params
Returns
ReturnsErrorsItem
ReturnsErrors
fetch
notifications
Params
ReturnsItem
ReturnsItemVariables
Returns
files
delete_draft_files
Params
ParamsFilesItem
Returns
ReturnsWarningsItem
ParamsFiles
ReturnsParentpaths
ReturnsWarnings
get_files
Params
Returns
ReturnsFilesItem
ReturnsParentsItem
ReturnsFiles
ReturnsParents
get_unused_draft_itemid
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
upload
Params
Returns
filters
get_available_in_context
Params
ParamsContextsItem
Returns
ReturnsFiltersItem
ReturnsWarningsItem
ParamsContexts
ReturnsFilters
ReturnsWarnings
form
dynamic_form
Params
Returns
get_filetypes_browser_data
Params
Returns
ReturnsGroupsItem
ReturnsGroupsItemTypesItem
ReturnsGroups
ReturnsGroupsItemTypes
get
component_strings
Params
ReturnsItem
Returns
fragment
Params
ParamsArgsItem
Returns
ParamsArgs
string
Params
ParamsStringparamsItem
ParamsStringparams
strings
Params
ParamsStringsItem
ParamsStringsItemStringparamsItem
ReturnsItem
ParamsStrings
ParamsStringsItemStringparams
Returns
user_dates
Params
ParamsTimestampsItem
Returns
ParamsTimestamps
ReturnsDates
grades
create_gradecategories
Params
ParamsCategoriesItem
ParamsCategoriesItemOptions
Returns
ReturnsWarningsItem
ParamsCategories
ReturnsCategoryids
ReturnsWarnings
create_gradecategory
Params
ParamsOptions
Returns
ReturnsWarningsItem
ReturnsWarnings
get_enrolled_users_for_search_widget
Params
Returns
ReturnsUsersItem
ReturnsWarningsItem
ReturnsUsers
ReturnsWarnings
get_enrolled_users_for_selector
Params
Returns
ReturnsUsersItem
ReturnsWarningsItem
ReturnsUsers
ReturnsWarnings
get_feedback
Params
Returns
get_gradeitems
Params
Returns
ReturnsGradeItemsItem
ReturnsWarningsItem
ReturnsGradeItems
ReturnsWarnings
get_groups_for_search_widget
Params
Returns
ReturnsGroupsItem
ReturnsWarningsItem
ReturnsGroups
ReturnsWarnings
get_groups_for_selector
Params
Returns
ReturnsGroupsItem
ReturnsWarningsItem
ReturnsGroups
ReturnsWarnings
grader_gradingpanel_point_fetch
Params
Returns
ReturnsGrade
ReturnsWarningsItem
ReturnsWarnings
grader_gradingpanel_point_store
Params
Returns
ReturnsGrade
ReturnsWarningsItem
ReturnsWarnings
grader_gradingpanel_scale_fetch
Params
Returns
ReturnsGrade
ReturnsGradeOptionsItem
ReturnsWarningsItem
ReturnsGradeOptions
ReturnsWarnings
grader_gradingpanel_scale_store
Params
Returns
ReturnsGrade
ReturnsGradeOptionsItem
ReturnsWarningsItem
ReturnsGradeOptions
ReturnsWarnings
update_grades
Params
ParamsGradesItem
ParamsItemdetails
ParamsGrades
grading
get_definitions
Params
Returns
ReturnsAreasItem
ReturnsAreasItemDefinitionsItem
ReturnsAreasItemDefinitionsItemGuide
ReturnsAreasItemDefinitionsItemGuideGuideCommentsItem
ReturnsAreasItemDefinitionsItemGuideGuideCriteriaItem
ReturnsAreasItemDefinitionsItemRubric
ReturnsAreasItemDefinitionsItemRubricRubricCriteriaItem
ReturnsAreasItemDefinitionsItemRubricRubricCriteriaItemLevelsItem
ReturnsWarningsItem
ParamsCmids
ReturnsAreas
ReturnsAreasItemDefinitions
ReturnsAreasItemDefinitionsItemGuideGuideComments
ReturnsAreasItemDefinitionsItemGuideGuideCriteria
ReturnsAreasItemDefinitionsItemRubricRubricCriteria
ReturnsAreasItemDefinitionsItemRubricRubricCriteriaItemLevels
ReturnsWarnings
get_gradingform_instances
Params
Returns
ReturnsInstancesItem
ReturnsInstancesItemGuide
ReturnsInstancesItemGuideCriteriaItem
ReturnsInstancesItemRubric
ReturnsInstancesItemRubricCriteriaItem
ReturnsWarningsItem
ReturnsInstances
ReturnsInstancesItemGuideCriteria
ReturnsInstancesItemRubricCriteria
ReturnsWarnings
save_definitions
Params
ParamsAreasItem
ParamsAreasItemDefinitionsItem
ParamsAreasItemDefinitionsItemGuide
ParamsAreasItemDefinitionsItemGuideGuideCommentsItem
ParamsAreasItemDefinitionsItemGuideGuideCriteriaItem
ParamsAreasItemDefinitionsItemRubric
ParamsAreasItemDefinitionsItemRubricRubricCriteriaItem
ParamsAreasItemDefinitionsItemRubricRubricCriteriaItemLevelsItem
ParamsAreas
ParamsAreasItemDefinitions
ParamsAreasItemDefinitionsItemGuideGuideComments
ParamsAreasItemDefinitionsItemGuideGuideCriteria
ParamsAreasItemDefinitionsItemRubricRubricCriteria
ParamsAreasItemDefinitionsItemRubricRubricCriteriaItemLevels
group
add_group_members
Params
ParamsMembersItem
ParamsMembers
assign_grouping
Params
ParamsAssignmentsItem
ParamsAssignments
create_groupings
Params
ParamsGroupingsItem
ReturnsItem
ParamsGroupings
Returns
create_groups
Params
ParamsGroupsItem
ReturnsItem
ParamsGroups
Returns
delete_group_members
Params
ParamsMembersItem
ParamsMembers
delete_groupings
Params
ParamsGroupingids
delete_groups
Params
ParamsGroupids
get_activity_allowed_groups
Params
Returns
ReturnsGroupsItem
ReturnsWarningsItem
ReturnsGroups
ReturnsWarnings
get_activity_groupmode
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_course_groupings
Params
ReturnsItem
Returns
get_course_groups
Params
ReturnsItem
Returns
get_course_user_groups
Params
Returns
ReturnsGroupsItem
ReturnsWarningsItem
ReturnsGroups
ReturnsWarnings
get_group_members
Params
ReturnsItem
ParamsGroupids
Returns
ReturnsItemUserids
get_groupings
Params
ReturnsItem
ReturnsItemGroupsItem
ParamsGroupingids
Returns
ReturnsItemGroups
get_groups
Params
ReturnsItem
ParamsGroupids
Returns
unassign_grouping
Params
ParamsUnassignmentsItem
ParamsUnassignments
update_groupings
Params
ParamsGroupingsItem
ParamsGroupings
update_groups
Params
ParamsGroupsItem
ParamsGroups
h5p
get_trusted_h5p_file
Params
Returns
ReturnsFilesItem
ReturnsWarningsItem
ReturnsFiles
ReturnsWarnings
message
block_user
Params
ReturnsItem
Returns
confirm_contact_request
Params
ReturnsItem
Returns
create_contact_request
Params
Returns
ReturnsRequest
ReturnsWarningsItem
ReturnsWarnings
data_for_messagearea_search_messages
Params
Returns
ReturnsContactsItem
ReturnsContacts
decline_contact_request
Params
ReturnsItem
Returns
delete_contacts
Params
ParamsUserids
delete_conversations_by_id
Params
ReturnsItem
ParamsConversationids
Returns
delete_message
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
delete_message_for_all_users
Params
ReturnsItem
Returns
get_blocked_users
Params
Returns
ReturnsUsersItem
ReturnsWarningsItem
ReturnsUsers
ReturnsWarnings
get_contact_requests
Params
ReturnsItem
ReturnsItemContactrequestsItem
ReturnsItemConversationsItem
Returns
ReturnsItemContactrequests
ReturnsItemConversations
get_conversation
Params
Returns
ReturnsMembersItem
ReturnsMembersItemContactrequestsItem
ReturnsMembersItemConversationsItem
ReturnsMessagesItem
ReturnsMembers
ReturnsMembersItemContactrequests
ReturnsMembersItemConversations
ReturnsMessages
get_conversation_between_users
Params
Returns
ReturnsMembersItem
ReturnsMembersItemContactrequestsItem
ReturnsMembersItemConversationsItem
ReturnsMessagesItem
ReturnsMembers
ReturnsMembersItemContactrequests
ReturnsMembersItemConversations
ReturnsMessages
get_conversation_counts
Params
Returns
ReturnsTypes
get_conversation_members
Params
ReturnsItem
ReturnsItemContactrequestsItem
ReturnsItemConversationsItem
Returns
ReturnsItemContactrequests
ReturnsItemConversations
get_conversation_messages
Params
Returns
ReturnsMembersItem
ReturnsMembersItemContactrequestsItem
ReturnsMembersItemConversationsItem
ReturnsMessagesItem
ReturnsMembers
ReturnsMembersItemContactrequests
ReturnsMembersItemConversations
ReturnsMessages
get_conversations
Params
Returns
ReturnsConversationsItem
ReturnsConversationsItemMembersItem
ReturnsConversationsItemMembersItemContactrequestsItem
ReturnsConversationsItemMembersItemConversationsItem
ReturnsConversationsItemMessagesItem
ReturnsConversations
ReturnsConversationsItemMembers
ReturnsConversationsItemMembersItemContactrequests
ReturnsConversationsItemMembersItemConversations
ReturnsConversationsItemMessages
get_member_info
Params
ReturnsItem
ReturnsItemContactrequestsItem
ReturnsItemConversationsItem
ParamsUserids
Returns
ReturnsItemContactrequests
ReturnsItemConversations
get_message_processor
Params
Returns
get_messages
Params
Returns
ReturnsMessagesItem
ReturnsWarningsItem
ReturnsMessages
ReturnsWarnings
get_received_contact_requests_count
Params
get_self_conversation
Params
Returns
ReturnsMembersItem
ReturnsMembersItemContactrequestsItem
ReturnsMembersItemConversationsItem
ReturnsMessagesItem
ReturnsMembers
ReturnsMembersItemContactrequests
ReturnsMembersItemConversations
ReturnsMessages
get_unread_conversation_counts
Params
Returns
ReturnsTypes
get_unread_conversations_count
Params
get_unread_notification_count
Params
get_user_contacts
Params
ReturnsItem
ReturnsItemContactrequestsItem
ReturnsItemConversationsItem
Returns
ReturnsItemContactrequests
ReturnsItemConversations
get_user_message_preferences
Params
Returns
ReturnsPreferences
ReturnsPreferencesComponentsItem
ReturnsPreferencesComponentsItemNotificationsItem
ReturnsPreferencesComponentsItemNotificationsItemProcessorsItem
ReturnsPreferencesComponentsItemNotificationsItemProcessorsItemLoggedin
ReturnsPreferencesComponentsItemNotificationsItemProcessorsItemLoggedoff
ReturnsPreferencesProcessorsItem
ReturnsWarningsItem
ReturnsPreferencesComponents
ReturnsPreferencesComponentsItemNotifications
ReturnsPreferencesComponentsItemNotificationsItemProcessors
ReturnsPreferencesProcessors
ReturnsWarnings
get_user_notification_preferences
Params
Returns
ReturnsPreferences
ReturnsPreferencesComponentsItem
ReturnsPreferencesComponentsItemNotificationsItem
ReturnsPreferencesComponentsItemNotificationsItemProcessorsItem
ReturnsPreferencesComponentsItemNotificationsItemProcessorsItemLoggedin
ReturnsPreferencesComponentsItemNotificationsItemProcessorsItemLoggedoff
ReturnsPreferencesProcessorsItem
ReturnsWarningsItem
ReturnsPreferencesComponents
ReturnsPreferencesComponentsItemNotifications
ReturnsPreferencesComponentsItemNotificationsItemProcessors
ReturnsPreferencesProcessors
ReturnsWarnings
mark_all_conversation_messages_as_read
Params
mark_all_notifications_as_read
Params
mark_message_read
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
mark_notification_read
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
message_processor_config_form
Params
ParamsFormvaluesItem
ParamsFormvalues
message_search_users
Params
Returns
ReturnsContactsItem
ReturnsContactsItemContactrequestsItem
ReturnsContactsItemConversationsItem
ReturnsNoncontactsItem
ReturnsNoncontactsItemContactrequestsItem
ReturnsNoncontactsItemConversationsItem
ReturnsContacts
ReturnsContactsItemContactrequests
ReturnsContactsItemConversations
ReturnsNoncontacts
ReturnsNoncontactsItemContactrequests
ReturnsNoncontactsItemConversations
mute_conversations
Params
ReturnsItem
ParamsConversationids
Returns
search_contacts
Params
ReturnsItem
Returns
send_instant_messages
Params
ParamsMessagesItem
ReturnsItem
ParamsMessages
Returns
send_messages_to_conversation
Params
ParamsMessagesItem
ReturnsItem
ParamsMessages
Returns
set_favourite_conversations
Params
ReturnsItem
ParamsConversations
Returns
unblock_user
Params
ReturnsItem
Returns
unmute_conversations
Params
ReturnsItem
ParamsConversationids
Returns
unset_favourite_conversations
Params
ReturnsItem
ParamsConversations
Returns
moodlenet
auth_check
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_share_info_activity
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
send_activity
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
notes
create_notes
Params
ParamsNotesItem
ReturnsItem
ParamsNotes
Returns
delete_notes
Params
ReturnsItem
ParamsNotes
Returns
get_course_notes
Params
Returns
ReturnsCoursenotesItem
ReturnsPersonalnotesItem
ReturnsSitenotesItem
ReturnsWarningsItem
ReturnsCoursenotes
ReturnsPersonalnotes
ReturnsSitenotes
ReturnsWarnings
get_notes
Params
Returns
ReturnsNotesItem
ReturnsWarningsItem
ParamsNotes
ReturnsNotes
ReturnsWarnings
update_notes
Params
ParamsNotesItem
ReturnsItem
ParamsNotes
Returns
view_notes
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
output
load_fontawesome_icon_map
Params
ReturnsItem
Returns
load_fontawesome_icon_system_map
Params
ReturnsItem
Returns
load_template
Params
load_template_with_dependencies
Params
Returns
ReturnsStringsItem
ReturnsTemplatesItem
ReturnsStrings
ReturnsTemplates
payment
get_available_gateways
Params
ReturnsItem
Returns
question
get_random_question_summaries
Params
Returns
ReturnsQuestionsItem
ReturnsQuestionsItemIcon
ParamsTagids
ReturnsQuestions
submit_tags_form
Params
Returns
update_flag
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
rating
add_rating
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_item_ratings
Params
Returns
ReturnsRatingsItem
ReturnsWarningsItem
ReturnsRatings
ReturnsWarnings
reportbuilder
audiences_delete
Params
columns_add
Params
Returns
ReturnsSortablecolumnsItem
ReturnsSortablecolumnsItemSorticon
ReturnsSortablecolumns
columns_delete
Params
Returns
ReturnsSortablecolumnsItem
ReturnsSortablecolumnsItemSorticon
ReturnsSortablecolumns
columns_reorder
Params
columns_sort_get
Params
Returns
ReturnsSortablecolumnsItem
ReturnsSortablecolumnsItemSorticon
ReturnsSortablecolumns
columns_sort_reorder
Params
Returns
ReturnsSortablecolumnsItem
ReturnsSortablecolumnsItemSorticon
ReturnsSortablecolumns
columns_sort_toggle
Params
Returns
ReturnsSortablecolumnsItem
ReturnsSortablecolumnsItemSorticon
ReturnsSortablecolumns
conditions_add
Params
Returns
ReturnsAvailableconditionsItem
ReturnsAvailableconditionsItemOptiongroup
ReturnsAvailableconditionsItemOptiongroupValuesItem
ReturnsAvailableconditions
ReturnsAvailableconditionsItemOptiongroupValues
conditions_delete
Params
Returns
ReturnsAvailableconditionsItem
ReturnsAvailableconditionsItemOptiongroup
ReturnsAvailableconditionsItemOptiongroupValuesItem
ReturnsAvailableconditions
ReturnsAvailableconditionsItemOptiongroupValues
conditions_reorder
Params
Returns
ReturnsAvailableconditionsItem
ReturnsAvailableconditionsItemOptiongroup
ReturnsAvailableconditionsItemOptiongroupValuesItem
ReturnsAvailableconditions
ReturnsAvailableconditionsItemOptiongroupValues
conditions_reset
Params
Returns
ReturnsAvailableconditionsItem
ReturnsAvailableconditionsItemOptiongroup
ReturnsAvailableconditionsItemOptiongroupValuesItem
ReturnsAvailableconditions
ReturnsAvailableconditionsItemOptiongroupValues
filters_add
Params
Returns
ReturnsActivefiltersItem
ReturnsAvailablefiltersItem
ReturnsAvailablefiltersItemOptiongroup
ReturnsAvailablefiltersItemOptiongroupValuesItem
ReturnsActivefilters
ReturnsAvailablefilters
ReturnsAvailablefiltersItemOptiongroupValues
filters_delete
Params
Returns
ReturnsActivefiltersItem
ReturnsAvailablefiltersItem
ReturnsAvailablefiltersItemOptiongroup
ReturnsAvailablefiltersItemOptiongroupValuesItem
ReturnsActivefilters
ReturnsAvailablefilters
ReturnsAvailablefiltersItemOptiongroupValues
filters_reorder
Params
Returns
ReturnsActivefiltersItem
ReturnsAvailablefiltersItem
ReturnsAvailablefiltersItemOptiongroup
ReturnsAvailablefiltersItemOptiongroupValuesItem
ReturnsActivefilters
ReturnsAvailablefilters
ReturnsAvailablefiltersItemOptiongroupValues
filters_reset
Params
list_reports
Params
Returns
ReturnsReportsItem
ReturnsReportsItemModifiedby
ReturnsWarningsItem
ReturnsReports
ReturnsWarnings
reports_delete
Params
reports_get
Params
Returns
ReturnsAttributesItem
ReturnsCardview
ReturnsConditions
ReturnsConditionsAvailableconditionsItem
ReturnsConditionsAvailableconditionsItemOptiongroup
ReturnsConditionsAvailableconditionsItemOptiongroupValuesItem
ReturnsFilters
ReturnsFiltersActivefiltersItem
ReturnsFiltersAvailablefiltersItem
ReturnsFiltersAvailablefiltersItemOptiongroup
ReturnsFiltersAvailablefiltersItemOptiongroupValuesItem
ReturnsSidebarmenucards
ReturnsSidebarmenucardsMenucardsItem
ReturnsSidebarmenucardsMenucardsItemItemsItem
ReturnsSorting
ReturnsSortingSortablecolumnsItem
ReturnsSortingSortablecolumnsItemSorticon
ReturnsAttributes
ReturnsConditionsAvailableconditions
ReturnsConditionsAvailableconditionsItemOptiongroupValues
ReturnsFiltersActivefilters
ReturnsFiltersAvailablefilters
ReturnsFiltersAvailablefiltersItemOptiongroupValues
ReturnsSidebarmenucardsMenucards
ReturnsSidebarmenucardsMenucardsItemItems
ReturnsSortingSortablecolumns
retrieve_report
Params
Returns
ReturnsData
ReturnsDataRowsItem
ReturnsDetails
ReturnsDetailsModifiedby
ReturnsWarningsItem
ReturnsDataHeaders
ReturnsDataRows
ReturnsDataRowsItemColumns
ReturnsWarnings
schedules_delete
Params
schedules_send
Params
schedules_toggle
Params
set_filters
Params
view_report
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
role
assign_roles
Params
ParamsAssignmentsItem
ParamsAssignments
unassign_roles
Params
ParamsUnassignmentsItem
ParamsUnassignments
search
get_relevant_users
Params
ReturnsItem
Returns
session
time_remaining
Params
Returns
touch
Params
table
get_dynamic_table_content
Params
ParamsFiltersItem
ParamsSortdataItem
Returns
ReturnsWarningsItem
ParamsFilters
ParamsFiltersItemValues
ParamsHiddencolumns
ParamsSortdata
ReturnsWarnings
tag
get_tag_areas
Params
Returns
ReturnsAreasItem
ReturnsWarningsItem
ReturnsAreas
ReturnsWarnings
get_tag_cloud
Params
Returns
ReturnsTagsItem
ReturnsWarningsItem
ReturnsTags
ReturnsWarnings
get_tag_collections
Params
Returns
ReturnsCollectionsItem
ReturnsWarningsItem
ReturnsCollections
ReturnsWarnings
get_tagindex
Params
ParamsTagindex
Returns
get_tagindex_per_area
Params
ParamsTagindex
ReturnsItem
Returns
get_tags
Params
ParamsTagsItem
Returns
ReturnsTagsItem
ReturnsWarningsItem
ParamsTags
ReturnsTags
ReturnsWarnings
update_tags
Params
ParamsTagsItem
Returns
ReturnsWarningsItem
ParamsTags
ReturnsWarnings
update
inplace_editable
Params
Returns
ReturnsEditicon
user
add_user_device
Params
ReturnsItemItem
Returns
ReturnsItem
add_user_private_files
Params
agree_site_policy
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
create_users
Params
ParamsUsersItem
ParamsUsersItemCustomfieldsItem
ParamsUsersItemPreferencesItem
ReturnsItem
ParamsUsers
ParamsUsersItemCustomfields
ParamsUsersItemPreferences
Returns
delete_users
Params
ParamsUserids
get_course_user_profiles
Params
ParamsUserlistItem
ReturnsItem
ReturnsItemCustomfieldsItem
ReturnsItemEnrolledcoursesItem
ReturnsItemGroupsItem
ReturnsItemPreferencesItem
ReturnsItemRolesItem
ParamsUserlist
Returns
ReturnsItemCustomfields
ReturnsItemEnrolledcourses
ReturnsItemGroups
ReturnsItemPreferences
ReturnsItemRoles
get_private_files_info
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_user_preferences
Params
Returns
ReturnsPreferencesItem
ReturnsWarningsItem
ReturnsPreferences
ReturnsWarnings
get_users
Params
ParamsCriteriaItem
Returns
ReturnsUsersItem
ReturnsUsersItemCustomfieldsItem
ReturnsUsersItemPreferencesItem
ReturnsWarningsItem
ParamsCriteria
ReturnsUsers
ReturnsUsersItemCustomfields
ReturnsUsersItemPreferences
ReturnsWarnings
get_users_by_field
Params
ReturnsItem
ReturnsItemCustomfieldsItem
ReturnsItemPreferencesItem
ParamsValues
Returns
ReturnsItemCustomfields
ReturnsItemPreferences
remove_user_device
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
search_identity
Params
Returns
ReturnsListItem
ReturnsListItemExtrafieldsItem
ReturnsList
ReturnsListItemExtrafields
set_user_preferences
Params
ParamsPreferencesItem
Returns
ReturnsSavedItem
ReturnsWarningsItem
ParamsPreferences
ReturnsSaved
ReturnsWarnings
update_picture
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
update_user_device_public_key
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
update_user_preferences
Params
ParamsPreferencesItem
ParamsPreferences
update_users
Params
ParamsUsersItem
ParamsUsersItemCustomfieldsItem
ParamsUsersItemPreferencesItem
Returns
ReturnsWarningsItem
ParamsUsers
ParamsUsersItemCustomfields
ParamsUsersItemPreferences
ReturnsWarnings
view_user_list
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
view_user_profile
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
webservice
get_site_info
Params
Returns
ReturnsAdvancedfeaturesItem
ReturnsFunctionsItem
ParamsServiceshortnames
ReturnsAdvancedfeatures
ReturnsFunctions
xapi
delete_state
Params
get_state
Params
get_states
Params
Returns
post_state
Params
statement_post
Params
Returns
enrol
guest
get_instance_info
Params
Returns
ReturnsInstanceinfo
ReturnsWarningsItem
ReturnsWarnings
manual
enrol_users
Params
ParamsEnrolmentsItem
ParamsEnrolments
unenrol_users
Params
ParamsEnrolmentsItem
ParamsEnrolments
meta
add_instances
Params
ParamsInstancesItem
ReturnsItem
ParamsInstances
Returns
delete_instances
Params
ParamsInstancesItem
ReturnsItem
ParamsInstances
Returns
self
enrol_user
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_instance_info
Params
Returns
gradereport
grader
get_users_in_report
Params
Returns
ReturnsUsersItem
ReturnsUsersItemCustomfieldsItem
ReturnsUsersItemPreferencesItem
ReturnsWarningsItem
ReturnsUsers
ReturnsUsersItemCustomfields
ReturnsUsersItemPreferences
ReturnsWarnings
overview
get_course_grades
Params
Returns
ReturnsGradesItem
ReturnsWarningsItem
ReturnsGrades
ReturnsWarnings
view_grade_report
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
singleview
get_grade_items_for_search_widget
Params
Returns
ReturnsGradeitemsItem
ReturnsWarningsItem
ReturnsGradeitems
ReturnsWarnings
user
get_access_information
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_grade_items
Params
Returns
ReturnsUsergradesItem
ReturnsUsergradesItemGradeitemsItem
ReturnsWarningsItem
ReturnsUsergrades
ReturnsUsergradesItemGradeitems
ReturnsWarnings
get_grades_table
Params
Returns
ReturnsTablesItem
ReturnsTablesItemTabledataItem
ReturnsTablesItemTabledataItemAverage
ReturnsTablesItemTabledataItemContributiontocoursetotal
ReturnsTablesItemTabledataItemFeedback
ReturnsTablesItemTabledataItemGrade
ReturnsTablesItemTabledataItemItemname
ReturnsTablesItemTabledataItemLeader
ReturnsTablesItemTabledataItemLettergrade
ReturnsTablesItemTabledataItemPercentage
ReturnsTablesItemTabledataItemRange
ReturnsTablesItemTabledataItemRank
ReturnsTablesItemTabledataItemWeight
ReturnsWarningsItem
ReturnsTables
ReturnsTablesItemTabledata
ReturnsTablesItemTabledataItemParentcategories
ReturnsWarnings
view_grade_report
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
gradingform
guide
grader_gradingpanel_fetch
Params
Returns
ReturnsGrade
ReturnsGradeCommentsItem
ReturnsGradeCriterionItem
ReturnsWarningsItem
ReturnsGradeComments
ReturnsGradeCriterion
ReturnsWarnings
grader_gradingpanel_store
Params
Returns
ReturnsGrade
ReturnsGradeCommentsItem
ReturnsGradeCriterionItem
ReturnsWarningsItem
ReturnsGradeComments
ReturnsGradeCriterion
ReturnsWarnings
rubric
grader_gradingpanel_fetch
Params
Returns
ReturnsGrade
ReturnsGradeCriteriaItem
ReturnsGradeCriteriaItemLevelsItem
ReturnsWarningsItem
ReturnsGradeCriteria
ReturnsGradeCriteriaItemLevels
ReturnsWarnings
grader_gradingpanel_store
Params
Returns
ReturnsGrade
ReturnsGradeCriteriaItem
ReturnsGradeCriteriaItemLevelsItem
ReturnsWarningsItem
ReturnsGradeCriteria
ReturnsGradeCriteriaItemLevels
ReturnsWarnings
media
videojs
get_language
Params
message
airnotifier
are_notification_preferences_configured
Params
Returns
ReturnsUsersItem
ReturnsWarningsItem
ParamsUserids
ReturnsUsers
ReturnsWarnings
enable_device
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_user_devices
Params
Returns
ReturnsDevicesItem
ReturnsWarningsItem
ReturnsDevices
ReturnsWarnings
is_system_configured
Params
popup
get_popup_notifications
Params
Returns
ReturnsNotificationsItem
ReturnsNotifications
get_unread_popup_notification_count
Params
mod
assign
copy_previous_attempt
Params
ReturnsItem
Returns
get_assignments
Params
Returns
ReturnsCoursesItem
ReturnsCoursesItemAssignmentsItem
ReturnsCoursesItemAssignmentsItemActivityattachmentsItem
ReturnsCoursesItemAssignmentsItemConfigsItem
ReturnsCoursesItemAssignmentsItemIntroattachmentsItem
ReturnsCoursesItemAssignmentsItemIntrofilesItem
ReturnsWarningsItem
ParamsCapabilities
ParamsCourseids
ReturnsCourses
ReturnsCoursesItemAssignments
ReturnsCoursesItemAssignmentsItemActivityattachments
ReturnsCoursesItemAssignmentsItemConfigs
ReturnsCoursesItemAssignmentsItemIntroattachments
ReturnsCoursesItemAssignmentsItemIntrofiles
ReturnsWarnings
get_grades
Params
Returns
ReturnsAssignmentsItem
ReturnsAssignmentsItemGradesItem
ReturnsWarningsItem
ParamsAssignmentids
ReturnsAssignments
ReturnsAssignmentsItemGrades
ReturnsWarnings
get_participant
Params
Returns
ReturnsUser
ReturnsUserCustomfieldsItem
ReturnsUserPreferencesItem
ReturnsUserCustomfields
ReturnsUserPreferences
get_submission_status
Params
Returns
ReturnsAssignmentdata
ReturnsAssignmentdataAttachments
ReturnsAssignmentdataAttachmentsActivityItem
ReturnsAssignmentdataAttachmentsIntroItem
ReturnsFeedback
ReturnsFeedbackGrade
ReturnsFeedbackPluginsItem
ReturnsFeedbackPluginsItemEditorfieldsItem
ReturnsFeedbackPluginsItemFileareasItem
ReturnsFeedbackPluginsItemFileareasItemFilesItem
ReturnsGradingsummary
ReturnsLastattempt
ReturnsLastattemptSubmission
ReturnsLastattemptSubmissionPluginsItem
ReturnsLastattemptSubmissionPluginsItemEditorfieldsItem
ReturnsLastattemptSubmissionPluginsItemFileareasItem
ReturnsLastattemptSubmissionPluginsItemFileareasItemFilesItem
ReturnsLastattemptTeamsubmission
ReturnsLastattemptTeamsubmissionPluginsItem
ReturnsLastattemptTeamsubmissionPluginsItemEditorfieldsItem
ReturnsLastattemptTeamsubmissionPluginsItemFileareasItem
ReturnsLastattemptTeamsubmissionPluginsItemFileareasItemFilesItem
ReturnsPreviousattemptsItem
ReturnsPreviousattemptsItemFeedbackpluginsItem
ReturnsPreviousattemptsItemFeedbackpluginsItemEditorfieldsItem
ReturnsPreviousattemptsItemFeedbackpluginsItemFileareasItem
ReturnsPreviousattemptsItemFeedbackpluginsItemFileareasItemFilesItem
ReturnsPreviousattemptsItemGrade
ReturnsPreviousattemptsItemSubmission
ReturnsPreviousattemptsItemSubmissionPluginsItem
ReturnsPreviousattemptsItemSubmissionPluginsItemEditorfieldsItem
ReturnsPreviousattemptsItemSubmissionPluginsItemFileareasItem
ReturnsPreviousattemptsItemSubmissionPluginsItemFileareasItemFilesItem
ReturnsWarningsItem
ReturnsAssignmentdataAttachmentsActivity
ReturnsAssignmentdataAttachmentsIntro
ReturnsFeedbackPlugins
ReturnsFeedbackPluginsItemEditorfields
ReturnsFeedbackPluginsItemFileareas
ReturnsFeedbackPluginsItemFileareasItemFiles
ReturnsLastattemptSubmissionPlugins
ReturnsLastattemptSubmissionPluginsItemEditorfields
ReturnsLastattemptSubmissionPluginsItemFileareas
ReturnsLastattemptSubmissionPluginsItemFileareasItemFiles
ReturnsLastattemptSubmissiongroupmemberswhoneedtosubmit
ReturnsLastattemptTeamsubmissionPlugins
ReturnsLastattemptTeamsubmissionPluginsItemEditorfields
ReturnsLastattemptTeamsubmissionPluginsItemFileareas
ReturnsLastattemptTeamsubmissionPluginsItemFileareasItemFiles
ReturnsLastattemptUsergroups
ReturnsPreviousattempts
ReturnsPreviousattemptsItemFeedbackplugins
ReturnsPreviousattemptsItemFeedbackpluginsItemEditorfields
ReturnsPreviousattemptsItemFeedbackpluginsItemFileareas
ReturnsPreviousattemptsItemFeedbackpluginsItemFileareasItemFiles
ReturnsPreviousattemptsItemSubmissionPlugins
ReturnsPreviousattemptsItemSubmissionPluginsItemEditorfields
ReturnsPreviousattemptsItemSubmissionPluginsItemFileareas
ReturnsPreviousattemptsItemSubmissionPluginsItemFileareasItemFiles
ReturnsWarnings
get_submissions
Params
Returns
ReturnsAssignmentsItem
ReturnsAssignmentsItemSubmissionsItem
ReturnsAssignmentsItemSubmissionsItemPluginsItem
ReturnsAssignmentsItemSubmissionsItemPluginsItemEditorfieldsItem
ReturnsAssignmentsItemSubmissionsItemPluginsItemFileareasItem
ReturnsAssignmentsItemSubmissionsItemPluginsItemFileareasItemFilesItem
ReturnsWarningsItem
ParamsAssignmentids
ReturnsAssignments
ReturnsAssignmentsItemSubmissions
ReturnsAssignmentsItemSubmissionsItemPlugins
ReturnsAssignmentsItemSubmissionsItemPluginsItemEditorfields
ReturnsAssignmentsItemSubmissionsItemPluginsItemFileareas
ReturnsAssignmentsItemSubmissionsItemPluginsItemFileareasItemFiles
ReturnsWarnings
get_user_flags
Params
Returns
ReturnsAssignmentsItem
ReturnsAssignmentsItemUserflagsItem
ReturnsWarningsItem
ParamsAssignmentids
ReturnsAssignments
ReturnsAssignmentsItemUserflags
ReturnsWarnings
get_user_mappings
Params
Returns
ReturnsAssignmentsItem
ReturnsAssignmentsItemMappingsItem
ReturnsWarningsItem
ParamsAssignmentids
ReturnsAssignments
ReturnsAssignmentsItemMappings
ReturnsWarnings
list_participants
Params
ReturnsItem
ReturnsItemCustomfieldsItem
ReturnsItemEnrolledcoursesItem
ReturnsItemGroupsItem
ReturnsItemPreferencesItem
ReturnsItemRolesItem
Returns
ReturnsItemCustomfields
ReturnsItemEnrolledcourses
ReturnsItemGroups
ReturnsItemPreferences
ReturnsItemRoles
lock_submissions
Params
ReturnsItem
ParamsUserids
Returns
reveal_identities
Params
ReturnsItem
Returns
revert_submissions_to_draft
Params
ReturnsItem
ParamsUserids
Returns
save_grade
Params
ParamsAdvancedgradingdata
ParamsAdvancedgradingdataGuide
ParamsAdvancedgradingdataGuideCriteriaItem
ParamsAdvancedgradingdataGuideCriteriaItemFillingsItem
ParamsAdvancedgradingdataRubric
ParamsAdvancedgradingdataRubricCriteriaItem
ParamsAdvancedgradingdataRubricCriteriaItemFillingsItem
ParamsPlugindata
ParamsPlugindataAssignfeedbackcommentsEditor
ParamsAdvancedgradingdataGuideCriteria
ParamsAdvancedgradingdataGuideCriteriaItemFillings
ParamsAdvancedgradingdataRubricCriteria
ParamsAdvancedgradingdataRubricCriteriaItemFillings
save_grades
Params
ParamsGradesItem
ParamsGradesItemAdvancedgradingdata
ParamsGradesItemAdvancedgradingdataGuide
ParamsGradesItemAdvancedgradingdataGuideCriteriaItem
ParamsGradesItemAdvancedgradingdataGuideCriteriaItemFillingsItem
ParamsGradesItemAdvancedgradingdataRubric
ParamsGradesItemAdvancedgradingdataRubricCriteriaItem
ParamsGradesItemAdvancedgradingdataRubricCriteriaItemFillingsItem
ParamsGradesItemPlugindata
ParamsGradesItemPlugindataAssignfeedbackcommentsEditor
ParamsGrades
ParamsGradesItemAdvancedgradingdataGuideCriteria
ParamsGradesItemAdvancedgradingdataGuideCriteriaItemFillings
ParamsGradesItemAdvancedgradingdataRubricCriteria
ParamsGradesItemAdvancedgradingdataRubricCriteriaItemFillings
save_submission
Params
ParamsPlugindata
ParamsPlugindataOnlinetextEditor
ReturnsItem
Returns
save_user_extensions
Params
ReturnsItem
ParamsDates
ParamsUserids
Returns
set_user_flags
Params
ParamsUserflagsItem
ReturnsItem
ParamsUserflags
Returns
start_submission
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
submit_for_grading
Params
ReturnsItem
Returns
submit_grading_form
Params
ReturnsItem
Returns
unlock_submissions
Params
ReturnsItem
ParamsUserids
Returns
view_assign
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
view_grading_table
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
view_submission_status
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
bigbluebuttonbn
can_join
Params
Returns
completion_validate
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
end_meeting
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_bigbluebuttonbns_by_courses
Params
Returns
ReturnsBigbluebuttonbnsItem
ReturnsBigbluebuttonbnsItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsBigbluebuttonbns
ReturnsBigbluebuttonbnsItemIntrofiles
ReturnsWarnings
get_join_url
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_recordings
Params
Returns
ReturnsTabledata
ReturnsTabledataColumnsItem
ReturnsWarningsItem
ReturnsTabledataColumns
ReturnsTabledataProfileFeatures
ReturnsWarnings
get_recordings_to_import
Params
Returns
ReturnsTabledata
ReturnsTabledataColumnsItem
ReturnsWarningsItem
ReturnsTabledataColumns
ReturnsTabledataProfileFeatures
ReturnsWarnings
meeting_info
Params
Returns
ReturnsFeaturesItem
ReturnsPresentationsItem
ReturnsFeatures
ReturnsPresentations
update_recording
Params
Returns
view_bigbluebuttonbn
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
book
get_books_by_courses
Params
Returns
ReturnsBooksItem
ReturnsBooksItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsBooks
ReturnsBooksItemIntrofiles
ReturnsWarnings
view_book
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
chat
get_chat_latest_messages
Params
Returns
ReturnsMessagesItem
ReturnsWarningsItem
ReturnsMessages
ReturnsWarnings
get_chat_users
Params
Returns
ReturnsUsersItem
ReturnsWarningsItem
ReturnsUsers
ReturnsWarnings
get_chats_by_courses
Params
Returns
ReturnsChatsItem
ReturnsChatsItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsChats
ReturnsChatsItemIntrofiles
ReturnsWarnings
get_session_messages
Params
Returns
ReturnsMessagesItem
ReturnsWarningsItem
ReturnsMessages
ReturnsWarnings
get_sessions
Params
Returns
ReturnsSessionsItem
ReturnsSessionsItemSessionusersItem
ReturnsWarningsItem
ReturnsSessions
ReturnsSessionsItemSessionusers
ReturnsWarnings
login_user
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
send_chat_message
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
view_chat
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
choice
delete_choice_responses
Params
Returns
ReturnsWarningsItem
ParamsResponses
ReturnsWarnings
get_choice_options
Params
Returns
ReturnsOptionsItem
ReturnsWarningsItem
ReturnsOptions
ReturnsWarnings
get_choice_results
Params
Returns
ReturnsOptionsItem
ReturnsOptionsItemUserresponsesItem
ReturnsWarningsItem
ReturnsOptions
ReturnsOptionsItemUserresponses
ReturnsWarnings
get_choices_by_courses
Params
Returns
ReturnsChoicesItem
ReturnsChoicesItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsChoices
ReturnsChoicesItemIntrofiles
ReturnsWarnings
submit_choice_response
Params
Returns
ReturnsAnswersItem
ReturnsWarningsItem
ParamsResponses
ReturnsAnswers
ReturnsWarnings
view_choice
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
data
add_entry
Params
ParamsDataItem
Returns
ReturnsFieldnotificationsItem
ReturnsWarningsItem
ParamsData
ReturnsFieldnotifications
ReturnsGeneralnotifications
ReturnsWarnings
approve_entry
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
delete_entry
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
delete_saved_preset
Params
Returns
ReturnsWarningsItem
ParamsPresetnames
ReturnsWarnings
get_data_access_information
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_databases_by_courses
Params
Returns
ReturnsDatabasesItem
ReturnsDatabasesItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsDatabases
ReturnsDatabasesItemIntrofiles
ReturnsWarnings
get_entries
Params
Returns
ReturnsEntriesItem
ReturnsEntriesItemContentsItem
ReturnsEntriesItemContentsItemFilesItem
ReturnsEntriesItemTagsItem
ReturnsWarningsItem
ReturnsEntries
ReturnsEntriesItemContents
ReturnsEntriesItemContentsItemFiles
ReturnsEntriesItemTags
ReturnsWarnings
get_entry
Params
Returns
ReturnsEntry
ReturnsEntryContentsItem
ReturnsEntryContentsItemFilesItem
ReturnsEntryTagsItem
ReturnsRatinginfo
ReturnsRatinginfoRatingsItem
ReturnsRatinginfoScalesItem
ReturnsRatinginfoScalesItemItemsItem
ReturnsWarningsItem
ReturnsEntryContents
ReturnsEntryContentsItemFiles
ReturnsEntryTags
ReturnsRatinginfoRatings
ReturnsRatinginfoScales
ReturnsRatinginfoScalesItemItems
ReturnsWarnings
get_fields
Params
Returns
ReturnsFieldsItem
ReturnsWarningsItem
ReturnsFields
ReturnsWarnings
get_mapping_information
Params
Returns
ReturnsData
ReturnsWarningsItem
ReturnsWarnings
search_entries
Params
ParamsAdvsearchItem
Returns
ReturnsEntriesItem
ReturnsEntriesItemContentsItem
ReturnsEntriesItemContentsItemFilesItem
ReturnsEntriesItemTagsItem
ReturnsWarningsItem
ParamsAdvsearch
ReturnsEntries
ReturnsEntriesItemContents
ReturnsEntriesItemContentsItemFiles
ReturnsEntriesItemTags
ReturnsWarnings
update_entry
Params
ParamsDataItem
Returns
ReturnsFieldnotificationsItem
ReturnsWarningsItem
ParamsData
ReturnsFieldnotifications
ReturnsGeneralnotifications
ReturnsWarnings
view_database
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
feedback
get_analysis
Params
Returns
ReturnsItemsdataItem
ReturnsItemsdataItemItem
ReturnsItemsdataItemItemItemfilesItem
ReturnsWarningsItem
ReturnsItemsdata
ReturnsItemsdataItemData
ReturnsItemsdataItemItemItemfiles
ReturnsWarnings
get_current_completed_tmp
Params
Returns
ReturnsFeedback
ReturnsWarningsItem
ReturnsWarnings
get_feedback_access_information
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_feedbacks_by_courses
Params
Returns
ReturnsFeedbacksItem
ReturnsFeedbacksItemIntrofilesItem
ReturnsFeedbacksItemPageaftersubmitfilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsFeedbacks
ReturnsFeedbacksItemIntrofiles
ReturnsFeedbacksItemPageaftersubmitfiles
ReturnsWarnings
get_finished_responses
Params
Returns
ReturnsResponsesItem
ReturnsWarningsItem
ReturnsResponses
ReturnsWarnings
get_items
Params
Returns
ReturnsItemsItem
ReturnsItemsItemItemfilesItem
ReturnsWarningsItem
ReturnsItems
ReturnsItemsItemItemfiles
ReturnsWarnings
get_last_completed
Params
Returns
ReturnsCompleted
ReturnsWarningsItem
ReturnsWarnings
get_non_respondents
Params
Returns
ReturnsUsersItem
ReturnsWarningsItem
ReturnsUsers
ReturnsWarnings
get_page_items
Params
Returns
ReturnsItemsItem
ReturnsItemsItemItemfilesItem
ReturnsWarningsItem
ReturnsItems
ReturnsItemsItemItemfiles
ReturnsWarnings
get_responses_analysis
Params
Returns
ReturnsAnonattemptsItem
ReturnsAnonattemptsItemResponsesItem
ReturnsAttemptsItem
ReturnsAttemptsItemResponsesItem
ReturnsWarningsItem
ReturnsAnonattempts
ReturnsAnonattemptsItemResponses
ReturnsAttempts
ReturnsAttemptsItemResponses
ReturnsWarnings
get_unfinished_responses
Params
Returns
ReturnsResponsesItem
ReturnsWarningsItem
ReturnsResponses
ReturnsWarnings
launch_feedback
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
process_page
Params
ParamsResponsesItem
Returns
ReturnsWarningsItem
ParamsResponses
ReturnsWarnings
view_feedback
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
folder
get_folders_by_courses
Params
Returns
ReturnsFoldersItem
ReturnsFoldersItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsFolders
ReturnsFoldersItemIntrofiles
ReturnsWarnings
view_folder
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
forum
add_discussion
Params
ParamsOptionsItem
Returns
ReturnsWarningsItem
ParamsOptions
ReturnsWarnings
add_discussion_post
Params
ParamsOptionsItem
Returns
ReturnsMessagesItem
ReturnsPost
ReturnsPostAttachmentsItem
ReturnsPostAttachmentsItemHtml
ReturnsPostAttachmentsItemUrls
ReturnsPostAuthor
ReturnsPostAuthorGroupsItem
ReturnsPostAuthorGroupsItemUrls
ReturnsPostAuthorUrls
ReturnsPostCapabilities
ReturnsPostHtml
ReturnsPostMessageinlinefilesItem
ReturnsPostTagsItem
ReturnsPostTagsItemUrls
ReturnsPostUrls
ReturnsWarningsItem
ParamsOptions
ReturnsMessages
ReturnsPostAttachments
ReturnsPostAuthorGroups
ReturnsPostMessageinlinefiles
ReturnsPostTags
ReturnsWarnings
can_add_discussion
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
delete_post
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_discussion_post
Params
Returns
ReturnsPost
ReturnsPostAttachmentsItem
ReturnsPostAttachmentsItemHtml
ReturnsPostAttachmentsItemUrls
ReturnsPostAuthor
ReturnsPostAuthorGroupsItem
ReturnsPostAuthorGroupsItemUrls
ReturnsPostAuthorUrls
ReturnsPostCapabilities
ReturnsPostHtml
ReturnsPostMessageinlinefilesItem
ReturnsPostTagsItem
ReturnsPostTagsItemUrls
ReturnsPostUrls
ReturnsWarningsItem
ReturnsPostAttachments
ReturnsPostAuthorGroups
ReturnsPostMessageinlinefiles
ReturnsPostTags
ReturnsWarnings
get_discussion_posts
Params
Returns
ReturnsPostsItem
ReturnsPostsItemAttachmentsItem
ReturnsPostsItemAttachmentsItemHtml
ReturnsPostsItemAttachmentsItemUrls
ReturnsPostsItemAuthor
ReturnsPostsItemAuthorGroupsItem
ReturnsPostsItemAuthorGroupsItemUrls
ReturnsPostsItemAuthorUrls
ReturnsPostsItemCapabilities
ReturnsPostsItemHtml
ReturnsPostsItemMessageinlinefilesItem
ReturnsPostsItemTagsItem
ReturnsPostsItemTagsItemUrls
ReturnsPostsItemUrls
ReturnsRatinginfo
ReturnsRatinginfoRatingsItem
ReturnsRatinginfoScalesItem
ReturnsRatinginfoScalesItemItemsItem
ReturnsWarningsItem
ReturnsPosts
ReturnsPostsItemAttachments
ReturnsPostsItemAuthorGroups
ReturnsPostsItemMessageinlinefiles
ReturnsPostsItemTags
ReturnsRatinginfoRatings
ReturnsRatinginfoScales
ReturnsRatinginfoScalesItemItems
ReturnsWarnings
get_discussion_posts_by_userid
Params
Returns
ReturnsDiscussionsItem
ReturnsDiscussionsItemPosts
ReturnsDiscussionsItemPostsParentpostsItem
ReturnsDiscussionsItemPostsParentpostsItemAttachmentsItem
ReturnsDiscussionsItemPostsParentpostsItemAttachmentsItemHtml
ReturnsDiscussionsItemPostsParentpostsItemAttachmentsItemUrls
ReturnsDiscussionsItemPostsParentpostsItemAuthor
ReturnsDiscussionsItemPostsParentpostsItemAuthorGroupsItem
ReturnsDiscussionsItemPostsParentpostsItemAuthorGroupsItemUrls
ReturnsDiscussionsItemPostsParentpostsItemAuthorUrls
ReturnsDiscussionsItemPostsParentpostsItemCapabilities
ReturnsDiscussionsItemPostsParentpostsItemHtml
ReturnsDiscussionsItemPostsParentpostsItemMessageinlinefilesItem
ReturnsDiscussionsItemPostsParentpostsItemTagsItem
ReturnsDiscussionsItemPostsParentpostsItemTagsItemUrls
ReturnsDiscussionsItemPostsParentpostsItemUrls
ReturnsDiscussionsItemPostsUserpostsItem
ReturnsDiscussionsItemPostsUserpostsItemAttachmentsItem
ReturnsDiscussionsItemPostsUserpostsItemAttachmentsItemHtml
ReturnsDiscussionsItemPostsUserpostsItemAttachmentsItemUrls
ReturnsDiscussionsItemPostsUserpostsItemAuthor
ReturnsDiscussionsItemPostsUserpostsItemAuthorGroupsItem
ReturnsDiscussionsItemPostsUserpostsItemAuthorGroupsItemUrls
ReturnsDiscussionsItemPostsUserpostsItemAuthorUrls
ReturnsDiscussionsItemPostsUserpostsItemCapabilities
ReturnsDiscussionsItemPostsUserpostsItemHtml
ReturnsDiscussionsItemPostsUserpostsItemMessageinlinefilesItem
ReturnsDiscussionsItemPostsUserpostsItemTagsItem
ReturnsDiscussionsItemPostsUserpostsItemTagsItemUrls
ReturnsDiscussionsItemPostsUserpostsItemUrls
ReturnsWarningsItem
ReturnsDiscussions
ReturnsDiscussionsItemPostsParentposts
ReturnsDiscussionsItemPostsParentpostsItemAttachments
ReturnsDiscussionsItemPostsParentpostsItemAuthorGroups
ReturnsDiscussionsItemPostsParentpostsItemMessageinlinefiles
ReturnsDiscussionsItemPostsParentpostsItemTags
ReturnsDiscussionsItemPostsUserposts
ReturnsDiscussionsItemPostsUserpostsItemAttachments
ReturnsDiscussionsItemPostsUserpostsItemAuthorGroups
ReturnsDiscussionsItemPostsUserpostsItemMessageinlinefiles
ReturnsDiscussionsItemPostsUserpostsItemTags
ReturnsWarnings
get_forum_access_information
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_forum_discussions
Params
Returns
ReturnsDiscussionsItem
ReturnsDiscussionsItemAttachmentsItem
ReturnsDiscussionsItemMessageinlinefilesItem
ReturnsWarningsItem
ReturnsDiscussions
ReturnsDiscussionsItemAttachments
ReturnsDiscussionsItemMessageinlinefiles
ReturnsWarnings
get_forum_discussions_paginated
Params
Returns
ReturnsDiscussionsItem
ReturnsDiscussionsItemAttachmentsItem
ReturnsDiscussionsItemMessageinlinefilesItem
ReturnsWarningsItem
ReturnsDiscussions
ReturnsDiscussionsItemAttachments
ReturnsDiscussionsItemMessageinlinefiles
ReturnsWarnings
get_forums_by_courses
Params
ReturnsItem
ReturnsItemIntrofilesItem
ParamsCourseids
Returns
ReturnsItemIntrofiles
prepare_draft_area_for_post
Params
ParamsFilestokeepItem
Returns
ReturnsAreaoptionsItem
ReturnsFilesItem
ReturnsWarningsItem
ParamsFilestokeep
ReturnsAreaoptions
ReturnsFiles
ReturnsWarnings
set_lock_state
Params
Returns
ReturnsTimes
set_pin_state
Params
Returns
ReturnsCapabilities
ReturnsGroup
ReturnsGroupUrls
ReturnsTimed
ReturnsTimes
ReturnsUrls
ReturnsUserstate
set_subscription_state
Params
Returns
ReturnsCapabilities
ReturnsGroup
ReturnsGroupUrls
ReturnsTimed
ReturnsTimes
ReturnsUrls
ReturnsUserstate
toggle_favourite_state
Params
Returns
ReturnsCapabilities
ReturnsGroup
ReturnsGroupUrls
ReturnsTimed
ReturnsTimes
ReturnsUrls
ReturnsUserstate
update_discussion_post
Params
ParamsOptionsItem
Returns
ReturnsWarningsItem
ParamsOptions
ReturnsWarnings
view_forum
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
view_forum_discussion
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
glossary
add_entry
Params
ParamsOptionsItem
Returns
ReturnsWarningsItem
ParamsOptions
ReturnsWarnings
delete_entry
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_authors
Params
ParamsOptions
Returns
ReturnsAuthorsItem
ReturnsWarningsItem
ReturnsAuthors
ReturnsWarnings
get_categories
Params
Returns
ReturnsCategoriesItem
ReturnsWarningsItem
ReturnsCategories
ReturnsWarnings
get_entries_by_author
Params
ParamsOptions
Returns
ReturnsEntriesItem
ReturnsEntriesItemAttachmentsItem
ReturnsEntriesItemDefinitioninlinefilesItem
ReturnsEntriesItemTagsItem
ReturnsRatinginfo
ReturnsRatinginfoRatingsItem
ReturnsRatinginfoScalesItem
ReturnsRatinginfoScalesItemItemsItem
ReturnsWarningsItem
ReturnsEntries
ReturnsEntriesItemAttachments
ReturnsEntriesItemDefinitioninlinefiles
ReturnsEntriesItemTags
ReturnsRatinginfoRatings
ReturnsRatinginfoScales
ReturnsRatinginfoScalesItemItems
ReturnsWarnings
get_entries_by_author_id
Params
ParamsOptions
Returns
ReturnsEntriesItem
ReturnsEntriesItemAttachmentsItem
ReturnsEntriesItemDefinitioninlinefilesItem
ReturnsEntriesItemTagsItem
ReturnsRatinginfo
ReturnsRatinginfoRatingsItem
ReturnsRatinginfoScalesItem
ReturnsRatinginfoScalesItemItemsItem
ReturnsWarningsItem
ReturnsEntries
ReturnsEntriesItemAttachments
ReturnsEntriesItemDefinitioninlinefiles
ReturnsEntriesItemTags
ReturnsRatinginfoRatings
ReturnsRatinginfoScales
ReturnsRatinginfoScalesItemItems
ReturnsWarnings
get_entries_by_category
Params
ParamsOptions
Returns
ReturnsEntriesItem
ReturnsEntriesItemAttachmentsItem
ReturnsEntriesItemDefinitioninlinefilesItem
ReturnsEntriesItemTagsItem
ReturnsRatinginfo
ReturnsRatinginfoRatingsItem
ReturnsRatinginfoScalesItem
ReturnsRatinginfoScalesItemItemsItem
ReturnsWarningsItem
ReturnsEntries
ReturnsEntriesItemAttachments
ReturnsEntriesItemDefinitioninlinefiles
ReturnsEntriesItemTags
ReturnsRatinginfoRatings
ReturnsRatinginfoScales
ReturnsRatinginfoScalesItemItems
ReturnsWarnings
get_entries_by_date
Params
ParamsOptions
Returns
ReturnsEntriesItem
ReturnsEntriesItemAttachmentsItem
ReturnsEntriesItemDefinitioninlinefilesItem
ReturnsEntriesItemTagsItem
ReturnsRatinginfo
ReturnsRatinginfoRatingsItem
ReturnsRatinginfoScalesItem
ReturnsRatinginfoScalesItemItemsItem
ReturnsWarningsItem
ReturnsEntries
ReturnsEntriesItemAttachments
ReturnsEntriesItemDefinitioninlinefiles
ReturnsEntriesItemTags
ReturnsRatinginfoRatings
ReturnsRatinginfoScales
ReturnsRatinginfoScalesItemItems
ReturnsWarnings
get_entries_by_letter
Params
ParamsOptions
Returns
ReturnsEntriesItem
ReturnsEntriesItemAttachmentsItem
ReturnsEntriesItemDefinitioninlinefilesItem
ReturnsEntriesItemTagsItem
ReturnsRatinginfo
ReturnsRatinginfoRatingsItem
ReturnsRatinginfoScalesItem
ReturnsRatinginfoScalesItemItemsItem
ReturnsWarningsItem
ReturnsEntries
ReturnsEntriesItemAttachments
ReturnsEntriesItemDefinitioninlinefiles
ReturnsEntriesItemTags
ReturnsRatinginfoRatings
ReturnsRatinginfoScales
ReturnsRatinginfoScalesItemItems
ReturnsWarnings
get_entries_by_search
Params
ParamsOptions
Returns
ReturnsEntriesItem
ReturnsEntriesItemAttachmentsItem
ReturnsEntriesItemDefinitioninlinefilesItem
ReturnsEntriesItemTagsItem
ReturnsRatinginfo
ReturnsRatinginfoRatingsItem
ReturnsRatinginfoScalesItem
ReturnsRatinginfoScalesItemItemsItem
ReturnsWarningsItem
ReturnsEntries
ReturnsEntriesItemAttachments
ReturnsEntriesItemDefinitioninlinefiles
ReturnsEntriesItemTags
ReturnsRatinginfoRatings
ReturnsRatinginfoScales
ReturnsRatinginfoScalesItemItems
ReturnsWarnings
get_entries_by_term
Params
ParamsOptions
Returns
ReturnsEntriesItem
ReturnsEntriesItemAttachmentsItem
ReturnsEntriesItemDefinitioninlinefilesItem
ReturnsEntriesItemTagsItem
ReturnsRatinginfo
ReturnsRatinginfoRatingsItem
ReturnsRatinginfoScalesItem
ReturnsRatinginfoScalesItemItemsItem
ReturnsWarningsItem
ReturnsEntries
ReturnsEntriesItemAttachments
ReturnsEntriesItemDefinitioninlinefiles
ReturnsEntriesItemTags
ReturnsRatinginfoRatings
ReturnsRatinginfoScales
ReturnsRatinginfoScalesItemItems
ReturnsWarnings
get_entries_to_approve
Params
ParamsOptions
Returns
ReturnsEntriesItem
ReturnsEntriesItemAttachmentsItem
ReturnsEntriesItemDefinitioninlinefilesItem
ReturnsEntriesItemTagsItem
ReturnsRatinginfo
ReturnsRatinginfoRatingsItem
ReturnsRatinginfoScalesItem
ReturnsRatinginfoScalesItemItemsItem
ReturnsWarningsItem
ReturnsEntries
ReturnsEntriesItemAttachments
ReturnsEntriesItemDefinitioninlinefiles
ReturnsEntriesItemTags
ReturnsRatinginfoRatings
ReturnsRatinginfoScales
ReturnsRatinginfoScalesItemItems
ReturnsWarnings
get_entry_by_id
Params
Returns
ReturnsEntry
ReturnsEntryAttachmentsItem
ReturnsEntryDefinitioninlinefilesItem
ReturnsEntryTagsItem
ReturnsPermissions
ReturnsRatinginfo
ReturnsRatinginfoRatingsItem
ReturnsRatinginfoScalesItem
ReturnsRatinginfoScalesItemItemsItem
ReturnsWarningsItem
ReturnsEntryAttachments
ReturnsEntryDefinitioninlinefiles
ReturnsEntryTags
ReturnsRatinginfoRatings
ReturnsRatinginfoScales
ReturnsRatinginfoScalesItemItems
ReturnsWarnings
get_glossaries_by_courses
Params
Returns
ReturnsGlossariesItem
ReturnsGlossariesItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsGlossaries
ReturnsGlossariesItemBrowsemodes
ReturnsGlossariesItemIntrofiles
ReturnsWarnings
prepare_entry_for_edition
Params
Returns
ReturnsAreasItem
ReturnsAreasItemOptionsItem
ReturnsWarningsItem
ReturnsAliases
ReturnsAreas
ReturnsAreasItemOptions
ReturnsCategories
ReturnsWarnings
update_entry
Params
ParamsOptionsItem
Returns
ReturnsWarningsItem
ParamsOptions
ReturnsWarnings
view_entry
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
view_glossary
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
h5pactivity
get_attempts
Params
Returns
ReturnsUsersattemptsItem
ReturnsUsersattemptsItemAttemptsItem
ReturnsUsersattemptsItemScored
ReturnsUsersattemptsItemScoredAttemptsItem
ReturnsWarningsItem
ParamsUserids
ReturnsUsersattempts
ReturnsUsersattemptsItemAttempts
ReturnsUsersattemptsItemScoredAttempts
ReturnsWarnings
get_h5pactivities_by_courses
Params
Returns
ReturnsH5pactivitiesItem
ReturnsH5pactivitiesItemDeployedfile
ReturnsH5pactivitiesItemIntrofilesItem
ReturnsH5pactivitiesItemPackageItem
ReturnsH5pglobalsettings
ReturnsWarningsItem
ParamsCourseids
ReturnsH5pactivities
ReturnsH5pactivitiesItemIntrofiles
ReturnsH5pactivitiesItemPackage
ReturnsWarnings
get_h5pactivity_access_information
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_results
Params
Returns
ReturnsAttemptsItem
ReturnsAttemptsItemResultsItem
ReturnsAttemptsItemResultsItemOptionsItem
ReturnsAttemptsItemResultsItemOptionsItemCorrectanswer
ReturnsAttemptsItemResultsItemOptionsItemUseranswer
ReturnsWarningsItem
ParamsAttemptids
ReturnsAttempts
ReturnsAttemptsItemResults
ReturnsAttemptsItemResultsItemOptions
ReturnsWarnings
get_user_attempts
Params
Returns
ReturnsUsersattemptsItem
ReturnsUsersattemptsItemAttemptsItem
ReturnsUsersattemptsItemScored
ReturnsUsersattemptsItemScoredAttemptsItem
ReturnsWarningsItem
ReturnsUsersattempts
ReturnsUsersattemptsItemAttempts
ReturnsUsersattemptsItemScoredAttempts
ReturnsWarnings
log_report_viewed
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
view_h5pactivity
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
imscp
get_imscps_by_courses
Params
Returns
ReturnsImscpsItem
ReturnsImscpsItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsImscps
ReturnsImscpsItemIntrofiles
ReturnsWarnings
view_imscp
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
label
get_labels_by_courses
Params
Returns
ReturnsLabelsItem
ReturnsLabelsItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsLabels
ReturnsLabelsItemIntrofiles
ReturnsWarnings
lesson
finish_attempt
Params
Returns
ReturnsDataItem
ReturnsMessagesItem
ReturnsWarningsItem
ReturnsData
ReturnsMessages
ReturnsWarnings
get_attempts_overview
Params
Returns
ReturnsData
ReturnsDataStudentsItem
ReturnsDataStudentsItemAttemptsItem
ReturnsWarningsItem
ReturnsDataStudents
ReturnsDataStudentsItemAttempts
ReturnsWarnings
get_content_pages_viewed
Params
Returns
ReturnsPagesItem
ReturnsWarningsItem
ReturnsPages
ReturnsWarnings
get_lesson
Params
Returns
ReturnsLesson
ReturnsLessonIntrofilesItem
ReturnsLessonMediafilesItem
ReturnsWarningsItem
ReturnsLessonIntrofiles
ReturnsLessonMediafiles
ReturnsWarnings
get_lesson_access_information
Params
Returns
ReturnsPreventaccessreasonsItem
ReturnsWarningsItem
ReturnsPreventaccessreasons
ReturnsWarnings
get_lessons_by_courses
Params
Returns
ReturnsLessonsItem
ReturnsLessonsItemIntrofilesItem
ReturnsLessonsItemMediafilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsLessons
ReturnsLessonsItemIntrofiles
ReturnsLessonsItemMediafiles
ReturnsWarnings
get_page_data
Params
Returns
ReturnsAnswersItem
ReturnsAnswersItemAnswerfilesItem
ReturnsAnswersItemResponsefilesItem
ReturnsContentfilesItem
ReturnsMessagesItem
ReturnsPage
ReturnsWarningsItem
ReturnsAnswers
ReturnsAnswersItemAnswerfiles
ReturnsAnswersItemResponsefiles
ReturnsContentfiles
ReturnsMessages
ReturnsWarnings
get_pages
Params
Returns
ReturnsPagesItem
ReturnsPagesItemPage
ReturnsWarningsItem
ReturnsPages
ReturnsPagesItemAnswerids
ReturnsPagesItemJumps
ReturnsWarnings
get_pages_possible_jumps
Params
Returns
ReturnsJumpsItem
ReturnsWarningsItem
ReturnsJumps
ReturnsWarnings
get_questions_attempts
Params
Returns
ReturnsAttemptsItem
ReturnsWarningsItem
ReturnsAttempts
ReturnsWarnings
get_user_attempt
Params
Returns
ReturnsAnswerpagesItem
ReturnsAnswerpagesItemAnswerdata
ReturnsAnswerpagesItemPage
ReturnsUserstats
ReturnsUserstatsGradeinfo
ReturnsWarningsItem
ReturnsAnswerpages
ReturnsAnswerpagesItemAnswerdataAnswers
ReturnsAnswerpagesItemAnswerdataAnswersItem
ReturnsWarnings
get_user_attempt_grade
Params
Returns
ReturnsGrade
ReturnsWarningsItem
ReturnsWarnings
get_user_grade
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_user_timers
Params
Returns
ReturnsTimersItem
ReturnsWarningsItem
ReturnsTimers
ReturnsWarnings
launch_attempt
Params
Returns
ReturnsMessagesItem
ReturnsWarningsItem
ReturnsMessages
ReturnsWarnings
process_page
Params
ParamsDataItem
Returns
ReturnsMessagesItem
ReturnsWarningsItem
ParamsData
ReturnsMessages
ReturnsWarnings
view_lesson
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
lti
create_tool_proxy
Params
Returns
ParamsCapabilityoffered
ParamsServiceoffered
create_tool_type
Params
Returns
ReturnsState
ReturnsUrls
ReturnsCapabilitygroups
ReturnsInstanceids
delete_tool_proxy
Params
Returns
delete_tool_type
Params
Returns
get_ltis_by_courses
Params
Returns
ReturnsLtisItem
ReturnsLtisItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsLtis
ReturnsLtisItemIntrofiles
ReturnsWarnings
get_tool_launch_data
Params
Returns
ReturnsParametersItem
ReturnsWarningsItem
ReturnsParameters
ReturnsWarnings
get_tool_proxies
Params
ReturnsItem
Returns
get_tool_proxy_registration_request
Params
Returns
get_tool_types
Params
ReturnsItem
ReturnsItemState
ReturnsItemUrls
Returns
ReturnsItemCapabilitygroups
ReturnsItemInstanceids
get_tool_types_and_proxies
Params
Returns
ReturnsProxiesItem
ReturnsTypesItem
ReturnsTypesItemState
ReturnsTypesItemUrls
ReturnsProxies
ReturnsTypes
ReturnsTypesItemCapabilitygroups
ReturnsTypesItemInstanceids
get_tool_types_and_proxies_count
Params
Returns
is_cartridge
Params
Returns
update_tool_type
Params
Returns
ReturnsState
ReturnsUrls
ReturnsCapabilitygroups
ReturnsInstanceids
view_lti
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
page
get_pages_by_courses
Params
Returns
ReturnsPagesItem
ReturnsPagesItemContentfilesItem
ReturnsPagesItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsPages
ReturnsPagesItemContentfiles
ReturnsPagesItemIntrofiles
ReturnsWarnings
view_page
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
quiz
get_attempt_access_information
Params
Returns
ReturnsWarningsItem
ReturnsPreventnewattemptreasons
ReturnsWarnings
get_attempt_data
Params
ParamsPreflightdataItem
Returns
ReturnsAttempt
ReturnsQuestionsItem
ReturnsQuestionsItemResponsefileareasItem
ReturnsQuestionsItemResponsefileareasItemFilesItem
ReturnsWarningsItem
ParamsPreflightdata
ReturnsMessages
ReturnsQuestions
ReturnsQuestionsItemResponsefileareas
ReturnsQuestionsItemResponsefileareasItemFiles
ReturnsWarnings
get_attempt_review
Params
Returns
ReturnsAdditionaldataItem
ReturnsAttempt
ReturnsQuestionsItem
ReturnsQuestionsItemResponsefileareasItem
ReturnsQuestionsItemResponsefileareasItemFilesItem
ReturnsWarningsItem
ReturnsAdditionaldata
ReturnsQuestions
ReturnsQuestionsItemResponsefileareas
ReturnsQuestionsItemResponsefileareasItemFiles
ReturnsWarnings
get_attempt_summary
Params
ParamsPreflightdataItem
Returns
ReturnsQuestionsItem
ReturnsQuestionsItemResponsefileareasItem
ReturnsQuestionsItemResponsefileareasItemFilesItem
ReturnsWarningsItem
ParamsPreflightdata
ReturnsQuestions
ReturnsQuestionsItemResponsefileareas
ReturnsQuestionsItemResponsefileareasItemFiles
ReturnsWarnings
get_combined_review_options
Params
Returns
ReturnsAlloptionsItem
ReturnsSomeoptionsItem
ReturnsWarningsItem
ReturnsAlloptions
ReturnsSomeoptions
ReturnsWarnings
get_quiz_access_information
Params
Returns
ReturnsWarningsItem
ReturnsAccessrules
ReturnsActiverulenames
ReturnsPreventaccessreasons
ReturnsWarnings
get_quiz_feedback_for_grade
Params
Returns
ReturnsFeedbackinlinefilesItem
ReturnsWarningsItem
ReturnsFeedbackinlinefiles
ReturnsWarnings
get_quiz_required_qtypes
Params
Returns
ReturnsWarningsItem
ReturnsQuestiontypes
ReturnsWarnings
get_quizzes_by_courses
Params
Returns
ReturnsQuizzesItem
ReturnsQuizzesItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsQuizzes
ReturnsQuizzesItemIntrofiles
ReturnsWarnings
get_reopen_attempt_confirmation
Params
get_user_attempts
Params
Returns
ReturnsAttemptsItem
ReturnsWarningsItem
ReturnsAttempts
ReturnsWarnings
get_user_best_grade
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
process_attempt
Params
ParamsDataItem
ParamsPreflightdataItem
Returns
ReturnsWarningsItem
ParamsData
ParamsPreflightdata
ReturnsWarnings
reopen_attempt
Params
save_attempt
Params
ParamsDataItem
ParamsPreflightdataItem
Returns
ReturnsWarningsItem
ParamsData
ParamsPreflightdata
ReturnsWarnings
set_question_version
Params
Returns
start_attempt
Params
ParamsPreflightdataItem
Returns
ReturnsAttempt
ReturnsWarningsItem
ParamsPreflightdata
ReturnsWarnings
view_attempt
Params
ParamsPreflightdataItem
Returns
ReturnsWarningsItem
ParamsPreflightdata
ReturnsWarnings
view_attempt_review
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
view_attempt_summary
Params
ParamsPreflightdataItem
Returns
ReturnsWarningsItem
ParamsPreflightdata
ReturnsWarnings
view_quiz
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
resource
get_resources_by_courses
Params
Returns
ReturnsResourcesItem
ReturnsResourcesItemContentfilesItem
ReturnsResourcesItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsResources
ReturnsResourcesItemContentfiles
ReturnsResourcesItemIntrofiles
ReturnsWarnings
view_resource
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
scorm
get_scorm_access_information
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_scorm_attempt_count
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_scorm_sco_tracks
Params
Returns
ReturnsData
ReturnsDataTracksItem
ReturnsWarningsItem
ReturnsDataTracks
ReturnsWarnings
get_scorm_scoes
Params
Returns
ReturnsScoesItem
ReturnsScoesItemExtradataItem
ReturnsWarningsItem
ReturnsScoes
ReturnsScoesItemExtradata
ReturnsWarnings
get_scorm_user_data
Params
Returns
ReturnsDataItem
ReturnsDataItemDefaultdataItem
ReturnsDataItemUserdataItem
ReturnsWarningsItem
ReturnsData
ReturnsDataItemDefaultdata
ReturnsDataItemUserdata
ReturnsWarnings
get_scorms_by_courses
Params
Returns
ReturnsScormsItem
ReturnsScormsItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsScorms
ReturnsScormsItemIntrofiles
ReturnsWarnings
insert_scorm_tracks
Params
ParamsTracksItem
Returns
ReturnsWarningsItem
ParamsTracks
ReturnsTrackids
ReturnsWarnings
launch_sco
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
view_scorm
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
survey
get_questions
Params
Returns
ReturnsQuestionsItem
ReturnsWarningsItem
ReturnsQuestions
ReturnsWarnings
get_surveys_by_courses
Params
Returns
ReturnsSurveysItem
ReturnsSurveysItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsSurveys
ReturnsSurveysItemIntrofiles
ReturnsWarnings
submit_answers
Params
ParamsAnswersItem
Returns
ReturnsWarningsItem
ParamsAnswers
ReturnsWarnings
view_survey
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
url
get_urls_by_courses
Params
Returns
ReturnsUrlsItem
ReturnsUrlsItemIntrofilesItem
ReturnsWarningsItem
ParamsCourseids
ReturnsUrls
ReturnsUrlsItemIntrofiles
ReturnsWarnings
view_url
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
wiki
edit_page
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_page_contents
Params
Returns
ReturnsPage
ReturnsPageTagsItem
ReturnsWarningsItem
ReturnsPageTags
ReturnsWarnings
get_page_for_editing
Params
Returns
ReturnsPagesection
ReturnsPagesectionWarningsItem
ReturnsPagesectionWarnings
get_subwiki_files
Params
Returns
ReturnsFilesItem
ReturnsWarningsItem
ReturnsFiles
ReturnsWarnings
get_subwiki_pages
Params
ParamsOptions
Returns
ReturnsPagesItem
ReturnsPagesItemTagsItem
ReturnsWarningsItem
ReturnsPages
ReturnsPagesItemTags
ReturnsWarnings
get_subwikis
Params
Returns
ReturnsSubwikisItem
ReturnsWarningsItem
ReturnsSubwikis
ReturnsWarnings
get_wikis_by_courses
Params
Returns
ReturnsWarningsItem
ReturnsWikisItem
ReturnsWikisItemIntrofilesItem
ParamsCourseids
ReturnsWarnings
ReturnsWikis
ReturnsWikisItemIntrofiles
new_page
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
view_page
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
view_wiki
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
workshop
add_submission
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
delete_submission
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
evaluate_assessment
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
evaluate_submission
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_assessment
Params
Returns
ReturnsAssessment
ReturnsAssessmentFeedbackattachmentfilesItem
ReturnsAssessmentFeedbackcontentfilesItem
ReturnsWarningsItem
ReturnsAssessmentFeedbackattachmentfiles
ReturnsAssessmentFeedbackcontentfiles
ReturnsWarnings
get_assessment_form_definition
Params
Returns
ReturnsCurrentItem
ReturnsDescriptionfilesItem
ReturnsDimensionsinfoItem
ReturnsFieldsItem
ReturnsOptionsItem
ReturnsWarningsItem
ReturnsCurrent
ReturnsDescriptionfiles
ReturnsDimensionsinfo
ReturnsFields
ReturnsOptions
ReturnsWarnings
get_grades
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_grades_report
Params
Returns
ReturnsReport
ReturnsReportGradesItem
ReturnsReportGradesItemReviewedbyItem
ReturnsReportGradesItemReviewerofItem
ReturnsWarningsItem
ReturnsReportGrades
ReturnsReportGradesItemReviewedby
ReturnsReportGradesItemReviewerof
ReturnsWarnings
get_reviewer_assessments
Params
Returns
ReturnsAssessmentsItem
ReturnsAssessmentsItemFeedbackattachmentfilesItem
ReturnsAssessmentsItemFeedbackcontentfilesItem
ReturnsWarningsItem
ReturnsAssessments
ReturnsAssessmentsItemFeedbackattachmentfiles
ReturnsAssessmentsItemFeedbackcontentfiles
ReturnsWarnings
get_submission
Params
Returns
ReturnsSubmission
ReturnsSubmissionAttachmentfilesItem
ReturnsSubmissionContentfilesItem
ReturnsWarningsItem
ReturnsSubmissionAttachmentfiles
ReturnsSubmissionContentfiles
ReturnsWarnings
get_submission_assessments
Params
Returns
ReturnsAssessmentsItem
ReturnsAssessmentsItemFeedbackattachmentfilesItem
ReturnsAssessmentsItemFeedbackcontentfilesItem
ReturnsWarningsItem
ReturnsAssessments
ReturnsAssessmentsItemFeedbackattachmentfiles
ReturnsAssessmentsItemFeedbackcontentfiles
ReturnsWarnings
get_submissions
Params
Returns
ReturnsSubmissionsItem
ReturnsSubmissionsItemAttachmentfilesItem
ReturnsSubmissionsItemContentfilesItem
ReturnsWarningsItem
ReturnsSubmissions
ReturnsSubmissionsItemAttachmentfiles
ReturnsSubmissionsItemContentfiles
ReturnsWarnings
get_user_plan
Params
Returns
ReturnsUserplan
ReturnsUserplanExamplesItem
ReturnsUserplanPhasesItem
ReturnsUserplanPhasesItemActionsItem
ReturnsUserplanPhasesItemTasksItem
ReturnsWarningsItem
ReturnsUserplanExamples
ReturnsUserplanPhases
ReturnsUserplanPhasesItemActions
ReturnsUserplanPhasesItemTasks
ReturnsWarnings
get_workshop_access_information
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_workshops_by_courses
Params
Returns
ReturnsWarningsItem
ReturnsWorkshopsItem
ReturnsWorkshopsItemConclusionfilesItem
ReturnsWorkshopsItemInstructauthorsfilesItem
ReturnsWorkshopsItemInstructreviewersfilesItem
ReturnsWorkshopsItemIntrofilesItem
ParamsCourseids
ReturnsWarnings
ReturnsWorkshops
ReturnsWorkshopsItemConclusionfiles
ReturnsWorkshopsItemInstructauthorsfiles
ReturnsWorkshopsItemInstructreviewersfiles
ReturnsWorkshopsItemIntrofiles
update_assessment
Params
ParamsDataItem
Returns
ReturnsWarningsItem
ParamsData
ReturnsWarnings
update_submission
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
view_submission
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
view_workshop
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
paygw
paypal
create_transaction_complete
Params
Returns
get_config_for_js
Params
Returns
qbank
columnsortorder
set_columnbank_order
Params
ParamsColumns
editquestion
set_status
Params
Returns
tagquestion
submit_tags_form
Params
Returns
quizaccess
seb
validate_quiz_keys
Params
Returns
report
competency
data_for_report
Params
Returns
ReturnsCourse
ReturnsUser
ReturnsUsercompetenciesItem
ReturnsUsercompetenciesItemCompetency
ReturnsUsercompetenciesItemCompetencyCompetency
ReturnsUsercompetenciesItemCompetencyComppath
ReturnsUsercompetenciesItemCompetencyComppathAncestorsItem
ReturnsUsercompetenciesItemCompetencyComppathFramework
ReturnsUsercompetenciesItemCompetencyFramework
ReturnsUsercompetenciesItemCompetencyLinkedcoursesItem
ReturnsUsercompetenciesItemCompetencyRelatedcompetenciesItem
ReturnsUsercompetenciesItemUsercompetencycourse
ReturnsUsercompetencies
ReturnsUsercompetenciesItemCompetencyComppathAncestors
ReturnsUsercompetenciesItemCompetencyLinkedcourses
ReturnsUsercompetenciesItemCompetencyRelatedcompetencies
insights
action_executed
Params
Returns
ReturnsWarningsItem
ParamsPredictionids
ReturnsWarnings
set_fixed_prediction
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
set_notuseful_prediction
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
tiny
autosave
reset_session
Params
Returns
resume_session
Params
Returns
update_session
Params
Returns
equation
filter
Params
Returns
tool
analytics
potential_contexts
Params
ReturnsItem
Returns
behat
get_entity_generator
Params
Returns
ReturnsRequired
dataprivacy
approve_data_request
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
bulk_approve_data_requests
Params
Returns
ReturnsWarningsItem
ParamsRequestids
ReturnsWarnings
bulk_deny_data_requests
Params
Returns
ReturnsWarningsItem
ParamsRequestids
ReturnsWarnings
cancel_data_request
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
confirm_contexts_for_deletion
Params
Returns
ReturnsWarningsItem
ParamsIds
ReturnsWarnings
contact_dpo
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
create_category_form
Params
Returns
ReturnsCategory
ReturnsWarningsItem
ReturnsWarnings
create_purpose_form
Params
Returns
ReturnsPurpose
ReturnsPurposeFormattedlawfulbasesItem
ReturnsPurposeFormattedsensitivedatareasonsItem
ReturnsWarningsItem
ReturnsPurposeFormattedlawfulbases
ReturnsPurposeFormattedsensitivedatareasons
ReturnsWarnings
delete_category
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
delete_purpose
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
deny_data_request
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_activity_options
Params
Returns
ReturnsOptionsItem
ReturnsWarningsItem
ReturnsOptions
ReturnsWarnings
get_category_options
Params
Returns
ReturnsOptionsItem
ReturnsWarningsItem
ReturnsOptions
ReturnsWarnings
get_data_request
Params
Returns
ReturnsResult
ReturnsResultDpouser
ReturnsResultForuser
ReturnsResultRequestedbyuser
ReturnsWarningsItem
ReturnsWarnings
get_purpose_options
Params
Returns
ReturnsOptionsItem
ReturnsWarningsItem
ReturnsOptions
ReturnsWarnings
get_users
Params
ReturnsItem
ReturnsItemExtrafieldsItem
Returns
ReturnsItemExtrafields
mark_complete
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
set_context_defaults
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
set_context_form
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
set_contextlevel_form
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
tree_extra_branches
Params
Returns
ReturnsBranchesItem
ReturnsBranchesItemBranchesItem
ReturnsWarningsItem
ReturnsBranches
ReturnsBranchesItemBranches
ReturnsBranchesItemBranchesItemBranches
ReturnsWarnings
lp
data_for_competencies_manage_page
Params
Returns
ReturnsFramework
data_for_competency_frameworks_manage_page
Params
ParamsPagecontext
Returns
ReturnsCompetencyframeworksItem
ReturnsCompetencyframeworks
ReturnsNavigation
data_for_competency_summary
Params
Returns
ReturnsCompetency
ReturnsComppath
ReturnsComppathAncestorsItem
ReturnsComppathFramework
ReturnsFramework
ReturnsLinkedcoursesItem
ReturnsRelatedcompetenciesItem
ReturnsComppathAncestors
ReturnsLinkedcourses
ReturnsRelatedcompetencies
data_for_course_competencies_page
Params
Returns
ReturnsCompetenciesItem
ReturnsCompetenciesItemCompetency
ReturnsCompetenciesItemComppath
ReturnsCompetenciesItemComppathAncestorsItem
ReturnsCompetenciesItemComppathFramework
ReturnsCompetenciesItemCoursecompetency
ReturnsCompetenciesItemCoursemodulesItem
ReturnsCompetenciesItemPlansItem
ReturnsCompetenciesItemPlansItemCommentarea
ReturnsCompetenciesItemPlansItemReviewer
ReturnsCompetenciesItemPlansItemTemplate
ReturnsCompetenciesItemRuleoutcomeoptionsItem
ReturnsCompetenciesItemUsercompetencycourse
ReturnsSettings
ReturnsStatistics
ReturnsStatisticsLeastproficientItem
ReturnsCompetencies
ReturnsCompetenciesItemComppathAncestors
ReturnsCompetenciesItemCoursemodules
ReturnsCompetenciesItemPlans
ReturnsCompetenciesItemRuleoutcomeoptions
ReturnsStatisticsLeastproficient
data_for_plan_page
Params
Returns
ReturnsCompetenciesItem
ReturnsCompetenciesItemCompetency
ReturnsCompetenciesItemComppath
ReturnsCompetenciesItemComppathAncestorsItem
ReturnsCompetenciesItemComppathFramework
ReturnsCompetenciesItemUsercompetency
ReturnsCompetenciesItemUsercompetencyReviewer
ReturnsCompetenciesItemUsercompetencyplan
ReturnsPlan
ReturnsPlanCommentarea
ReturnsPlanReviewer
ReturnsPlanTemplate
ReturnsCompetencies
ReturnsCompetenciesItemComppathAncestors
data_for_plans_page
Params
Returns
ReturnsPlansItem
ReturnsPlansItemCommentarea
ReturnsPlansItemReviewer
ReturnsPlansItemTemplate
ReturnsNavigation
ReturnsPlans
data_for_related_competencies_section
Params
Returns
ReturnsRelatedcompetenciesItem
ReturnsRelatedcompetencies
data_for_template_competencies_page
Params
ParamsPagecontext
Returns
ReturnsCompetenciesItem
ReturnsCompetenciesItemCompetency
ReturnsCompetenciesItemComppath
ReturnsCompetenciesItemComppathAncestorsItem
ReturnsCompetenciesItemComppathFramework
ReturnsCompetenciesItemFramework
ReturnsCompetenciesItemLinkedcoursesItem
ReturnsCompetenciesItemRelatedcompetenciesItem
ReturnsStatistics
ReturnsStatisticsLeastproficientItem
ReturnsTemplate
ReturnsCompetencies
ReturnsCompetenciesItemComppathAncestors
ReturnsCompetenciesItemLinkedcourses
ReturnsCompetenciesItemRelatedcompetencies
ReturnsStatisticsLeastproficient
data_for_templates_manage_page
Params
ParamsPagecontext
Returns
ReturnsTemplatesItem
ReturnsNavigation
ReturnsTemplates
data_for_user_competency_summary
Params
Returns
ReturnsCommentarea
ReturnsCompetency
ReturnsCompetencyCompetency
ReturnsCompetencyComppath
ReturnsCompetencyComppathAncestorsItem
ReturnsCompetencyComppathFramework
ReturnsCompetencyFramework
ReturnsCompetencyLinkedcoursesItem
ReturnsCompetencyRelatedcompetenciesItem
ReturnsEvidenceItem
ReturnsEvidenceItemActionuser
ReturnsUser
ReturnsUsercompetency
ReturnsUsercompetencyReviewer
ReturnsUsercompetencycourse
ReturnsUsercompetencyplan
ReturnsCompetencyComppathAncestors
ReturnsCompetencyLinkedcourses
ReturnsCompetencyRelatedcompetencies
ReturnsEvidence
data_for_user_competency_summary_in_course
Params
Returns
ReturnsCourse
ReturnsCoursemodulesItem
ReturnsPlansItem
ReturnsPlansItemCommentarea
ReturnsPlansItemReviewer
ReturnsPlansItemTemplate
ReturnsUsercompetencysummary
ReturnsUsercompetencysummaryCommentarea
ReturnsUsercompetencysummaryCompetency
ReturnsUsercompetencysummaryCompetencyCompetency
ReturnsUsercompetencysummaryCompetencyComppath
ReturnsUsercompetencysummaryCompetencyComppathAncestorsItem
ReturnsUsercompetencysummaryCompetencyComppathFramework
ReturnsUsercompetencysummaryCompetencyFramework
ReturnsUsercompetencysummaryCompetencyLinkedcoursesItem
ReturnsUsercompetencysummaryCompetencyRelatedcompetenciesItem
ReturnsUsercompetencysummaryEvidenceItem
ReturnsUsercompetencysummaryEvidenceItemActionuser
ReturnsUsercompetencysummaryUser
ReturnsUsercompetencysummaryUsercompetency
ReturnsUsercompetencysummaryUsercompetencyReviewer
ReturnsUsercompetencysummaryUsercompetencycourse
ReturnsUsercompetencysummaryUsercompetencyplan
ReturnsCoursemodules
ReturnsPlans
ReturnsUsercompetencysummaryCompetencyComppathAncestors
ReturnsUsercompetencysummaryCompetencyLinkedcourses
ReturnsUsercompetencysummaryCompetencyRelatedcompetencies
ReturnsUsercompetencysummaryEvidence
data_for_user_competency_summary_in_plan
Params
Returns
ReturnsPlan
ReturnsPlanCommentarea
ReturnsPlanReviewer
ReturnsPlanTemplate
ReturnsUsercompetencysummary
ReturnsUsercompetencysummaryCommentarea
ReturnsUsercompetencysummaryCompetency
ReturnsUsercompetencysummaryCompetencyCompetency
ReturnsUsercompetencysummaryCompetencyComppath
ReturnsUsercompetencysummaryCompetencyComppathAncestorsItem
ReturnsUsercompetencysummaryCompetencyComppathFramework
ReturnsUsercompetencysummaryCompetencyFramework
ReturnsUsercompetencysummaryCompetencyLinkedcoursesItem
ReturnsUsercompetencysummaryCompetencyRelatedcompetenciesItem
ReturnsUsercompetencysummaryEvidenceItem
ReturnsUsercompetencysummaryEvidenceItemActionuser
ReturnsUsercompetencysummaryUser
ReturnsUsercompetencysummaryUsercompetency
ReturnsUsercompetencysummaryUsercompetencyReviewer
ReturnsUsercompetencysummaryUsercompetencycourse
ReturnsUsercompetencysummaryUsercompetencyplan
ReturnsUsercompetencysummaryCompetencyComppathAncestors
ReturnsUsercompetencysummaryCompetencyLinkedcourses
ReturnsUsercompetencysummaryCompetencyRelatedcompetencies
ReturnsUsercompetencysummaryEvidence
data_for_user_evidence_list_page
Params
Returns
ReturnsEvidenceItem
ReturnsEvidenceItemFilesItem
ReturnsEvidenceItemUsercompetenciesItem
ReturnsEvidenceItemUsercompetenciesItemCompetency
ReturnsEvidenceItemUsercompetenciesItemUsercompetency
ReturnsEvidenceItemUsercompetenciesItemUsercompetencyReviewer
ReturnsEvidence
ReturnsEvidenceItemFiles
ReturnsEvidenceItemUsercompetencies
ReturnsNavigation
data_for_user_evidence_page
Params
Returns
ReturnsUserevidence
ReturnsUserevidenceFilesItem
ReturnsUserevidenceUsercompetenciesItem
ReturnsUserevidenceUsercompetenciesItemCompetency
ReturnsUserevidenceUsercompetenciesItemUsercompetency
ReturnsUserevidenceUsercompetenciesItemUsercompetencyReviewer
ReturnsUserevidenceFiles
ReturnsUserevidenceUsercompetencies
list_courses_using_competency
Params
ReturnsItem
Returns
search_cohorts
Params
ParamsContext
Returns
ReturnsCohortsItem
ReturnsCohortsItemCustomfieldsItem
ReturnsCohorts
ReturnsCohortsItemCustomfields
search_users
Params
Returns
ReturnsUsersItem
ReturnsUsers
mobile
call_external_functions
Params
ParamsRequestsItem
Returns
ReturnsResponsesItem
ParamsRequests
ReturnsResponses
get_autologin_key
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
get_config
Params
Returns
ReturnsSettingsItem
ReturnsWarningsItem
ReturnsSettings
ReturnsWarnings
get_content
Params
ParamsArgsItem
Returns
ReturnsFilesItem
ReturnsOtherdataItem
ReturnsRestrict
ReturnsTemplatesItem
ParamsArgs
ReturnsFiles
ReturnsOtherdata
ReturnsRestrictCourses
ReturnsRestrictUsers
ReturnsTemplates
get_plugins_supporting_mobile
Params
Returns
ReturnsPluginsItem
ReturnsWarningsItem
ReturnsPlugins
ReturnsPluginsItemDependencies
ReturnsWarnings
get_public_config
Params
Returns
ReturnsIdentityprovidersItem
ReturnsWarningsItem
ReturnsIdentityproviders
ReturnsWarnings
get_tokens_for_qr_login
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
validate_subscription_key
Params
Returns
ReturnsWarningsItem
ReturnsWarnings
moodlenet
search_courses
Params
Returns
ReturnsCoursesItem
ReturnsCourses
verify_webfinger
Params
Returns
policy
get_policy_version
Params
Returns
ReturnsResult
ReturnsResultPolicy
ReturnsWarningsItem
ReturnsWarnings
submit_accept_on_behalf
Params
templatelibrary
list_templates
Params
Returns
load_canonical_template
Params
usertours
complete_tour
Params
Returns
fetch_and_start_tour
Params
Returns
ReturnsTourconfig
ReturnsTourconfigStepsItem
ReturnsTourconfigSteps
reset_tour
Params
Returns
step_shown
Params
Returns
xmldb
invoke_move_action
Params
FunctionDefinition
MoodleClient
pkg
flatten
login
Generated using
TypeDoc
True on success