academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Lecturer-roles → Update a lecturer role

AI-generated

Summary

Update an existing lecturer role by specifying its ID, type, and optional attributes, modifying properties such as labels, permissions, and transfer settings within the academyFIVE system.

Inputs

  • data (required) — An object containing the lecturer role details to update, including the required fields 'id' (the unique identifier of the lecturer role) and 'type', and a nested 'attributes' collection with optional fields.
  • data.attributes.labelDe — German label for the lecturer role.
  • data.attributes.labelEn — English label for the lecturer role.
  • data.attributes.mayEditCourseBundleContent — Flag indicating if a lecturer in this role may edit content in the CourseBundle, subject to CampusWEB settings.
  • data.attributes.isShownInCourseBundle — Flag indicating if a lecturer in this role is visible in the CourseBundle.
  • data.attributes.courseBundleLabelSource — Source label used for displaying the lecturer in the CourseBundle.
  • data.attributes.isTransferredToExam — Flag indicating if a lecturer in this role is transferred into the exam.
  • data.attributes.transfersTeachingLoad — Flag indicating if teaching units are transferred to the lecturer's teaching load or contract.
  • data.attributes.mayRecordAttendance — Flag indicating if a lecturer in this role may record attendance.
  • data.attributes.isTransferredToAppointmentsAsLecturer — Flag indicating if a lecturer in this role is transferred into appointments as a lecturer.
  • data.attributes.isTransferredToAppointmentsAsParticipant — Flag indicating if a lecturer in this role is transferred into appointments as a participant.
  • data.attributes.mayMessageParticipants — Flag indicating if a lecturer in this role may message participants.

Output shape

a list of JSON objects representing the updated lecturer role data returned by the academyFIVE API

The output is returned as standard JSON data. If the API response indicates an error and 'Continue On Fail' is enabled, the output item will contain an error message. Otherwise, an exception is thrown on failure.

Examples

Example 1: Update a lecturer role's labels and permissions

Provide 'id' and 'type' along with optional 'attributes' such as 'labelEn', 'mayEditCourseBundleContent', and 'mayRecordAttendance' to modify the role.

Links

Discussion