academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Event-series → Create custom event series with event dates

AI-generated

Summary

Creates an academyFIVE custom event series with its event dates by sending the configured values in an authenticated API request. Choose the required planning status, custom event type, site, and starting planning year; add date entries and any applicable course, exam, room, lecturer, or planning details.

Inputs

  • data — Optional request data collection containing a type and attributes. Attributes can include eventDates, each with a date, times or all-day setting, teaching units, planning status, custom event type, title, comments, link, and room, lecturer, planning group, or assessor IDs. The UI describes eventDates as a multiple-value collection with a minimum of one and maximum of one.
  • courseId — ID of the course associated with the event series.
  • courseLectureSeriesId — ID of the associated course lecture series.
  • courseLectureSeriesPartId — ID of the associated course lecture series part.
  • teachingUnits — Amount of teaching units for the event series.
  • title — Event series title.
  • examId — ID of the associated exam.
  • examPartId — ID of the associated exam part.
  • planningStatusId (required) — ID of a planning status configured in academyFIVE.
  • customEventTypeId (required) — ID of a custom event type configured in academyFIVE.
  • siteId (required) — Site ID.
  • roomIds — IDs of rooms configured in academyFIVE.
  • lecturerIds — IDs of lecturer profiles.
  • planningGroupIds — IDs of planning groups configured in academyFIVE.
  • planningYear (required) — Year in which the event series starts.
  • planningTerm — Planning term: first through fourth quarter (11–14), summer semester (2), or winter semester (1).
  • link — Free-text link.
  • linkLabel — Label for the link.
  • customId — Custom ID for external reference.

Output shape

One or more JSON items from the API response, paired with their corresponding input item.

The operation sends the request for each input item. If Continue On Fail is enabled, a failed item returns JSON containing an error message.

Links

Discussion