AcademicRegistrationOfferings

This service accesses class schedule and catalog information in the AIM System.

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

Base URL: /domains/legacy/academic/registration/offerings

Version: v1

Default response content-types: application/json, application/xml
Schemes: https

Summary

Path Operation Description
/ GET

Get the list of available year terms.

PUT

Add a class

/documentation GET

service definition

/{year_term} GET

Get the list of available teaching areas within a year term.

/{year_term}/{teaching_area} GET

Get the list of available courses within a teaching area.

/{year_term}/{teaching_area}/{curriculum_id}/{title_code} GET

Get the list of availabe sections and their information within a course.

Paths

Get the list of available year terms.

GET /

Tags: OfferingsService

Get the list of available year terms.

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"course_catalog_information": [
]
,
"course_selected": "*",
"registration_year_terms ": [
"20175",
"20181",
"20183",
"20184"
]
,
"teaching_area": "*",
"year_term": "*"
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Add a class

PUT /

Tags: OfferingsService

Add a class

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

service definition

GET /documentation

service definition

Uses default content-types: application/json application/xml

200 OK

Success

Get the list of available teaching areas within a year term.

GET /{year_term}

Tags: OfferingsService

Get the list of available teaching areas within a year term.

year_term

yearTerm -> [1-2][0-9]{3}[1345]

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/20181/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"course_catalog_information": [
]
,
"course_selected": "*",
"registration_year_terms ": [
"20175",
"20181",
"20183",
"20184"
]
,
"teaching_area": "*",
"teaching_areas ": [
{
"department": "C S",
"description": "Computer Science"
}
]
,
"year_term": "20181"
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get the list of available courses within a teaching area.

GET /{year_term}/{teaching_area}

Tags: OfferingsService

Get the list of available courses within a teaching area.

year_term

yearTerm -> [1-2][0-9]{3}[1345]

path string
teaching_area

string ->

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/20181/C S/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"course_catalog_information": [
]
,
"course_selected": "*",
"courses ": [
{
"catalog_number": "142",
"course_title": "Intro to Computer Programming",
"curriculum_id": "01489",
"title_code": "002"
}
]
,
"registration_year_terms ": [
"20175",
"20181",
"20183",
"20184"
]
,
"teaching_area": "C S",
"teaching_areas ": [
{
"department": "C S",
"description": "Computer Science"
}
]
,
"year_term": "20181"
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get the list of availabe sections and their information within a course.

GET /{year_term}/{teaching_area}/{curriculum_id}/{title_code}

Tags: OfferingsService

Get the list of availabe sections and their information within a course.

year_term

yearTerm -> [1-2][0-9]{3}[1345]

path string
teaching_area

string ->

path string
curriculum_id

string ->

path string
title_code

string ->

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/20181/C S/01489/002/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"course_catalog_information": [
{
"catalog_name": "C S 142 - Introduction to Computer Programming.",
"course_sections": [
{
"add_action": "",
"available_seats": "63",
"building": "TMCB",
"class_period": "1:00a - 11:50p",
"course_fee": "",
"credit_hours": "3.0",
"days": "MWF",
"honors": "false",
"instructor": "Professor, Name",
"lab_quiz_section": "",
"limitations": "",
"na1": "005",
"permission_code_accepted": "true",
"permission_code_required": "false",
"room": "1170",
"section": "005",
"section_begin_date": "2018-01-08",
"section_end_date": "2018-04-18",
"section_size": "150",
"section_type": "",
"sequence": "parent",
"waitlist_count": "0"
}
]
,
"credit_hours": "3.0 credit hours, 3 class hours a week, and 0 lab hours",
"curriculum_id": "01489",
"description": "Introduction to object-oriented program design and development. Principles of algorithm formulation and implementation.",
"header_list": [
]
,
"header_text": "CS 142 section 006 is taught online.  Generally there are no formal class meetings, however students are 1) expected to attend orientation sessions during the first week of class, 2) required to take the exams in the Computer Science department computer labs, and 3) encouraged to attend a few special class meetings scheduled from time to time during the course of the semester.  Students must be attentive to their email if enrolled in this class. Students with no experience in computer science may be better served by one of the other sections which are taught in a traditional setting. CS 142 section 005 is taught online.  Generally there are no formal class meetings, however students are 1) expected to attend orientation sessions during the first week of class, 2) required to take the exams in the Computer Science department computer labs, and 3) encouraged to attend a few special class meetings scheduled from time to time during the course of the semester.  Students must be attentive to their email if enrolled in this class. Students with no experience in computer science may be better served by one of the other sections which are taught in a traditional setting.",
"note": "Students are allowed only 1 retake of C S 142. This includes students who have failed or withdrawn (received a %22W%22 grade). If after 1 retake, a student needs to retake the course again, the student must wait 1 semester/term before being allowed to take any C S course and must follow the petition process at cs.byu.edu/retake-policy. This policy does not apply to classes dropped before the add/drop deadline. Petitions for exceptions to the policy can be completed at cs.byu.edu/retake-policy.",
"offered": "Please See Department",
"prerequisites": "Knowledge of algebra. Knowledge of algebra.",
"recommended": "None",
"semester": "Winter 2018 (08 Jan 2018 - 18 Apr 2018)",
"slc_sections": [
{
"add_action": "",
"available_seats": "15",
"building": "SLC",
"class_period": "1:00a - 11:50p",
"course_fee": "",
"credit_hours": "3.0",
"days": "MWF",
"honors": "false",
"instructor": "Professor, Name",
"lab_quiz_section": "0",
"limitations": "",
"na1": "007",
"permission_code_accepted": "false",
"permission_code_required": "false",
"room": "318",
"section": "007",
"section_begin_date": "2018-01-08",
"section_end_date": "2018-04-18",
"section_size": "30",
"section_type": "SALT LAKE",
"sequence": "parent",
"waitlist_count": ""
}
]
,
"title_code": "002",
"when_taught": "Fall; Winter; Spring."
}
]
,
"course_selected": "142",
"courses ": [
{
"catalog_number": "142",
"course_title": "Intro to Computer Programming",
"curriculum_id": "01489",
"title_code": "002"
}
]
,
"num_records": "7",
"teaching_area": "C S",
"teaching_areas ": [
{
"department": "C S",
"description": "Computer Science"
}
]
,
"year_term": "20181"
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Schema definitions

