Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Attach module slot(s) to a curricula version

Creates one or more module slots in a curricula version. Pass moduleIds (resolves each module’s default version) or a single courseModuleVersionId. Optionally assign curriculaVersionTermId, curriculaVersionPathwayId, and parentId (another item in the same version). Returns a single item when one module is attached, or { items, count } when multiple moduleIds are provided. Scoped to your integration’s institution via Basic Auth credentials.

POST/curricula/{id}/versions/{versionId}/items
Authorization
AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters
idstringrequired
versionIdstringrequired
Header parameters
Idempotency-Keystringrequired
Request body
requiredapplication/json
moduleIdsstring[]
min items 1
courseModuleVersionIdstring
curriculaVersionTermIdstring
curriculaVersionPathwayIdstring
parentIdstring
isCoreModuleboolean
isFinalModuleboolean
Responses
201

Item(s) created

dataCurriculaVersionItem | objectrequired
Show properties
One of:
CurriculaVersionItem
idstringrequired
curriculaVersionIdstringrequired
courseModuleIdstring | null
courseModuleVersionIdstring | null
curriculaVersionTermIdstring | null
curriculaVersionPathwayIdstring | null
parentIdstring | null
isCoreModulebooleanrequired
isFinalModulebooleanrequired
moduleGroupIdstring | null
updatedAtstring<date-time> | null
parentItemIdstring | null
childCountintegerrequired
courseModuleCurriculaVersionItemCourseModule | null
Show properties
Any of:
CurriculaVersionItemCourseModule
idstringrequired
namestringrequired
codestring | null
null
null
courseModuleVersionCurriculaVersionItemCourseModuleVersion | null
Show properties
Any of:
CurriculaVersionItemCourseModuleVersion
idstringrequired
namestringrequired
versionstringrequired
statusstringrequired
Allowed:DRAFTACTIVEARCHIVED
null
null
curriculaVersionTermCurriculaVersionItemTermRef | null
Show properties
Any of:
CurriculaVersionItemTermRef
idstringrequired
namestringrequired
positionintegerrequired
null
null
curriculaVersionPathwayCurriculaVersionItemPathwayRef | null
Show properties
Any of:
CurriculaVersionItemPathwayRef
idstringrequired
namestringrequired
typestringrequired
Allowed:FIXEDSELECTABLE_FOCUS
null
null
object
itemsCurriculaVersionItem[]required
Show properties
Array of CurriculaVersionItem
idstringrequired
curriculaVersionIdstringrequired
courseModuleIdstring | null
courseModuleVersionIdstring | null
curriculaVersionTermIdstring | null
curriculaVersionPathwayIdstring | null
parentIdstring | null
isCoreModulebooleanrequired
isFinalModulebooleanrequired
moduleGroupIdstring | null
updatedAtstring<date-time> | null
parentItemIdstring | null
childCountintegerrequired
courseModuleCurriculaVersionItemCourseModule | null
Show properties
Any of:
CurriculaVersionItemCourseModule
idstringrequired
namestringrequired
codestring | null
null
null
courseModuleVersionCurriculaVersionItemCourseModuleVersion | null
Show properties
Any of:
CurriculaVersionItemCourseModuleVersion
idstringrequired
namestringrequired
versionstringrequired
statusstringrequired
Allowed:DRAFTACTIVEARCHIVED
null
null
curriculaVersionTermCurriculaVersionItemTermRef | null
Show properties
Any of:
CurriculaVersionItemTermRef
idstringrequired
namestringrequired
positionintegerrequired
null
null
curriculaVersionPathwayCurriculaVersionItemPathwayRef | null
Show properties
Any of:
CurriculaVersionItemPathwayRef
idstringrequired
namestringrequired
typestringrequired
Allowed:FIXEDSELECTABLE_FOCUS
null
null
countintegerrequired
metaResponseMetarequired
Show properties
requestIdstringrequired
timestampstring<date-time>required
versionstringrequired
Allowed:v4
watermarkstring<date-time>

