Create an organization term

Creates an organization term (semester/period) with start and end dates. termStart must be strictly before termEnd. Optionally set election and reassessment registration windows. Returns 422 when start and end are the same instant (… must not be the same) or when start is after end (… must be before …). Scoped to your integration’s institution via Basic Auth credentials.

POST/organization-terms

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Header parameters

Idempotency-Keystringrequired

Request body

requiredapplication/json

namestringrequired

min length 1

codestring

Optional term code. Whitespace-only values are stored as null.

termStartstring<date-time>required

Term start date. Must include a timezone offset (Z or ±HH:MM); values without offset return 422. Must be strictly before termEnd. If equal to termEnd, the API returns 422 with field error termStart and termEnd must not be the same.

termEndstring<date-time>required

Term end date. Must include a timezone offset (Z or ±HH:MM); values without offset return 422. Must be strictly after termStart. If equal to termStart, the API returns 422 with field error termStart and termEnd must not be the same.

electionStartstring<date-time>

Must include a timezone offset (Z or ±HH:MM).

electionEndstring<date-time>

Must include a timezone offset (Z or ±HH:MM).

reassessmentRegistrationStartstring<date-time>

Must include a timezone offset (Z or ±HH:MM).

reassessmentRegistrationEndstring<date-time>

Must include a timezone offset (Z or ±HH:MM).

Responses

201

Term created

dataOrganizationTermrequired

Academic term (semester) with optional module election and reassessment registration windows.

Show properties

idstringrequired

namestringrequired

termEndstring<date-time>required

End of the academic term.

institutionIdstringrequired

termStartstring<date-time>required

Start of the academic term.

codestring | null

electionEndstring<date-time> | null

Deadline for module elections for this term.

electionStartstring<date-time> | null

When students may begin electing modules for this term.

reassessmentRegistrationEndstring<date-time> | null

When reassessment registration closes.

reassessmentRegistrationStartstring<date-time> | null

When reassessment registration opens.

metaResponseMetarequired

Show properties

requestIdstringrequired

timestampstring<date-time>required

versionstringrequired

Allowed:v4

400

Bad Request

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

401

Unauthorized

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

409

Conflict

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

422

Unprocessable Entity — validation or business rule error

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

429

Too Many Requests

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

500

Internal Server Error

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Basic auth usernameBasic auth password

Remember on this deviceInclude my values in samples

Parameters

Idempotency-Keyheader*

Bodyapplication/json

namestring*codestringOptional term code. Whitespace-only values are stored as null.termStartstring*Term start date. Must include a timezone offset (`Z` or `±HH:MM`); values without offset return 422. Must be strictly before `termEnd`. If equal to `termEnd`, the API returns `422` with field error `termStart and termEnd must not be the same`.termEndstring*Term end date. Must include a timezone offset (`Z` or `±HH:MM`); values without offset return 422. Must be strictly after `termStart`. If equal to `termStart`, the API returns `422` with field error `termStart and termEnd must not be the same`.electionStartstringMust include a timezone offset (`Z` or `±HH:MM`).electionEndstringMust include a timezone offset (`Z` or `±HH:MM`).reassessmentRegistrationStartstringMust include a timezone offset (`Z` or `±HH:MM`).reassessmentRegistrationEndstringMust include a timezone offset (`Z` or `±HH:MM`).

Request

curl -X POST 'https://fuxam.app/api/v4/organization-terms' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Idempotency-Key: string' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Winter Semester 2024/25",
  "code": "WS2425",
  "termStart": "2024-10-01T00:00:00.000Z",
  "termEnd": "2025-03-31T23:59:59.000Z",
  "electionStart": "2024-09-01T00:00:00.000Z",
  "electionEnd": "2024-09-15T23:59:59.000Z"
}'

const response = await fetch("https://fuxam.app/api/v4/organization-terms", {
  method: "POST",
  headers: {
    "Authorization": "Basic YOUR_CREDENTIALS",
    "Idempotency-Key": "string",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"Winter Semester 2024/25\",\n  \"code\": \"WS2425\",\n  \"termStart\": \"2024-10-01T00:00:00.000Z\",\n  \"termEnd\": \"2025-03-31T23:59:59.000Z\",\n  \"electionStart\": \"2024-09-01T00:00:00.000Z\",\n  \"electionEnd\": \"2024-09-15T23:59:59.000Z\"\n}"
});

import requests

response = requests.post(
    "https://fuxam.app/api/v4/organization-terms",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS",
        "Idempotency-Key": "string",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"Winter Semester 2024/25\",\n  \"code\": \"WS2425\",\n  \"termStart\": \"2024-10-01T00:00:00.000Z\",\n  \"termEnd\": \"2025-03-31T23:59:59.000Z\",\n  \"electionStart\": \"2024-09-01T00:00:00.000Z\",\n  \"electionEnd\": \"2024-09-15T23:59:59.000Z\"\n}",
)

Response

{
  "data": {
    "id": "ot_001",
    "name": "WS 2024/25",
    "termEnd": "2025-03-31T23:59:59.000Z",
    "institutionId": "inst_123",
    "termStart": "2024-10-01T00:00:00.000Z",
    "code": "WS24",
    "electionEnd": null,
    "electionStart": null,
    "reassessmentRegistrationEnd": null,
    "reassessmentRegistrationStart": null
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-06-26T00:00:00.000Z",
    "version": "v4"
  }
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}