MDL-63522 course: Return more fields in get_course_content WS
[moodle.git] / course / upgrade.txt
CommitLineData
9df9f1f0
JL
1This files describes API changes in /course/*,
2information provided here is intended especially for developers.
3
a487a3ed
DK
4=== 3.6 ===
5
1206a487 6 * External function core_course_external::get_course_public_information now returns the roles and the primary role of course
a487a3ed 7 contacts.
1206a487
JL
8 * External function core_course_external::get_course_contents now return the following additional file fields:
9 - onclick (onclick javascript action code)
10 - afterlink (after link info to be displayed)
11 - customdata (module custom data (JSON encoded))
a487a3ed 12
8c52eb2a 13=== 3.5 ===
a487a3ed 14
7afa724c 15 * There is a new capability 'moodle/course:setforcedlanguage' to control which users can force the course
8c52eb2a 16 language; create_course and update_course functions delegate access control to the caller code; if you
7afa724c 17 are calling those functions you may be interested in checking if the logged in user has 'moodle/course:setforcedlanguage' capability.
8c52eb2a 18
e45fc71e
JL
19=== 3.3 ===
20
21 * External function core_course_external::get_courses_by_field now returns the course filters list and status.
ef83fc2a 22 * External function core_course_external::get_courses_by_field now returns the end date of the course.
dbc404de
JL
23 * External function core_course_external::get_course_contents now return the following additional file fields:
24 - mimetype (the file mime type)
25 - isexternalfile (if is a file reference to a external repository)
26 - repositorytype (the repository name in case is a external file)
27 Those fields are VALUE_OPTIONAL for backwards compatibility.
935429e2
JL
28 * External function core_course_external::get_course_contents now return the following fields for section and modules:
29 - uservisible (whether the section or module is visible by the user)
30 - availabilityinfo (availability information if the course or module has any access restriction set
e45fc71e 31
9df9f1f0
JL
32=== 3.2 ===
33
34 * External function core_course_external::get_course_contents now returns the section's number in the course (new section field).
82f5802a 35 * External function core_course_external::get_course_contents now returns if a section is hidden in the course format.
14590070
JL
36 * External functions that were returning file information now return the following file fields:
37 filename, filepath, mimetype, filesize, timemodified and fileurl.
38 Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
4f2378d9
FM
39 * The modchooser now uses a renderable and a template, thus its associated renderer
40 methods have been deprecated. Note that the call to core_course_render::course_modchooser,
41 is still required. Deprecated methods:
42 - core_course_renderer::course_modchooser_module_types
43 - core_course_renderer::course_modchooser_module
44 - core_course_renderer::course_modchooser_title
8643c576
DM
45 * You can now specify a course end date when calling core_course_external::create_courses and core_course_external::update_courses
46 external functions. core_course_external::get_courses external function is now returning courses end date values.