Academic Units

Academic Units Resource of the University API

More information: https://it.byu.edu

Contact Info: api@byu.edu

Base URL: /byuapi/academic_units

Version: v1

Default request content-types: application/json

Default response content-types: application/json

Schemes: https

Summary

Path	Operation	Description
/	GET	Academic Units
	OPTIONS	Academic Units
	POST	Academic Units
	PUT	Academic Units
/{academic_unit_id},{academic_unit_effective_date}	DELETE	Academic Units
	GET	An Academic Unit
	OPTIONS	Academic Units
	PUT	Modify Academic Units
/{academic_unit_id},{academic_unit_effective_date}/assigned_programs	GET	Academic Programs assigned to an Academic Unit
	OPTIONS	Assigned Academic Programs
	PUT	Assign an Academic Program to an Academic Unit
/{academic_unit_id},{academic_unit_effective_date}/assigned_programs/{academic_program_id},{academic_program_assignment_effective_date}	DELETE	Academic Programs assigned to an Academic Unit
	GET	An Academic Program assigned to an Academic Unit
	OPTIONS	Academic Program
	PUT	Modify Academic Programs assignment effective date to an Academic Unit
/{academic_unit_id},{academic_unit_effective_date}/assigned_teaching_areas	GET	Teaching Areas assigned to an Academic Unit
	OPTIONS	Teaching Areas
	PUT	Teaching Areas assigned to an Academic Unit
/{academic_unit_id},{academic_unit_effective_date}/assigned_teaching_areas/{teaching_area_name},{teaching_area_assignment_effective_date}	DELETE	Expire Teaching Area assigned to an Academic Unit
	GET	A Teaching Area assigned to an Academic Unit
	OPTIONS	Teaching Area assignment options
	PUT	Modify Teaching Area assignment effective date to an Academic Unit
/{academic_unit_id},{academic_unit_effective_date}/contacts	GET	Contacts assigned to an Academic Unit
	OPTIONS	Contacts
	PUT	Contacts of an Academic Unit
/{academic_unit_id},{academic_unit_effective_date}/contacts/{contact_type},{contact_effective_date}	DELETE	Expire Contact of an Academic Unit
	GET	A contact assigned to an Academic Unit
	OPTIONS	Contact
	PUT	Modify Contact of an Academic Unit
/{academic_unit_id},{academic_unit_effective_date}/parent_academic_unit	GET	Parent Academic Unit associated to an Academic Unit
	OPTIONS	Parent Academic Unit
	PUT	Parent Academic Unit associated to an Academic Unit
/{academic_unit_id},{academic_unit_effective_date}/sub_academic_units	GET	Subordinate Academic Units assigned to an Academic Unit
	OPTIONS	Subordinate Academic Units Options
	PUT	Subordinate Academic Units assigned to an Academic Unit
/{academic_unit_id},{academic_unit_effective_date}/sub_academic_units/{sub_academic_unit_id},{sub_academic_unit_effective_date}	DELETE	Remove a specific subordinate Academic Unit assigned to an Academic Unit
	GET	A subordinate Academic Unit assigned to an Academic Unit
	OPTIONS	Options for a subordinate Academic Unit
	PUT	Modify a specific subordinate Academic Unit of an Academic Unit

Paths

Academic Units

GET /

Tags: AcademicUnits

Returns a collection of Academic Units


