Get Prefixes

Returns the list of course prefixes for a given institution and academic year.

Api

Route: /Prefixes/api/Institution/{institutionId}/Year/{academicYearId}
Method: GET
Key Required: Yes
Common Response: No
Response Type: Array of Prefix

Route Parameters

institutionId (integer): The institution id (from: Get Institutions)
academicYearId (integer): The academic year id (from: Get Academic Years)

Query Parameters (Optional)

includeTerminated (boolean): When true, includes prefixes that have been terminated. Defaults to false.

Curl Example

curl -X 'GET' \
  'https://prod.assistng.org/Prefixes/api/Institution/110/Year/74' \
  -H 'accept: application/json' -H 'API-Key':'<redacted>'

institutionId = 110 (Allan Hancock College)
academicYearId = 74 (2023-2024, from Get Academic Years)
API-Key = <redacted> (You’ll need to provide your own key.)

Sample Response

[
  {
    "id": 1234,
    "begin": {
      "yearTermCode": "F2023",
      "id": 291,
      "beginDate": "2023-10-01T00:00:00",
      "endDate": "2024-01-01T00:00:00",
      "description": "Fall 2023",
      "code": "F2023",
      "academicYearId": 74,
      "termId": 1
    },
    "end": null,
    "prefixParentId": 1200,
    "code": "ART",
    "description": "Art",
    "institutionId": 110,
    "department": "Visual Arts",
    "beginId": 291,
    "endId": null,
    "departmentParentId": 13008,
    "isPublished": true
  }
]

Prefix Model

id (integer): The unique identifier for this prefix version.
begin (Prefix Year Term): The year term in which this prefix became active.
end (Prefix Year Term): The year term in which this prefix was terminated. null if the prefix is still active.
prefixParentId (integer): A shared identifier that groups all versioned records of the same prefix together. All versions of a prefix share the same prefixParentId, allowing them to be linked across year terms.
code (string): The short course prefix code (e.g. ART, MATH).
description (string): The full name of the prefix.
institutionId (integer): The id of the institution this prefix belongs to.
department (string): The name of the department this prefix is associated with.
beginId (integer): The id of the begin year term (corresponds to begin.id).
endId (integer): The id of the end year term (corresponds to end.id). null if the prefix is still active.
departmentParentId (integer): The parentId of the department this prefix belongs to (see Get Departments).
isPublished (boolean): Whether this prefix is currently published.

Prefix Year Term Model

The year term model returned by the Prefixes API extends the standard Year Term with two additional fields:

academicYearId (integer): The id of the academic year this term belongs to (from: Get Academic Years)
termId (integer): The id of the term within the academic year.