Banner Terms API

This REST API will pull data from the ODS View, MST_TERM_CODES_UH. No DGR is required for this because it’s considered public data, which is low risk, and it’s an internal ITS request.

Source Database Information

Located in LastPass vault

folder: Shared-ES Software Engineering Databases
name: Kuali Build ODS 9.0

API Methods

Retrieve Terms

Specs:

include results from academic_year 2015 forward
include results where academic_period_type = ‘S’ and ‘O’ and 'C'
exclude results with academic_period_type = ‘S’ and academic_period_desc has ‘Apprenticeship’ in the value

Parameter:

academic_year - the earliest academic year to pull data from

Return: academic_period_desc and academic_period from 2015 to 2 years after the active academic year

Database Column	Label in JSON

Database Column	Label in JSON
`academic_period`	term_code
`academic_period_desc`	term_description

Sample Query

SELECT t.academic_period, t.academic_period_desc
FROM mst_term_codes_uh t
WHERE t.academic_year >= '2015' and t.academic_year != '9999'
ORDER BY 1;

Retrieve Term

Parameter: term code (academic_period)

Return: record for the given term code

Database Column	Label in JSON

Database Column	Label in JSON
`academic_period`	term_code
`academic_period_desc`	term_description
`start_date`	start_date
`end_date`	end_date
`academic_year`	academic_year
`academic_year_desc`	academic_year_desc
`academic_period_type`	academic_period_type
`academic_period_type_desc`	academic_period_type_desc

Sample Query

SELECT t.academic_period, t.academic_period_desc
     , t.start_date, t.end_date
     , t.academic_year, t.academic_year_desc
     , t.academic_period_type, t.academic_period_type_desc
FROM mst_term_codes_uh t
WHERE t.academic_period = '202310';

References

Jira ticket granting access to MST_TERM_CODES_UH