as_of_date	Date that lies between the effective and expired dates of the Academic Unit	query	string
academic_unit_id	Academic Unit ID	query	string
academic_unit_effective_date	Effective date of the Academic Unit	query	string
academic_unit_expired_date	Expired date of the Academic Unit	query	string
academic_unit_name	Name of the Academic Unit	query	string
academic_unit_official_name	Official name of the Academic Unit	query	string
academic_unit_type	Unit type of the Academic Unit	query	string
parent_academic_unit_id	academic_unit_id of the parent Academic Unit of an Academic Unit	query	string
old_academic_unit_id	Old academic_unit_id of an Academic Unit	query	string
academic_program_id	Academic Program ID	query	string
academic_program_effective_date	Academic Program Effective Date	query	string
academic_program_expired_date	Academic Program Expired Date	query	string
academic_program_type	Academic Program Type	query	string
academic_program_description	Academic Program Description	query	string
academic_program_diploma_description	Academic Program Diploma Description	query	string
academic_program_long_description	Academic Program Long Description	query	string
academic_program_degree	Academic Program Degree	query	string
academic_program_admission_required	Academic Program Long Description	query	string
academic_program_is_teaching_program	Indicates whether Academic Program is a teaching program	query	string
academic_program_has_limited_enrollment	Indicates whether Academic Program has limited enrollment	query	string
academic_program_committee_members_needed_count	Indicates the number of committee members an Academic Program requires	query	string
academic_program_major_program_id	Academic (emphasis) Program's associated Academic Program ID for its major	query	string
academic_program_emphasis_required	Indicates whether Academic Program requires an emphasis	query	string
academic_program_minor_required	Indicates whether Academic Program requires a minor	query	string
academic_program_study_list_required	Indicates whether Academic Program requires a study list	query	string
academic_program_has_honors_recognition	Indicates whether Academic Program has honors recognition	query	string
academic_program_maximum_years_to_complete	Indicates maximum number of years in which Academic Program must be completed	query	string
academic_program_program_hours	Indicates the number of hours in an Academic Program	query	string
academic_program_minimum_program_hours	Indicates minimum number of hours in which Academic Program must be completed	query	string
academic_program_maximum_program_hours	Indicates maximum number of hours in which Academic Program must be completed	query	string
academic_program_maximum_requirement_hours	Academic Program	query	string
academic_program_maximum_requirement_classes	Academic Program	query	string
academic_program_prior_program_id	Academic Program's prior Academic Program ID	query	string
academic_program_comments	Comments about Academic Program	query	string
academic_program_date_time_updated	Date/Time Academic Program was last updated	query	string
academic_program_updated_by_id	ID of person who last updated Academic Program	query	string
academic_program_updated_by_name	Name of person who last updated Academic Program	query	string
teaching_area_name	Teaching Area name	query	string
teaching_area_long_name	Long name of Teaching Area	query	string
teaching_area_effective_date	Effective date of the Teaching Area	query	string
teaching_area_expired_date	Expired date of Teaching Area	query	string
teaching_area_date_time_updated	Date/Time Teaching Area was last updated	query	string
teaching_area_updated_by_id	ID of person who last updated Teaching Area	query	string
teaching_area_updated_by_name	Name of person who last updated Teaching Area	query	string
contact_effective_date	Effective date of Contact	query	string
contact_expired_date	Expired date of Contact	query	string
contact_person_id	ID of person associated with Contact information	query	string
contact_person_name	Name of person associated with Contact information	query	string
sub_academic_unit_id	Academic Unit ID of subordinate Academic Unit	query	string
sub_academic_unit_effective_date	Effective date of subordinate Academic Unit	query	string
sub_academic_unit_expired_date	Expired date of subordinate Academic Unit	query	string
sub_academic_unit_name	Name of subordinate Academic Unit	query	string
sub_academic_unit_official_name	Official name of subordinate Academic Unit	query	string
sub_academic_unit_type	Type of subordinate Academic Unit	query	string
context	Defines a group of field sets to be returned in collection	query	string
field_sets	List of field sets to be returned in collection	query	string
page_start	Skip into the academic_units collection before starting to return items	query	string
page_size	How many items of the academic_units collection are returned?	query	string

Uses default content-types: application/json

200 OK: A collection of Academic Units

academic_units
204 No Content: No Academic Units satisfy the query parameters - the collection is empty
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
default: Unexpected error

error

Academic Units

OPTIONS /

Tags: AcademicUnits

What can this endpoint do?

Uses default content-types: application/json

200 OK: Supported HTTP Methods

methods
400 Bad Request: Invalid Request - unable to interpret request

error
default: Unexpected error

error

Academic Units

POST /

Tags: AcademicUnits

Create a new Academic Unit

Uses default content-types: application/json

The Academic Unit to be added

academic_unit

Uses default content-types: application/json

201 Created: Returns the academic unit that was added

academic_unit
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to add a new Academic Unit

error
403 Forbidden: Access denied - not authorized to add the new Academic Unit

error
409 Conflict: Body of the request contains conflicting, malformed, or invalid data

error
default: Unexpected error

error

Academic Units

PUT /

Tags: AcademicUnits

Modify a specific Academic Unit (defined by query parameters)

Uses default content-types: application/json

The Academic Unit to be modified

academic_units


context	Defines a group of field sets used in updating the Academic Unit	query	string
field_sets	List of field sets used in updating the Academic Unit	query	string

Uses default content-types: application/json

200 OK: Returns the Academic Units that were modified

academic_units
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to modify the Academic Unit

error
403 Forbidden: Access denied - not authorized to modify the Academic Unit

error
409 Conflict: Body of the request contains conflicting, malformed, or invalid data

error
default: Unexpected error

error

Academic Units

DELETE /{academic_unit_id},{academic_unit_effective_date}

Tags: AcademicUnits

Expire a specific Academic Unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: The specific Academic Unit that was successfully expired

academic_unit
204 No Content: No Academic Unit found that matches key value

academic_unit
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to expire an Academic Unit

error
403 Forbidden: Access denied to protected data

error
409 Conflict: Unable to perform expire request

error
default: Unexpected error

error

An Academic Unit

GET /{academic_unit_id},{academic_unit_effective_date}

Tags: AcademicUnits

Returns a specific Academic Unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string
fieldset	List of field sets to be returned with the specific Academic Unit	query	string

Uses default content-types: application/json

200 OK: An Academic Units

academic_unit
204 No Content: No class found that matches key values

academic_unit
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to retrieve specific Academic Unit

error
403 Forbidden: Access denied to protected data

error
409 Conflict: Query parameters conflict or are malformed

error
default: Unexpected error

error

Academic Units

OPTIONS /{academic_unit_id},{academic_unit_effective_date}

Tags: AcademicUnits

What can this endpoint do?


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: Supported HTTP Methods

methods
400 Bad Request: Invalid Request - unable to interpret request

error
default: Unexpected error

error

