academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Lecturer-contract-employments [Beta] → Create a new lecturer contract employment

AI-generated

Summary

Creates a lecturer contract employment by sending the supplied data and relationships to the academyFIVE API. Use it to associate an employment period and teaching load with a lecturer contract and employment status.

Inputs

  • data.type (required) — Resource type sent in the request body.
  • data.attributes.teachingUnits (required) — Teaching units for the employment.
  • data.attributes.startDate (required) — Employment start date.
  • data.attributes.endDate (required) — Employment end date.
  • data.attributes.occupationTypeId (required) — Occupation type ID: 1 for Internal or 2 for External.
  • data.attributes.capacity — Optional capacity value.
  • data.attributes.workingDays — Optional working days, using ISO 8601 numbering (1=Monday through 7=Sunday). This is available only when Teaching load PRO is active.
  • data.relationships.lecturerContract.data.type (required) — Type of the related lecturer contract resource.
  • data.relationships.lecturerContract.data.id (required) — ID of the lecturer contract.
  • data.relationships.lecturerContractEmploymentStatus.data.type (required) — Type of the related employment status resource.
  • data.relationships.lecturerContractEmploymentStatus.data.id (required) — ID of the employment status, found in academyFIVE under Settings → Lecturer contracts → Status values employments.

Output shape

A list of JSON items returned by the API.

Each response item is paired with its corresponding input item. If Continue On Fail is enabled, a failed input produces an item with an error field.

Links

Discussion