Workplace Web services: Difference between revisions
m (Typos) |
m (Changed area content to more meaningful values) |
||
Line 11: | Line 11: | ||
!Description | !Description | ||
|- | |- | ||
| | |Appointment module | ||
|mod_appointment_* | |mod_appointment_* | ||
|Handling of sessions and booking in the Appointment activity | |Handling of sessions and booking in the Appointment activity | ||
|- | |- | ||
| | |Certificates | ||
|tool_certificate_* | |tool_certificate_* | ||
|Handling of certificate elements and templates as well as certificate issuing | |Handling of certificate elements and templates as well as certificate issuing | ||
|- | |- | ||
| | |Certifications | ||
|tool_certification_* | |tool_certification_* | ||
|Handling of certificate users, dates, and allocations | |Handling of certificate users, dates, and allocations | ||
|- | |- | ||
| | |Dynamic rules | ||
|tool_dynamicrule_* | |tool_dynamicrule_* | ||
|Handling of dynamic rules, actions, and conditions | |Handling of dynamic rules, actions, and conditions | ||
|- | |- | ||
| | |Organisations | ||
|tool_organisation_ | |tool_organisation_ | ||
|Handling of departments, positions, jobs, and managers | |Handling of departments, positions, jobs, and managers | ||
|- | |- | ||
| | |Programs | ||
|tool_program_* | |tool_program_* | ||
|Handling of program users, dates, and allocations | |Handling of program users, dates, and allocations | ||
|- | |- | ||
| | |Report builder | ||
|tool_reportbuilder_ | |tool_reportbuilder_ | ||
|Handling of all report details, columns, filters, conditions, orders, audiences, and schedules | |Handling of all report details, columns, filters, conditions, orders, audiences, and schedules | ||
|- | |- | ||
| | |Tenants | ||
|tool_tenant_* | |tool_tenant_* | ||
|Handling of tenants, tenant users, and shared space | |Handling of tenants, tenant users, and shared space | ||
|- | |- | ||
| | |Migrations | ||
|tool_wp_* | |tool_wp_* | ||
|Handling of migration import and export. See also dedicated docs on [[Migration Web services|Migration web services]]. | |Handling of migration import and export. See also dedicated docs on [[Migration Web services|Migration web services]]. |
Latest revision as of 07:44, 10 February 2022
Configuring and handling of web services in Moodle Workplace is identical to Moodle, that is the same protocols and naming conventions are supported. The only difference between Moodle and Moodle Workplace is that Moodle Workplace supports significantly more web services and functions.
There is detailed documentation on how to create and enable web services in Moodle, which is a pre-requisite for using Moodle Workplace web services. Furthermore, there is thorough documentation covering all topics on web services development in Moodle.
A number of new areas have been created to group Moodle Workplace-specific web services:
Area | Names | Description |
---|---|---|
Appointment module | mod_appointment_* | Handling of sessions and booking in the Appointment activity |
Certificates | tool_certificate_* | Handling of certificate elements and templates as well as certificate issuing |
Certifications | tool_certification_* | Handling of certificate users, dates, and allocations |
Dynamic rules | tool_dynamicrule_* | Handling of dynamic rules, actions, and conditions |
Organisations | tool_organisation_ | Handling of departments, positions, jobs, and managers |
Programs | tool_program_* | Handling of program users, dates, and allocations |
Report builder | tool_reportbuilder_ | Handling of all report details, columns, filters, conditions, orders, audiences, and schedules |
Tenants | tool_tenant_* | Handling of tenants, tenant users, and shared space |
Migrations | tool_wp_* | Handling of migration import and export. See also dedicated docs on Migration web services. |
Details on each web service is available in the API documentation at Site administration > Plugins > Web services > API documentation.