Modify Academic Units

PUT /{academic_unit_id},{academic_unit_effective_date}

Tags: AcademicUnits

Modify a specific AIM Class

Uses default content-types: application/json

The modified Academic Unit

academic_unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
field_sets	List of field sets also used when modifying specific Academic Unit	query	string

Uses default content-types: application/json

200 OK: The specific Academic Unit that was successfully modified

academic_unit
204 No Content: No Academic Unit found that matches key value

academic_unit
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to modify Academic Unit

error
403 Forbidden: Access denied to protected data

error
409 Conflict: Unable to perform update request

error
default: Unexpected error

error

Academic Programs assigned to an Academic Unit

GET /{academic_unit_id},{academic_unit_effective_date}/assigned_programs

Tags: AcademicUnits

Retrieves a collection of assigned Academic Programs for a specific Academic Unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
assigned_academic_program_effective_as_of_date	Date that lies between the effective and expired of the assigned Academic Program	query	string
page_start	Skip into pages of the assigned Academic Programs collection before starting to return items	query	string
page_size	How many items of the assigned Academic Programs collection are returned?	query	string

Uses default content-types: application/json

200 OK: Collection Retrieved

assigned_programs
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
404 Not Found: No assigned Academic Programs satisfy the query parameters - the collection is empty

error
409 Conflict: Query parameters conflict or are malformed

error
default: Unexpected error

error

Assigned Academic Programs

OPTIONS /{academic_unit_id},{academic_unit_effective_date}/assigned_programs

Tags: AcademicUnits

What can this endpoint do?


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: Supported HTTP Methods

methods
400 Bad Request: Invalid Request - unable to interpret request

error
default: Unexpected error

error

Assign an Academic Program to an Academic Unit

PUT /{academic_unit_id},{academic_unit_effective_date}/assigned_programs

Tags: AcademicUnits

Assign an Academic Program to an Academic Unit

Uses default content-types: application/json

The Academic Program to be added

assigned_program


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: Academic Program assigned to the Academic Unit

assigned_program
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
409 Conflict: Request Body conflicts or is malformed

error
default: Unexpected error

error

Academic Programs assigned to an Academic Unit

DELETE /{academic_unit_id},{academic_unit_effective_date}/assigned_programs/{academic_program_id},{academic_program_assignment_effective_date}

Tags: AcademicUnits

Expire a specific Academic Program


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
academic_program_id	The specific Academic Program ID	path	string
academic_program_assignment_effective_date	The effective date of the Academic Program assignment to the Academic Unit	path	string (date-time)

Uses default content-types: application/json

204 No Content: Academic Program successfully removed
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
default: Unexpected error

error

An Academic Program assigned to an Academic Unit

GET /{academic_unit_id},{academic_unit_effective_date}/assigned_programs/{academic_program_id},{academic_program_assignment_effective_date}

Tags: AcademicUnits

Retrieves a specific assigned Academic Program to the Academic Unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
academic_program_id	The specific Academic Program ID	path	string
academic_program_assignment_effective_date	The effective date of the Academic Program assignment to the Academic Unit	path	string (date-time)

Uses default content-types: application/json

200 OK: Item Retrieved

assigned_program
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
404 Not Found: No Academic Programs satisfy the request

error
default: Unexpected error

error

Academic Program

OPTIONS /{academic_unit_id},{academic_unit_effective_date}/assigned_programs/{academic_program_id},{academic_program_assignment_effective_date}

Tags: AcademicUnits

What can this endpoint do?


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
academic_program_id	The specific Academic Program ID	path	string
academic_program_assignment_effective_date	The effective date of the Academic Program assignment to the Academic Unit	path	string (date-time)

Uses default content-types: application/json

200 OK: Supported HTTP Methods

methods
400 Bad Request: Invalid Request - unable to interpret request

error
default: Unexpected error

error

Modify Academic Programs assignment effective date to an Academic Unit

PUT /{academic_unit_id},{academic_unit_effective_date}/assigned_programs/{academic_program_id},{academic_program_assignment_effective_date}

Tags: AcademicUnits

Modify a specific Academic Program's assignment effective date to an Academic Unit

Uses default content-types: application/json

The modified Academic Program

assigned_program


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
academic_program_id	The specific Academic Program ID	path	string
academic_program_assignment_effective_date	The effective date of the Academic Program assignment to the Academic Unit	path	string (date-time)

Uses default content-types: application/json

200 OK: Academic Program Modified

assigned_program
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
409 Conflict: Request Body conflicts or is malformed

error
default: Unexpected error

error

Teaching Areas assigned to an Academic Unit

GET /{academic_unit_id},{academic_unit_effective_date}/assigned_teaching_areas

Tags: AcademicUnits

Retrieves a collection of Teaching Areas assigned to a specific Academic Unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
assigned_teaching_area_effective_as_of_date	Date that lies between the effective and expired of the assigned Teaching Area	query	string
page_start	Skip into pages of the Teaching Areas collection before starting to return items	query	string
page_size	How many items of the Teaching Areas collection are returned?	query	string

Uses default content-types: application/json

200 OK: Collection Retrieved