add_action: string

available_seats: string

building: string

catalog_name: string

catalog_number: string

class_period: string

course_catalog_information: object[]

object
catalog_name: catalog_name
description: description
credit_hours: credit_hours
header_text: header_text
header_list: header_list
prerequisites: prerequisites
recommended: recommended
note: note
when_taught: when_taught
offered: offered
semester: semester
curriculum_id: curriculum_id
title_code: title_code
course_sections: course_sections
slc_sections: slc_sections

course_fee: string

course_sections: object[]

object
sequence: sequence
permission_code_accepted: permission_code_accepted
permission_code_required: permission_code_required
add_action: add_action
limitations: limitations
section: section
section_type: section_type
available_seats: available_seats
section_size: section_size
waitlist_count: waitlist_count
lab_quiz_section: lab_quiz_section
credit_hours: credit_hours
class_period: class_period
days: days
room: room
building: building
honors: honors
na1: na1
instructor: instructor
section_begin_date: section_begin_date
section_end_date: section_end_date
course_fee: course_fee

course_selected: string

course_title: string

courses: object[]

object
curriculum_id: curriculum_id
title_code: title_code
catalog_number: catalog_number
course_title: course_title

credit_hours: string

curriculum_id: string

days: string

department: string

description: string

error_data: object

code: string
name: string
message: string
httpStatusCode: number

ErrorResponse: object

request: object
method: string
resource: string
attributes: string
status: number
statusMessage: string
errors: errors
response: object

errors: object[]

header_list: object[]

object

header_text: string

honors: string

instructor: string

lab_quiz_section: string

limitations: string

na1: string

note: string

num_records: string

offered: string

permission_code_accepted: string

permission_code_required: string

prerequisites: string

registration_year_terms: string[]

string

RegOfferingsService: object

request: request
response: response

RegOfferingsServiceTeachingArea: object

request: request
response: responseTeachingArea

RegOfferingsServiceTeachingAreaCurriculumId: object

RegOfferingsServiceYearTerm: object

request: request
response: responseYearTerm

request: object

method: string
resource: string
attributes: string
status: number
statusMessage: string

response: object

year_term: year_term
teaching_area: teaching_area
course_selected: course_selected
registration_year_terms : registration_year_terms
course_catalog_information: course_catalog_information

responseTeachingArea: object

year_term: year_term
teaching_area: teaching_area
course_selected: course_selected
registration_year_terms : registration_year_terms
teaching_areas : teaching_areas
courses : courses
course_catalog_information: course_catalog_information

responseTeachingAreaCurriculumId: object

year_term: year_term
num_records: num_records
teaching_area: teaching_area
course_selected: course_selected
teaching_areas : teaching_areas
courses : courses
course_catalog_information: course_catalog_information

responseYearTerm: object

year_term: year_term
teaching_area: teaching_area
course_selected: course_selected
registration_year_terms : registration_year_terms
teaching_areas : teaching_areas
course_catalog_information: course_catalog_information

room: string

section: string

section_begin_date: string

section_end_date: string

section_size: string

section_type: string

semester: string

sequence: string

slc_sections: object[]

object
sequence: sequence
permission_code_accepted: permission_code_accepted
permission_code_required: permission_code_required
add_action: add_action
limitations: limitations
section: section
section_type: section_type
available_seats: available_seats
section_size: section_size
waitlist_count: waitlist_count
lab_quiz_section: lab_quiz_section
credit_hours: credit_hours
class_period: class_period
days: days
room: room
building: building
honors: honors
na1: na1
instructor: instructor
section_begin_date: section_begin_date
section_end_date: section_end_date
course_fee: course_fee

teaching_area: string

teaching_areas: object[]

object
department: department
description: description

title_code: string

waitlist_count: string

when_taught: string

year_term: string

Service Path: 
/domains/legacy/academic/registration/offerings
Domain or University API: 
/domains/D/academic/registration/offerings

Community

 

Don't see your question listed here? Ask!