Fuxam API v4

Terms, modules, curricula, cohorts, study programs, and continuing education.

Terms

Institution-wide academic terms (semesters). Used by curriculum version term mappings and cohort scheduling. Distinct from curriculum version terms under /curricula/.../versions/.../terms. Alias: /terms and /terms/{id} expose the same operations as /organization-terms and /organization-terms/{id}. Idempotency: POST create keys are stored under /organization-terms regardless of which path you call — replays via /terms or /organization-terms return the same cached response.

• GET
  List organization terms/organization-terms
• POST
  Create an organization term/organization-terms
• GET
  Get an organization term/organization-terms/{id}
• PATCH
  Update an organization term/organization-terms/{id}
• DELETE
  Delete an organization term/organization-terms/{id}
• GET
  List organization terms (alias)/terms
• POST
  Create an organization term (alias)/terms
• GET
  Get an organization term (alias)/terms/{id}
• PATCH
  Update an organization term (alias)/terms/{id}
• DELETE
  Delete an organization term (alias)/terms/{id}

Modules

Course modules and their versions (create, read, update, archive). List responses include summary fields; use GET by ID for full detail.

• GET
  List modules/modules
• POST
  Create a module/modules
• GET
  Get a module/modules/{id}
• PATCH
  Update a module/modules/{id}
• DELETE
  Delete a module/modules/{id}
• PATCH
  Archive or unarchive a module/modules/{id}/archive
• GET
  List versions of a module/modules/{id}/versions
• POST
  Create a module version/modules/{id}/versions
• GET
  Get a module version/modules/{id}/versions/{versionId}
• PATCH
  Update a module version/modules/{id}/versions/{versionId}
• DELETE
  Delete a module version/modules/{id}/versions/{versionId}
• POST
  Duplicate a module version/modules/{id}/versions/{versionId}/duplicate
• GET
  List Submodules for a Module version/modules/{id}/versions/{versionId}/submodules
• POST
  Add a Submodule to a Module version/modules/{id}/versions/{versionId}/submodules
• DELETE
  Remove a Submodule from a Module version/modules/{id}/versions/{versionId}/submodules/{connectionId}

Module groups

Groups of module versions. Optional moduleIds on create/update attach modules by resolving each module’s default version.

• GET
  List module groups/module-groups
• POST
  Create a module group/module-groups
• GET
  Get a module group/module-groups/{id}
• PATCH
  Update a module group/module-groups/{id}
• DELETE
  Delete a module group/module-groups/{id}

Curricula

Curricula and versions: curriculum CRUD, version management, study terms, module slots (items), elective pathways, and parent-child module placement within a version. Optional moduleIds on create/update attach modules to the default version. Elective clusters (elective-clusters) are deferred to a future release (v4.0 out of scope).

• GET
  List curricula/curricula
• POST
  Create a curriculum/curricula
• GET
  Get a curriculum/curricula/{id}
• PATCH
  Update a curriculum/curricula/{id}
• DELETE
  Delete a curriculum/curricula/{id}
• PATCH
  Archive or unarchive a curriculum/curricula/{id}/archive
• GET
  List curricula versions/curricula/{id}/versions
• POST
  Create a curricula version/curricula/{id}/versions
• GET
  Get a curricula version/curricula/{id}/versions/{versionId}
• PATCH
  Update a curricula version/curricula/{id}/versions/{versionId}
• DELETE
  Delete a curricula version/curricula/{id}/versions/{versionId}
• GET
  List terms in a curricula version/curricula/{id}/versions/{versionId}/terms
• POST
  Create a term in a curricula version/curricula/{id}/versions/{versionId}/terms
• PATCH
  Update a term in a curricula version/curricula/{id}/versions/{versionId}/terms/{termId}
• DELETE
  Delete a term from a curricula version/curricula/{id}/versions/{versionId}/terms/{termId}
• GET
  List pathways in a curricula version/curricula/{id}/versions/{versionId}/pathways
• POST
  Create a pathway in a curricula version/curricula/{id}/versions/{versionId}/pathways
• PATCH
  Update a pathway in a curricula version/curricula/{id}/versions/{versionId}/pathways/{pathwayId}
• DELETE
  Delete a pathway from a curricula version/curricula/{id}/versions/{versionId}/pathways/{pathwayId}
• GET
  List curricula version items (module slots)/curricula/{id}/versions/{versionId}/items
• POST
  Attach module slot(s) to a curricula version/curricula/{id}/versions/{versionId}/items
• GET
  Get a curricula version item/curricula/{id}/versions/{versionId}/items/{itemId}
• DELETE
  Delete a curricula version item/curricula/{id}/versions/{versionId}/items/{itemId}
• PUT
  Set parent item for a module slot/curricula/{id}/versions/{versionId}/items/{itemId}/parent
• DELETE
  Remove parent from a module slot/curricula/{id}/versions/{versionId}/items/{itemId}/parent

Cohorts

Top-level cohort collection for study programs and continuing education programs. Filter by studyProgramId or studyProgramVersionId. Manage cohort CRUD and member enrollment.

• GET
  List cohorts/cohorts
• POST
  Create a cohort/cohorts
• GET
  Get a cohort/cohorts/{id}
• PATCH
  Update a cohort/cohorts/{id}
• DELETE
  Delete a cohort/cohorts/{id}
• GET
  List cohort members/cohorts/{id}/members
• POST
  Add members to a cohort/cohorts/{id}/members
• DELETE
  Remove a member from a cohort/cohorts/{id}/members/{userId}

Study programs

Study programs (Bachelor, Master, etc.) including versions, connected curricula, and responsible users. Use GET /cohorts?studyProgramId={id} or GET /cohorts?studyProgramVersionId={versionId} for cohorts.

• GET
  List study programs/study-programs
• POST
  Create a study program/study-programs
• GET
  Get a study program/study-programs/{id}
• PATCH
  Update a study program/study-programs/{id}
• DELETE
  Delete a study program/study-programs/{id}
• GET
  List study program versions/study-programs/{id}/versions
• POST
  Create a study program version/study-programs/{id}/versions
• GET
  Get a study program version/study-programs/{id}/versions/{versionId}
• PATCH
  Update a study program version/study-programs/{id}/versions/{versionId}
• DELETE
  Delete a study program version/study-programs/{id}/versions/{versionId}

Continuing education

Continuing education programs (type=CONTINUING_EDUCATION) — same capabilities as study programs: CRUD, versions, curriculum attachment. Use GET /cohorts?studyProgramId={id} for cohorts.

• GET
  List continuing education programs/continuing-education
• POST
  Create a continuing education program/continuing-education
• GET
  Get a continuing education program/continuing-education/{id}
• PATCH
  Update a continuing education program/continuing-education/{id}
• DELETE
  Delete a continuing education program/continuing-education/{id}
• GET
  List continuing education program versions/continuing-education/{id}/versions
• POST
  Create a continuing education program version/continuing-education/{id}/versions
• GET
  Get a continuing education program version/continuing-education/{id}/versions/{versionId}
• PATCH
  Update a continuing education program version/continuing-education/{id}/versions/{versionId}
• DELETE
  Delete a continuing education program version/continuing-education/{id}/versions/{versionId}