assigned_teaching_areas
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
404 Not Found: No Teaching Areas satisfy the query parameters - the collection is empty

error
409 Conflict: Query parameters conflict or are malformed

error
default: Unexpected error

error

Teaching Areas

OPTIONS /{academic_unit_id},{academic_unit_effective_date}/assigned_teaching_areas

Tags: AcademicUnits

What can this endpoint do?


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: Supported HTTP Methods

methods
400 Bad Request: Invalid Request - unable to interpret request

error
default: Unexpected error

error

Teaching Areas assigned to an Academic Unit

PUT /{academic_unit_id},{academic_unit_effective_date}/assigned_teaching_areas

Tags: AcademicUnits

Assign a Teaching Area to an Academic Unit

Uses default content-types: application/json

The Teaching Area to be assigned to the Academic Unit

assigned_teaching_area


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: Teaching Area assigned

assigned_teaching_area
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
409 Conflict: Request Body conflicts or is malformed

error
default: Unexpected error

error

Expire Teaching Area assigned to an Academic Unit

DELETE /{academic_unit_id},{academic_unit_effective_date}/assigned_teaching_areas/{teaching_area_name},{teaching_area_assignment_effective_date}

Tags: AcademicUnits

Expire a specific Teaching Area assignment to an Academic Unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
teaching_area_name	The specific Teaching Area name	path	string
teaching_area_assignment_effective_date	The effective date of the Teaching Area assignment to the Academic Unit	path	string (date-time)

Uses default content-types: application/json

204 No Content: Teaching Area successfully removed
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
default: Unexpected error

error

A Teaching Area assigned to an Academic Unit

GET /{academic_unit_id},{academic_unit_effective_date}/assigned_teaching_areas/{teaching_area_name},{teaching_area_assignment_effective_date}

Tags: AcademicUnits

Retrieves a specific Teaching Area


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
teaching_area_name	The specific Teaching Area name	path	string
teaching_area_assignment_effective_date	The effective date of the Teaching Area assignment to the Academic Unit	path	string (date-time)

Uses default content-types: application/json

200 OK: Item Retrieved

assigned_teaching_area
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
404 Not Found: No Teaching Areas satisfy the request

error
default: Unexpected error

error

Teaching Area assignment options

OPTIONS /{academic_unit_id},{academic_unit_effective_date}/assigned_teaching_areas/{teaching_area_name},{teaching_area_assignment_effective_date}

Tags: AcademicUnits

What can this endpoint do?


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
teaching_area_name	The specific Teaching Area name	path	string
teaching_area_assignment_effective_date	The effective date of the Teaching Area assignment to the Academic Unit	path	string (date-time)

Uses default content-types: application/json

200 OK: Supported HTTP Methods

methods
400 Bad Request: Invalid Request - unable to interpret request

error
default: Unexpected error

error

Modify Teaching Area assignment effective date to an Academic Unit

PUT /{academic_unit_id},{academic_unit_effective_date}/assigned_teaching_areas/{teaching_area_name},{teaching_area_assignment_effective_date}

Tags: AcademicUnits

Modify a specific Teaching Area assignment effective date to an Academic Unit

Uses default content-types: application/json

The modified Teaching Area assignment

assigned_teaching_area


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
teaching_area_name	The specific Teaching Area name	path	string
teaching_area_assignment_effective_date	The effective date of the Teaching Area assignment to the Academic Unit	path	string (date-time)

Uses default content-types: application/json

200 OK: Teaching Area assignment

assigned_teaching_area
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
409 Conflict: Request Body conflicts or is malformed

error
default: Unexpected error

error

Contacts assigned to an Academic Unit

GET /{academic_unit_id},{academic_unit_effective_date}/contacts

Tags: AcademicUnits

Retrieves a collection of Contacts for a specific Academic Unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
contacts_effective_as_of_date	Date that lies between the effective and expired date of the contacts	query	string
page_start	Skip into pages of the Contacts collection before starting to return items	query	string
page_size	How many items of the Contacts collection are returned?	query	string

Uses default content-types: application/json

200 OK: Collection Retrieved

contacts
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
404 Not Found: No Contacts satisfy the query parameters - the collection is empty

error
409 Conflict: Query parameters conflict or are malformed

error
default: Unexpected error

error

Contacts

OPTIONS /{academic_unit_id},{academic_unit_effective_date}/contacts

Tags: AcademicUnits

What can this endpoint do?


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: Supported HTTP Methods

methods
400 Bad Request: Invalid Request - unable to interpret request

error
default: Unexpected error

error

Contacts of an Academic Unit

PUT /{academic_unit_id},{academic_unit_effective_date}/contacts

Tags: AcademicUnits

Add a contact type of an Academic Unit

Uses default content-types: application/json

The Contact to be added

contact


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: Contact Added

contact
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
409 Conflict: Request Body conflicts or is malformed

error
default: Unexpected error

error

Expire Contact of an Academic Unit

DELETE /{academic_unit_id},{academic_unit_effective_date}/contacts/{contact_type},{contact_effective_date}

Tags: AcademicUnits

Expire a specific Contact


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
contact_type	The contact type of the Contact	path	string
contact_effective_date	The effective date of the contact type	path	string (date-time)

