Meta

Meta resources of the University API

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /byuapi/meta

Version: v1

Default request content-types: application/json
Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/buildings GET

Buildings

/class_begin_times GET

Class Begin Times

/class_block_codes GET

Class Block Codes

/class_end_times GET

Class End Times

/class_instructors GET

Class Instructors

/course_levels GET

Course Levels

/course_numbers GET

Course Numbers

/credit_hours GET

Credit Hours

/section_types GET

Section Types

/teaching_areas GET

Returns a collection of Teaching Areas

OPTIONS

Teaching Areas

POST

Create a new Teaching Area

/teaching_areas/{teaching_area},{effective_date} DELETE

Expire a specific Teaching Area

GET

An Teaching Area

OPTIONS

Teaching Areas

/year_terms GET

Year Terms

Paths

Buildings

GET /buildings

Tags: Buildings

Returns a collection of Buildings

class_schedule

Return only the buildings that have classes scheduled in them

query boolean
year_term

Return only the buildings that have classes scheduled in them, in the given Year Term.

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No items satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Class Begin Times

GET /class_begin_times

Tags: ClassTimes

Returns a collection of all the possible start times for classes.

class_schedule

Return only the begin times for classes that are currently scheduled.

query boolean
year_term

Return only the begin times for classes that are scheduled in the given year_term.

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No items satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Class Block Codes

GET /class_block_codes

Tags: YearTerms

Returns a collection of Class Block Codes.

year_term

Returns the block codes for the given Year Term.

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No items satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Class End Times

GET /class_end_times

Tags: ClassTimes

Returns a collection of all possible end times for classes.

class_schedule

Returns only the end times for classes that are currently scheduled.

query boolean
year_term

Returns only the end times for classes that are scheduled in the given Year Term.

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No items satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Class Instructors

GET /class_instructors

Tags: ClassInstructors

Returns a collection of Class Instructors.

class_schedule

Returns only instructors of currently scheduled classes.

query boolean
year_term

Returns only instructors of classes scheduled in the given Year Term.

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No items satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Course Levels

GET /course_levels

Tags: CourseLevels

Returns a collection of Course Levels.

class_schedule

Returns only the course levels for currently scheduled classes.

query boolean
year_term

Returns only the course levels for classes scheduled in the given Year Term.

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No items satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Course Numbers

GET /course_numbers

Tags: CourseNumbers

Returns a collection of Course Numbers.

class_schedule

Returns only the course numbers for classes that are currently scheduled.

query boolean
teaching_area

Returns only the course numbers for courses in the given teaching area.

query string
year_term

Returns only the course numbers for classes that are scheduled in the given Year Term.

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No items satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Credit Hours

GET /credit_hours

Tags: CreditHours

Returns a collection of credit hours.

class_schedule

Returns only the set of credit hours for currently scheduled classes.

query boolean
year_term

Returns only the set of credit hours for classes that are scheduled in the given Year Term.

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No items satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Section Types

GET /section_types

Tags: SectionTypes

Returns a collection of section types.

class_schedule

Returns only the section types of currently scheduled classes.

query boolean
year_term

Returns only the section types of classes scheduled in the given year term.

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No items satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Returns a collection of Teaching Areas

GET /teaching_areas

Tags: TeachingAreas

Returns a collection of Teaching Areas

as_of_date

Date that lies between the effective and expired of the Teaching Area

query string
teaching_area

Teaching Area

query string
effective_date

Effective date of the Teaching Area

query string
expired_date

Expired date of the Teaching Area

query string
name

Name of the Teaching Area

query string
date_time_updated

Date/Time Teaching Area was last updated

query string
updated_by_id

ID of person who last updated Teaching Area

query string
updated_by_name

Name of person who last updated Teaching Area

query string
class_schedule

Return only the teaching areas that have classes scheduled in them.

query boolean
page_start

Skip into 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
year_term

Return only the teaching areas that have classes scheduled in them in the given year term.

query string

Uses default content-types: application/json

200 OK

A collection of Teaching Areas

204 No Content

No Teaching Areas satisfy the query parameters - the collection is empty

400 Bad Request

Query parameters conflict or are malformed

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

default

Unexpected error

Teaching Areas

OPTIONS /teaching_areas

Tags: TeachingAreas

What can this endpoint do?

Uses default content-types: application/json

200 OK

Supported HTTP Methods

default

Unexpected error

Create a new Teaching Area

POST /teaching_areas

Tags: TeachingAreas

Create a new Teaching Area

Uses default content-types: application/json

The Teaching Area to be added

Uses default content-types: application/json

201 Created

Returns the Teaching Area that was added

400 Bad Request

Body of the request contains conflicting, malformed, or invalid data

401 Unauthorized

Authentication required to add a new Teaching Area

403 Forbidden

Access denied - not authorized to add the new Teaching Area

default

Unexpected error

Expire a specific Teaching Area

