academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Event-series → Create event series

AI-generated

Summary

Create an academyFIVE event series by sending its event attributes, recurrence settings, schedule, and planning details to the API.

Inputs

  • data.type — Optional event series type.
  • data.attributes.allDay — Whether the events last all day; defaults to false. When true, the API sets the start and end times to 00:00:00 and 23:59:00.
  • data.attributes.startTime, endTime — Event start and end times.
  • data.attributes.recurrenceType, calculationChoice, endDate, recurrenceCount, weekDays — Optional recurrence settings: type, calculation choice, last date, occurrence count, and one or more weekdays.
  • data.attributes.courseId, courseLectureSeriesId, courseLectureSeriesPartId, examId, examPartId, title — Optional course, lecture series, exam, or title associations.
  • data.attributes.planningStatusId (required) — ID of a planning status configured in academyFIVE.
  • data.attributes.customId — Optional custom ID.
  • data.attributes.customEventTypeId (required) — ID of a custom event type configured in academyFIVE.
  • data.attributes.startDate (required) — First date of the event series.
  • data.attributes.siteId (required) — Site ID.
  • data.attributes.roomIds, lecturerIds, planningGroupIds — Optional lists of IDs for rooms, lecturers, and planning groups configured in academyFIVE.
  • data.attributes.comment, comment2 — Optional free-text comments.
  • data.attributes.planningYear (required) — Year in which the event series starts.
  • data.attributes.planningTerm — Optional term code: 11–14 for first through fourth quarter, 2 for summer semester, or 1 for winter semester.
  • data.attributes.teachingUnits — Optional amount of teaching units for the event.
  • data.attributes.includeVacation, includeHolidays, includeWorkingPeriods (required) — Whether to generate events during vacations, holidays, and working periods; each defaults to false.
  • data.attributes.linkLabel, link — Optional link label and link for the event series.

Output shape

A list of JSON items returned by the API, paired with their corresponding input items.

With Continue On Fail enabled, failed input items produce an item containing an error message. The operation sends JSON using the configured academyFIVE API credentials.

Links

Discussion