Uses default content-types: application/json

204 No Content: Contact successfully removed
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
default: Unexpected error

error

A contact assigned to an Academic Unit

GET /{academic_unit_id},{academic_unit_effective_date}/contacts/{contact_type},{contact_effective_date}

Tags: AcademicUnits

Retrieves a specific Contact


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
contact_type	The contact type of the Contact	path	string
contact_effective_date	The effective date of the contact type	path	string (date-time)

Uses default content-types: application/json

200 OK: Item Retrieved

contact
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
default: Unexpected error

error

Contact

OPTIONS /{academic_unit_id},{academic_unit_effective_date}/contacts/{contact_type},{contact_effective_date}

Tags: AcademicUnits

What can this endpoint do?


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
contact_type	The contact type of the Contact	path	string
contact_effective_date	The effective date of the contact type	path	string (date-time)

Uses default content-types: application/json

200 OK: Supported HTTP Methods

methods
400 Bad Request: Invalid Request - unable to interpret request

error
default: Unexpected error

error

Modify Contact of an Academic Unit

PUT /{academic_unit_id},{academic_unit_effective_date}/contacts/{contact_type},{contact_effective_date}

Tags: AcademicUnits

Modify a specific Contact

Uses default content-types: application/json

The modified Contact

contact


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
contact_type	The contact type of the Contact	path	string
contact_effective_date	The effective date of the contact type	path	string (date-time)

Uses default content-types: application/json

200 OK: Contact Modified

contact
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
default: Unexpected error

error

Parent Academic Unit associated to an Academic Unit

GET /{academic_unit_id},{academic_unit_effective_date}/parent_academic_unit

Tags: AcademicUnits

Retrieves an Academic Unit associated as the parent to a specific Academic Unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: Collection Retrieved

parent_academic_unit
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
404 Not Found: No parent Academic Unit exits

error
409 Conflict: Query parameters conflict or are malformed

error
default: Unexpected error

error

Parent Academic Unit

OPTIONS /{academic_unit_id},{academic_unit_effective_date}/parent_academic_unit

Tags: AcademicUnits

What can this endpoint do?


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: Supported HTTP Methods

methods
400 Bad Request: Invalid Request - unable to interpret request

error
default: Unexpected error

error

Parent Academic Unit associated to an Academic Unit

PUT /{academic_unit_id},{academic_unit_effective_date}/parent_academic_unit

Tags: AcademicUnits

Associate the parent Academic Unit to this Academic Unit

Uses default content-types: application/json

The parent Academic Unit and associated attributes

parent_academic_unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: Parent Academic Unit associated

parent_academic_unit
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
409 Conflict: Request Body conflicts or is malformed

error
default: Unexpected error

error

Subordinate Academic Units assigned to an Academic Unit

GET /{academic_unit_id},{academic_unit_effective_date}/sub_academic_units

Tags: AcademicUnits

Retrieves a collection of subordinate Academic Units for a specific Academic Unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
sub_academic_unit_effective_as_of_date	Date that lies between the effective and expired of the subordinate Academic Unit	query	string
page_start	Skip into pages of the subordinate Academic Units collection before starting to return items	query	string
page_size	How many items of the subordinate Academic Units collection are returned?	query	string

Uses default content-types: application/json

200 OK: Collection Retrieved

sub_academic_units
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
404 Not Found: No subordinate Academic Units satisfy the query parameters - the collection is empty

error
409 Conflict: Query parameters conflict or are malformed

error
default: Unexpected error

error

Subordinate Academic Units Options

OPTIONS /{academic_unit_id},{academic_unit_effective_date}/sub_academic_units

Tags: AcademicUnits

What can this endpoint do?


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: Supported HTTP Methods

methods
400 Bad Request: Invalid Request - unable to interpret request

error
default: Unexpected error

error

Subordinate Academic Units assigned to an Academic Unit

PUT /{academic_unit_id},{academic_unit_effective_date}/sub_academic_units

Tags: AcademicUnits

Add an subordinate Academic Unit to an Academic Unit by specifying the specific subordinate Academic Unit ID

Uses default content-types: application/json

The subordinate Academic Unit to be added

sub_academic_unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: Subordinate Academic Unit Added

sub_academic_unit
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
409 Conflict: Request Body conflicts or is malformed

error
default: Unexpected error

error

Remove a specific subordinate Academic Unit assigned to an Academic Unit

DELETE /{academic_unit_id},{academic_unit_effective_date}/sub_academic_units/{sub_academic_unit_id},{sub_academic_unit_effective_date}

Tags: AcademicUnits

Remove a specific subordinate Academic Unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
sub_academic_unit_id	The specific subordinate Academic Unit ID	path	string
sub_academic_unit_effective_date	The specific subordinate Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

204 No Content: The specific subordinate Academic Unit was successfully removed
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
default: Unexpected error

error

A subordinate Academic Unit assigned to an Academic Unit

GET /{academic_unit_id},{academic_unit_effective_date}/sub_academic_units/{sub_academic_unit_id},{sub_academic_unit_effective_date}

Tags: AcademicUnits