Present on GET /users?updatedSince= pages. Taken at the first page minus a 60s overlap. Bound into pagination.next_cursor. Use it as the next updatedSince after deduping by user id. Delivery is inclusive >= and at-least-once.

400

Bad Request

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties
idstringrequired
startTimestring<date-time>required
conflictingLogobject

Present on time-tracking 409 when the interval being written overlaps an existing log or open session. Start uses [punch, ∞). Stop uses [sessionStart, stop). endTime is null while that session is still open.

Show properties
idstringrequired
startTimestring<date-time>required
endTimestring<date-time> | nullrequired
401

Unauthorized

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties
idstringrequired
startTimestring<date-time>required
conflictingLogobject

Present on time-tracking 409 when the interval being written overlaps an existing log or open session. Start uses [punch, ∞). Stop uses [sessionStart, stop). endTime is null while that session is still open.

Show properties
idstringrequired
startTimestring<date-time>required
endTimestring<date-time> | nullrequired
409

Conflict — duplicate email or membership code (body includes existingUserId when known), a time-tracking session that is already running (activeSession), a time-tracking interval that overlaps an existing log (conflictingLog), idempotency key reused with a different body (idempotency_key_reused), or concurrent request with the same key still in progress (idempotency_key_in_progress)

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties
idstringrequired
startTimestring<date-time>required
conflictingLogobject

Present on time-tracking 409 when the interval being written overlaps an existing log or open session. Start uses [punch, ∞). Stop uses [sessionStart, stop). endTime is null while that session is still open.

Show properties
idstringrequired
startTimestring<date-time>required
endTimestring<date-time> | nullrequired
422

Unprocessable Entity — validation or business rule error

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties
idstringrequired
startTimestring<date-time>required
conflictingLogobject

Present on time-tracking 409 when the interval being written overlaps an existing log or open session. Start uses [punch, ∞). Stop uses [sessionStart, stop). endTime is null while that session is still open.

Show properties
idstringrequired
startTimestring<date-time>required
endTimestring<date-time> | nullrequired
429

Too Many Requests — 1000 requests per minute per institution. Includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (ISO-8601), and Retry-After (seconds).

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties
idstringrequired
startTimestring<date-time>required
conflictingLogobject

Present on time-tracking 409 when the interval being written overlaps an existing log or open session. Start uses [punch, ∞). Stop uses [sessionStart, stop). endTime is null while that session is still open.

Show properties
idstringrequired
startTimestring<date-time>required
endTimestring<date-time> | nullrequired
500

Internal Server Error

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties
idstringrequired
startTimestring<date-time>required
conflictingLogobject

Present on time-tracking 409 when the interval being written overlaps an existing log or open session. Start uses [punch, ∞). Stop uses [sessionStart, stop). endTime is null while that session is still open.

Show properties
idstringrequired
startTimestring<date-time>required
endTimestring<date-time> | nullrequired
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST 'https://fuxam.app/api/v4/curricula/string/versions/string/items' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Idempotency-Key: string' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "moduleIds": [
    "mod_001"
  ],
  "curriculaVersionTermId": "cvt_001",
  "isCoreModule": true
}'
Response
{
  "data": {
    "id": "cvi_001",
    "curriculaVersionId": "cv_001",
    "courseModuleId": "mod_001",
    "courseModuleVersionId": "modv_001",
    "curriculaVersionTermId": "cvt_001",
    "curriculaVersionPathwayId": null,
    "parentId": null,
    "isCoreModule": true,
    "isFinalModule": false,
    "moduleGroupId": null,
    "updatedAt": null,
    "courseModule": {
      "id": "mod_001",
      "name": "Introduction to Economics",
      "code": "ECO101"
    },
    "courseModuleVersion": {
      "id": "modv_001",
      "name": "Introduction to Economics",
      "version": "1.0",
      "status": "ACTIVE"
    },
    "curriculaVersionTerm": {
      "id": "cvt_001",
      "name": "Semester 1",
      "position": 1
    },
    "curriculaVersionPathway": null,
    "parentItemId": null,
    "childCount": 0
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-06-26T00:00:00.000Z",
    "version": "v4"
  }
}

War diese Seite hilfreich?