DELETE /teaching_areas/{teaching_area},{effective_date}

Tags: TeachingAreas

Expire a specific Teaching Area

teaching_area

The specific Teaching Area

path string
effective_date

The specific Teaching Area effective date

path string (date-time)

Uses default content-types: application/json

200 OK

The specific Teaching Area that was successfully expired

204 No Content

No Teaching Area found that matches key value

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to expire an Teaching Area

403 Forbidden

Access denied to protected data

default

Unexpected error

An Teaching Area

GET /teaching_areas/{teaching_area},{effective_date}

Tags: TeachingAreas

Returns a specific Teaching Area

teaching_area

The specific Teaching Area

path string
effective_date

The specific Teaching Area effective date

path string (date-time)
expired_date

Expired date of the Teaching Area

query string
name

Name of the Teaching Area

query string
date_time_updated

Date/Time Teaching Area was last updated

query string
updated_by_id

ID of person who last updated Teaching Area

query string
updated_by_name

Name of person who last updated Teaching Area

query string

Uses default content-types: application/json

200 OK

An Teaching Areas

204 No Content

No class found that matches key values

400 Bad Request

Query parameters conflict or are malformed

401 Unauthorized

Authentication required to retrieve specific Teaching Area

403 Forbidden

Access denied to protected data

default

Unexpected error

Teaching Areas

OPTIONS /teaching_areas/{teaching_area},{effective_date}

Tags: TeachingAreas

What can this endpoint do?

teaching_area

The specific Teaching Area

path string
effective_date

The specific Teaching Area effective date

path string (date-time)

Uses default content-types: application/json

200 OK

Supported HTTP Methods

400 Bad Request

Invalid Request - unable to interpret request

default

Unexpected error

Year Terms

GET /year_terms

Tags: YearTerms

Returns a collection of Year Terms.

class_schedule

Returns only the set of Year Terms that have scheduled classes.

query boolean

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No items satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Schema definitions

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_number: object

A generic numeric field for the BYU University API

value: number
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
display_label: string
desc: string
ext_desc: string

building: object

A building

links: building_links
building: api_string
building_name: api_string

buildings: object

A collection of Buildings

links: buildings_links
metadata: metadata
values: object[]

class_begin_time: object

A Class Begin Time

links: class_begin_time_link
begin_time: api_string
begin_time_formatted: api_string

class_begin_times: object

A collection of Class Begin Times

links: class_begin_times_links
metadata: metadata
values: object[]

class_block_code: object

A Class Block Code

links: class_block_code_link
block_code: api_string

class_block_codes: object

A collection of Class Block Codes

links: class_block_codes_links
metadata: metadata
values: object[]

class_end_time: object

A Class End Time

links: class_end_time_link
end_time: api_string
end_time_formatted: api_string

class_end_times: object

A collection of Class End Times

links: class_end_times_links
metadata: metadata
values: object[]

class_instructor: object

A Class Instructor

links: class_instructor_link
instructor_name: api_string
instructor_id: api_string
department: api_string

class_instructors: object

A collection of Class Instructors

links: class_instructors_links
metadata: metadata
values: object[]

course_level: object

A Course Level

links: course_level_link
course_level: api_string

course_levels: object

A collection of Course Levels

links: course_levels_links
metadata: metadata
values: object[]

course_number: object

A Course Number

links: course_number_link
curriculum_id: api_string
title_code: api_string
course_number: api_string
course_suffix: api_string
course_title: api_string

course_numbers: object

A collection of Course Numbers

links: course_numbers_links
metadata: metadata
values: object[]

credit_hour: object

A Credit Hour

links: credit_hour_link
credit_hours: api_number

credit_hours: object

A collection of Credit Hours

links: credit_hours_links
metadata: metadata
values: object[]

error: object

Error Information

return_code: integer (int32)
explanation: string
error_data: 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 }
validation_response: validation_response

methods: string[]

Supported HTTP Methods

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

section_type: object

A Section Type

links: section_type_link
section_type: api_string

section_types: object

A collection of Section Types

links: section_types_links
metadata: metadata
values: object[]

teaching_area: object

A Teaching Area

links: teaching_area_link
teaching_area: api_string
effective_date: api_date
expired_date: api_date
name: api_string
academic_unit_id: api_string
unit_name: api_string
previous_teaching_area: api_string
date_time_updated: api_date
updated_by_id: api_person_id
updated_by_name: api_string

teaching_areas: object

A collection of Teaching Areas

links: teaching_areas_links
metadata: metadata
values: object[]

validation_response: object

return_code: integer
response: string

year_term: object

A Year Term

links: year_term_link
year_term: api_string

year_terms: object

A collection of Year Terms

links: year_terms_links
metadata: metadata
values: object[]
Service Path: 
/byuapi/meta
Domain or University API: 
/U/meta
Tags: 

Community

 

Don't see your question listed here? Ask!

Tags