Retrieves a specific subordinate Academic Unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
sub_academic_unit_id	The specific subordinate Academic Unit ID	path	string
sub_academic_unit_effective_date	The specific subordinate Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: Item Retrieved

sub_academic_unit
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
404 Not Found: No subordinate Academic Units satisfy the request

error
default: Unexpected error

error

Options for a subordinate Academic Unit

OPTIONS /{academic_unit_id},{academic_unit_effective_date}/sub_academic_units/{sub_academic_unit_id},{sub_academic_unit_effective_date}

Tags: AcademicUnits

What can this endpoint do?


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
sub_academic_unit_id	The specific subordinate Academic Unit ID	path	string
sub_academic_unit_effective_date	The specific subordinate Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: Supported HTTP Methods

methods
400 Bad Request: Invalid Request - unable to interpret request

error
default: Unexpected error

error

Modify a specific subordinate Academic Unit of an Academic Unit

PUT /{academic_unit_id},{academic_unit_effective_date}/sub_academic_units/{sub_academic_unit_id},{sub_academic_unit_effective_date}

Tags: AcademicUnits

Modify a specific subordinate Academic Unit

Uses default content-types: application/json

The modified subordinate Academic Unit

sub_academic_unit


academic_unit_id	The specific Academic Unit ID	path	string
academic_unit_effective_date	The specific Academic Unit effective date	path	string (date-time)
sub_academic_unit_id	The specific subordinate Academic Unit ID	path	string
sub_academic_unit_effective_date	The specific subordinate Academic Unit effective date	path	string (date-time)

Uses default content-types: application/json

200 OK: The subordinate Academic Unit modified

sub_academic_unit
400 Bad Request: Invalid Request - unable to interpret request

error
401 Unauthorized: Authentication required to access data

error
403 Forbidden: Access denied to protected data

error
409 Conflict: Request Body conflicts or is malformed

error
default: Unexpected error

error

Schema definitions

academic_program: object

An Academic Program

links: object

Hypermedia Links that impact a single Academic Program

academic_program.info: link
academic_program.modify: link
academic_program.delete: link

metadata: metadata

program_id: academic_program_id

effective_date: api_date

expired_date: api_date

program_type: academic_program_type

description: api_string

diploma_description: api_string

long_description: api_string

degree: academic_program_degree

is_open_admission: api_boolean

is_teaching_program: api_boolean

is_limited_enrollment_program: api_boolean

committee_members_needed_count: api_count

major_program_id: academic_program_id

ge_program_id: academic_program_id

core_program_id: academic_program_id

emphasis_required: api_boolean

minor_required: api_boolean

study_list_required: api_boolean

has_honors_recognition: api_boolean

maximum_years_to_complete: api_zero_positive_integer

program_hours: api_zero_positive_integer

minimum_program_hours: api_zero_positive_integer

maximum_program_hours: api_zero_positive_integer

maximum_requirement_hours: api_zero_positive_integer

maximum_requirement_classes: api_zero_positive_integer

prior_program_id: academic_program_id

comments: api_string

date_time_updated: api_date

updated_by_id: api_person_id

academic_program_degree: object

Academic Program Degree Abbreviation

value: string , x ∈ { 2YC , 6YC , AA , AIS , AS , BA , BES , BFA , BGS , BIS , BM , BMU , BS , CERT , CGN , DMA , DRE , EDD , EDS , EdS , JD , LLM , MA , MAC , MACC , MBA , MCD , MCE , MCH , MCL , ME , MED , MEM , MES , MFA , MFR , MHA , MHE , MIE , MIN , MISM , MLIS , MLS , MM , MMU , MN , MOB , MPA , MPH , MPP , MRE , MRED , MS , MSW , MTM , NDG , PBS , PHD , PRE , SPC , TC , TESL , TL }
api_type: string , x ∈ { modifiable , read-only , related }
domain: string (uri)
related_resource: string
display_label: string

academic_program_id: object

Academic Program ID

value: string , must match ^[0-9]{5}$
api_type: string , x ∈ { modifiable , read-only , related , system }
key: boolean
related_resource: string
display_label: string

academic_program_type: object

Academic Program Type

value: string , x ∈ { CERT , SPECIALIZATION , LICENSURE , EMPHASIS , GE , NONDEGREE , MAJOR , MINOR , UNIV , HONORS , PRE-MAJOR , POST-BACHELORS }
api_type: string , x ∈ { modifiable , read-only , related }
domain: string (uri)
related_resource: string
display_label: string

academic_unit: object

An item in the Academic Units collection

basic: academic_unit_basic
parent_academic_unit: parent_academic_unit
sub_academic_units: sub_academic_units
assigned_programs: assigned_programs
assigned_teaching_areas: assigned_teaching_areas
contacts: contacts

academic_unit_basic: object

Basic data for an Academic Unit item

links: object

Hypermedia Links that impact the Academic Unit

academic_units.info: link
academic_units.modify: link
academic_units.delete: link

metadata: object

validation_response: validation_response

academic_unit_id: academic_unit_id

effective_date: https://raw.githubusercontent.com/byu-oit/api-repo-sandbox/master/swagger20/academicunits/academic_units_definitions.json#/api_date

