Get Institutions
In addition to being versioned by Academic Year or Year Terms, data in the ASSIST system is associated with Institutions. The Get Institutions API allows you to get information about that institution, such as the name (which can change over time).
Api
- Route
/institutions/api
- Method
- GET
- Key Required
- No
- Common Response
- No
- Response Type
- Array of Institution
Sample Response
[
{
"id": 14,
"names": [
{
"name": "Rancho Santiago College",
"hasDepartments": true,
"hideInList": false
},
{
"name": "Santa Ana College",
"fromYear": 1997,
"hasDepartments": true,
"hideInList": false
}
],
"code": "RSC",
"prefers2016LegacyReport": false,
"isCommunityCollege": true,
"category": 2,
"termType": 0,
"beginId": 0,
"termTypeAcademicYears": [
{
"termType": 0,
"fromYear": 2018
},
{
"termType": 0,
"fromYear": 1997
},
{
"termType": 0,
"fromYear": 1980
}
]
}
]
Response Fields (Institution)
Some fields presented in the example are not documented below. These fields that are not documented can be ignored.
Institution Model
- id (int)
- Represents the unique ID for the institution in the system. This value does not change from year to year and can be used when calling other APIs for data specific to the given institution.
- names (string array)
- The names collection provides possible name values for the given institution depending on which year you are observing the data. When the
fromYear
value is specified, that name record applies to any academic years that start in that year as well as all following years up to the point where another name record starts. When thefromYear
value is not specified, or not present, it means that record is thedefault
value to use. In the above example, institution 14 has the name “Rancho Santiago College.” Starting in 1997 the institution’s name changed to “Santa Ana College.” This means you would use the name “Santa Ana College” when observing this institution in 1997 and newer records. In years prior to 1996, you would use the name “Santa Ana College.” - code (string)
- A unique code, abbreviation, assigned to the institution.
- isCommunityCollege (boolean)
- A
true
orfalse
value indicating if the given institution is a Community College (CCC). - category (int)
- An
int
value representing one of the possibleInstitution Type
values below. - termType (int)
- (Deprecated) - in older version(s) of the API this value provided a term type that was not versioned by academic year and exists for backward-compatability.
- beginId (int)
- An ‘int’ value for the initial year of the institution.
- termTypeAcademicYears (int array)
- The termTypeAcademicYears collection provides possible
Term Types
(see below) for the institutions given the academic year you are observing the data. Similar logic is applied to these values using thefromYear
property as documented for thenames
collection (above).
Institution Categories
Institutions will have one of the following category values assigned to them:
- 0
- CSU (California State University)
- 1
- UC (University of California)
- 2
- CCC (California Community College)
- 5
- AICCU (Independent University)
Term Types
Institutions will use one of three possible term types:
- 0
- Semester
- 1
- Quarter
- 2
- Trimester
The term type an institution uses can change over time so, it is important to select the correct value from the termTypeAcademicYears
collecting depending on which academic year you are observing the data for.