AcademicClassScheduleClass

This service accesses the classes for which the student has registered for a given term. The operations of this service correspond to the class schedule capabilities of the CLS10 web page in the AIM System.

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

Base URL: /domains/legacy/academic/classschedule/class

Version: v1

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

Summary

Path Operation Description
/delete/{curriculum_id}/{title_code}/{section_number}/{year_term} DELETE

Deletes a class record (CURRENTLY NOT SUPPORTED)

/documentation GET

service definition

/{teaching_area_curriculum_id}/{catalog_number_title_code}/{section_number}/{year_term} GET

Returns the class schedule record.

Paths

Deletes a class record (CURRENTLY NOT SUPPORTED)

DELETE /delete/{curriculum_id}/{title_code}/{section_number}/{year_term}

Tags: ClassService

Deletes a class record (CURRENTLY NOT SUPPORTED)

curriculum_id

string -> 5 digit int

path string
title_code

string -> 3 digit int

path string
section_number

string -> 3 digit int

path string
year_term

string -> YYYY[1|3|4|5]

path string

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.

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

Returns the class schedule record.

GET /{teaching_area_curriculum_id}/{catalog_number_title_code}/{section_number}/{year_term}

Tags: ClassService

Returns the class schedule record.

teaching_area_curriculum_id

string -> string of 3 to 5 chars

path string
catalog_number_title_code

string -> 3 digit int that sometimes has an appended char

path string
section_number

string -> 3 digit int

path string
year_term

string -> YYYY[1|3|4|5]

path string

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.

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

adds: number

building: string

capacity: string

class_end_date: string

class_fee: string

class_start_date: string

class_title: string

ClassScheduleRecordService: object

request: request
response: response

combined_classes: string[]

string

count: number

count_category: string

count_type: string

course: string

credit_hours: number

credit_type: string

cross_listed_courses: string[]

string

curriculum_id: string

days: string

drops: number

end_date: string

end_time: string

event_type: string

final_events: object[]

object
status: status
event_type: event_type
start_time: start_time
end_time: end_time
days: days
room: room
building: building
start_date: start_date
end_date: end_date
scheduling_type: scheduling_type
capacity: capacity

final_flag: string

ge_area: string

grade_due_date: string

grade_due_time: string

help_records: string[]

string

honors: boolean

instructors: string[]

string

lab_hours: number

lab_quiz: string

lecture_hours: number

min_credit_hours: number

raincheck_allowed: boolean

raincheck_total: string

reg_end_date: string

reg_method: string

reg_method_description: string

reg_start_date: string

request: object

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

response: object

course: course
section: section
class_title: class_title
curriculum_id: curriculum_id
title_code: title_code
updated_time: updated_time
update_by: update_by
cross_listed_courses: cross_listed_courses
section_information: section_information
room_schedule: room_schedule
instructors: instructors
size_mix_totals: size_mix_totals
combined_classes: combined_classes

room: string

room_events: object[]

object
status: status
event_type: event_type
start_time: start_time
end_time: end_time
days: days
room: room
building: building
start_date: start_date
end_date: end_date
scheduling_type: scheduling_type
capacity: capacity

room_schedule: object

room_events: room_events
final_events: final_events
help_records: help_records

scheduling_type: string

section: string

section_information: object

credit_hours: credit_hours
lecture_hours: lecture_hours
lab_hours: lab_hours
min_credit_hours: min_credit_hours
section_status: section_status
section_size: section_size
class_fee: class_fee
raincheck_total: raincheck_total
waitlist_total: waitlist_total
section_type: section_type
credit_type: credit_type
raincheck_allowed: raincheck_allowed
waitlist_status: waitlist_status
honors: honors
service_learning: service_learning
reg_method: reg_method
reg_method_description: reg_method_description
ge_area: ge_area
lab_quiz: lab_quiz
reg_start_date: reg_start_date
reg_end_date: reg_end_date
class_start_date: class_start_date
class_end_date: class_end_date
withdraw_by: withdraw_by
grade_due_date: grade_due_date
grade_due_time: grade_due_time
total_enrolled: total_enrolled
total_adds: total_adds
total_drops: total_drops
final_flag: final_flag

section_size: number

section_status: string

section_type: string

service_learning: string

size_mix_totals: object

count_category: count_category
count_type: count_type
count: count
total_enrolled: total_enrolled
adds: adds
drops: drops

start_date: string

start_time: string

status: string

title_code: string

total_adds: number

total_drops: number

total_enrolled: string

update_by: string

updated_time: string

waitlist_status: string

waitlist_total: number

withdraw_by: string

Service Path: 
/domains/legacy/academic/classschedule/class
Domain or University API: 
/domains/D/academic/classschedule/class

Community

 

Don't see your question listed here? Ask!