expired_date: api_date

unit_name: api_string

official_name: api_string

unit_type: academic_unit_type

academic_unit_contact_type: object

Academic Unit Contact Type

value: string , x ∈ { ADVISEMENT CENTER , ASSOCIATE DEAN GRADES , CADS , CHAIR , DEAN , GRAD COORDINATOR , GRAD SECRETARY , GRADE CONTACT , GRADE ROLL MONITOR , SCHED OFFICER , TEACHING AREA }
api_type: string , x ∈ { modifiable , read-only , related }
key: boolean
domain: string (uri)
related_resource: string
display_label: string

academic_unit_id: object

Academic Unit ID

value: string , must match ^[0-9]{4}$
api_type: string , x ∈ { system }
key: boolean
display_label: string

academic_unit_type: object

Academic Unit Type

value: string , x ∈ { ACAD VP , COLLEGE , INSTITUTE , CENTER , DIVISION , PROGRAM , SCHOOL , DEPARTMENT }
api_type: string , x ∈ { read-only , modifiable }
domain: string (uri)
display_label: string

academic_units: object

A collection of Academic Units

links: object

Hypermedia Links that impact the entire Academic Units collection

academic_units.info: link
academic_units.current: link
academic_units.prev: link
academic_units.next: link
academic_units.create: link

metadata: metadata

values: object[]

academic_unit

api_boolean: object

A generic definition of a boolean for the BYU University API

value: boolean
api_type: string , x ∈ { modifiable , read-only , related , system }
key: boolean
related_resource: string
display_label: string

api_count: object

A generic definition of an integer count for the BYU University API

value: integer (int32)
api_type: string , x ∈ { modifiable , read-only , related , system }
key: boolean
related_resource: string
display_label: string

api_date: object

BYU API date property that is a key

value: string (date-time)
api_type: string , x ∈ { modifiable , read-only , related , system }
key: boolean
related_resource: string
display_label: string

api_person_id: object

A generic definition of a person ID for the BYU University API

value: string , must match ^[0-9]{9}$
api_type: string , x ∈ { modifiable , read-only , related , system }
key: boolean
related_resource: string
display_label: string

api_string: object

A generic description field for the BYU University API

value: string
api_type: string , x ∈ { modifiable , read-only , related , system }
key: boolean
related_resource: string
domain: string (uri)
display_label: string
description: string

api_zero_positive_integer: object

An explanation about the puropose of this instance described by this schema.

value: integer , { x ∈ ℤ | x ≥ 0 }
api_type: string , x ∈ { modifiable , read-only , related , system }
key: boolean
related_resource: string
display_label: string

assigned_program: object

An assigned Academic Program to the Academic Unit

links: object

Hypermedia Links that impact the subordinate Academic Unit

assigned_programs.info: link
assigned_programs.unassign: link

metadata: object

field_sets_returned: object[]

object

field_sets_available: object[]

object

default_field_sets: object[]

object

contexts_available: object

all: object[]: object

validation_response: validation_response

effective_date: api_date

expired_date: api_date

academic_program: academic_program

assigned_programs: object

A collection of assigned Academic Programs to the Academic Unit

links: object

Hypermedia Links that impact the entire Academic Programs collection

assigned_programs.info: link
assigned_programs.prev: link
assigned_programs.next: link
assigned_programs.assign: link

metadata: object

collection_size: integer , { x ∈ ℤ | x ≥ 0 }

page_start: integer , { x ∈ ℤ | x ≥ 0 }

page_end: integer , { x ∈ ℤ | x ≥ 0 }

page_size: integer , { x ∈ ℤ | x ≥ 0 }

default_page_size: integer , { x ∈ ℤ | x ≥ 1 }

max_page_size: integer , { x ∈ ℤ | x ≥ 0 }

field_sets_returned: object[]

object

field_sets_available: object[]

object

default_field_sets: object[]

object

contexts_available: object

all: object[]: object

validation_response: validation_response

values: object[]

assigned_program

assigned_teaching_area: object

An assigned Teaching Area for the Academic Unit

links: object

Hypermedia Links that impact the essential data in the relationship of an assigned Teaching Area to an Academic Unit

assigned_teaching_areas.info: link
assigned_teaching_areas.unassign: link

metadata: object

field_sets_returned: object[]

object

field_sets_available: object[]

object

default_field_sets: object[]

object

contexts_available: object

all: object[]: object

validation_response: validation_response

effective_date: api_date

expired_date: api_date

teaching_area: teaching_area

updated_by: updated_by

assigned_teaching_areas: object

A collection of assigned Teaching Areas to the Academic Unit

links: object

Hypermedia Links that impact the entire assigned Teaching Areas collection

assigned_teaching_areas.info: link
assigned_teaching_areas.prev: link
assigned_teaching_areas.next: link
assigned_teaching_areas.assign: link

metadata: object

collection_size: integer , { x ∈ ℤ | x ≥ 0 }

page_start: integer , { x ∈ ℤ | x ≥ 0 }

page_end: integer , { x ∈ ℤ | x ≥ 0 }

page_size: integer , { x ∈ ℤ | x ≥ 0 }

