academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Working-periods → Create working period

AI-generated

Summary

Create a working period in academyFIVE for the specified year, term, dates, and bookability, and associate it with a cohort.

Inputs

  • data.type (required) — Type of working-period resource.
  • data.attributes.year (required) — Year of the working period.
  • data.attributes.term (required) — Term of the working period.
  • data.attributes.periodName (required) — Name of the working period.
  • data.attributes.periodStartDate (required) — Start date in YYYY-MM-DD format.
  • data.attributes.periodEndDate (required) — End date in YYYY-MM-DD format.
  • data.attributes.bookable (required) — Whether the working period is bookable; defaults to false.
  • data.relationships.cohorts.data.type (required) — Type of the related cohort resource.
  • data.relationships.cohorts.data.id (required) — ID of the cohort to associate with the working period.

Output shape

A list of JSON items from the API response.

The node sends the configured values in an authenticated JSON API request. Each returned item is paired with its input item; with Continue On Fail enabled, a failed request produces an item containing an error message.

Links

Discussion