default_page_size: integer , { x ∈ ℤ | x ≥ 1 }

max_page_size: integer , { x ∈ ℤ | x ≥ 0 }

field_sets_returned: object[]

object

field_sets_available: object[]

object

default_field_sets: object[]

object

contexts_available: object

all: object[]: object

validation_response: validation_response

values: object[]

assigned_teaching_area

contact: object

The structure between an entity that tracts who updated the entity and when.

links: object

Hypermedia Links that impact a single Contact

contacts.info: link
contacts.modify: link
contacts.remove: link

metadata: object

field_sets_returned: object[]

object

field_sets_available: object[]

object

default_field_sets: object[]

object

contexts_available: object

all: object[]: object

validation_response: validation_response

contact_type: academic_unit_contact_type

effective_date: api_date

expired_date: api_date

contact_note: api_string

identity: identity

updated_by: updated_by

contacts: object

A collection of contacts for an Academic Unit

links: object

Hypermedia Links that impact the entire collection of contacts for an Academic Unit

contacts.info: link
contacts.prev: link
contacts.next: link
contacts.add: link

metadata: object

collection_size: integer , { x ∈ ℤ | x ≥ 0 }

page_start: integer , { x ∈ ℤ | x ≥ 0 }

page_end: integer , { x ∈ ℤ | x ≥ 0 }

page_size: integer , { x ∈ ℤ | x ≥ 0 }

default_page_size: integer , { x ∈ ℤ | x ≥ 1 }

max_page_size: integer , { x ∈ ℤ | x ≥ 0 }

field_sets_returned: object[]

object

field_sets_available: object[]

object

default_field_sets: object[]

object

contexts_available: object

all: object[]: object

validation_response: validation_response

values: object[]

contact

contexts_available: object

Contexts Available

all: object[]: object

error: object

Error Information

return_code: integer (int32)
explanation: string
error_data: string

field_set_strings: string , x ∈ { basic , parent_academic_unit , sub_academic_units , assigned_programs , assigned_teaching_areas , contacts }

List of available field sets

identity: object

An Identity

links: object

Hypermedia Links that impact an Identity

identity.info: link

metadata: object

validation_response: validation_response

identity_id: api_string

name: api_string

address: api_string

phone_number: api_string

e_mail: api_string

link: object

Hypermedia link format

rel: string
href: string (uri)
method: string , x ∈ { DELETE , GET , OPTIONS , POST , PUT }
title: string

metadata: object

collection_size: integer , { x ∈ ℤ | x ≥ 0 }
page_start: integer , { x ∈ ℤ | x ≥ 0 }
page_end: integer , { x ∈ ℤ | x ≥ 0 }
page_size: integer , { x ∈ ℤ | x ≥ 0 }
default_page_size: integer , { x ∈ ℤ | x ≥ 1 }
max_page_size: integer , { x ∈ ℤ | x ≥ 0 }
field_sets_returned: object[]: field_set_strings
field_sets_available: object[]: field_set_strings
default_field_sets: object[]: field_set_strings
contexts_available: contexts_available
validation_response: validation_response

methods: string[]

Supported HTTP Methods

string , x ∈ { DELETE , GET , OPTIONS , POST , PUT }

parent_academic_unit: object

Data for a parent Academic Unit

links: object

Hypermedia Links that impact the Academic Unit

parent_academic_unit.info: link
parent_academic_unit.assign: link
parent_academic_unit.unassign: link

metadata: object

field_sets_returned: object[]

object

field_sets_available: object[]

object

default_field_sets: object[]

object

contexts_available: object

all: object[]: object

validation_response: validation_response

academic_unit: academic_unit_basic

sub_academic_unit: object

A subordinate Academic Unit

links: object

Hypermedia Links that impact the subordinate Academic Unit

sub_academic_units.info: link
sub_academic_units.remove: link

metadata: object

field_sets_returned: object[]

object

field_sets_available: object[]

object

default_field_sets: object[]

object

contexts_available: object

all: object[]: object

validation_response: validation_response

effective_date: api_date

expired_date: api_date

academic_unit: academic_unit_basic

sub_academic_units: object

A collection of Subordinate Academic Units

links: object

Hypermedia Links that impact the entire Subordinate Academic Units collection

sub_academic_units.info: link
sub_academic_units.prev: link
sub_academic_units.next: link
sub_academic_units.add: link

metadata: object

collection_size: integer , { x ∈ ℤ | x ≥ 0 }

page_start: integer , { x ∈ ℤ | x ≥ 0 }

page_end: integer , { x ∈ ℤ | x ≥ 0 }

page_size: integer , { x ∈ ℤ | x ≥ 0 }

default_page_size: integer , { x ∈ ℤ | x ≥ 1 }

max_page_size: integer , { x ∈ ℤ | x ≥ 0 }

field_sets_returned: object[]

object

field_sets_available: object[]

object

default_field_sets: object[]

object

contexts_available: object

all: object[]: object

validation_response: validation_response

values: object[]

sub_academic_unit

teaching_area: object

A Teaching Area

links: object

Hypermedia Links that impact an assigned Teaching Area to the Academic Unit